libZSservicesZSamazonka-waf-regionalZSamazonka-waf-regional
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.WAFRegional.CreateWebACLMigrationStack

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

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

Read CreateWebACLMigrationStack Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack

Show CreateWebACLMigrationStack Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack

Generic CreateWebACLMigrationStack Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack

Associated Types

type Rep CreateWebACLMigrationStack :: Type -> Type #

NFData CreateWebACLMigrationStack Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack

Hashable CreateWebACLMigrationStack Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack

ToJSON CreateWebACLMigrationStack Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack

AWSRequest CreateWebACLMigrationStack Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack

ToHeaders CreateWebACLMigrationStack Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack

ToPath CreateWebACLMigrationStack Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack

ToQuery CreateWebACLMigrationStack Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack

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

newCreateWebACLMigrationStack Source #

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 #

Constructors

CreateWebACLMigrationStackResponse' 

Fields

Instances

Instances details
Eq CreateWebACLMigrationStackResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack

Read CreateWebACLMigrationStackResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack

Show CreateWebACLMigrationStackResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack

Generic CreateWebACLMigrationStackResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack

Associated Types

type Rep CreateWebACLMigrationStackResponse :: Type -> Type #

NFData CreateWebACLMigrationStackResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateWebACLMigrationStack

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 #

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