@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
189 lines (188 loc) • 6.68 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@pulumi/volcengine";
* import * as volcengine from "@volcengine/pulumi";
*
* const fooZones = volcengine.ecs.getZones({});
* const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
* vpcName: "acc-test-vpc",
* cidrBlock: "172.16.0.0/16",
* });
* const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
* subnetName: "acc-test-subnet",
* cidrBlock: "172.16.0.0/24",
* zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
* vpcId: fooVpc.id,
* });
* const fooGateway = new volcengine.nat.Gateway("fooGateway", {
* vpcId: fooVpc.id,
* subnetId: fooSubnet.id,
* spec: "Small",
* natGatewayName: "acc-test-ng",
* description: "acc-test",
* billingType: "PostPaid",
* projectName: "default",
* tags: [{
* key: "k1",
* value: "v1",
* }],
* });
* ```
*
* ## Import
*
* NatGateway can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:nat/gateway:Gateway default ngw-vv3t043k05sm****
* ```
*/
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 billing type of the NatGateway, the value is `PostPaid` or `PrePaid`.
*/
readonly billingType: pulumi.Output<string | undefined>;
/**
* The description of the NatGateway.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The name of the NatGateway.
*/
readonly natGatewayName: pulumi.Output<string | undefined>;
/**
* The period of the NatGateway, the valid value range in 1~9 or 12 or 24 or 36. Default value is 12. The period unit defaults to `Month`.This field is only effective when creating a PrePaid NatGateway. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
readonly period: pulumi.Output<number | undefined>;
/**
* The ProjectName of the NatGateway.
*/
readonly projectName: pulumi.Output<string>;
/**
* The specification of the NatGateway. Optional choice contains `Small`(default), `Medium`, `Large` or leave blank.
*/
readonly spec: pulumi.Output<string>;
/**
* The ID of the Subnet.
*/
readonly subnetId: pulumi.Output<string>;
/**
* Tags.
*/
readonly tags: pulumi.Output<outputs.nat.GatewayTag[] | undefined>;
/**
* The ID of the VPC.
*/
readonly vpcId: pulumi.Output<string>;
/**
* 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 billing type of the NatGateway, the value is `PostPaid` or `PrePaid`.
*/
billingType?: pulumi.Input<string>;
/**
* The description of the NatGateway.
*/
description?: pulumi.Input<string>;
/**
* The name of the NatGateway.
*/
natGatewayName?: pulumi.Input<string>;
/**
* The period of the NatGateway, the valid value range in 1~9 or 12 or 24 or 36. Default value is 12. The period unit defaults to `Month`.This field is only effective when creating a PrePaid NatGateway. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
period?: pulumi.Input<number>;
/**
* The ProjectName of the NatGateway.
*/
projectName?: pulumi.Input<string>;
/**
* The specification of the NatGateway. Optional choice contains `Small`(default), `Medium`, `Large` or leave blank.
*/
spec?: pulumi.Input<string>;
/**
* The ID of the Subnet.
*/
subnetId?: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.nat.GatewayTag>[]>;
/**
* The ID of the VPC.
*/
vpcId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Gateway resource.
*/
export interface GatewayArgs {
/**
* The billing type of the NatGateway, the value is `PostPaid` or `PrePaid`.
*/
billingType?: pulumi.Input<string>;
/**
* The description of the NatGateway.
*/
description?: pulumi.Input<string>;
/**
* The name of the NatGateway.
*/
natGatewayName?: pulumi.Input<string>;
/**
* The period of the NatGateway, the valid value range in 1~9 or 12 or 24 or 36. Default value is 12. The period unit defaults to `Month`.This field is only effective when creating a PrePaid NatGateway. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
period?: pulumi.Input<number>;
/**
* The ProjectName of the NatGateway.
*/
projectName?: pulumi.Input<string>;
/**
* The specification of the NatGateway. Optional choice contains `Small`(default), `Medium`, `Large` or leave blank.
*/
spec?: pulumi.Input<string>;
/**
* The ID of the Subnet.
*/
subnetId: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.nat.GatewayTag>[]>;
/**
* The ID of the VPC.
*/
vpcId: pulumi.Input<string>;
}