software.amazon.awscdk.services.wafv2

Class CfnRegexPatternSet

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.CfnRegexPatternSet

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

A CloudFormation `AWS::WAFv2::RegexPatternSet`.

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 an RegexPatternSet to have AWS WAF inspect a web request component for a specific set of regular expression patterns.

You use a regex pattern set by providing its Amazon Resource Name (ARN) to the rule statement RegexPatternSetReferenceStatement , when you add a rule to a rule group or web ACL.

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.*;
 CfnRegexPatternSet cfnRegexPatternSet = CfnRegexPatternSet.Builder.create(this, "MyCfnRegexPatternSet")
         .regularExpressionList(List.of("regularExpressionList"))
         .scope("scope")
         // the properties below are optional
         .description("description")
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the regex pattern set.
String	getAttrId() The ID of the regex pattern set.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description of the set that helps with identification.
String	getName() The name of the set.
List<String>	getRegularExpressionList() The regular expression patterns in the set.
String	getScope() Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
TagManager	getTags() Key:value pairs associated with an AWS resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) A description of the set that helps with identification.
void	setName(String value) The name of the set.
void	setRegularExpressionList(List<String> value) The regular expression patterns in the set.
void	setScope(String value) Specifies whether this is for an Amazon CloudFront distribution or for a regional application.

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

CfnRegexPatternSet

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

CfnRegexPatternSet

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

CfnRegexPatternSet

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

Create a new `AWS::WAFv2::RegexPatternSet`.

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

The Amazon Resource Name (ARN) of the regex pattern set.

getAttrId

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

The ID of the regex pattern set.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

Key:value pairs associated with an AWS resource.

The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.

To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.

getRegularExpressionList

@Stability(value=Stable)
 @NotNull
public List<String> getRegularExpressionList()

The regular expression patterns in the set.

setRegularExpressionList

@Stability(value=Stable)
public void setRegularExpressionList(@NotNull
                                                              List<String> value)

The regular expression patterns in the set.

getScope

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

Specifies whether this is for an Amazon CloudFront distribution or for a regional application.

A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AWS AppSync GraphQL API. Valid Values are CLOUDFRONT and REGIONAL .

For CLOUDFRONT , you must create your WAFv2 resources in the US East (N. Virginia) Region, us-east-1 .

setScope

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

Specifies whether this is for an Amazon CloudFront distribution or for a regional application.

A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AWS AppSync GraphQL API. Valid Values are CLOUDFRONT and REGIONAL .

For CLOUDFRONT , you must create your WAFv2 resources in the US East (N. Virginia) Region, us-east-1 .

getDescription

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

A description of the set that helps with identification.

setDescription

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

A description of the set that helps with identification.

getName

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

The name of the set.

You cannot change the name after you create the set.

setName

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

The name of the set.

You cannot change the name after you create the set.