Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudFormation.TestType

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.

For resource types, this includes passing all contracts tests defined for the type.
For modules, this includes determining if the module's model meets all necessary requirements.

For more information, see Testing your public extension prior to publishing in the CloudFormation CLI User Guide.

If you don't specify a version, CloudFormation uses the default version of the extension in your account and region for testing.

To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType.

Once you've initiated testing on an extension using TestType, you can pass the returned TypeVersionArn into DescribeType to monitor the current test status and test status description for the extension.

An extension must have a test status of PASSED before it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.

Synopsis

data TestType = TestType' {
- arn :: Maybe Text
- logDeliveryBucket :: Maybe Text
- type' :: Maybe ThirdPartyType
- typeName :: Maybe Text
- versionId :: Maybe Text
}
newTestType :: TestType
testType_arn :: Lens' TestType (Maybe Text)
testType_logDeliveryBucket :: Lens' TestType (Maybe Text)
testType_type :: Lens' TestType (Maybe ThirdPartyType)
testType_typeName :: Lens' TestType (Maybe Text)
testType_versionId :: Lens' TestType (Maybe Text)
data TestTypeResponse = TestTypeResponse' {
- typeVersionArn :: Maybe Text
- httpStatus :: Int
}
newTestTypeResponse :: Int -> TestTypeResponse
testTypeResponse_typeVersionArn :: Lens' TestTypeResponse (Maybe Text)
testTypeResponse_httpStatus :: Lens' TestTypeResponse Int

Creating a Request

data TestType Source #

See: newTestType smart constructor.

Constructors

TestType'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) of the extension.
Conditional: You must specify Arn, or TypeName and Type.
logDeliveryBucket :: Maybe Text
The S3 bucket to which CloudFormation delivers the contract test execution logs.
CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of PASSED or FAILED.
The user calling TestType must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:
- ```
GetObject
```
- ```
PutObject
```
For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.
type' :: Maybe ThirdPartyType
The type of the extension to test.
Conditional: You must specify Arn, or TypeName and Type.
typeName :: Maybe Text
The name of the extension to test.
Conditional: You must specify Arn, or TypeName and Type.
versionId :: Maybe Text
The version of the extension to test.
You can specify the version id with either Arn, or with TypeName and Type.
If you don't specify a version, CloudFormation uses the default version of the extension in this account and region for testing.

Instances

Instances details

