Package software.amazon.awscdk.services.wafv2

Interface CfnWebACLAssociationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebACLAssociationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:32.009Z")
@Stability(Stable)
public interface CfnWebACLAssociationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnWebACLAssociation.

Example:

 EventApi api;
 CfnWebACL webAcl;
 // Associate waf with Event API
 // Associate waf with Event API
 CfnWebACLAssociation.Builder.create(this, "WafAssociation")
         .resourceArn(api.getApiArn())
         .webAclArn(webAcl.getAttrArn())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWebACLAssociationProps.Builder	A builder for CfnWebACLAssociationProps
static final class	CfnWebACLAssociationProps.Jsii$Proxy	An implementation for CfnWebACLAssociationProps

Method Summary

Modifier and Type	Method	Description
static CfnWebACLAssociationProps.Builder	builder()
Object	getResourceArn()	The Amazon Resource Name (ARN) of the resource to associate with the web ACL.
String	getWebAclArn()	The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getResourceArn

@Stability(Stable)
@NotNull
Object 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: *partition* :elasticloadbalancing: *region* : *account-id* :loadbalancer/app/ *load-balancer-name* / *load-balancer-id*
• For an Amazon API Gateway REST API: arn: *partition* :apigateway: *region* ::/restapis/ *api-id* /stages/ *stage-name*
• For an AWS AppSync GraphQL API: arn: *partition* :appsync: *region* : *account-id* :apis/ *GraphQLApiId*
• For an Amazon Cognito user pool: arn: *partition* :cognito-idp: *region* : *account-id* :userpool/ *user-pool-id*
• For an AWS App Runner service: arn: *partition* :apprunner: *region* : *account-id* :service/ *apprunner-service-name* / *apprunner-service-id*
• For an AWS Verified Access instance: arn: *partition* :ec2: *region* : *account-id* :verified-access-instance/ *instance-id*
• For an AWS Amplify instance: arn: *partition* :amplify: *region* : *account-id* :apps/ *app-id*

Returns union: either String or ILoadBalancerRef or IGraphQLApiRef or IWebACLRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html#cfn-wafv2-webaclassociation-resourcearn

getWebAclArn

@Stability(Stable)
@NotNull
String getWebAclArn()

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html#cfn-wafv2-webaclassociation-webaclarn

builder

@Stability(Stable)
static CfnWebACLAssociationProps.Builder builder()

Returns:

a CfnWebACLAssociationProps.Builder of CfnWebACLAssociationProps