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.

wafv2¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.wafv2.AwaitableGetIpSetResult(addresses=None, arn=None, description=None, id=None, ip_address_version=None, name=None, scope=None)¶

class pulumi_aws.wafv2.AwaitableGetRegexPatternSetResult(arn=None, description=None, id=None, name=None, regular_expressions=None, scope=None)¶

class pulumi_aws.wafv2.AwaitableGetWebAclResult(arn=None, description=None, id=None, name=None, scope=None)¶

class pulumi_aws.wafv2.GetIpSetResult(addresses=None, arn=None, description=None, id=None, ip_address_version=None, name=None, scope=None)¶

A collection of values returned by getIpSet.

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

arn = None¶: The Amazon Resource Name (ARN) of the entity.

description = None¶: The description of the set that helps with identification.

id = None¶: The provider-assigned unique ID for this managed resource.

ip_address_version = None¶: The IP address version of the set.

class pulumi_aws.wafv2.GetRegexPatternSetResult(arn=None, description=None, id=None, name=None, regular_expressions=None, scope=None)¶

A collection of values returned by getRegexPatternSet.

arn = None¶: The Amazon Resource Name (ARN) of the entity.

description = None¶: The description of the set that helps with identification.

id = None¶: The provider-assigned unique ID for this managed resource.

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

class pulumi_aws.wafv2.GetWebAclResult(arn=None, description=None, id=None, name=None, scope=None)¶

A collection of values returned by getWebAcl.

arn = None¶: The Amazon Resource Name (ARN) of the entity.

description = None¶: The description of the WebACL that helps with identification.

id = None¶: The provider-assigned unique ID for this managed resource.

class pulumi_aws.wafv2.IpSet(resource_name, opts=None, addresses=None, description=None, ip_address_version=None, name=None, scope=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Provides a WAFv2 IP Set Resource

import pulumi
import pulumi_aws as aws

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

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
addresses (pulumi.Input[list]) – 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.
description (pulumi.Input[str]) – A friendly description of the IP set.
ip_address_version (pulumi.Input[str]) – Specify IPV4 or IPV6. Valid values are IPV4 or IPV6.
name (pulumi.Input[str]) – A friendly name of the IP set.
scope (pulumi.Input[str]) – 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).
tags (pulumi.Input[dict]) – An array of key:value pairs to associate with the resource.

addresses: pulumi.Output[list] = None¶: 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.

arn: pulumi.Output[str] = None¶: The Amazon Resource Name (ARN) that identifies the cluster.

description: pulumi.Output[str] = None¶: A friendly description of the IP set.

ip_address_version: pulumi.Output[str] = None¶: Specify IPV4 or IPV6. Valid values are IPV4 or IPV6.

name: pulumi.Output[str] = None¶: A friendly name of the IP set.

scope: pulumi.Output[str] = None¶: 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).

tags: pulumi.Output[dict] = None¶: An array of key:value pairs to associate with the resource.

