@pulumi/aws/ec2/getVpcIpam.d.ts

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

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Data source for managing a VPC IPAM.
 *
 * ## Example Usage
 *
 * ### Basic Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.ec2.getVpcIpam({
 *     id: "ipam-abcd1234",
 * });
 * ```
 */
export declare function getVpcIpam(args: GetVpcIpamArgs, opts?: pulumi.InvokeOptions): Promise<GetVpcIpamResult>;
/**
 * A collection of arguments for invoking getVpcIpam.
 */
export interface GetVpcIpamArgs {
    /**
     * ID of the IPAM.
     */
    id: 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;
}
/**
 * A collection of values returned by getVpcIpam.
 */
export interface GetVpcIpamResult {
    /**
     * ARN of the IPAM.
     */
    readonly arn: string;
    /**
     * The default resource discovery association ID.
     */
    readonly defaultResourceDiscoveryAssociationId: string;
    /**
     * The default resource discovery ID.
     */
    readonly defaultResourceDiscoveryId: string;
    /**
     * Description for the IPAM.
     */
    readonly description: string;
    /**
     * If private GUA is enabled.
     */
    readonly enablePrivateGua: boolean;
    /**
     * ID of the IPAM resource.
     */
    readonly id: string;
    /**
     * Region that the IPAM exists in.
     */
    readonly ipamRegion: string;
    /**
     * AWS account that is charged for active IP addresses managed in IPAM.
     */
    readonly meteredAccount: string;
    /**
     * Regions that the IPAM is configured to operate in.
     */
    readonly operatingRegions: outputs.ec2.GetVpcIpamOperatingRegion[];
    /**
     * ID of the account that owns this IPAM.
     */
    readonly ownerId: string;
    /**
     * ID of the default private scope.
     */
    readonly privateDefaultScopeId: string;
    /**
     * ID of the default public scope.
     */
    readonly publicDefaultScopeId: string;
    readonly region: string;
    /**
     * Number of resource discovery associations.
     */
    readonly resourceDiscoveryAssociationCount: number;
    /**
     * Number of scopes on this IPAM.
     */
    readonly scopeCount: number;
    /**
     * Current state of the IPAM.
     */
    readonly state: string;
    /**
     * State message of the IPAM.
     */
    readonly stateMessage: string;
    /**
     * Tags of the IPAM resource.
     */
    readonly tags: {
        [key: string]: string;
    };
    /**
     * IPAM Tier.
     */
    readonly tier: string;
}
/**
 * Data source for managing a VPC IPAM.
 *
 * ## Example Usage
 *
 * ### Basic Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.ec2.getVpcIpam({
 *     id: "ipam-abcd1234",
 * });
 * ```
 */
export declare function getVpcIpamOutput(args: GetVpcIpamOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetVpcIpamResult>;
/**
 * A collection of arguments for invoking getVpcIpam.
 */
export interface GetVpcIpamOutputArgs {
    /**
     * ID of the IPAM.
     */
    id: 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>;
}