AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.4.0 published on Wednesday, May 4, 2022 by Pulumi

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/v5/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
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = Output.of(Wafv2Functions.getIpSet(GetIpSetArgs.builder()
            .name("some-ip-set")
            .scope("REGIONAL")
            .build()));

        }
}
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",
}));
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)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws:wafv2/getIpSet:getIpSet
  Arguments:
    # Arguments dictionary

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 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.

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.

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 List

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 Sequence[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
addresses List

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

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.