Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.WAFRegional.CreateWebACLMigrationStack

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the specified Amazon S3 bucket. Then, in CloudFormation, you create a stack from the template, to create the web ACL and its resources in AWS WAFV2. Use this to migrate your AWS WAF Classic web ACL to the latest version of AWS WAF.

This is part of a larger migration procedure for web ACLs from AWS WAF Classic to the latest version of AWS WAF. For the full procedure, including caveats and manual steps to complete the migration and switch over to the new web ACL, see Migrating your AWS WAF Classic resources to AWS WAF in the AWS WAF Developer Guide.

Synopsis

data CreateWebACLMigrationStack = CreateWebACLMigrationStack' {
- webACLId :: Text
- s3BucketName :: Text
- ignoreUnsupportedType :: Bool
}
newCreateWebACLMigrationStack :: Text -> Text -> Bool -> CreateWebACLMigrationStack
createWebACLMigrationStack_webACLId :: Lens' CreateWebACLMigrationStack Text
createWebACLMigrationStack_s3BucketName :: Lens' CreateWebACLMigrationStack Text
createWebACLMigrationStack_ignoreUnsupportedType :: Lens' CreateWebACLMigrationStack Bool
data CreateWebACLMigrationStackResponse = CreateWebACLMigrationStackResponse' {
- httpStatus :: Int
- s3ObjectUrl :: Text
}
newCreateWebACLMigrationStackResponse :: Int -> Text -> CreateWebACLMigrationStackResponse
createWebACLMigrationStackResponse_httpStatus :: Lens' CreateWebACLMigrationStackResponse Int
createWebACLMigrationStackResponse_s3ObjectUrl :: Lens' CreateWebACLMigrationStackResponse Text

Creating a Request

data CreateWebACLMigrationStack Source #

See: newCreateWebACLMigrationStack smart constructor.

Constructors

CreateWebACLMigrationStack'

Fields

webACLId :: Text
The UUID of the WAF Classic web ACL that you want to migrate to WAF v2.
s3BucketName :: Text
The name of the Amazon S3 bucket to store the CloudFormation template in. The S3 bucket must be configured as follows for the migration:
- The bucket name must start with aws-waf-migration-. For example, aws-waf-migration-my-web-acl.
- The bucket must be in the Region where you are deploying the template. For example, for a web ACL in us-west-2, you must use an Amazon S3 bucket in us-west-2 and you must deploy the template stack to us-west-2.
- The bucket policies must permit the migration process to write data. For listings of the bucket policies, see the Examples section.
ignoreUnsupportedType :: Bool
Indicates whether to exclude entities that can't be migrated or to stop the migration. Set this to true to ignore unsupported entities in the web ACL during the migration. Otherwise, if AWS WAF encounters unsupported entities, it stops the process and throws an exception.

Instances

Instances details

