Docs Home
We recommend new projects start with resources from the AWS provider.
aws-native.wafv2.RegexPatternSet
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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
This property is required. string - The unique name of the resource.
- args
This property is required. RegexPatternSetArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. RegexPatternSetArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. RegexPatternSetArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. 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:
- Regular
Expression List This property is required. List<string> - The regular expression patterns in the set.
- Scope
This property is required. Pulumi.Aws Native. Wa Fv2. Regex Pattern Set Scope - 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.
-
List<Pulumi.
Aws Native. 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.
- Regular
Expression List This property is required. []string - The regular expression patterns in the set.
- Scope
This property is required. RegexPattern Set Scope - 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.
-
Tag
Args 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 This property is required. List<String> - The regular expression patterns in the set.
- scope
This property is required. RegexPattern Set Scope - 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.
- 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.
- regular
Expression List This property is required. string[] - The regular expression patterns in the set.
- scope
This property is required. RegexPattern Set Scope - 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.
- 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 This property is required. Sequence[str] - The regular expression patterns in the set.
- scope
This property is required. RegexPattern Set Scope - 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.
-
Sequence[Tag
Args] 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 This property is required. List<String> - The regular expression patterns in the set.
- scope
This property is required. "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.
- 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:
Supporting Types
RegexPatternSetScope, RegexPatternSetScopeArgs
- Cloudfront
- CLOUDFRONT
- Regional
- REGIONAL
- Regex
Pattern Set Scope Cloudfront - CLOUDFRONT
- Regex
Pattern Set Scope Regional - REGIONAL
- Cloudfront
- CLOUDFRONT
- Regional
- REGIONAL
- Cloudfront
- CLOUDFRONT
- Regional
- REGIONAL
- CLOUDFRONT
- CLOUDFRONT
- REGIONAL
- REGIONAL
- "CLOUDFRONT"
- CLOUDFRONT
- "REGIONAL"
- REGIONAL
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.