static get(resource_name, id, opts=None, addresses=None, arn=None, description=None, ip_address_version=None, lock_token=None, name=None, scope=None, tags=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
addresses (pulumi.Input[list]) – 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.
arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) that identifies the cluster.
description (pulumi.Input[str]) – A friendly description of the IP set.
ip_address_version (pulumi.Input[str]) – Specify IPV4 or IPV6. Valid values are IPV4 or IPV6.
name (pulumi.Input[str]) – A friendly name of the IP set.
scope (pulumi.Input[str]) – 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).
tags (pulumi.Input[dict]) – An array of key:value pairs to associate with the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.wafv2.RegexPatternSet(resource_name, opts=None, description=None, name=None, regular_expressions=None, scope=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Provides an AWS WAFv2 Regex Pattern Set Resource

import pulumi
import pulumi_aws as aws

example = aws.wafv2.RegexPatternSet("example",
    description="Example regex pattern set",
    regular_expressions=[
        {
            "regexString": "one",
        },
        {
            "regexString": "two",
        },
    ],
    scope="REGIONAL",
    tags={
        "Tag1": "Value1",
        "Tag2": "Value2",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – A friendly description of the regular expression pattern set.
name (pulumi.Input[str]) – A friendly name of the regular expression pattern set.
regular_expressions (pulumi.Input[list]) – 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.
scope (pulumi.Input[str]) – 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.
tags (pulumi.Input[dict]) – An array of key:value pairs to associate with the resource.

The regular_expressions object supports the following:

regexString (pulumi.Input[str]) - The string representing the regular expression, see the AWS WAF documentation for more information.

arn: pulumi.Output[str] = None¶: The Amazon Resource Name (ARN) that identifies the cluster.

description: pulumi.Output[str] = None¶: A friendly description of the regular expression pattern set.

name: pulumi.Output[str] = None¶: A friendly name of the regular expression pattern set.

regular_expressions: pulumi.Output[list] = None¶

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.

regexString (str) - The string representing the regular expression, see the AWS WAF documentation for more information.

scope: pulumi.Output[str] = None¶: 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.

tags: pulumi.Output[dict] = None¶: An array of key:value pairs to associate with the resource.

static get(resource_name, id, opts=None, arn=None, description=None, lock_token=None, name=None, regular_expressions=None, scope=None, tags=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) that identifies the cluster.
description (pulumi.Input[str]) – A friendly description of the regular expression pattern set.
name (pulumi.Input[str]) – A friendly name of the regular expression pattern set.
regular_expressions (pulumi.Input[list]) – 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.
scope (pulumi.Input[str]) – 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.
tags (pulumi.Input[dict]) – An array of key:value pairs to associate with the resource.

The regular_expressions object supports the following:

regexString (pulumi.Input[str]) - The string representing the regular expression, see the AWS WAF documentation for more information.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.wafv2.WebAclAssociation(resource_name, opts=None, resource_arn=None, web_acl_arn=None, __props__=None, __name__=None, __opts__=None)¶

Creates a WAFv2 Web ACL Association.

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
resource_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the resource to associate with the web ACL. This must be an ARN of an Application Load Balancer or an Amazon API Gateway stage.
web_acl_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the Web ACL that you want to associate with the resource.

resource_arn: pulumi.Output[str] = None¶: The Amazon Resource Name (ARN) of the resource to associate with the web ACL. This must be an ARN of an Application Load Balancer or an Amazon API Gateway stage.

web_acl_arn: pulumi.Output[str] = None¶: The Amazon Resource Name (ARN) of the Web ACL that you want to associate with the resource.

static get(resource_name, id, opts=None, resource_arn=None, web_acl_arn=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
resource_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the resource to associate with the web ACL. This must be an ARN of an Application Load Balancer or an Amazon API Gateway stage.
web_acl_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the Web ACL that you want to associate with the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_aws.wafv2.get_ip_set(name=None, scope=None, opts=None)¶

Retrieves the summary of a WAFv2 IP Set.

import pulumi
import pulumi_aws as aws

example = aws.wafv2.get_ip_set(name="some-ip-set",
    scope="REGIONAL")

Parameters

name (str) – The name of the WAFv2 IP Set.
scope (str) – 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.

pulumi_aws.wafv2.get_regex_pattern_set(name=None, scope=None, opts=None)¶

Retrieves the summary of a WAFv2 Regex Pattern Set.

import pulumi
import pulumi_aws as aws

example = aws.wafv2.get_regex_pattern_set(name="some-regex-pattern-set",
    scope="REGIONAL")

Parameters

name (str) – The name of the WAFv2 Regex Pattern Set.
scope (str) – 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.

pulumi_aws.wafv2.get_web_acl(name=None, scope=None, opts=None)¶

Retrieves the summary of a WAFv2 Web ACL.

import pulumi
import pulumi_aws as aws

example = aws.wafv2.get_web_acl(name="some-web-acl",
    scope="REGIONAL")

Parameters

name (str) – The name of the WAFv2 Web ACL.
scope (str) – 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.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

wafv2¶

On This Page