AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
aws.wafv2.getRegexPatternSet
Explore with Pulumi AI
Retrieves the summary of a WAFv2 Regex Pattern Set.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.wafv2.getRegexPatternSet({
    name: "some-regex-pattern-set",
    scope: "REGIONAL",
});
import pulumi
import pulumi_aws as aws
example = aws.wafv2.get_regex_pattern_set(name="some-regex-pattern-set",
    scope="REGIONAL")
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() => 
{
    var example = Aws.WafV2.GetRegexPatternSet.Invoke(new()
    {
        Name = "some-regex-pattern-set",
        Scope = "REGIONAL",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.wafv2.Wafv2Functions;
import com.pulumi.aws.wafv2.inputs.GetRegexPatternSetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var example = Wafv2Functions.getRegexPatternSet(GetRegexPatternSetArgs.builder()
            .name("some-regex-pattern-set")
            .scope("REGIONAL")
            .build());
    }
}
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)
public static Output<GetRegexPatternSetResult> getRegexPatternSet(GetRegexPatternSetArgs args, InvokeOptions options)
fn::invoke:
  function: aws:wafv2/getRegexPatternSet:getRegexPatternSet
  arguments:
    # arguments dictionaryThe following arguments are supported:
getRegexPatternSet Result
The following output properties are available:
- Arn string
- ARN of the entity.
- Description string
- Description of the set that helps with identification.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- RegularExpressions List<GetRegex Pattern Set Regular Expression> 
- One or more blocks of regular expression patterns that AWS WAF is searching for. See Regular Expression below for details.
- Scope string
- Arn string
- ARN of the entity.
- Description string
- Description of the set that helps with identification.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- RegularExpressions []GetRegex Pattern Set Regular Expression 
- One or more blocks of regular expression patterns that AWS WAF is searching for. See Regular Expression below for details.
- Scope string
- arn String
- ARN of the entity.
- description String
- Description of the set that helps with identification.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- regularExpressions List<GetRegex Pattern Set Regular Expression> 
- One or more blocks of regular expression patterns that AWS WAF is searching for. See Regular Expression below for details.
- scope String
- arn string
- ARN of the entity.
- description string
- Description of the set that helps with identification.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- regularExpressions GetRegex Pattern Set Regular Expression[] 
- One or more blocks of regular expression patterns that AWS WAF is searching for. See Regular Expression below for details.
- scope string
- arn str
- ARN of the entity.
- description str
- Description of the set that helps with identification.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- regular_expressions Sequence[GetRegex Pattern Set Regular Expression] 
- One or more blocks of regular expression patterns that AWS WAF is searching for. See Regular Expression below for details.
- scope str
- arn String
- ARN of the entity.
- description String
- Description of the set that helps with identification.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- regularExpressions List<Property Map>
- 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) String representing the regular expression, see the AWS WAF documentation for more information.
- RegexString string
- (Required) String representing the regular expression, see the AWS WAF documentation for more information.
- regexString String
- (Required) String representing the regular expression, see the AWS WAF documentation for more information.
- regexString string
- (Required) String representing the regular expression, see the AWS WAF documentation for more information.
- regex_string str
- (Required) String representing the regular expression, see the AWS WAF documentation for more information.
- regexString String
- (Required) String representing the regular expression, see the AWS WAF documentation for more information.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the awsTerraform Provider.