Eq CreateWebACLMigrationStack Source #
Instance details Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack Methods (==) :: CreateWebACLMigrationStack -> CreateWebACLMigrationStack -> Bool # (/=) :: CreateWebACLMigrationStack -> CreateWebACLMigrationStack -> Bool #
Read CreateWebACLMigrationStack Source #
Instance details Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack Methods readsPrec :: Int -> ReadS CreateWebACLMigrationStack # readList :: ReadS [CreateWebACLMigrationStack] # readPrec :: ReadPrec CreateWebACLMigrationStack # readListPrec :: ReadPrec [CreateWebACLMigrationStack] #
Show CreateWebACLMigrationStack Source #
Instance details Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack Methods showsPrec :: Int -> CreateWebACLMigrationStack -> ShowS # show :: CreateWebACLMigrationStack -> String # showList :: [CreateWebACLMigrationStack] -> ShowS #
Generic CreateWebACLMigrationStack Source #
Instance details Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack Associated Types type Rep CreateWebACLMigrationStack :: Type -> Type # Methods from :: CreateWebACLMigrationStack -> Rep CreateWebACLMigrationStack x # to :: Rep CreateWebACLMigrationStack x -> CreateWebACLMigrationStack #
NFData CreateWebACLMigrationStack Source #
Instance details Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack Methods rnf :: CreateWebACLMigrationStack -> () #
Hashable CreateWebACLMigrationStack Source #
Instance details Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack Methods hashWithSalt :: Int -> CreateWebACLMigrationStack -> Int # hash :: CreateWebACLMigrationStack -> Int #
ToJSON CreateWebACLMigrationStack Source #
Instance details Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack Methods toJSON :: CreateWebACLMigrationStack -> Value # toEncoding :: CreateWebACLMigrationStack -> Encoding # toJSONList :: [CreateWebACLMigrationStack] -> Value # toEncodingList :: [CreateWebACLMigrationStack] -> Encoding #
AWSRequest CreateWebACLMigrationStack Source #
Instance details Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack Associated Types type AWSResponse CreateWebACLMigrationStack # Methods request :: CreateWebACLMigrationStack -> Request CreateWebACLMigrationStack # response :: MonadResource m => Logger -> Service -> Proxy CreateWebACLMigrationStack -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateWebACLMigrationStack))) #
ToHeaders CreateWebACLMigrationStack Source #
Instance details Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack Methods toHeaders :: CreateWebACLMigrationStack -> [Header] #
ToPath CreateWebACLMigrationStack Source #
Instance details Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack Methods toPath :: CreateWebACLMigrationStack -> ByteString #
ToQuery CreateWebACLMigrationStack Source #
Instance details Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack Methods toQuery :: CreateWebACLMigrationStack -> QueryString #
type Rep CreateWebACLMigrationStack Source #
Instance details Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack type Rep CreateWebACLMigrationStack = D1 ('MetaData "CreateWebACLMigrationStack" "Amazonka.WAFRegional.CreateWebACLMigrationStack" "libZSservicesZSamazonka-waf-regionalZSamazonka-waf-regional" 'False) (C1 ('MetaCons "CreateWebACLMigrationStack'" 'PrefixI 'True) (S1 ('MetaSel ('Just "webACLId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "s3BucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "ignoreUnsupportedType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))
type AWSResponse CreateWebACLMigrationStack Source #
Instance details Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack type AWSResponse CreateWebACLMigrationStack = CreateWebACLMigrationStackResponse

newCreateWebACLMigrationStack Source #

Arguments

:: Text	`$sel:webACLId:CreateWebACLMigrationStack'`
-> Text	`$sel:s3BucketName:CreateWebACLMigrationStack'`
-> Bool	`$sel:ignoreUnsupportedType:CreateWebACLMigrationStack'`
-> CreateWebACLMigrationStack

Create a value of CreateWebACLMigrationStack 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:webACLId:CreateWebACLMigrationStack', createWebACLMigrationStack_webACLId - The UUID of the WAF Classic web ACL that you want to migrate to WAF v2.

$sel:s3BucketName:CreateWebACLMigrationStack', createWebACLMigrationStack_s3BucketName - The name of the Amazon S3 bucket to store the CloudFormation template in. The S3 bucket must be configured as follows for the migration:

The bucket name must start with aws-waf-migration-. For example, aws-waf-migration-my-web-acl.
The bucket must be in the Region where you are deploying the template. For example, for a web ACL in us-west-2, you must use an Amazon S3 bucket in us-west-2 and you must deploy the template stack to us-west-2.
The bucket policies must permit the migration process to write data. For listings of the bucket policies, see the Examples section.

$sel:ignoreUnsupportedType:CreateWebACLMigrationStack', createWebACLMigrationStack_ignoreUnsupportedType - Indicates whether to exclude entities that can't be migrated or to stop the migration. Set this to true to ignore unsupported entities in the web ACL during the migration. Otherwise, if AWS WAF encounters unsupported entities, it stops the process and throws an exception.

Request Lenses

createWebACLMigrationStack_webACLId :: Lens' CreateWebACLMigrationStack Text Source #

The UUID of the WAF Classic web ACL that you want to migrate to WAF v2.

createWebACLMigrationStack_s3BucketName :: Lens' CreateWebACLMigrationStack Text Source #

