RegexMatchSet class

Provides a WAF Regex Match Set Resource

Example Usage

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

const exampleRegexPatternSet = new aws.waf.RegexPatternSet("example", {
    name: "example",
    regexPatternStrings: [
        "one",
        "two",
    ],
});
const example = new aws.waf.RegexMatchSet("example", {
    regexMatchTuples: [{
        fieldToMatch: {
            data: "User-Agent",
            type: "HEADER",
        },
        regexPatternSetId: exampleRegexPatternSet.id,
        textTransformation: "NONE",
    }],
    name: "example",
});
import pulumi
import pulumi_aws as aws

example_regex_pattern_set = aws.waf.RegexPatternSet("example",
    name="example",
    regex_pattern_strings=[
        "one",
        "two",
    ])
example = aws.waf.RegexMatchSet("example",
    regex_match_tuples=[{
        "field_to_match": {
            "data": "User-Agent",
            "type": "HEADER",
        },
        "regex_pattern_set_id": example_regex_pattern_set.id,
        "text_transformation": "NONE",
    }],
    name="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

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

    var example = new Aws.Waf.RegexMatchSet("example", new()
    {
        RegexMatchTuples = new[]
        {
            new Aws.Waf.Inputs.RegexMatchSetRegexMatchTupleArgs
            {
                FieldToMatch = new Aws.Waf.Inputs.RegexMatchSetRegexMatchTupleFieldToMatchArgs
                {
                    Data = "User-Agent",
                    Type = "HEADER",
                },
                RegexPatternSetId = exampleRegexPatternSet.Id,
                TextTransformation = "NONE",
            },
        },
        Name = "example",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleRegexPatternSet, err := waf.NewRegexPatternSet(ctx, "example", &waf.RegexPatternSetArgs{
			Name: pulumi.String("example"),
			RegexPatternStrings: pulumi.StringArray{
				pulumi.String("one"),
				pulumi.String("two"),
			},
		})
		if err != nil {
			return err
		}
		_, err = waf.NewRegexMatchSet(ctx, "example", &waf.RegexMatchSetArgs{
			RegexMatchTuples: waf.RegexMatchSetRegexMatchTupleArray{
				&waf.RegexMatchSetRegexMatchTupleArgs{
					FieldToMatch: &waf.RegexMatchSetRegexMatchTupleFieldToMatchArgs{
						Data: pulumi.String("User-Agent"),
						Type: pulumi.String("HEADER"),
					},
					RegexPatternSetId:  exampleRegexPatternSet.ID().ToIDOutput().ToStringOutput(),
					TextTransformation: pulumi.String("NONE"),
				},
			},
			Name: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_waf_regexmatchset" "example" {
  regex_match_tuples {
    field_to_match = {
      data = "User-Agent"
      type = "HEADER"
    }
    regex_pattern_set_id = aws_waf_regexpatternset.example.id
    text_transformation  = "NONE"
  }
  name = "example"
}
resource "aws_waf_regexpatternset" "example" {
  name                  = "example"
  regex_pattern_strings = ["one", "two"]
}
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 com.pulumi.aws.waf.RegexMatchSet;
import com.pulumi.aws.waf.RegexMatchSetArgs;
import com.pulumi.aws.waf.inputs.RegexMatchSetRegexMatchTupleArgs;
import com.pulumi.aws.waf.inputs.RegexMatchSetRegexMatchTupleFieldToMatchArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 exampleRegexPatternSet = new RegexPatternSet("exampleRegexPatternSet", RegexPatternSetArgs.builder()
            .name("example")
            .regexPatternStrings(
                "one",
                "two")
            .build());

        var example = new RegexMatchSet("example", RegexMatchSetArgs.builder()
            .regexMatchTuples(RegexMatchSetRegexMatchTupleArgs.builder()
                .fieldToMatch(RegexMatchSetRegexMatchTupleFieldToMatchArgs.builder()
                    .data("User-Agent")
                    .type("HEADER")
                    .build())
                .regexPatternSetId(exampleRegexPatternSet.id())
                .textTransformation("NONE")
                .build())
            .name("example")
            .build());

    }
}
resources:
  example:
    type: aws:waf:RegexMatchSet
    properties:
      regexMatchTuples:
        - fieldToMatch:
            data: User-Agent
            type: HEADER
          regexPatternSetId: ${exampleRegexPatternSet.id}
          textTransformation: NONE
      name: example
  exampleRegexPatternSet:
    type: aws:waf:RegexPatternSet
    name: example
    properties:
      name: example
      regexPatternStrings:
        - one
        - two

Import

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

$ pulumi import aws:waf/regexMatchSet:RegexMatchSet example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc

Constructors

RegexMatchSet(String name, {RegexMatchSetArgs? args, CustomResourceOptions? options})
Creates a new RegexMatchSet. name The Pulumi resource name. args Arguments used to configure this RegexMatchSet. The set of arguments for RegexMatchSet. options Resource options controlling this resource's behavior.
RegexMatchSet.reference(String urn)
Creates a typed reference to an existing RegexMatchSet resource.

Properties

arn ↔ Output<String>
ARN
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
The name or description of the Regex Match Set.
latefinal
regexMatchTuples ↔ Output<List<RegexMatchSetRegexMatchTuple>?>
The regular expression pattern that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. See below.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {RegexMatchSetState? state, CustomResourceOptions? options}) → RegexMatchSet
Gets an existing RegexMatchSet resource's state with the given name and id.