@huaweicloudos/pulumi
Version:
A Pulumi package for creating and managing Huaweicloud cloud resources.
274 lines (273 loc) • 9.96 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages an ER instance resource within HuaweiCloud.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as pulumi from "@huaweicloudos/pulumi";
*
* const config = new pulumi.Config();
* const routerName = config.requireObject("routerName");
* const bgpAsNumber = config.requireObject("bgpAsNumber");
* const availabilityZones = config.requireObject("availabilityZones");
* const test = new huaweicloud.er.Instance("test", {
* availabilityZones: availabilityZones,
* asn: bgpAsNumber,
* });
* ```
*
* ## Import
*
* The router instance can be imported using the `id`, e.g. bash
*
* ```sh
* $ pulumi import huaweicloud:Er/instance:Instance test 0ce123456a00f2591fabc00385ff1234
* ```
*/
export declare class Instance extends pulumi.CustomResource {
/**
* Get an existing Instance 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?: InstanceState, opts?: pulumi.CustomResourceOptions): Instance;
/**
* Returns true if the given object is an instance of Instance. 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 Instance;
/**
* The BGP AS number of the ER instance.
* The valid value is range from `64,512` to `65534` or range from `4,200,000,000` to `4,294,967,294`.
*/
readonly asn: pulumi.Output<number>;
/**
* Whether to automatically accept the creation of shared
* attachment.
* The default value is **false**.
*/
readonly autoAcceptSharedAttachments: pulumi.Output<boolean | undefined>;
/**
* The availability zone list where the ER instance is located.
* The maximum number of availability zone is two. Select two AZs to configure active-active deployment for high
* availability which will ensure reliability and disaster recovery.
*/
readonly availabilityZones: pulumi.Output<string[]>;
/**
* The creation time.
*/
readonly createdAt: pulumi.Output<string>;
/**
* The ID of the default association route table.
*/
readonly defaultAssociationRouteTableId: pulumi.Output<string>;
/**
* The ID of the default propagation route table.
*/
readonly defaultPropagationRouteTableId: pulumi.Output<string>;
/**
* The description of the ER instance.
* The description contain a maximum of `255` characters, and the angle brackets (< and >) are not allowed.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Whether to enable the association of the default route table.
* The default value is **false**.
*/
readonly enableDefaultAssociation: pulumi.Output<boolean | undefined>;
/**
* Whether to enable the propagation of the default route table.
* The default value is **false**.
*/
readonly enableDefaultPropagation: pulumi.Output<boolean | undefined>;
/**
* Specifies the enterprise project ID to which the ER instance
* belongs.
*/
readonly enterpriseProjectId: pulumi.Output<string>;
/**
* The router name.
* The name can contain `1` to `64` characters, only English letters, Chinese characters, digits, underscore (_),
* hyphens (-) and dots (.) allowed.
*/
readonly name: pulumi.Output<string>;
/**
* Specifies the region in which to create the resource.
* If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
*/
readonly region: pulumi.Output<string>;
/**
* Current status of the router.
*/
readonly status: pulumi.Output<string>;
/**
* Specifies the key/value pairs to associate with the instance.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The latest update time.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Create a Instance 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: InstanceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Instance resources.
*/
export interface InstanceState {
/**
* The BGP AS number of the ER instance.
* The valid value is range from `64,512` to `65534` or range from `4,200,000,000` to `4,294,967,294`.
*/
asn?: pulumi.Input<number>;
/**
* Whether to automatically accept the creation of shared
* attachment.
* The default value is **false**.
*/
autoAcceptSharedAttachments?: pulumi.Input<boolean>;
/**
* The availability zone list where the ER instance is located.
* The maximum number of availability zone is two. Select two AZs to configure active-active deployment for high
* availability which will ensure reliability and disaster recovery.
*/
availabilityZones?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The creation time.
*/
createdAt?: pulumi.Input<string>;
/**
* The ID of the default association route table.
*/
defaultAssociationRouteTableId?: pulumi.Input<string>;
/**
* The ID of the default propagation route table.
*/
defaultPropagationRouteTableId?: pulumi.Input<string>;
/**
* The description of the ER instance.
* The description contain a maximum of `255` characters, and the angle brackets (< and >) are not allowed.
*/
description?: pulumi.Input<string>;
/**
* Whether to enable the association of the default route table.
* The default value is **false**.
*/
enableDefaultAssociation?: pulumi.Input<boolean>;
/**
* Whether to enable the propagation of the default route table.
* The default value is **false**.
*/
enableDefaultPropagation?: pulumi.Input<boolean>;
/**
* Specifies the enterprise project ID to which the ER instance
* belongs.
*/
enterpriseProjectId?: pulumi.Input<string>;
/**
* The router name.
* The name can contain `1` to `64` characters, only English letters, Chinese characters, digits, underscore (_),
* hyphens (-) and dots (.) allowed.
*/
name?: pulumi.Input<string>;
/**
* Specifies the region in which to create the resource.
* If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
*/
region?: pulumi.Input<string>;
/**
* Current status of the router.
*/
status?: pulumi.Input<string>;
/**
* Specifies the key/value pairs to associate with the instance.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The latest update time.
*/
updatedAt?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Instance resource.
*/
export interface InstanceArgs {
/**
* The BGP AS number of the ER instance.
* The valid value is range from `64,512` to `65534` or range from `4,200,000,000` to `4,294,967,294`.
*/
asn: pulumi.Input<number>;
/**
* Whether to automatically accept the creation of shared
* attachment.
* The default value is **false**.
*/
autoAcceptSharedAttachments?: pulumi.Input<boolean>;
/**
* The availability zone list where the ER instance is located.
* The maximum number of availability zone is two. Select two AZs to configure active-active deployment for high
* availability which will ensure reliability and disaster recovery.
*/
availabilityZones: pulumi.Input<pulumi.Input<string>[]>;
/**
* The ID of the default association route table.
*/
defaultAssociationRouteTableId?: pulumi.Input<string>;
/**
* The ID of the default propagation route table.
*/
defaultPropagationRouteTableId?: pulumi.Input<string>;
/**
* The description of the ER instance.
* The description contain a maximum of `255` characters, and the angle brackets (< and >) are not allowed.
*/
description?: pulumi.Input<string>;
/**
* Whether to enable the association of the default route table.
* The default value is **false**.
*/
enableDefaultAssociation?: pulumi.Input<boolean>;
/**
* Whether to enable the propagation of the default route table.
* The default value is **false**.
*/
enableDefaultPropagation?: pulumi.Input<boolean>;
/**
* Specifies the enterprise project ID to which the ER instance
* belongs.
*/
enterpriseProjectId?: pulumi.Input<string>;
/**
* The router name.
* The name can contain `1` to `64` characters, only English letters, Chinese characters, digits, underscore (_),
* hyphens (-) and dots (.) allowed.
*/
name?: pulumi.Input<string>;
/**
* Specifies the region in which to create the resource.
* If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
*/
region?: pulumi.Input<string>;
/**
* Specifies the key/value pairs to associate with the instance.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}