The name of the Amazon S3 bucket to store the CloudFormation template in. The S3 bucket must be configured as follows for the migration:

The bucket name must start with aws-waf-migration-. For example, aws-waf-migration-my-web-acl.
The bucket must be in the Region where you are deploying the template. For example, for a web ACL in us-west-2, you must use an Amazon S3 bucket in us-west-2 and you must deploy the template stack to us-west-2.
The bucket policies must permit the migration process to write data. For listings of the bucket policies, see the Examples section.

createWebACLMigrationStack_ignoreUnsupportedType :: Lens' CreateWebACLMigrationStack Bool Source #

Indicates whether to exclude entities that can't be migrated or to stop the migration. Set this to true to ignore unsupported entities in the web ACL during the migration. Otherwise, if AWS WAF encounters unsupported entities, it stops the process and throws an exception.

Destructuring the Response

data CreateWebACLMigrationStackResponse Source #

See: newCreateWebACLMigrationStackResponse smart constructor.

Constructors

CreateWebACLMigrationStackResponse'
Fields httpStatus :: Int The response's http status code. s3ObjectUrl :: Text The URL of the template created in Amazon S3.

Instances

Instances details

Eq CreateWebACLMigrationStackResponse Source #
Instance details Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack Methods (==) :: CreateWebACLMigrationStackResponse -> CreateWebACLMigrationStackResponse -> Bool # (/=) :: CreateWebACLMigrationStackResponse -> CreateWebACLMigrationStackResponse -> Bool #
Read CreateWebACLMigrationStackResponse Source #
Instance details Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack Methods readsPrec :: Int -> ReadS CreateWebACLMigrationStackResponse # readList :: ReadS [CreateWebACLMigrationStackResponse] # readPrec :: ReadPrec CreateWebACLMigrationStackResponse # readListPrec :: ReadPrec [CreateWebACLMigrationStackResponse] #
Show CreateWebACLMigrationStackResponse Source #
Instance details Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack Methods showsPrec :: Int -> CreateWebACLMigrationStackResponse -> ShowS # show :: CreateWebACLMigrationStackResponse -> String # showList :: [CreateWebACLMigrationStackResponse] -> ShowS #
Generic CreateWebACLMigrationStackResponse Source #
Instance details Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack Associated Types type Rep CreateWebACLMigrationStackResponse :: Type -> Type # Methods from :: CreateWebACLMigrationStackResponse -> Rep CreateWebACLMigrationStackResponse x # to :: Rep CreateWebACLMigrationStackResponse x -> CreateWebACLMigrationStackResponse #
NFData CreateWebACLMigrationStackResponse Source #
Instance details Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack Methods rnf :: CreateWebACLMigrationStackResponse -> () #
type Rep CreateWebACLMigrationStackResponse Source #
Instance details Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack type Rep CreateWebACLMigrationStackResponse = D1 ('MetaData "CreateWebACLMigrationStackResponse" "Amazonka.WAFRegional.CreateWebACLMigrationStack" "libZSservicesZSamazonka-waf-regionalZSamazonka-waf-regional" 'False) (C1 ('MetaCons "CreateWebACLMigrationStackResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "s3ObjectUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateWebACLMigrationStackResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateWebACLMigrationStackResponse'`
-> Text	`$sel:s3ObjectUrl:CreateWebACLMigrationStackResponse'`
-> CreateWebACLMigrationStackResponse

Create a value of CreateWebACLMigrationStackResponse 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:httpStatus:CreateWebACLMigrationStackResponse', createWebACLMigrationStackResponse_httpStatus - The response's http status code.

$sel:s3ObjectUrl:CreateWebACLMigrationStackResponse', createWebACLMigrationStackResponse_s3ObjectUrl - The URL of the template created in Amazon S3.

Response Lenses

createWebACLMigrationStackResponse_httpStatus :: Lens' CreateWebACLMigrationStackResponse Int Source #

The response's http status code.

createWebACLMigrationStackResponse_s3ObjectUrl :: Lens' CreateWebACLMigrationStackResponse Text Source #

The URL of the template created in Amazon S3.