software.amazon.awscdk.services.wafv2

Class CfnWebACLAssociation

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.wafv2.CfnWebACLAssociation

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.819Z")
 @Stability(value=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, or an AWS AppSync GraphQL API.

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 .

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnWebACLAssociation.Builder A fluent builder for CfnWebACLAssociation.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnWebACLAssociation(software.constructs.Construct scope, String id, CfnWebACLAssociationProps props) Create a new `AWS::WAFv2::WebACLAssociation`.
protected	CfnWebACLAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnWebACLAssociation(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	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.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setResourceArn(String value) The Amazon Resource Name (ARN) of the resource to associate with the web ACL.
void	setWebAclArn(String value) The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnWebACLAssociation

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

CfnWebACLAssociation

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

CfnWebACLAssociation

@Stability(value=Stable)
public CfnWebACLAssociation(@NotNull
                                                     software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getResourceArn

@Stability(value=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*

setResourceArn

@Stability(value=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*

getWebAclArn

@Stability(value=Stable)
 @NotNull
public String getWebAclArn()

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

setWebAclArn

@Stability(value=Stable)
public void setWebAclArn(@NotNull
                                                  String value)

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