1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. wafv2
  5. getRegexPatternSet

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

aws-native.wafv2.getRegexPatternSet

Explore with Pulumi AI

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

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 .

Using getRegexPatternSet

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRegexPatternSet(args: GetRegexPatternSetArgs, opts?: InvokeOptions): Promise<GetRegexPatternSetResult>
function getRegexPatternSetOutput(args: GetRegexPatternSetOutputArgs, opts?: InvokeOptions): Output<GetRegexPatternSetResult>
Copy
def get_regex_pattern_set(id: Optional[str] = None,
                          name: Optional[str] = None,
                          scope: Optional[RegexPatternSetScope] = None,
                          opts: Optional[InvokeOptions] = None) -> GetRegexPatternSetResult
def get_regex_pattern_set_output(id: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          scope: Optional[pulumi.Input[RegexPatternSetScope]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetRegexPatternSetResult]
Copy
func LookupRegexPatternSet(ctx *Context, args *LookupRegexPatternSetArgs, opts ...InvokeOption) (*LookupRegexPatternSetResult, error)
func LookupRegexPatternSetOutput(ctx *Context, args *LookupRegexPatternSetOutputArgs, opts ...InvokeOption) LookupRegexPatternSetResultOutput
Copy

> Note: This function is named LookupRegexPatternSet in the Go SDK.

public static class GetRegexPatternSet 
{
    public static Task<GetRegexPatternSetResult> InvokeAsync(GetRegexPatternSetArgs args, InvokeOptions? opts = null)
    public static Output<GetRegexPatternSetResult> Invoke(GetRegexPatternSetInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRegexPatternSetResult> getRegexPatternSet(GetRegexPatternSetArgs args, InvokeOptions options)
public static Output<GetRegexPatternSetResult> getRegexPatternSet(GetRegexPatternSetArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:wafv2:getRegexPatternSet
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
Id of the RegexPatternSet
Name This property is required. string
Name of the RegexPatternSet.
Scope This property is required. Pulumi.AwsNative.WaFv2.RegexPatternSetScope
Use CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.
Id This property is required. string
Id of the RegexPatternSet
Name This property is required. string
Name of the RegexPatternSet.
Scope This property is required. RegexPatternSetScope
Use CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.
id This property is required. String
Id of the RegexPatternSet
name This property is required. String
Name of the RegexPatternSet.
scope This property is required. RegexPatternSetScope
Use CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.
id This property is required. string
Id of the RegexPatternSet
name This property is required. string
Name of the RegexPatternSet.
scope This property is required. RegexPatternSetScope
Use CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.
id This property is required. str
Id of the RegexPatternSet
name This property is required. str
Name of the RegexPatternSet.
scope This property is required. RegexPatternSetScope
Use CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.
id This property is required. String
Id of the RegexPatternSet
name This property is required. String
Name of the RegexPatternSet.
scope This property is required. "CLOUDFRONT" | "REGIONAL"
Use CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.

getRegexPatternSet Result

The following output properties are available:

Arn string
ARN of the WAF entity.
Description string
Description of the entity.
Id string
Id of the RegexPatternSet
RegularExpressionList List<string>
The regular expression patterns in the set.
Tags List<Pulumi.AwsNative.Outputs.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.

Arn string
ARN of the WAF entity.
Description string
Description of the entity.
Id string
Id of the RegexPatternSet
RegularExpressionList []string
The regular expression patterns in the set.
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.

arn String
ARN of the WAF entity.
description String
Description of the entity.
id String
Id of the RegexPatternSet
regularExpressionList List<String>
The regular expression patterns in the set.
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.

arn string
ARN of the WAF entity.
description string
Description of the entity.
id string
Id of the RegexPatternSet
regularExpressionList string[]
The regular expression patterns in the set.
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.

arn str
ARN of the WAF entity.
description str
Description of the entity.
id str
Id of the RegexPatternSet
regular_expression_list Sequence[str]
The regular expression patterns in the set.
tags Sequence[root_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.

arn String
ARN of the WAF entity.
description String
Description of the entity.
id String
Id of the RegexPatternSet
regularExpressionList List<String>
The regular expression patterns in the set.
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.

Supporting Types

RegexPatternSetScope

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

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

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