1. Docs
  2. Reference
  3. API
  4. @pulumi/aws
  5. wafv2

Module wafv2

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Functions

Others

Resources

Resource IpSet

class IpSet extends CustomResource

Provides a WAFv2 IP Set Resource

Example Usage

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

const example = new aws.wafv2.IpSet("example", {
    addresses: [
        "1.2.3.4/32",
        "5.6.7.8/32",
    ],
    description: "Example IP set",
    ipAddressVersion: "IPV4",
    scope: "REGIONAL",
    tags: {
        Tag1: "Value1",
        Tag2: "Value2",
    },
});

constructor

new IpSet(name: string, args: IpSetArgs, opts?: pulumi.CustomResourceOptions)

Create a IpSet resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: IpSetState, opts?: pulumi.CustomResourceOptions): IpSet

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is IpSet

Returns true if the given object is an instance of IpSet. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property addresses

public addresses: pulumi.Output<string[] | undefined>;

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.

property arn

public arn: pulumi.Output<string>;

The Amazon Resource Name (ARN) that identifies the cluster.

property description

public description: pulumi.Output<string | undefined>;

A friendly description of the IP set.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipAddressVersion

public ipAddressVersion: pulumi.Output<string>;

Specify IPV4 or IPV6. Valid values are IPV4 or IPV6.

property lockToken

public lockToken: pulumi.Output<string>;

property name

public name: pulumi.Output<string>;

A friendly name of the IP set.

property scope

public scope: pulumi.Output<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 (N. Virginia).

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

An array of key:value pairs to associate with the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RegexPatternSet

class RegexPatternSet extends CustomResource

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", {
    description: "Example regex pattern set",
    regularExpressions: [
        {
            regexString: "one",
        },
        {
            regexString: "two",
        },
    ],
    scope: "REGIONAL",
    tags: {
        Tag1: "Value1",
        Tag2: "Value2",
    },
});

constructor

new RegexPatternSet(name: string, args: RegexPatternSetArgs, opts?: pulumi.CustomResourceOptions)

Create a RegexPatternSet resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RegexPatternSetState, opts?: pulumi.CustomResourceOptions): RegexPatternSet

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is RegexPatternSet

Returns true if the given object is an instance of RegexPatternSet. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The Amazon Resource Name (ARN) that identifies the cluster.

property description

public description: pulumi.Output<string | undefined>;

A friendly description of the regular expression pattern set.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property lockToken

public lockToken: pulumi.Output<string>;

property name

public name: pulumi.Output<string>;

A friendly name of the regular expression pattern set.

property regularExpressions

public regularExpressions: pulumi.Output<RegexPatternSetRegularExpression[] | undefined>;

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.

property scope

public scope: pulumi.Output<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.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

An array of key:value pairs to associate with the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getIpSet

getIpSet(args: GetIpSetArgs, opts?: pulumi.InvokeOptions): Promise<GetIpSetResult>

Retrieves the summary of a WAFv2 IP Set.

Example Usage

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

const example = pulumi.output(aws.wafv2.getIpSet({
    name: "some-ip-set",
    scope: "REGIONAL",
}, { async: true }));

Function getRegexPatternSet

getRegexPatternSet(args: GetRegexPatternSetArgs, opts?: pulumi.InvokeOptions): Promise<GetRegexPatternSetResult>

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 = pulumi.output(aws.wafv2.getRegexPatternSet({
    name: "some-regex-pattern-set",
    scope: "REGIONAL",
}, { async: true }));

Others

interface GetIpSetArgs

interface GetIpSetArgs

A collection of arguments for invoking getIpSet.

property name

name: string;

The name of the WAFv2 IP Set.

property scope

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.

interface GetIpSetResult

interface GetIpSetResult

A collection of values returned by getIpSet.

property addresses

addresses: string[];

An array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation.

property arn

arn: string;

The Amazon Resource Name (ARN) of the entity.

property description

description: string;

The description of the set that helps with identification.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ipAddressVersion

ipAddressVersion: string;

The IP address version of the set.

property name

name: string;

property scope

scope: string;

interface GetRegexPatternSetArgs

interface GetRegexPatternSetArgs

A collection of arguments for invoking getRegexPatternSet.

property name

name: string;

The name of the WAFv2 Regex Pattern Set.

property scope

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.

interface GetRegexPatternSetResult

interface GetRegexPatternSetResult

A collection of values returned by getRegexPatternSet.

property arn

arn: string;

The Amazon Resource Name (ARN) of the entity.

property description

description: string;

The description of the set that helps with identification.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

property regularExpressions

regularExpressions: GetRegexPatternSetRegularExpression[];

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

property scope

scope: string;

interface IpSetArgs

interface IpSetArgs

The set of arguments for constructing a IpSet resource.

property addresses

addresses?: pulumi.Input<pulumi.Input<string>[]>;

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.

property description

description?: pulumi.Input<string>;

A friendly description of the IP set.

property ipAddressVersion

ipAddressVersion: pulumi.Input<string>;

Specify IPV4 or IPV6. Valid values are IPV4 or IPV6.

property name

name?: pulumi.Input<string>;

A friendly name of the IP set.

property scope

scope: pulumi.Input<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 (N. Virginia).

property tags

tags?: pulumi.Input<{[key: string]: any}>;

An array of key:value pairs to associate with the resource.

interface IpSetState

interface IpSetState

Input properties used for looking up and filtering IpSet resources.

property addresses

addresses?: pulumi.Input<pulumi.Input<string>[]>;

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.

property arn

arn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) that identifies the cluster.

property description

description?: pulumi.Input<string>;

A friendly description of the IP set.

property ipAddressVersion

ipAddressVersion?: pulumi.Input<string>;

Specify IPV4 or IPV6. Valid values are IPV4 or IPV6.

property lockToken

lockToken?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

A friendly name of the IP set.

property scope

scope?: pulumi.Input<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 (N. Virginia).

property tags

tags?: pulumi.Input<{[key: string]: any}>;

An array of key:value pairs to associate with the resource.

interface RegexPatternSetArgs

interface RegexPatternSetArgs

The set of arguments for constructing a RegexPatternSet resource.

property description

description?: pulumi.Input<string>;

A friendly description of the regular expression pattern set.

property name

name?: pulumi.Input<string>;

A friendly name of the regular expression pattern set.

property regularExpressions

regularExpressions?: pulumi.Input<pulumi.Input<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.

property scope

scope: pulumi.Input<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.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

An array of key:value pairs to associate with the resource.

interface RegexPatternSetState

interface RegexPatternSetState

Input properties used for looking up and filtering RegexPatternSet resources.

property arn

arn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) that identifies the cluster.

property description

description?: pulumi.Input<string>;

A friendly description of the regular expression pattern set.

property lockToken

lockToken?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

A friendly name of the regular expression pattern set.

property regularExpressions

regularExpressions?: pulumi.Input<pulumi.Input<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.

property scope

scope?: pulumi.Input<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.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

An array of key:value pairs to associate with the resource.