Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. wafv2
  5. RegexPatternSet

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.wafv2.RegexPatternSet

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Contains a list of Regular expressions based on the provided inputs. RegexPatternSet can be used with other WAF entities with RegexPatternSetReferenceStatement to perform other actions .

    Create RegexPatternSet Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RegexPatternSet(name: string, args: RegexPatternSetArgs, opts?: CustomResourceOptions);
    @overload
def RegexPatternSet(resource_name: str,
                    args: RegexPatternSetArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def RegexPatternSet(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    regular_expression_list: Optional[Sequence[str]] = None,
                    scope: Optional[RegexPatternSetScope] = None,
                    description: Optional[str] = None,
                    name: Optional[str] = None,
                    tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewRegexPatternSet(ctx *Context, name string, args RegexPatternSetArgs, opts ...ResourceOption) (*RegexPatternSet, error)
    public RegexPatternSet(string name, RegexPatternSetArgs args, CustomResourceOptions? opts = null)
    public RegexPatternSet(String name, RegexPatternSetArgs args)
public RegexPatternSet(String name, RegexPatternSetArgs args, CustomResourceOptions options)

    type: aws-native:wafv2:RegexPatternSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args RegexPatternSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RegexPatternSetArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RegexPatternSetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RegexPatternSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RegexPatternSetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    RegexPatternSet Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RegexPatternSet resource accepts the following input properties:

    RegularExpressionList List<string>
    The regular expression patterns in the set.
    Scope Pulumi.AwsNative.WaFv2.RegexPatternSetScope
    Use CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.
    Description string
    Description of the entity.
    Name string
    Name of the RegexPatternSet.
    Tags List<Pulumi.AwsNative.Inputs.Tag>

    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.

    RegularExpressionList []string
    The regular expression patterns in the set.
    Scope RegexPatternSetScope
    Use CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.
    Description string
    Description of the entity.
    Name string
    Name of the RegexPatternSet.
    Tags TagArgs

    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.

    regularExpressionList List<String>
    The regular expression patterns in the set.
    scope RegexPatternSetScope
    Use CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.
    description String
    Description of the entity.
    name String
    Name of the RegexPatternSet.
    tags List<Tag>

    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.

    regularExpressionList string[]
    The regular expression patterns in the set.
    scope RegexPatternSetScope
    Use CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.
    description string
    Description of the entity.
    name string
    Name of the RegexPatternSet.
    tags Tag[]

    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.

    regular_expression_list Sequence[str]
    The regular expression patterns in the set.
    scope RegexPatternSetScope
    Use CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.
    description str
    Description of the entity.
    name str
    Name of the RegexPatternSet.
    tags Sequence[TagArgs]

    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.

    regularExpressionList List<String>
    The regular expression patterns in the set.
    scope "CLOUDFRONT" | "REGIONAL"
    Use CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.
    description String
    Description of the entity.
    name String
    Name of the RegexPatternSet.
    tags List<Property Map>

    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RegexPatternSet resource produces the following output properties:

    Arn string
    ARN of the WAF entity.
    AwsId string
    Id of the RegexPatternSet
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    ARN of the WAF entity.
    AwsId string
    Id of the RegexPatternSet
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    ARN of the WAF entity.
    awsId String
    Id of the RegexPatternSet
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    ARN of the WAF entity.
    awsId string
    Id of the RegexPatternSet
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    ARN of the WAF entity.
    aws_id str
    Id of the RegexPatternSet
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    ARN of the WAF entity.
    awsId String
    Id of the RegexPatternSet
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    RegexPatternSetScope, RegexPatternSetScopeArgs

    Cloudfront
    CLOUDFRONT
    Regional
    REGIONAL
    RegexPatternSetScopeCloudfront
    CLOUDFRONT
    RegexPatternSetScopeRegional
    REGIONAL
    Cloudfront
    CLOUDFRONT
    Regional
    REGIONAL
    Cloudfront
    CLOUDFRONT
    Regional
    REGIONAL
    CLOUDFRONT
    CLOUDFRONT
    REGIONAL
    REGIONAL
    "CLOUDFRONT"
    CLOUDFRONT
    "REGIONAL"
    REGIONAL

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native