RegexPatternSet class
Provides an AWS WAFv2 Regex Pattern Set Resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.wafv2.RegexPatternSet("example", {
regularExpressions: [
{
regexString: "one",
},
{
regexString: "two",
},
],
name: "example",
description: "Example regex pattern set",
scope: "REGIONAL",
tags: {
Tag1: "Value1",
Tag2: "Value2",
},
});
import pulumi
import pulumi_aws as aws
example = aws.wafv2.RegexPatternSet("example",
regular_expressions=[
{
"regex_string": "one",
},
{
"regex_string": "two",
},
],
name="example",
description="Example regex pattern set",
scope="REGIONAL",
tags={
"Tag1": "Value1",
"Tag2": "Value2",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.WafV2.RegexPatternSet("example", new()
{
RegularExpressions = new[]
{
new Aws.WafV2.Inputs.RegexPatternSetRegularExpressionArgs
{
RegexString = "one",
},
new Aws.WafV2.Inputs.RegexPatternSetRegularExpressionArgs
{
RegexString = "two",
},
},
Name = "example",
Description = "Example regex pattern set",
Scope = "REGIONAL",
Tags =
{
{ "Tag1", "Value1" },
{ "Tag2", "Value2" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/wafv2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := wafv2.NewRegexPatternSet(ctx, "example", &wafv2.RegexPatternSetArgs{
RegularExpressions: wafv2.RegexPatternSetRegularExpressionArray{
&wafv2.RegexPatternSetRegularExpressionArgs{
RegexString: pulumi.String("one"),
},
&wafv2.RegexPatternSetRegularExpressionArgs{
RegexString: pulumi.String("two"),
},
},
Name: pulumi.String("example"),
Description: pulumi.String("Example regex pattern set"),
Scope: pulumi.String("REGIONAL"),
Tags: pulumi.StringMap{
"Tag1": pulumi.String("Value1"),
"Tag2": pulumi.String("Value2"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_wafv2_regexpatternset" "example" {
regular_expressions {
regex_string = "one"
}
regular_expressions {
regex_string = "two"
}
name = "example"
description = "Example regex pattern set"
scope = "REGIONAL"
tags = {
"Tag1" = "Value1"
"Tag2" = "Value2"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.wafv2.RegexPatternSet;
import com.pulumi.aws.wafv2.RegexPatternSetArgs;
import com.pulumi.aws.wafv2.inputs.RegexPatternSetRegularExpressionArgs;
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 example = new RegexPatternSet("example", RegexPatternSetArgs.builder()
.regularExpressions(
RegexPatternSetRegularExpressionArgs.builder()
.regexString("one")
.build(),
RegexPatternSetRegularExpressionArgs.builder()
.regexString("two")
.build())
.name("example")
.description("Example regex pattern set")
.scope("REGIONAL")
.tags(Map.ofEntries(
Map.entry("Tag1", "Value1"),
Map.entry("Tag2", "Value2")
))
.build());
}
}
resources:
example:
type: aws:wafv2:RegexPatternSet
properties:
regularExpressions:
- regexString: one
- regexString: two
name: example
description: Example regex pattern set
scope: REGIONAL
tags:
Tag1: Value1
Tag2: Value2
Import
Using pulumi import, import WAFv2 Regex Pattern Sets using ID/name/scope. For example:
$ pulumi import aws:wafv2/regexPatternSet:RegexPatternSet example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc/example/REGIONAL
Constructors
- RegexPatternSet(String name, {RegexPatternSetArgs? args, CustomResourceOptions? options})
-
Creates a new RegexPatternSet.
nameThe Pulumi resource name.argsArguments used to configure this RegexPatternSet. The set of arguments for RegexPatternSet.optionsResource options controlling this resource's behavior. - RegexPatternSet.reference(String urn)
- Creates a typed reference to an existing RegexPatternSet resource.
Properties
-
arn
↔ Output<
String> -
ARN that identifies the cluster.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
description
↔ Output<
String?> -
A friendly description of the regular expression pattern set.
latefinal
- 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
-
lockToken
↔ Output<
String> -
latefinal
-
name
↔ Output<
String> -
A friendly name of the regular expression pattern set. If omitted, the provider will assign a random, unique name. Conflicts with
namePrefix.latefinal -
namePrefix
↔ Output<
String> -
Creates a unique name beginning with the specified prefix. Conflicts with
name.latefinal -
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
regularExpressions
↔ Output<
List< RegexPatternSetRegularExpression> ?> -
One or more blocks of regular expression patterns that you want AWS WAF to search for, such as
B[a@]dB[o0]t. See Regular Expression below for details.latefinal -
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
scope
↔ Output<
String> -
Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are
CLOUDFRONTorREGIONAL. To work with CloudFront, you must also specify the regionus-east-1(N. Virginia) on the AWS provider.latefinal -
An array of key:value pairs to associate with the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
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, {RegexPatternSetState? state, CustomResourceOptions? options}) → RegexPatternSet -
Gets an existing RegexPatternSet resource's state with the given
nameandid.