@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
160 lines (159 loc) • 5.75 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates a scope for AWS IPAM.
*
* ## Example Usage
*
* Basic usage:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const current = aws.getRegion({});
* const example = new aws.ec2.VpcIpam("example", {operatingRegions: [{
* regionName: current.then(current => current.region),
* }]});
* const exampleVpcIpamScope = new aws.ec2.VpcIpamScope("example", {
* ipamId: example.id,
* description: "Another Scope",
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import IPAMs using the `scope_id`. For example:
*
* ```sh
* $ pulumi import aws:ec2/vpcIpamScope:VpcIpamScope example ipam-scope-0513c69f283d11dfb
* ```
*/
export declare class VpcIpamScope extends pulumi.CustomResource {
/**
* Get an existing VpcIpamScope resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VpcIpamScopeState, opts?: pulumi.CustomResourceOptions): VpcIpamScope;
/**
* Returns true if the given object is an instance of VpcIpamScope. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is VpcIpamScope;
/**
* The Amazon Resource Name (ARN) of the scope.
*/
readonly arn: pulumi.Output<string>;
/**
* A description for the scope you're creating.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The ARN of the IPAM for which you're creating this scope.
*/
readonly ipamArn: pulumi.Output<string>;
/**
* The ID of the IPAM for which you're creating this scope.
*/
readonly ipamId: pulumi.Output<string>;
readonly ipamScopeType: pulumi.Output<string>;
/**
* Defines if the scope is the default scope or not.
*/
readonly isDefault: pulumi.Output<boolean>;
/**
* The number of pools in the scope.
*/
readonly poolCount: pulumi.Output<number>;
/**
* 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.
*/
readonly region: pulumi.Output<string>;
/**
* Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a VpcIpamScope resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: VpcIpamScopeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering VpcIpamScope resources.
*/
export interface VpcIpamScopeState {
/**
* The Amazon Resource Name (ARN) of the scope.
*/
arn?: pulumi.Input<string>;
/**
* A description for the scope you're creating.
*/
description?: pulumi.Input<string>;
/**
* The ARN of the IPAM for which you're creating this scope.
*/
ipamArn?: pulumi.Input<string>;
/**
* The ID of the IPAM for which you're creating this scope.
*/
ipamId?: pulumi.Input<string>;
ipamScopeType?: pulumi.Input<string>;
/**
* Defines if the scope is the default scope or not.
*/
isDefault?: pulumi.Input<boolean>;
/**
* The number of pools in the scope.
*/
poolCount?: pulumi.Input<number>;
/**
* 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>;
/**
* Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a VpcIpamScope resource.
*/
export interface VpcIpamScopeArgs {
/**
* A description for the scope you're creating.
*/
description?: pulumi.Input<string>;
/**
* The ID of the IPAM for which you're creating this scope.
*/
ipamId: 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>;
/**
* Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}