ToHeaders TestType Source #
Instance details Defined in Amazonka.CloudFormation.TestType Methods toHeaders :: TestType -> [Header] #
ToPath TestType Source #
Instance details Defined in Amazonka.CloudFormation.TestType Methods toPath :: TestType -> ByteString #
ToQuery TestType Source #
Instance details Defined in Amazonka.CloudFormation.TestType Methods toQuery :: TestType -> QueryString #
AWSRequest TestType Source #
Instance details Defined in Amazonka.CloudFormation.TestType Associated Types type AWSResponse TestType # Methods request :: (Service -> Service) -> TestType -> Request TestType # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy TestType -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TestType))) #
Generic TestType Source #
Instance details Defined in Amazonka.CloudFormation.TestType Associated Types type Rep TestType :: Type -> Type # Methods from :: TestType -> Rep TestType x # to :: Rep TestType x -> TestType #
Read TestType Source #
Instance details Defined in Amazonka.CloudFormation.TestType Methods readsPrec :: Int -> ReadS TestType # readList :: ReadS [TestType] # readPrec :: ReadPrec TestType # readListPrec :: ReadPrec [TestType] #
Show TestType Source #
Instance details Defined in Amazonka.CloudFormation.TestType Methods showsPrec :: Int -> TestType -> ShowS # show :: TestType -> String # showList :: [TestType] -> ShowS #
NFData TestType Source #
Instance details Defined in Amazonka.CloudFormation.TestType Methods rnf :: TestType -> () #
Eq TestType Source #
Instance details Defined in Amazonka.CloudFormation.TestType Methods (==) :: TestType -> TestType -> Bool # (/=) :: TestType -> TestType -> Bool #
Hashable TestType Source #
Instance details Defined in Amazonka.CloudFormation.TestType Methods hashWithSalt :: Int -> TestType -> Int # hash :: TestType -> Int #
type AWSResponse TestType Source #
Instance details Defined in Amazonka.CloudFormation.TestType type AWSResponse TestType = TestTypeResponse
type Rep TestType Source #
Instance details Defined in Amazonka.CloudFormation.TestType type Rep TestType = D1 ('MetaData "TestType" "Amazonka.CloudFormation.TestType" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "TestType'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "logDeliveryBucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThirdPartyType)) :: (S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newTestType :: TestType Source #

Create a value of TestType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

TestType, testType_arn - The Amazon Resource Name (ARN) of the extension.

Conditional: You must specify Arn, or TypeName and Type.

$sel:logDeliveryBucket:TestType', testType_logDeliveryBucket - The S3 bucket to which CloudFormation delivers the contract test execution logs.

CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of PASSED or FAILED.

The user calling TestType must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:

```
GetObject
```
```
PutObject
```

For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.

TestType, testType_type - The type of the extension to test.

Conditional: You must specify Arn, or TypeName and Type.

TestType, testType_typeName - The name of the extension to test.

Conditional: You must specify Arn, or TypeName and Type.

TestType, testType_versionId - The version of the extension to test.

You can specify the version id with either Arn, or with TypeName and Type.

If you don't specify a version, CloudFormation uses the default version of the extension in this account and region for testing.

Request Lenses

testType_arn :: Lens' TestType (Maybe Text) Source #

The Amazon Resource Name (ARN) of the extension.

Conditional: You must specify Arn, or TypeName and Type.

testType_logDeliveryBucket :: Lens' TestType (Maybe Text) Source #

The S3 bucket to which CloudFormation delivers the contract test execution logs.

CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of PASSED or FAILED.

The user calling TestType must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:

```
GetObject
```
```
PutObject
```

For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.

testType_type :: Lens' TestType (Maybe ThirdPartyType) Source #

The type of the extension to test.

Conditional: You must specify Arn, or TypeName and Type.

testType_typeName :: Lens' TestType (Maybe Text) Source #

The name of the extension to test.

Conditional: You must specify Arn, or TypeName and Type.

testType_versionId :: Lens' TestType (Maybe Text) Source #

The version of the extension to test.

You can specify the version id with either Arn, or with TypeName and Type.

If you don't specify a version, CloudFormation uses the default version of the extension in this account and region for testing.

Destructuring the Response

data TestTypeResponse Source #

See: newTestTypeResponse smart constructor.

Constructors

TestTypeResponse'
Fields typeVersionArn :: Maybe Text The Amazon Resource Name (ARN) of the extension. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic TestTypeResponse Source #
Instance details Defined in Amazonka.CloudFormation.TestType Associated Types type Rep TestTypeResponse :: Type -> Type # Methods from :: TestTypeResponse -> Rep TestTypeResponse x # to :: Rep TestTypeResponse x -> TestTypeResponse #
Read TestTypeResponse Source #
Instance details Defined in Amazonka.CloudFormation.TestType Methods readsPrec :: Int -> ReadS TestTypeResponse # readList :: ReadS [TestTypeResponse] # readPrec :: ReadPrec TestTypeResponse # readListPrec :: ReadPrec [TestTypeResponse] #
Show TestTypeResponse Source #
Instance details Defined in Amazonka.CloudFormation.TestType Methods showsPrec :: Int -> TestTypeResponse -> ShowS # show :: TestTypeResponse -> String # showList :: [TestTypeResponse] -> ShowS #
NFData TestTypeResponse Source #
Instance details Defined in Amazonka.CloudFormation.TestType Methods rnf :: TestTypeResponse -> () #
Eq TestTypeResponse Source #
Instance details Defined in Amazonka.CloudFormation.TestType Methods (==) :: TestTypeResponse -> TestTypeResponse -> Bool # (/=) :: TestTypeResponse -> TestTypeResponse -> Bool #
type Rep TestTypeResponse Source #
Instance details Defined in Amazonka.CloudFormation.TestType type Rep TestTypeResponse = D1 ('MetaData "TestTypeResponse" "Amazonka.CloudFormation.TestType" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "TestTypeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "typeVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newTestTypeResponse Source #

Arguments

:: Int	`$sel:httpStatus:TestTypeResponse'`
-> TestTypeResponse

Create a value of TestTypeResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:typeVersionArn:TestTypeResponse', testTypeResponse_typeVersionArn - The Amazon Resource Name (ARN) of the extension.

$sel:httpStatus:TestTypeResponse', testTypeResponse_httpStatus - The response's http status code.

Response Lenses

testTypeResponse_typeVersionArn :: Lens' TestTypeResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the extension.

testTypeResponse_httpStatus :: Lens' TestTypeResponse Int Source #

The response's http status code.