software.amazon.awscdk.services.wafv2

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.wafv2.CfnWebACL

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:08.242Z")
 @Stability(value=Stable)
public class CfnWebACL
extends CfnResource
implements IInspectable

A CloudFormation `AWS::WAFv2::WebACL`.

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.*;
 Object all;
 Object allQueryArguments;
 Object body;
 Object count;
 Object method;
 Object none;
 IPSetReferenceStatementProperty pSetReferenceStatementProperty;
 Object queryString;
 Object singleHeader;
 Object singleQueryArgument;
 StatementProperty statementProperty_;
 Object uriPath;
 CfnWebACL cfnWebACL = CfnWebACL.Builder.create(this, "MyCfnWebACL")
         .defaultAction(DefaultActionProperty.builder()
                 .allow(AllowActionProperty.builder()
                         .customRequestHandling(CustomRequestHandlingProperty.builder()
                                 .insertHeaders(List.of(CustomHTTPHeaderProperty.builder()
                                         .name("name")
                                         .value("value")
                                         .build()))
                                 .build())
                         .build())
                 .block(BlockActionProperty.builder()
                         .customResponse(CustomResponseProperty.builder()
                                 .responseCode(123)
                                 // the properties below are optional
                                 .customResponseBodyKey("customResponseBodyKey")
                                 .responseHeaders(List.of(CustomHTTPHeaderProperty.builder()
                                         .name("name")
                                         .value("value")
                                         .build()))
                                 .build())
                         .build())
                 .build())
         .scope("scope")
         .visibilityConfig(VisibilityConfigProperty.builder()
                 .cloudWatchMetricsEnabled(false)
                 .metricName("metricName")
                 .sampledRequestsEnabled(false)
                 .build())
         // the properties below are optional
         .customResponseBodies(Map.of(
                 "customResponseBodiesKey", CustomResponseBodyProperty.builder()
                         .content("content")
                         .contentType("contentType")
                         .build()))
         .description("description")
         .name("name")
         .rules(List.of(RuleProperty.builder()
                 .name("name")
                 .priority(123)
                 .statement(StatementProperty.builder()
                         .andStatement(AndStatementProperty.builder()
                                 .statements(List.of(statementProperty_))
                                 .build())
                         .byteMatchStatement(ByteMatchStatementProperty.builder()
                                 .fieldToMatch(FieldToMatchProperty.builder()
                                         .allQueryArguments(allQueryArguments)
                                         .body(body)
                                         .jsonBody(JsonBodyProperty.builder()
                                                 .matchPattern(JsonMatchPatternProperty.builder()
                                                         .all(all)
                                                         .includedPaths(List.of("includedPaths"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 // the properties below are optional
                                                 .invalidFallbackBehavior("invalidFallbackBehavior")
                                                 .build())
                                         .method(method)
                                         .queryString(queryString)
                                         .singleHeader(singleHeader)
                                         .singleQueryArgument(singleQueryArgument)
                                         .uriPath(uriPath)
                                         .build())
                                 .positionalConstraint("positionalConstraint")
                                 .textTransformations(List.of(TextTransformationProperty.builder()
                                         .priority(123)
                                         .type("type")
                                         .build()))
                                 // the properties below are optional
                                 .searchString("searchString")
                                 .searchStringBase64("searchStringBase64")
                                 .build())
                         .geoMatchStatement(GeoMatchStatementProperty.builder()
                                 .countryCodes(List.of("countryCodes"))
                                 .forwardedIpConfig(ForwardedIPConfigurationProperty.builder()
                                         .fallbackBehavior("fallbackBehavior")
                                         .headerName("headerName")
                                         .build())
                                 .build())
                         .ipSetReferenceStatement(pSetReferenceStatementProperty)
                         .labelMatchStatement(LabelMatchStatementProperty.builder()
                                 .key("key")
                                 .scope("scope")
                                 .build())
                         .managedRuleGroupStatement(ManagedRuleGroupStatementProperty.builder()
                                 .name("name")
                                 .vendorName("vendorName")
                                 // the properties below are optional
                                 .excludedRules(List.of(ExcludedRuleProperty.builder()
                                         .name("name")
                                         .build()))
                                 .scopeDownStatement(statementProperty_)
                                 .version("version")
                                 .build())
                         .notStatement(NotStatementProperty.builder()
                                 .statement(statementProperty_)
                                 .build())
                         .orStatement(OrStatementProperty.builder()
                                 .statements(List.of(statementProperty_))
                                 .build())
                         .rateBasedStatement(RateBasedStatementProperty.builder()
                                 .aggregateKeyType("aggregateKeyType")
                                 .limit(123)
                                 // the properties below are optional
                                 .forwardedIpConfig(ForwardedIPConfigurationProperty.builder()
                                         .fallbackBehavior("fallbackBehavior")
                                         .headerName("headerName")
                                         .build())
                                 .scopeDownStatement(statementProperty_)
                                 .build())
                         .regexPatternSetReferenceStatement(RegexPatternSetReferenceStatementProperty.builder()
                                 .arn("arn")
                                 .fieldToMatch(FieldToMatchProperty.builder()
                                         .allQueryArguments(allQueryArguments)
                                         .body(body)
                                         .jsonBody(JsonBodyProperty.builder()
                                                 .matchPattern(JsonMatchPatternProperty.builder()
                                                         .all(all)
                                                         .includedPaths(List.of("includedPaths"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 // the properties below are optional
                                                 .invalidFallbackBehavior("invalidFallbackBehavior")
                                                 .build())
                                         .method(method)
                                         .queryString(queryString)
                                         .singleHeader(singleHeader)
                                         .singleQueryArgument(singleQueryArgument)
                                         .uriPath(uriPath)
                                         .build())
                                 .textTransformations(List.of(TextTransformationProperty.builder()
                                         .priority(123)
                                         .type("type")
                                         .build()))
                                 .build())
                         .ruleGroupReferenceStatement(RuleGroupReferenceStatementProperty.builder()
                                 .arn("arn")
                                 // the properties below are optional
                                 .excludedRules(List.of(ExcludedRuleProperty.builder()
                                         .name("name")
                                         .build()))
                                 .build())
                         .sizeConstraintStatement(SizeConstraintStatementProperty.builder()
                                 .comparisonOperator("comparisonOperator")
                                 .fieldToMatch(FieldToMatchProperty.builder()
                                         .allQueryArguments(allQueryArguments)
                                         .body(body)
                                         .jsonBody(JsonBodyProperty.builder()
                                                 .matchPattern(JsonMatchPatternProperty.builder()
                                                         .all(all)
                                                         .includedPaths(List.of("includedPaths"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 // the properties below are optional
                                                 .invalidFallbackBehavior("invalidFallbackBehavior")
                                                 .build())
                                         .method(method)
                                         .queryString(queryString)
                                         .singleHeader(singleHeader)
                                         .singleQueryArgument(singleQueryArgument)
                                         .uriPath(uriPath)
                                         .build())
                                 .size(123)
                                 .textTransformations(List.of(TextTransformationProperty.builder()
                                         .priority(123)
                                         .type("type")
                                         .build()))
                                 .build())
                         .sqliMatchStatement(SqliMatchStatementProperty.builder()
                                 .fieldToMatch(FieldToMatchProperty.builder()
                                         .allQueryArguments(allQueryArguments)
                                         .body(body)
                                         .jsonBody(JsonBodyProperty.builder()
                                                 .matchPattern(JsonMatchPatternProperty.builder()
                                                         .all(all)
                                                         .includedPaths(List.of("includedPaths"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 // the properties below are optional
                                                 .invalidFallbackBehavior("invalidFallbackBehavior")
                                                 .build())
                                         .method(method)
                                         .queryString(queryString)
                                         .singleHeader(singleHeader)
                                         .singleQueryArgument(singleQueryArgument)
                                         .uriPath(uriPath)
                                         .build())
                                 .textTransformations(List.of(TextTransformationProperty.builder()
                                         .priority(123)
                                         .type("type")
                                         .build()))
                                 .build())
                         .xssMatchStatement(XssMatchStatementProperty.builder()
                                 .fieldToMatch(FieldToMatchProperty.builder()
                                         .allQueryArguments(allQueryArguments)
                                         .body(body)
                                         .jsonBody(JsonBodyProperty.builder()
                                                 .matchPattern(JsonMatchPatternProperty.builder()
                                                         .all(all)
                                                         .includedPaths(List.of("includedPaths"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 // the properties below are optional
                                                 .invalidFallbackBehavior("invalidFallbackBehavior")
                                                 .build())
                                         .method(method)
                                         .queryString(queryString)
                                         .singleHeader(singleHeader)
                                         .singleQueryArgument(singleQueryArgument)
                                         .uriPath(uriPath)
                                         .build())
                                 .textTransformations(List.of(TextTransformationProperty.builder()
                                         .priority(123)
                                         .type("type")
                                         .build()))
                                 .build())
                         .build())
                 .visibilityConfig(VisibilityConfigProperty.builder()
                         .cloudWatchMetricsEnabled(false)
                         .metricName("metricName")
                         .sampledRequestsEnabled(false)
                         .build())
                 // the properties below are optional
                 .action(RuleActionProperty.builder()
                         .allow(AllowActionProperty.builder()
                                 .customRequestHandling(CustomRequestHandlingProperty.builder()
                                         .insertHeaders(List.of(CustomHTTPHeaderProperty.builder()
                                                 .name("name")
                                                 .value("value")
                                                 .build()))
                                         .build())
                                 .build())
                         .block(BlockActionProperty.builder()
                                 .customResponse(CustomResponseProperty.builder()
                                         .responseCode(123)
                                         // the properties below are optional
                                         .customResponseBodyKey("customResponseBodyKey")
                                         .responseHeaders(List.of(CustomHTTPHeaderProperty.builder()
                                                 .name("name")
                                                 .value("value")
                                                 .build()))
                                         .build())
                                 .build())
                         .count(CountActionProperty.builder()
                                 .customRequestHandling(CustomRequestHandlingProperty.builder()
                                         .insertHeaders(List.of(CustomHTTPHeaderProperty.builder()
                                                 .name("name")
                                                 .value("value")
                                                 .build()))
                                         .build())
                                 .build())
                         .build())
                 .overrideAction(OverrideActionProperty.builder()
                         .count(count)
                         .none(none)
                         .build())
                 .ruleLabels(List.of(LabelProperty.builder()
                         .name("name")
                         .build()))
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnWebACL.AllowActionProperty Example:
static interface	CfnWebACL.AndStatementProperty Example:
static interface	CfnWebACL.BlockActionProperty Example:
static class	CfnWebACL.Builder A fluent builder for CfnWebACL.
static interface	CfnWebACL.ByteMatchStatementProperty Example:
static interface	CfnWebACL.CountActionProperty Example:
static interface	CfnWebACL.CustomHTTPHeaderProperty Example:
static interface	CfnWebACL.CustomRequestHandlingProperty Example:
static interface	CfnWebACL.CustomResponseBodyProperty Example:
static interface	CfnWebACL.CustomResponseProperty Example:
static interface	CfnWebACL.DefaultActionProperty Example:
static interface	CfnWebACL.ExcludedRuleProperty Example:
static interface	CfnWebACL.FieldToMatchProperty Example:
static interface	CfnWebACL.ForwardedIPConfigurationProperty Example:
static interface	CfnWebACL.GeoMatchStatementProperty Example:
static interface	CfnWebACL.IPSetForwardedIPConfigurationProperty
static interface	CfnWebACL.IPSetReferenceStatementProperty
static interface	CfnWebACL.JsonBodyProperty Example:
static interface	CfnWebACL.JsonMatchPatternProperty Example:
static interface	CfnWebACL.LabelMatchStatementProperty Example:
static interface	CfnWebACL.LabelProperty Example:
static interface	CfnWebACL.ManagedRuleGroupStatementProperty Example:
static interface	CfnWebACL.NotStatementProperty Example:
static interface	CfnWebACL.OrStatementProperty Example:
static interface	CfnWebACL.OverrideActionProperty Example:
static interface	CfnWebACL.RateBasedStatementProperty Example:
static interface	CfnWebACL.RegexPatternSetReferenceStatementProperty Example:
static interface	CfnWebACL.RuleActionProperty Example:
static interface	CfnWebACL.RuleGroupReferenceStatementProperty Example:
static interface	CfnWebACL.RuleProperty Example:
static interface	CfnWebACL.SizeConstraintStatementProperty Example:
static interface	CfnWebACL.SqliMatchStatementProperty Example:
static interface	CfnWebACL.StatementProperty Example:
static interface	CfnWebACL.TextTransformationProperty Example:
static interface	CfnWebACL.VisibilityConfigProperty Example:
static interface	CfnWebACL.XssMatchStatementProperty Example:

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::WAFv2::WebACL`.
protected	CfnWebACL(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnWebACL(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
Number	getAttrCapacity()
String	getAttrId()
String	getAttrLabelNamespace()
protected Map<String,Object>	getCfnProperties()
Object	getCustomResponseBodies() `AWS::WAFv2::WebACL.CustomResponseBodies`.
Object	getDefaultAction() `AWS::WAFv2::WebACL.DefaultAction`.
String	getDescription() `AWS::WAFv2::WebACL.Description`.
String	getName() `AWS::WAFv2::WebACL.Name`.
Object	getRules() `AWS::WAFv2::WebACL.Rules`.
String	getScope() `AWS::WAFv2::WebACL.Scope`.
TagManager	getTags() `AWS::WAFv2::WebACL.Tags`.
Object	getVisibilityConfig() `AWS::WAFv2::WebACL.VisibilityConfig`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCustomResponseBodies(IResolvable value) `AWS::WAFv2::WebACL.CustomResponseBodies`.
void	setCustomResponseBodies(Map<String,Object> value) `AWS::WAFv2::WebACL.CustomResponseBodies`.
void	setDefaultAction(CfnWebACL.DefaultActionProperty value) `AWS::WAFv2::WebACL.DefaultAction`.
void	setDefaultAction(IResolvable value) `AWS::WAFv2::WebACL.DefaultAction`.
void	setDescription(String value) `AWS::WAFv2::WebACL.Description`.
void	setName(String value) `AWS::WAFv2::WebACL.Name`.
void	setRules(IResolvable value) `AWS::WAFv2::WebACL.Rules`.
void	setRules(List<Object> value) `AWS::WAFv2::WebACL.Rules`.
void	setScope(String value) `AWS::WAFv2::WebACL.Scope`.
void	setVisibilityConfig(CfnWebACL.VisibilityConfigProperty value) `AWS::WAFv2::WebACL.VisibilityConfig`.
void	setVisibilityConfig(IResolvable value) `AWS::WAFv2::WebACL.VisibilityConfig`.

Methods inherited from class software.amazon.awscdk.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.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::WAFv2::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.

getAttrArn

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

getAttrCapacity

@Stability(value=Stable)
 @NotNull
public Number getAttrCapacity()

getAttrId

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

getAttrLabelNamespace

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCustomResponseBodies

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

`AWS::WAFv2::WebACL.CustomResponseBodies`.

setCustomResponseBodies

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

`AWS::WAFv2::WebACL.CustomResponseBodies`.

setCustomResponseBodies

@Stability(value=Stable)
public void setCustomResponseBodies(@Nullable
                                                             Map<String,Object> value)

`AWS::WAFv2::WebACL.CustomResponseBodies`.

getDefaultAction

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

`AWS::WAFv2::WebACL.DefaultAction`.

setDefaultAction

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

`AWS::WAFv2::WebACL.DefaultAction`.

setDefaultAction

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

`AWS::WAFv2::WebACL.DefaultAction`.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

`AWS::WAFv2::WebACL.Description`.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

`AWS::WAFv2::WebACL.Description`.

getName

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

`AWS::WAFv2::WebACL.Name`.

setName

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

`AWS::WAFv2::WebACL.Name`.

getRules

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

`AWS::WAFv2::WebACL.Rules`.

setRules

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

`AWS::WAFv2::WebACL.Rules`.

setRules

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

`AWS::WAFv2::WebACL.Rules`.

getScope

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

`AWS::WAFv2::WebACL.Scope`.

setScope

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

`AWS::WAFv2::WebACL.Scope`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::WAFv2::WebACL.Tags`.

getVisibilityConfig

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

`AWS::WAFv2::WebACL.VisibilityConfig`.

setVisibilityConfig

@Stability(value=Stable)
public void setVisibilityConfig(@NotNull
                                                         CfnWebACL.VisibilityConfigProperty value)

`AWS::WAFv2::WebACL.VisibilityConfig`.

setVisibilityConfig

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

`AWS::WAFv2::WebACL.VisibilityConfig`.