AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.4.0 published on Wednesday, May 4, 2022 by Pulumi

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/v5/go/aws/wafv2"
	"github.com/pulumi/pulumi/sdk/v3/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
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = Output.of(Wafv2Functions.getRegexPatternSet(GetRegexPatternSetArgs.builder()
            .name("some-regex-pattern-set")
            .scope("REGIONAL")
            .build()));

        }
}
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",
}));
variables:
  example:
    Fn::Invoke:
      Function: aws:wafv2:getRegexPatternSet
      Arguments:
        name: some-regex-pattern-set
        scope: REGIONAL

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>
def get_regex_pattern_set(name: Optional[str] = None,
                          scope: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetRegexPatternSetResult
def get_regex_pattern_set_output(name: Optional[pulumi.Input[str]] = None,
                          scope: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetRegexPatternSetResult]
func LookupRegexPatternSet(ctx *Context, args *LookupRegexPatternSetArgs, opts ...InvokeOption) (*LookupRegexPatternSetResult, error)
func LookupRegexPatternSetOutput(ctx *Context, args *LookupRegexPatternSetOutputArgs, opts ...InvokeOption) LookupRegexPatternSetResultOutput

> 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)
}
public static CompletableFuture<GetRegexPatternSetResult> getRegexPatternSet(GetRegexPatternSetArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws:wafv2/getRegexPatternSet:getRegexPatternSet
  Arguments:
    # Arguments dictionary

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 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.

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.

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<Pulumi.Aws.WafV2.Outputs.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 ListRegexPatternSetRegularExpression>

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 Sequence[GetRegexPatternSetRegularExpression]

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

scope str
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

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

scope String

Supporting Types

GetRegexPatternSetRegularExpression

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 string

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

regex_string str

(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.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.