1. Docs
  2. Reference
  3. API
  4. AWS
  5. wafv2
  6. GetIpSet

GetIpSet

Retrieves the summary of a WAFv2 IP Set.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Aws.WafV2.GetIpSet.InvokeAsync(new Aws.WafV2.GetIpSetArgs
        {
            Name = "some-ip-set",
            Scope = "REGIONAL",
        }));
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/wafv2"
    "github.com/pulumi/pulumi/sdk/v2/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
    })
}
import pulumi
import pulumi_aws as aws

example = aws.wafv2.get_ip_set(name="some-ip-set",
    scope="REGIONAL")
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 }));

Using GetIpSet

function getIpSet(args: GetIpSetArgs, opts?: InvokeOptions): Promise<GetIpSetResult>
function  get_ip_set(name=None, scope=None, opts=None)
func LookupIpSet(ctx *Context, args *LookupIpSetArgs, opts ...InvokeOption) (*LookupIpSetResult, error)

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

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

The following arguments are supported:

Name string

The 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

The 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

The 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

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.

GetIpSet Result

The following output properties are available:

Addresses List<string>

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

Arn string

The Amazon Resource Name (ARN) of the entity.

Description string

The description of the set that helps with identification.

Id string

The provider-assigned unique ID for this managed resource.

IpAddressVersion string

The IP address version of the set.

Name string
Scope string
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.

Arn string

The Amazon Resource Name (ARN) of the entity.

Description string

The description of the set that helps with identification.

Id string

The provider-assigned unique ID for this managed resource.

IpAddressVersion string

The IP address version of the set.

Name string
Scope string
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.

arn string

The Amazon Resource Name (ARN) of the entity.

description string

The description of the set that helps with identification.

id string

The provider-assigned unique ID for this managed resource.

ipAddressVersion string

The IP address version of the set.

name string
scope string
addresses List[str]

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

arn str

The Amazon Resource Name (ARN) of the entity.

description str

The description of the set that helps with identification.

id str

The provider-assigned unique ID for this managed resource.

ip_address_version str

The IP address version of the set.

name str
scope str

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.