Package software.amazon.awscdk.services.wafv2

Class CfnWebACLAssociation

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.wafv2.CfnWebACLAssociation
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:36.616Z") @Stability(Stable) public class CfnWebACLAssociation extends CfnResource implements IInspectable
A CloudFormation AWS::WAFv2::WebACLAssociation.

This is the latest version of AWS WAF , named AWS WAF V2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .

Use a web ACL association to define an association between a web ACL and a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, or an AWS App Runner service.

For Amazon CloudFront , don't use this resource. Instead, use your CloudFront distribution configuration. To associate a web ACL with a distribution, provide the Amazon Resource Name (ARN) of the WebACL to your CloudFront distribution configuration. To disassociate a web ACL, provide an empty ARN. For information, see AWS::CloudFront::Distribution .

When you create a web ACL or make changes to a web ACL or web ACL components, like rules and rule groups, AWS WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an AWS resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.wafv2.*;
 CfnWebACLAssociation cfnWebACLAssociation = CfnWebACLAssociation.Builder.create(this, "MyCfnWebACLAssociation")
         .resourceArn("resourceArn")
         .webAclArn("webAclArn")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnWebACLAssociation

      protected CfnWebACLAssociation(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnWebACLAssociation

      protected CfnWebACLAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnWebACLAssociation

      @Stability(Stable) public CfnWebACLAssociation(@NotNull Construct scope, @NotNull String id, @NotNull CfnWebACLAssociationProps props)
      Create a new AWS::WAFv2::WebACLAssociation.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getResourceArn

      @Stability(Stable) @NotNull public String getResourceArn()
      The Amazon Resource Name (ARN) of the resource to associate with the web ACL.

      The ARN must be in one of the following formats:

      • For an Application Load Balancer: arn:aws:elasticloadbalancing: *region* : *account-id* :loadbalancer/app/ *load-balancer-name* / *load-balancer-id*
      • For an Amazon API Gateway REST API: arn:aws:apigateway: *region* ::/restapis/ *api-id* /stages/ *stage-name*
      • For an AWS AppSync GraphQL API: arn:aws:appsync: *region* : *account-id* :apis/ *GraphQLApiId*
      • For an Amazon Cognito user pool: arn:aws:cognito-idp: *region* : *account-id* :userpool/ *user-pool-id*
      • For an AWS App Runner service: arn:aws:apprunner: *region* : *account-id* :service/ *apprunner-service-name* / *apprunner-service-id*

    • setResourceArn

      @Stability(Stable) public void setResourceArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the resource to associate with the web ACL.

      The ARN must be in one of the following formats:

      • For an Application Load Balancer: arn:aws:elasticloadbalancing: *region* : *account-id* :loadbalancer/app/ *load-balancer-name* / *load-balancer-id*
      • For an Amazon API Gateway REST API: arn:aws:apigateway: *region* ::/restapis/ *api-id* /stages/ *stage-name*
      • For an AWS AppSync GraphQL API: arn:aws:appsync: *region* : *account-id* :apis/ *GraphQLApiId*
      • For an Amazon Cognito user pool: arn:aws:cognito-idp: *region* : *account-id* :userpool/ *user-pool-id*
      • For an AWS App Runner service: arn:aws:apprunner: *region* : *account-id* :service/ *apprunner-service-name* / *apprunner-service-id*

    • getWebAclArn

      @Stability(Stable) @NotNull public String getWebAclArn()
      The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.

    • setWebAclArn

      @Stability(Stable) public void setWebAclArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.