Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. wafv2
  5. IpSet

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.wafv2.IpSet

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Contains a list of IP addresses. This can be either IPV4 or IPV6. The list will be mutually

Create IpSet Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new IpSet(name: string, args: IpSetArgs, opts?: CustomResourceOptions);
@overload
def IpSet(resource_name: str,
          args: IpSetArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def IpSet(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          addresses: Optional[Sequence[str]] = None,
          ip_address_version: Optional[IpSetIpAddressVersion] = None,
          scope: Optional[IpSetScope] = None,
          description: Optional[str] = None,
          name: Optional[str] = None,
          tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewIpSet(ctx *Context, name string, args IpSetArgs, opts ...ResourceOption) (*IpSet, error)
public IpSet(string name, IpSetArgs args, CustomResourceOptions? opts = null)
public IpSet(String name, IpSetArgs args)
public IpSet(String name, IpSetArgs args, CustomResourceOptions options)

type: aws-native:wafv2:IpSet
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 This property is required. IpSetArgs
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 This property is required. IpSetArgs
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 This property is required. IpSetArgs
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 This property is required. IpSetArgs
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. IpSetArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

IpSet 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 IpSet resource accepts the following input properties:

Addresses This property is required. List<string>
List of IPAddresses.
IpAddressVersion This property is required. Pulumi.AwsNative.WaFv2.IpSetIpAddressVersion
The version of the IP addresses, either IPV4 or IPV6 .
Scope This property is required. Pulumi.AwsNative.WaFv2.IpSetScope

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. Valid Values are CLOUDFRONT and REGIONAL .

For CLOUDFRONT , you must create your WAFv2 resources in the US East (N. Virginia) Region, us-east-1 .

Description string
A description of the IP set that helps with identification.
Name string
The name of the IP set. You cannot change the name of an IPSet after you create it.
Tags List<Pulumi.AwsNative.Inputs.Tag>

Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.

To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.

Addresses This property is required. []string
List of IPAddresses.
IpAddressVersion This property is required. IpSetIpAddressVersion
The version of the IP addresses, either IPV4 or IPV6 .
Scope This property is required. IpSetScope

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. Valid Values are CLOUDFRONT and REGIONAL .

For CLOUDFRONT , you must create your WAFv2 resources in the US East (N. Virginia) Region, us-east-1 .

Description string
A description of the IP set that helps with identification.
Name string
The name of the IP set. You cannot change the name of an IPSet after you create it.
Tags TagArgs

Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.

To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.

addresses This property is required. List<String>
List of IPAddresses.
ipAddressVersion This property is required. IpSetIpAddressVersion
The version of the IP addresses, either IPV4 or IPV6 .
scope This property is required. IpSetScope

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. Valid Values are CLOUDFRONT and REGIONAL .

For CLOUDFRONT , you must create your WAFv2 resources in the US East (N. Virginia) Region, us-east-1 .

description String
A description of the IP set that helps with identification.
name String
The name of the IP set. You cannot change the name of an IPSet after you create it.
tags List<Tag>

Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.

To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.

addresses This property is required. string[]
List of IPAddresses.
ipAddressVersion This property is required. IpSetIpAddressVersion
The version of the IP addresses, either IPV4 or IPV6 .
scope This property is required. IpSetScope

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. Valid Values are CLOUDFRONT and REGIONAL .

For CLOUDFRONT , you must create your WAFv2 resources in the US East (N. Virginia) Region, us-east-1 .

description string
A description of the IP set that helps with identification.
name string
The name of the IP set. You cannot change the name of an IPSet after you create it.
tags Tag[]

Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.

To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.

addresses This property is required. Sequence[str]
List of IPAddresses.
ip_address_version This property is required. IpSetIpAddressVersion
The version of the IP addresses, either IPV4 or IPV6 .
scope This property is required. IpSetScope

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. Valid Values are CLOUDFRONT and REGIONAL .

For CLOUDFRONT , you must create your WAFv2 resources in the US East (N. Virginia) Region, us-east-1 .

description str
A description of the IP set that helps with identification.
name str
The name of the IP set. You cannot change the name of an IPSet after you create it.
tags Sequence[TagArgs]

Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.

To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.

addresses This property is required. List<String>
List of IPAddresses.
ipAddressVersion This property is required. "IPV4" | "IPV6"
The version of the IP addresses, either IPV4 or IPV6 .
scope This property is required. "CLOUDFRONT" | "REGIONAL"

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. Valid Values are CLOUDFRONT and REGIONAL .

For CLOUDFRONT , you must create your WAFv2 resources in the US East (N. Virginia) Region, us-east-1 .

description String
A description of the IP set that helps with identification.
name String
The name of the IP set. You cannot change the name of an IPSet after you create it.
tags List<Property Map>

Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.

To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.

Outputs

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

Arn string
The Amazon Resource Name (ARN) of the IP set.
AwsId string
The ID of the IP set.
Id string
The provider-assigned unique ID for this managed resource.
Arn string
The Amazon Resource Name (ARN) of the IP set.
AwsId string
The ID of the IP set.
Id string
The provider-assigned unique ID for this managed resource.
arn String
The Amazon Resource Name (ARN) of the IP set.
awsId String
The ID of the IP set.
id String
The provider-assigned unique ID for this managed resource.
arn string
The Amazon Resource Name (ARN) of the IP set.
awsId string
The ID of the IP set.
id string
The provider-assigned unique ID for this managed resource.
arn str
The Amazon Resource Name (ARN) of the IP set.
aws_id str
The ID of the IP set.
id str
The provider-assigned unique ID for this managed resource.
arn String
The Amazon Resource Name (ARN) of the IP set.
awsId String
The ID of the IP set.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

IpSetIpAddressVersion
, IpSetIpAddressVersionArgs

Ipv4
IPV4
Ipv6
IPV6
IpSetIpAddressVersionIpv4
IPV4
IpSetIpAddressVersionIpv6
IPV6
Ipv4
IPV4
Ipv6
IPV6
Ipv4
IPV4
Ipv6
IPV6
IPV4
IPV4
IPV6
IPV6
"IPV4"
IPV4
"IPV6"
IPV6

IpSetScope
, IpSetScopeArgs

Cloudfront
CLOUDFRONT
Regional
REGIONAL
IpSetScopeCloudfront
CLOUDFRONT
IpSetScopeRegional
REGIONAL
Cloudfront
CLOUDFRONT
Regional
REGIONAL
Cloudfront
CLOUDFRONT
Regional
REGIONAL
CLOUDFRONT
CLOUDFRONT
REGIONAL
REGIONAL
"CLOUDFRONT"
CLOUDFRONT
"REGIONAL"
REGIONAL

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native