@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
158 lines (157 loc) • 4.68 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage nat ip
* ## 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 intranetNatGateway = new volcengine.nat.Gateway("intranetNatGateway", {
* vpcId: fooVpc.id,
* subnetId: fooSubnet.id,
* natGatewayName: "acc-test-intranet_ng",
* description: "acc-test",
* networkType: "intranet",
* billingType: "PostPaidByUsage",
* projectName: "default",
* tags: [{
* key: "k1",
* value: "v1",
* }],
* });
* const fooIp = new volcengine.nat.Ip("fooIp", {
* natGatewayId: intranetNatGateway.id,
* natIpName: "acc-test-nat-ip",
* natIpDescription: "acc-test",
* natIp: "172.16.0.3",
* });
* ```
*
* ## Import
*
* NatIp can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:nat/ip:Ip default resource_id
* ```
*/
export declare class Ip extends pulumi.CustomResource {
/**
* Get an existing Ip 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?: IpState, opts?: pulumi.CustomResourceOptions): Ip;
/**
* Returns true if the given object is an instance of Ip. 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 Ip;
/**
* Whether the Ip is the default Nat Ip.
*/
readonly isDefault: pulumi.Output<boolean>;
/**
* The id of the nat gateway to which the Nat Ip belongs.
*/
readonly natGatewayId: pulumi.Output<string>;
/**
* The ip address of the Nat Ip.
*/
readonly natIp: pulumi.Output<string>;
/**
* The description of the Nat Ip.
*/
readonly natIpDescription: pulumi.Output<string>;
/**
* The name of the Nat Ip.
*/
readonly natIpName: pulumi.Output<string>;
/**
* The status of the Nat Ip.
*/
readonly status: pulumi.Output<string>;
/**
* The using status of the Nat Ip.
*/
readonly usingStatus: pulumi.Output<string>;
/**
* Create a Ip 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: IpArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Ip resources.
*/
export interface IpState {
/**
* Whether the Ip is the default Nat Ip.
*/
isDefault?: pulumi.Input<boolean>;
/**
* The id of the nat gateway to which the Nat Ip belongs.
*/
natGatewayId?: pulumi.Input<string>;
/**
* The ip address of the Nat Ip.
*/
natIp?: pulumi.Input<string>;
/**
* The description of the Nat Ip.
*/
natIpDescription?: pulumi.Input<string>;
/**
* The name of the Nat Ip.
*/
natIpName?: pulumi.Input<string>;
/**
* The status of the Nat Ip.
*/
status?: pulumi.Input<string>;
/**
* The using status of the Nat Ip.
*/
usingStatus?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Ip resource.
*/
export interface IpArgs {
/**
* The id of the nat gateway to which the Nat Ip belongs.
*/
natGatewayId: pulumi.Input<string>;
/**
* The ip address of the Nat Ip.
*/
natIp?: pulumi.Input<string>;
/**
* The description of the Nat Ip.
*/
natIpDescription?: pulumi.Input<string>;
/**
* The name of the Nat Ip.
*/
natIpName?: pulumi.Input<string>;
}