@pulumi/aws/wafv2/getIpSet.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Retrieves the summary of a WAFv2 IP Set.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.wafv2.getIpSet({
 *     name: "some-ip-set",
 *     scope: "REGIONAL",
 * });
 * ```
 */
export declare function getIpSet(args: GetIpSetArgs, opts?: pulumi.InvokeOptions): Promise<GetIpSetResult>;
/**
 * A collection of arguments for invoking getIpSet.
 */
export interface GetIpSetArgs {
    /**
     * Name of the WAFv2 IP Set.
     */
    name: string;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: 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.
     */
    scope: string;
}
/**
 * A collection of values returned by getIpSet.
 */
export interface GetIpSetResult {
    /**
     * An array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation.
     */
    readonly addresses: string[];
    /**
     * ARN of the entity.
     */
    readonly arn: string;
    /**
     * Description of the set that helps with identification.
     */
    readonly description: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * IP address version of the set.
     */
    readonly ipAddressVersion: string;
    readonly name: string;
    readonly region: string;
    readonly scope: string;
}
/**
 * Retrieves the summary of a WAFv2 IP Set.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.wafv2.getIpSet({
 *     name: "some-ip-set",
 *     scope: "REGIONAL",
 * });
 * ```
 */
export declare function getIpSetOutput(args: GetIpSetOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetIpSetResult>;
/**
 * A collection of arguments for invoking getIpSet.
 */
export interface GetIpSetOutputArgs {
    /**
     * Name of the WAFv2 IP Set.
     */
    name: pulumi.Input<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<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.
     */
    scope: pulumi.Input<string>;
}