aws-native.wafv2.getIpSet

Explore with Pulumi AI

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

AWS Cloud Control v1.31.0 published on Wednesday, Jul 16, 2025 by Pulumi

pulumi/pulumi-aws-native

Using getIpSet

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getIpSet(args: GetIpSetArgs, opts?: InvokeOptions): Promise<GetIpSetResult>
function getIpSetOutput(args: GetIpSetOutputArgs, opts?: InvokeOptions): Output<GetIpSetResult>

def get_ip_set(id: Optional[str] = None,
               name: Optional[str] = None,
               scope: Optional[IpSetScope] = None,
               opts: Optional[InvokeOptions] = None) -> GetIpSetResult
def get_ip_set_output(id: Optional[pulumi.Input[str]] = None,
               name: Optional[pulumi.Input[str]] = None,
               scope: Optional[pulumi.Input[IpSetScope]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetIpSetResult]

func LookupIpSet(ctx *Context, args *LookupIpSetArgs, opts ...InvokeOption) (*LookupIpSetResult, error)
func LookupIpSetOutput(ctx *Context, args *LookupIpSetOutputArgs, opts ...InvokeOption) LookupIpSetResultOutput

> Note: This function is named LookupIpSet in the Go SDK.

public static class GetIpSet 
{
    public static Task<GetIpSetResult> InvokeAsync(GetIpSetArgs args, InvokeOptions? opts = null)
    public static Output<GetIpSetResult> Invoke(GetIpSetInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetIpSetResult> getIpSet(GetIpSetArgs args, InvokeOptions options)
public static Output<GetIpSetResult> getIpSet(GetIpSetArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:wafv2:getIpSet
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: The ID of the IP set.
Name string: The name of the IP set. You cannot change the name of an IPSet after you create it.
Scope 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 .

Id string: The ID of the IP set.
Name string: The name of the IP set. You cannot change the name of an IPSet after you create it.
Scope 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 .

id String: The ID of the IP set.
name String: The name of the IP set. You cannot change the name of an IPSet after you create it.
scope 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 .

id string: The ID of the IP set.
name string: The name of the IP set. You cannot change the name of an IPSet after you create it.
scope 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 .

id str: The ID of the IP set.
name str: The name of the IP set. You cannot change the name of an IPSet after you create it.
scope 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 .

id String: The ID of the IP set.
name String: The name of the IP set. You cannot change the name of an IPSet after you create it.
scope "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 .

getIpSet Result

The following output properties are available:

Addresses List<string>: List of IPAddresses.
Arn string: The Amazon Resource Name (ARN) of the IP set.
Description string: A description of the IP set that helps with identification.
Id string: The ID of the IP set.
IpAddressVersion Pulumi.AwsNative.WaFv2.IpSetIpAddressVersion: The version of the IP addresses, either IPV4 or IPV6 .
Tags List<Pulumi.AwsNative.Outputs.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 []string: List of IPAddresses.
Arn string: The Amazon Resource Name (ARN) of the IP set.
Description string: A description of the IP set that helps with identification.
Id string: The ID of the IP set.
IpAddressVersion IpSetIpAddressVersion: The version of the IP addresses, either IPV4 or IPV6 .
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 List<String>: List of IPAddresses.
arn String: The Amazon Resource Name (ARN) of the IP set.
description String: A description of the IP set that helps with identification.
id String: The ID of the IP set.
ipAddressVersion IpSetIpAddressVersion: The version of the IP addresses, either IPV4 or IPV6 .
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 string[]: List of IPAddresses.
arn string: The Amazon Resource Name (ARN) of the IP set.
description string: A description of the IP set that helps with identification.
id string: The ID of the IP set.
ipAddressVersion IpSetIpAddressVersion: The version of the IP addresses, either IPV4 or IPV6 .
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 Sequence[str]: List of IPAddresses.
arn str: The Amazon Resource Name (ARN) of the IP set.
description str: A description of the IP set that helps with identification.
id str: The ID of the IP set.
ip_address_version IpSetIpAddressVersion: The version of the IP addresses, either IPV4 or IPV6 .
tags Sequence[root_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 List<String>: List of IPAddresses.
arn String: The Amazon Resource Name (ARN) of the IP set.
description String: A description of the IP set that helps with identification.
id String: The ID of the IP set.
ipAddressVersion "IPV4" | "IPV6": The version of the IP addresses, either IPV4 or IPV6 .
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.

Supporting Types

IpSetIpAddressVersion

IpSetScope

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.31.0 published on Wednesday, Jul 16, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.wafv2.getIpSet

On this page

On this page

Using getIpSet

getIpSet Result

Supporting Types

IpSetIpAddressVersion

IpSetScope

Tag

Package Details

On this page

On this page