software.amazon.awscdk.services.waf.regional

Class CfnWebACL

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.waf.regional.CfnWebACL

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.670Z")
 @Stability(value=Stable)
public class CfnWebACL
extends CfnResource
implements IInspectable

A CloudFormation `AWS::WAFRegional::WebACL`.

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF , use the AWS WAF V2 API and see the AWS WAF Developer Guide . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL , you also specify a default action ( ALLOW or BLOCK ), and the action for each Rule that you add to a WebACL , for example, block requests from specified IP addresses or block requests from specified referrers. If you add more than one Rule to a WebACL , a request needs to match only one of the specifications to be allowed, blocked, or counted.

To identify the requests that you want AWS WAF to filter, you associate the WebACL with an API Gateway API or an Application Load Balancer.

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.waf.regional.*;
 CfnWebACL cfnWebACL = CfnWebACL.Builder.create(this, "MyCfnWebACL")
         .defaultAction(ActionProperty.builder()
                 .type("type")
                 .build())
         .metricName("metricName")
         .name("name")
         // the properties below are optional
         .rules(List.of(RuleProperty.builder()
                 .action(ActionProperty.builder()
                         .type("type")
                         .build())
                 .priority(123)
                 .ruleId("ruleId")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnWebACL.ActionProperty Specifies the action AWS WAF takes when a web request matches or doesn't match all rule conditions.
static class	CfnWebACL.Builder A fluent builder for CfnWebACL.
static interface	CfnWebACL.RuleProperty A combination of `ByteMatchSet` , `IPSet` , and/or `SqlInjectionMatchSet` objects that identify the web requests that you want to allow, block, or count.

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
	CfnWebACL(software.constructs.Construct scope, String id, CfnWebACLProps props) Create a new `AWS::WAFRegional::WebACL`.
protected	CfnWebACL(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnWebACL(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
Object	getDefaultAction() The action to perform if none of the `Rules` contained in the `WebACL` match.
String	getMetricName() A name for the metrics for this `WebACL` .
String	getName() A friendly name or description of the `WebACL` .
Object	getRules() An array that contains the action for each `Rule` in a `WebACL` , the priority of the `Rule` , and the ID of the `Rule` .
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDefaultAction(CfnWebACL.ActionProperty value) The action to perform if none of the `Rules` contained in the `WebACL` match.
void	setDefaultAction(IResolvable value) The action to perform if none of the `Rules` contained in the `WebACL` match.
void	setMetricName(String value) A name for the metrics for this `WebACL` .
void	setName(String value) A friendly name or description of the `WebACL` .
void	setRules(IResolvable value) An array that contains the action for each `Rule` in a `WebACL` , the priority of the `Rule` , and the ID of the `Rule` .
void	setRules(List<Object> value) An array that contains the action for each `Rule` in a `WebACL` , the priority of the `Rule` , and the ID of the `Rule` .

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

CfnWebACL

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

CfnWebACL

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

CfnWebACL

@Stability(value=Stable)
public CfnWebACL(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id,
                                          @NotNull
                                          CfnWebACLProps props)

Create a new `AWS::WAFRegional::WebACL`.

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

getDefaultAction

@Stability(value=Stable)
 @NotNull
public Object getDefaultAction()

The action to perform if none of the `Rules` contained in the `WebACL` match.

The action is specified by the WafAction object.

setDefaultAction

@Stability(value=Stable)
public void setDefaultAction(@NotNull
                                                      CfnWebACL.ActionProperty value)

The action to perform if none of the `Rules` contained in the `WebACL` match.

The action is specified by the WafAction object.

setDefaultAction

@Stability(value=Stable)
public void setDefaultAction(@NotNull
                                                      IResolvable value)

The action to perform if none of the `Rules` contained in the `WebACL` match.

The action is specified by the WafAction object.

getMetricName

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

A name for the metrics for this `WebACL` .

The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the WebACL .

setMetricName

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

A name for the metrics for this `WebACL` .

The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the WebACL .

getName

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

A friendly name or description of the `WebACL` .

You can't change the name of a WebACL after you create it.

setName

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

A friendly name or description of the `WebACL` .

You can't change the name of a WebACL after you create it.

getRules

@Stability(value=Stable)
 @Nullable
public Object getRules()

An array that contains the action for each `Rule` in a `WebACL` , the priority of the `Rule` , and the ID of the `Rule` .

setRules

@Stability(value=Stable)
public void setRules(@Nullable
                                              IResolvable value)

An array that contains the action for each `Rule` in a `WebACL` , the priority of the `Rule` , and the ID of the `Rule` .

setRules

@Stability(value=Stable)
public void setRules(@Nullable
                                              List<Object> value)

An array that contains the action for each `Rule` in a `WebACL` , the priority of the `Rule` , and the ID of the `Rule` .