WAF / Client / create_web_acl_migration_stack

create_web_acl_migration_stack#

WAF.Client.create_web_acl_migration_stack(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.create_web_acl_migration_stack(
    WebACLId='string',
    S3BucketName='string',
    IgnoreUnsupportedType=True|False
)
Parameters:

  • WebACLId (string) –

    [REQUIRED]

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

  • S3BucketName (string) –

    [REQUIRED]

    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 (boolean) –

    [REQUIRED]

    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.

Return type:

dict

Returns:

Response Syntax

{
    'S3ObjectUrl': 'string'
}

Response Structure

  • (dict) –

    • S3ObjectUrl (string) –

      The URL of the template created in Amazon S3.

Exceptions

  • WAF.Client.exceptions.WAFInternalErrorException

  • WAF.Client.exceptions.WAFInvalidParameterException

  • WAF.Client.exceptions.WAFInvalidOperationException

  • WAF.Client.exceptions.WAFNonexistentItemException

  • WAF.Client.exceptions.WAFEntityMigrationException