1. Packages
  2. AWS
  3. API Docs
  4. waf
  5. RegexPatternSet
AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi

aws.waf.RegexPatternSet

Explore with Pulumi AI

Provides a WAF Regex Pattern Set Resource

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.waf.RegexPatternSet("example", {
    name: "my_waf_regex_pattern_set",
    regexPatternStrings: [
        "one",
        "two",
    ],
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.waf.RegexPatternSet("example",
    name="my_waf_regex_pattern_set",
    regex_pattern_strings=[
        "one",
        "two",
    ])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/waf"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := waf.NewRegexPatternSet(ctx, "example", &waf.RegexPatternSetArgs{
			Name: pulumi.String("my_waf_regex_pattern_set"),
			RegexPatternStrings: pulumi.StringArray{
				pulumi.String("one"),
				pulumi.String("two"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Waf.RegexPatternSet("example", new()
    {
        Name = "my_waf_regex_pattern_set",
        RegexPatternStrings = new[]
        {
            "one",
            "two",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.waf.RegexPatternSet;
import com.pulumi.aws.waf.RegexPatternSetArgs;
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) {
        var example = new RegexPatternSet("example", RegexPatternSetArgs.builder()
            .name("my_waf_regex_pattern_set")
            .regexPatternStrings(            
                "one",
                "two")
            .build());

    }
}
Copy
resources:
  example:
    type: aws:waf:RegexPatternSet
    properties:
      name: my_waf_regex_pattern_set
      regexPatternStrings:
        - one
        - two
Copy

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: Optional[RegexPatternSetArgs] = None,
                    opts: Optional[ResourceOptions] = None)

@overload
def RegexPatternSet(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    name: Optional[str] = None,
                    regex_pattern_strings: Optional[Sequence[str]] = None)
func NewRegexPatternSet(ctx *Context, name string, args *RegexPatternSetArgs, opts ...ResourceOption) (*RegexPatternSet, error)
public RegexPatternSet(string name, RegexPatternSetArgs? args = null, CustomResourceOptions? opts = null)
public RegexPatternSet(String name, RegexPatternSetArgs args)
public RegexPatternSet(String name, RegexPatternSetArgs args, CustomResourceOptions options)
type: aws:waf: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 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 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 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 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.

Constructor example

The following reference example uses placeholder values for all input properties.

var regexPatternSetResource = new Aws.Waf.RegexPatternSet("regexPatternSetResource", new()
{
    Name = "string",
    RegexPatternStrings = new[]
    {
        "string",
    },
});
Copy
example, err := waf.NewRegexPatternSet(ctx, "regexPatternSetResource", &waf.RegexPatternSetArgs{
	Name: pulumi.String("string"),
	RegexPatternStrings: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var regexPatternSetResource = new RegexPatternSet("regexPatternSetResource", RegexPatternSetArgs.builder()
    .name("string")
    .regexPatternStrings("string")
    .build());
Copy
regex_pattern_set_resource = aws.waf.RegexPatternSet("regexPatternSetResource",
    name="string",
    regex_pattern_strings=["string"])
Copy
const regexPatternSetResource = new aws.waf.RegexPatternSet("regexPatternSetResource", {
    name: "string",
    regexPatternStrings: ["string"],
});
Copy
type: aws:waf:RegexPatternSet
properties:
    name: string
    regexPatternStrings:
        - string
Copy

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:

Name Changes to this property will trigger replacement. string
The name or description of the Regex Pattern Set.
RegexPatternStrings List<string>
A list of regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
Name Changes to this property will trigger replacement. string
The name or description of the Regex Pattern Set.
RegexPatternStrings []string
A list of regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
name Changes to this property will trigger replacement. String
The name or description of the Regex Pattern Set.
regexPatternStrings List<String>
A list of regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
name Changes to this property will trigger replacement. string
The name or description of the Regex Pattern Set.
regexPatternStrings string[]
A list of regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
name Changes to this property will trigger replacement. str
The name or description of the Regex Pattern Set.
regex_pattern_strings Sequence[str]
A list of regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
name Changes to this property will trigger replacement. String
The name or description of the Regex Pattern Set.
regexPatternStrings List<String>
A list of regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.

Outputs

All input properties are implicitly available as output properties. Additionally, the RegexPatternSet resource produces the following output properties:

Arn string
Amazon Resource Name (ARN)
Id string
The provider-assigned unique ID for this managed resource.
Arn string
Amazon Resource Name (ARN)
Id string
The provider-assigned unique ID for this managed resource.
arn String
Amazon Resource Name (ARN)
id String
The provider-assigned unique ID for this managed resource.
arn string
Amazon Resource Name (ARN)
id string
The provider-assigned unique ID for this managed resource.
arn str
Amazon Resource Name (ARN)
id str
The provider-assigned unique ID for this managed resource.
arn String
Amazon Resource Name (ARN)
id String
The provider-assigned unique ID for this managed resource.

Look up Existing RegexPatternSet Resource

Get an existing RegexPatternSet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: RegexPatternSetState, opts?: CustomResourceOptions): RegexPatternSet
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        name: Optional[str] = None,
        regex_pattern_strings: Optional[Sequence[str]] = None) -> RegexPatternSet
func GetRegexPatternSet(ctx *Context, name string, id IDInput, state *RegexPatternSetState, opts ...ResourceOption) (*RegexPatternSet, error)
public static RegexPatternSet Get(string name, Input<string> id, RegexPatternSetState? state, CustomResourceOptions? opts = null)
public static RegexPatternSet get(String name, Output<String> id, RegexPatternSetState state, CustomResourceOptions options)
resources:  _:    type: aws:waf:RegexPatternSet    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string
Amazon Resource Name (ARN)
Name Changes to this property will trigger replacement. string
The name or description of the Regex Pattern Set.
RegexPatternStrings List<string>
A list of regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
Arn string
Amazon Resource Name (ARN)
Name Changes to this property will trigger replacement. string
The name or description of the Regex Pattern Set.
RegexPatternStrings []string
A list of regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
arn String
Amazon Resource Name (ARN)
name Changes to this property will trigger replacement. String
The name or description of the Regex Pattern Set.
regexPatternStrings List<String>
A list of regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
arn string
Amazon Resource Name (ARN)
name Changes to this property will trigger replacement. string
The name or description of the Regex Pattern Set.
regexPatternStrings string[]
A list of regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
arn str
Amazon Resource Name (ARN)
name Changes to this property will trigger replacement. str
The name or description of the Regex Pattern Set.
regex_pattern_strings Sequence[str]
A list of regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
arn String
Amazon Resource Name (ARN)
name Changes to this property will trigger replacement. String
The name or description of the Regex Pattern Set.
regexPatternStrings List<String>
A list of regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.

Import

Using pulumi import, import AWS WAF Regex Pattern Set using their ID. For example:

$ pulumi import aws:waf/regexPatternSet:RegexPatternSet example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.