Package software.amazon.awscdk.services.wafv2

Interface CfnRegexPatternSetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRegexPatternSetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:25.841Z")
@Stability(Stable)
public interface CfnRegexPatternSetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRegexPatternSet.

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.*;
 CfnRegexPatternSetProps cfnRegexPatternSetProps = CfnRegexPatternSetProps.builder()
         .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRegexPatternSetProps.Builder	A builder for CfnRegexPatternSetProps
static final class	CfnRegexPatternSetProps.Jsii$Proxy	An implementation for CfnRegexPatternSetProps

Method Summary

Modifier and Type	Method	Description
static CfnRegexPatternSetProps.Builder	builder()
default String	getDescription()	A description of the set that helps with identification.
default 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.
default List<CfnTag>	getTags()	Key:value pairs associated with an AWS resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRegularExpressionList

@Stability(Stable)
@NotNull
List<String> getRegularExpressionList()

The regular expression patterns in the set.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-regularexpressionlist

getScope

@Stability(Stable)
@NotNull
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, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. Valid Values are CLOUDFRONT and REGIONAL .

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-scope

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the set that helps with identification.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-description

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the set.

You cannot change the name after you create the set.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-name

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-tags

builder

@Stability(Stable)
static CfnRegexPatternSetProps.Builder builder()

Returns:

a CfnRegexPatternSetProps.Builder of CfnRegexPatternSetProps