@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
101 lines (100 loc) • 3.34 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a resource to manage direct connect gateway
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const foo = new volcengine.direct_connect.Gateway("foo", {
* description: "tf-test",
* directConnectGatewayName: "tf-test-gateway",
* tags: [{
* key: "k1",
* value: "v1",
* }],
* });
* ```
*
* ## Import
*
* DirectConnectGateway can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:direct_connect/gateway:Gateway default resource_id
* ```
*/
export declare class Gateway extends pulumi.CustomResource {
/**
* Get an existing Gateway 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?: GatewayState, opts?: pulumi.CustomResourceOptions): Gateway;
/**
* Returns true if the given object is an instance of Gateway. 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 Gateway;
/**
* The description of direct connect gateway.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The name of direct connect gateway.
*/
readonly directConnectGatewayName: pulumi.Output<string | undefined>;
/**
* The direct connect gateway tags.
*/
readonly tags: pulumi.Output<outputs.direct_connect.GatewayTag[] | undefined>;
/**
* Create a Gateway 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?: GatewayArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Gateway resources.
*/
export interface GatewayState {
/**
* The description of direct connect gateway.
*/
description?: pulumi.Input<string>;
/**
* The name of direct connect gateway.
*/
directConnectGatewayName?: pulumi.Input<string>;
/**
* The direct connect gateway tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.direct_connect.GatewayTag>[]>;
}
/**
* The set of arguments for constructing a Gateway resource.
*/
export interface GatewayArgs {
/**
* The description of direct connect gateway.
*/
description?: pulumi.Input<string>;
/**
* The name of direct connect gateway.
*/
directConnectGatewayName?: pulumi.Input<string>;
/**
* The direct connect gateway tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.direct_connect.GatewayTag>[]>;
}