@huaweicloudos/pulumi
Version:
A Pulumi package for creating and managing Huaweicloud cloud resources.
113 lines (112 loc) • 3.36 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import { output as outputs } from "../types";
/**
* Provides details about a specific VPC.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as huaweicloud from "@pulumi/huaweicloud";
*
* const config = new pulumi.Config();
* const vpcName = config.requireObject("vpcName");
* const vpc = huaweicloud.Vpc.getVpc({
* name: vpcName,
* });
* ```
*/
export declare function getVpc(args?: GetVpcArgs, opts?: pulumi.InvokeOptions): Promise<GetVpcResult>;
/**
* A collection of arguments for invoking getVpc.
*/
export interface GetVpcArgs {
/**
* Specifies the cidr block of the desired VPC.
*/
cidr?: string;
/**
* Specifies the enterprise project ID which the desired VPC belongs to.
*/
enterpriseProjectId?: string;
/**
* Specifies the id of the VPC to retrieve.
*/
id?: string;
/**
* Specifies an unique name for the VPC. The value is a string of no more than 64 characters
* and can contain digits, letters, underscores (_), and hyphens (-).
*/
name?: string;
/**
* Specifies the region in which to obtain the VPC. If omitted, the provider-level region
* will be used.
*/
region?: string;
/**
* Specifies the current status of the desired VPC. The value can be CREATING, OK or ERROR.
*/
status?: string;
}
/**
* A collection of values returned by getVpc.
*/
export interface GetVpcResult {
readonly cidr: string;
/**
* The supplementary information about the VPC. The value is a string of
* no more than 255 characters and cannot contain angle brackets (< or >).
*/
readonly description: string;
readonly enterpriseProjectId: string;
readonly id: string;
readonly name: string;
readonly region: string;
/**
* @deprecated use huaweicloud_vpc_route_table data source to get all routes
*/
readonly routes: outputs.Vpc.GetVpcRoute[];
/**
* The secondary CIDR blocks of the VPC.
*/
readonly secondaryCidrs: string[];
readonly status: string;
/**
* The key/value pairs to associate with the VPC.
*/
readonly tags: {
[key: string]: string;
};
}
export declare function getVpcOutput(args?: GetVpcOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetVpcResult>;
/**
* A collection of arguments for invoking getVpc.
*/
export interface GetVpcOutputArgs {
/**
* Specifies the cidr block of the desired VPC.
*/
cidr?: pulumi.Input<string>;
/**
* Specifies the enterprise project ID which the desired VPC belongs to.
*/
enterpriseProjectId?: pulumi.Input<string>;
/**
* Specifies the id of the VPC to retrieve.
*/
id?: pulumi.Input<string>;
/**
* Specifies an unique name for the VPC. The value is a string of no more than 64 characters
* and can contain digits, letters, underscores (_), and hyphens (-).
*/
name?: pulumi.Input<string>;
/**
* Specifies the region in which to obtain the VPC. If omitted, the provider-level region
* will be used.
*/
region?: pulumi.Input<string>;
/**
* Specifies the current status of the desired VPC. The value can be CREATING, OK or ERROR.
*/
status?: pulumi.Input<string>;
}