@huaweicloudos/pulumi
Version:
A Pulumi package for creating and managing Huaweicloud cloud resources.
236 lines (235 loc) • 8.23 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages a network instance resource within HuaweiCloud.
*
* Load VPCs or virtual gateways to the cloud connection. If you load virtual gateways, your on-premises data center
* can access multiple VPCs to build a hybrid cloud.
*
* Each network instance can be loaded onto only one cloud connection.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as pulumi from "@huaweicloudos/pulumi";
*
* const config = new pulumi.Config();
* const cloudConnectionId = config.requireObject("cloudConnectionId");
* const vpcInstanceId = config.requireObject("vpcInstanceId");
* const vpcProjectId = config.requireObject("vpcProjectId");
* const vpcRegionId = config.requireObject("vpcRegionId");
* const cidr = config.requireObject("cidr");
* const test = new huaweicloud.cc.NetworkInstance("test", {
* type: "vpc",
* cloudConnectionId: cloudConnectionId,
* instanceId: vpcInstanceId,
* projectId: vpcProjectId,
* regionId: vpcRegionId,
* cidrs: [cidr],
* });
* ```
*
* ## Import
*
* The network instance can be imported using the `id`, e.g. bash
*
* ```sh
* $ pulumi import huaweicloud:Cc/networkInstance:NetworkInstance test 0ce123456a00f2591fabc00385ff1234
* ```
*/
export declare class NetworkInstance extends pulumi.CustomResource {
/**
* Get an existing NetworkInstance 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?: NetworkInstanceState, opts?: pulumi.CustomResourceOptions): NetworkInstance;
/**
* Returns true if the given object is an instance of NetworkInstance. 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 NetworkInstance;
/**
* List of routes advertised by the VPC or virtual gateway.
*/
readonly cidrs: pulumi.Output<string[]>;
/**
* Cloud connection ID.
*/
readonly cloudConnectionId: pulumi.Output<string>;
/**
* The description about the network instance.
* The description contain a maximum of `255` characters, and the angle brackets (< and >) are not allowed.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Account ID.
*/
readonly domainId: pulumi.Output<string>;
/**
* Account ID of the VPC or virtual gateway.
*/
readonly instanceDomainId: pulumi.Output<string>;
/**
* ID of the VPC or virtual gateway to be loaded to the cloud connection.
*/
readonly instanceId: pulumi.Output<string>;
/**
* The network instance name.
* The name can contain `1` to `64` characters, only English letters, Chinese characters, digits, hyphens (-),
* underscores (_) and dots (.).
*/
readonly name: pulumi.Output<string>;
/**
* Project ID of the VPC or virtual gateway.
*/
readonly projectId: 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>;
/**
* Region ID of the VPC or virtual gateway.
*/
readonly regionId: pulumi.Output<string>;
/**
* Network instance status.
* The options are as follows:
* + **ACTIVE**: The network instance is available.
*/
readonly status: pulumi.Output<string>;
/**
* Type of the network instance to be loaded to the cloud connection.
* The options are as follows:
* + **vpc**: Virtual Private Cloud.
* + **vgw**: virtual gateway.
*/
readonly type: pulumi.Output<string>;
/**
* Create a NetworkInstance 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: NetworkInstanceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering NetworkInstance resources.
*/
export interface NetworkInstanceState {
/**
* List of routes advertised by the VPC or virtual gateway.
*/
cidrs?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Cloud connection ID.
*/
cloudConnectionId?: pulumi.Input<string>;
/**
* The description about the network instance.
* The description contain a maximum of `255` characters, and the angle brackets (< and >) are not allowed.
*/
description?: pulumi.Input<string>;
/**
* Account ID.
*/
domainId?: pulumi.Input<string>;
/**
* Account ID of the VPC or virtual gateway.
*/
instanceDomainId?: pulumi.Input<string>;
/**
* ID of the VPC or virtual gateway to be loaded to the cloud connection.
*/
instanceId?: pulumi.Input<string>;
/**
* The network instance name.
* The name can contain `1` to `64` characters, only English letters, Chinese characters, digits, hyphens (-),
* underscores (_) and dots (.).
*/
name?: pulumi.Input<string>;
/**
* Project ID of the VPC or virtual gateway.
*/
projectId?: 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>;
/**
* Region ID of the VPC or virtual gateway.
*/
regionId?: pulumi.Input<string>;
/**
* Network instance status.
* The options are as follows:
* + **ACTIVE**: The network instance is available.
*/
status?: pulumi.Input<string>;
/**
* Type of the network instance to be loaded to the cloud connection.
* The options are as follows:
* + **vpc**: Virtual Private Cloud.
* + **vgw**: virtual gateway.
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a NetworkInstance resource.
*/
export interface NetworkInstanceArgs {
/**
* List of routes advertised by the VPC or virtual gateway.
*/
cidrs: pulumi.Input<pulumi.Input<string>[]>;
/**
* Cloud connection ID.
*/
cloudConnectionId: pulumi.Input<string>;
/**
* The description about the network instance.
* The description contain a maximum of `255` characters, and the angle brackets (< and >) are not allowed.
*/
description?: pulumi.Input<string>;
/**
* Account ID of the VPC or virtual gateway.
*/
instanceDomainId?: pulumi.Input<string>;
/**
* ID of the VPC or virtual gateway to be loaded to the cloud connection.
*/
instanceId: pulumi.Input<string>;
/**
* The network instance name.
* The name can contain `1` to `64` characters, only English letters, Chinese characters, digits, hyphens (-),
* underscores (_) and dots (.).
*/
name?: pulumi.Input<string>;
/**
* Project ID of the VPC or virtual gateway.
*/
projectId: 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>;
/**
* Region ID of the VPC or virtual gateway.
*/
regionId: pulumi.Input<string>;
/**
* Type of the network instance to be loaded to the cloud connection.
* The options are as follows:
* + **vpc**: Virtual Private Cloud.
* + **vgw**: virtual gateway.
*/
type: pulumi.Input<string>;
}