@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
167 lines (166 loc) • 5.56 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage snat entry
* ## 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",
* }],
* });
* const fooAddress = new volcengine.eip.Address("fooAddress", {
* description: "acc-test",
* bandwidth: 1,
* billingType: "PostPaidByBandwidth",
* isp: "BGP",
* });
* const fooAssociate = new volcengine.eip.Associate("fooAssociate", {
* allocationId: fooAddress.id,
* instanceId: fooGateway.id,
* instanceType: "Nat",
* });
* const fooSnatEntry = new volcengine.nat.SnatEntry("fooSnatEntry", {
* snatEntryName: "acc-test-snat-entry",
* natGatewayId: fooGateway.id,
* eipId: fooAddress.id,
* sourceCidr: "172.16.0.0/24",
* }, {
* dependsOn: [fooAssociate],
* });
* ```
*
* ## Import
*
* Snat entry can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:nat/snatEntry:SnatEntry default snat-3fvhk47kf56****
* ```
*/
export declare class SnatEntry extends pulumi.CustomResource {
/**
* Get an existing SnatEntry 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?: SnatEntryState, opts?: pulumi.CustomResourceOptions): SnatEntry;
/**
* Returns true if the given object is an instance of SnatEntry. 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 SnatEntry;
/**
* The id of the public ip address used by the SNAT entry.
*/
readonly eipId: pulumi.Output<string>;
/**
* The id of the nat gateway to which the entry belongs.
*/
readonly natGatewayId: pulumi.Output<string>;
/**
* The name of the SNAT entry.
*/
readonly snatEntryName: pulumi.Output<string>;
/**
* The SourceCidr of the SNAT entry. Only one of `subnet_id,source_cidr` can be specified.
*/
readonly sourceCidr: pulumi.Output<string>;
/**
* The status of the SNAT entry.
*/
readonly status: pulumi.Output<string>;
/**
* The id of the subnet that is required to access the internet. Only one of `subnet_id,source_cidr` can be specified.
*/
readonly subnetId: pulumi.Output<string>;
/**
* Create a SnatEntry 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: SnatEntryArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SnatEntry resources.
*/
export interface SnatEntryState {
/**
* The id of the public ip address used by the SNAT entry.
*/
eipId?: pulumi.Input<string>;
/**
* The id of the nat gateway to which the entry belongs.
*/
natGatewayId?: pulumi.Input<string>;
/**
* The name of the SNAT entry.
*/
snatEntryName?: pulumi.Input<string>;
/**
* The SourceCidr of the SNAT entry. Only one of `subnet_id,source_cidr` can be specified.
*/
sourceCidr?: pulumi.Input<string>;
/**
* The status of the SNAT entry.
*/
status?: pulumi.Input<string>;
/**
* The id of the subnet that is required to access the internet. Only one of `subnet_id,source_cidr` can be specified.
*/
subnetId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a SnatEntry resource.
*/
export interface SnatEntryArgs {
/**
* The id of the public ip address used by the SNAT entry.
*/
eipId: pulumi.Input<string>;
/**
* The id of the nat gateway to which the entry belongs.
*/
natGatewayId: pulumi.Input<string>;
/**
* The name of the SNAT entry.
*/
snatEntryName?: pulumi.Input<string>;
/**
* The SourceCidr of the SNAT entry. Only one of `subnet_id,source_cidr` can be specified.
*/
sourceCidr?: pulumi.Input<string>;
/**
* The id of the subnet that is required to access the internet. Only one of `subnet_id,source_cidr` can be specified.
*/
subnetId?: pulumi.Input<string>;
}