1. Docs
  2. Reference
  3. API
  4. AWS
  5. wafv2
  6. GetRegexPatternSet

GetRegexPatternSet

Retrieves the summary of a WAFv2 Regex Pattern Set.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Aws.WafV2.GetRegexPatternSet.InvokeAsync(new Aws.WafV2.GetRegexPatternSetArgs
        {
            Name = "some-regex-pattern-set",
            Scope = "REGIONAL",
        }));
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/wafv2"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := wafv2.LookupRegexPatternSet(ctx, &wafv2.LookupRegexPatternSetArgs{
            Name:  "some-regex-pattern-set",
            Scope: "REGIONAL",
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_aws as aws

example = aws.wafv2.get_regex_pattern_set(name="some-regex-pattern-set",
    scope="REGIONAL")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = pulumi.output(aws.wafv2.getRegexPatternSet({
    name: "some-regex-pattern-set",
    scope: "REGIONAL",
}, { async: true }));

Using GetRegexPatternSet

function getRegexPatternSet(args: GetRegexPatternSetArgs, opts?: InvokeOptions): Promise<GetRegexPatternSetResult>
function  get_regex_pattern_set(name=None, scope=None, opts=None)
func LookupRegexPatternSet(ctx *Context, args *LookupRegexPatternSetArgs, opts ...InvokeOption) (*LookupRegexPatternSetResult, error)

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

public static class GetRegexPatternSet {
    public static Task<GetRegexPatternSetResult> InvokeAsync(GetRegexPatternSetArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string

The name of the WAFv2 Regex Pattern Set.

Scope string

Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are CLOUDFRONT or REGIONAL. To work with CloudFront, you must also specify the region us-east-1 (N. Virginia) on the AWS provider.

Name string

The name of the WAFv2 Regex Pattern Set.

Scope string

Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are CLOUDFRONT or REGIONAL. To work with CloudFront, you must also specify the region us-east-1 (N. Virginia) on the AWS provider.

name string

The name of the WAFv2 Regex Pattern Set.

scope string

Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are CLOUDFRONT or REGIONAL. To work with CloudFront, you must also specify the region us-east-1 (N. Virginia) on the AWS provider.

name str

The name of the WAFv2 Regex Pattern Set.

scope str

Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are CLOUDFRONT or REGIONAL. To work with CloudFront, you must also specify the region us-east-1 (N. Virginia) on the AWS provider.

GetRegexPatternSet Result

The following output properties are available:

Arn string

The Amazon Resource Name (ARN) of the entity.

Description string

The description of the set that helps with identification.

Id string

The provider-assigned unique ID for this managed resource.

Name string
RegularExpressions List<GetRegexPatternSetRegularExpression>

One or more blocks of regular expression patterns that AWS WAF is searching for. See Regular Expression below for details.

Scope string
Arn string

The Amazon Resource Name (ARN) of the entity.

Description string

The description of the set that helps with identification.

Id string

The provider-assigned unique ID for this managed resource.

Name string
RegularExpressions []GetRegexPatternSetRegularExpression

One or more blocks of regular expression patterns that AWS WAF is searching for. See Regular Expression below for details.

Scope string
arn string

The Amazon Resource Name (ARN) of the entity.

description string

The description of the set that helps with identification.

id string

The provider-assigned unique ID for this managed resource.

name string
regularExpressions GetRegexPatternSetRegularExpression[]

One or more blocks of regular expression patterns that AWS WAF is searching for. See Regular Expression below for details.

scope string
arn str

The Amazon Resource Name (ARN) of the entity.

description str

The description of the set that helps with identification.

id str

The provider-assigned unique ID for this managed resource.

name str
regular_expressions List[GetRegexPatternSetRegularExpression]

One or more blocks of regular expression patterns that AWS WAF is searching for. See Regular Expression below for details.

scope str

Supporting Types

GetRegexPatternSetRegularExpression

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

RegexString string

(Required) The string representing the regular expression, see the AWS WAF documentation for more information.

RegexString string

(Required) The string representing the regular expression, see the AWS WAF documentation for more information.

regexString string

(Required) The string representing the regular expression, see the AWS WAF documentation for more information.

regexString str

(Required) The string representing the regular expression, see the AWS WAF documentation for more information.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.