1. Packages
  2. AWS
  3. API Docs
  4. wafv2
  5. getIpSet
AWS v6 v6.83.2 published on Thursday, Nov 20, 2025 by Pulumi
aws-v6 logo
AWS v6 v6.83.2 published on Thursday, Nov 20, 2025 by Pulumi

    Retrieves the summary of a WAFv2 IP Set.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.wafv2.getIpSet({
        name: "some-ip-set",
        scope: "REGIONAL",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.wafv2.get_ip_set(name="some-ip-set",
        scope="REGIONAL")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/wafv2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := wafv2.LookupIpSet(ctx, &wafv2.LookupIpSetArgs{
    			Name:  "some-ip-set",
    			Scope: "REGIONAL",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Aws.WafV2.GetIpSet.Invoke(new()
        {
            Name = "some-ip-set",
            Scope = "REGIONAL",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.wafv2.Wafv2Functions;
    import com.pulumi.aws.wafv2.inputs.GetIpSetArgs;
    import java.util.List;
    import java.util.ArrayList;
    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) {
            final var example = Wafv2Functions.getIpSet(GetIpSetArgs.builder()
                .name("some-ip-set")
                .scope("REGIONAL")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: aws:wafv2:getIpSet
          arguments:
            name: some-ip-set
            scope: REGIONAL
    

    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(name: Optional[str] = None,
                   scope: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetIpSetResult
    def get_ip_set_output(name: Optional[pulumi.Input[str]] = None,
                   scope: Optional[pulumi.Input[str]] = 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:wafv2/getIpSet:getIpSet
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Name of the WAFv2 IP Set.
    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.
    Name string
    Name of the WAFv2 IP Set.
    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.
    name String
    Name of the WAFv2 IP Set.
    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.
    name string
    Name of the WAFv2 IP Set.
    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.
    name str
    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.
    name String
    Name of the WAFv2 IP Set.
    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.

    getIpSet Result

    The following output properties are available:

    Addresses List<string>
    An array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation.
    Arn string
    ARN of the entity.
    Description string
    Description of the set that helps with identification.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddressVersion string
    IP address version of the set.
    Name string
    Scope string
    Addresses []string
    An array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation.
    Arn string
    ARN of the entity.
    Description string
    Description of the set that helps with identification.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddressVersion string
    IP address version of the set.
    Name string
    Scope string
    addresses List<String>
    An array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation.
    arn String
    ARN of the entity.
    description String
    Description of the set that helps with identification.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddressVersion String
    IP address version of the set.
    name String
    scope String
    addresses string[]
    An array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation.
    arn string
    ARN of the entity.
    description string
    Description of the set that helps with identification.
    id string
    The provider-assigned unique ID for this managed resource.
    ipAddressVersion string
    IP address version of the set.
    name string
    scope string
    addresses Sequence[str]
    An array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation.
    arn str
    ARN of the entity.
    description str
    Description of the set that helps with identification.
    id str
    The provider-assigned unique ID for this managed resource.
    ip_address_version str
    IP address version of the set.
    name str
    scope str
    addresses List<String>
    An array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation.
    arn String
    ARN of the entity.
    description String
    Description of the set that helps with identification.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddressVersion String
    IP address version of the set.
    name String
    scope String

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws-v6 logo
    AWS v6 v6.83.2 published on Thursday, Nov 20, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate