software.amazon.awscdk.services.wafv2

Class CfnWebACLAssociation

java.lang.Object

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-21T22:31:01.244Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnWebACLAssociation(Construct scope, java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getResourceArn() The Amazon Resource Name (ARN) of the resource to associate with the web ACL.
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setResourceArn(java.lang.String value) The Amazon Resource Name (ARN) of the resource to associate with the web ACL.
void	setWebAclArn(java.lang.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.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnWebACLAssociation(Construct scope,
                            java.lang.String id,
                            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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getResourceArn

public java.lang.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

public void setResourceArn(java.lang.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

public java.lang.String getWebAclArn()

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

setWebAclArn

public void setWebAclArn(java.lang.String value)

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