volcengine.nat.Gateway
Explore with Pulumi AI
Import
NatGateway can be imported using the id, e.g.
$ pulumi import volcengine:nat/gateway:Gateway default ngw-vv3t043k05sm****
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;
using Volcengine = Volcengine.Pulumi.Volcengine;
return await Deployment.RunAsync(() =>
{
var fooZones = Volcengine.Ecs.Zones.Invoke();
var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
{
VpcName = "acc-test-vpc",
CidrBlock = "172.16.0.0/16",
});
var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
{
SubnetName = "acc-test-subnet",
CidrBlock = "172.16.0.0/24",
ZoneId = fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
VpcId = fooVpc.Id,
});
var fooGateway = new Volcengine.Nat.Gateway("fooGateway", new()
{
VpcId = fooVpc.Id,
SubnetId = fooSubnet.Id,
Spec = "Small",
NatGatewayName = "acc-test-ng",
Description = "acc-test",
BillingType = "PostPaid",
ProjectName = "default",
Tags = new[]
{
new Volcengine.Nat.Inputs.GatewayTagArgs
{
Key = "k1",
Value = "v1",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/nat"
"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
fooZones, err := ecs.Zones(ctx, nil, nil)
if err != nil {
return err
}
fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
VpcName: pulumi.String("acc-test-vpc"),
CidrBlock: pulumi.String("172.16.0.0/16"),
})
if err != nil {
return err
}
fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
SubnetName: pulumi.String("acc-test-subnet"),
CidrBlock: pulumi.String("172.16.0.0/24"),
ZoneId: *pulumi.String(fooZones.Zones[0].Id),
VpcId: fooVpc.ID(),
})
if err != nil {
return err
}
_, err = nat.NewGateway(ctx, "fooGateway", &nat.GatewayArgs{
VpcId: fooVpc.ID(),
SubnetId: fooSubnet.ID(),
Spec: pulumi.String("Small"),
NatGatewayName: pulumi.String("acc-test-ng"),
Description: pulumi.String("acc-test"),
BillingType: pulumi.String("PostPaid"),
ProjectName: pulumi.String("default"),
Tags: nat.GatewayTagArray{
&nat.GatewayTagArgs{
Key: pulumi.String("k1"),
Value: pulumi.String("v1"),
},
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.ecs.EcsFunctions;
import com.pulumi.volcengine.ecs.inputs.ZonesArgs;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.vpc.Subnet;
import com.pulumi.volcengine.vpc.SubnetArgs;
import com.pulumi.volcengine.nat.Gateway;
import com.pulumi.volcengine.nat.GatewayArgs;
import com.pulumi.volcengine.nat.inputs.GatewayTagArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var fooZones = EcsFunctions.Zones();
var fooVpc = new Vpc("fooVpc", VpcArgs.builder()
.vpcName("acc-test-vpc")
.cidrBlock("172.16.0.0/16")
.build());
var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()
.subnetName("acc-test-subnet")
.cidrBlock("172.16.0.0/24")
.zoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
.vpcId(fooVpc.id())
.build());
var fooGateway = new Gateway("fooGateway", GatewayArgs.builder()
.vpcId(fooVpc.id())
.subnetId(fooSubnet.id())
.spec("Small")
.natGatewayName("acc-test-ng")
.description("acc-test")
.billingType("PostPaid")
.projectName("default")
.tags(GatewayTagArgs.builder()
.key("k1")
.value("v1")
.build())
.build());
}
}
import pulumi
import pulumi_volcengine as volcengine
foo_zones = volcengine.ecs.zones()
foo_vpc = volcengine.vpc.Vpc("fooVpc",
vpc_name="acc-test-vpc",
cidr_block="172.16.0.0/16")
foo_subnet = volcengine.vpc.Subnet("fooSubnet",
subnet_name="acc-test-subnet",
cidr_block="172.16.0.0/24",
zone_id=foo_zones.zones[0].id,
vpc_id=foo_vpc.id)
foo_gateway = volcengine.nat.Gateway("fooGateway",
vpc_id=foo_vpc.id,
subnet_id=foo_subnet.id,
spec="Small",
nat_gateway_name="acc-test-ng",
description="acc-test",
billing_type="PostPaid",
project_name="default",
tags=[volcengine.nat.GatewayTagArgs(
key="k1",
value="v1",
)])
import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";
import * as volcengine from "@volcengine/pulumi";
const fooZones = volcengine.ecs.Zones({});
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",
}],
});
resources:
fooVpc:
type: volcengine:vpc:Vpc
properties:
vpcName: acc-test-vpc
cidrBlock: 172.16.0.0/16
fooSubnet:
type: volcengine:vpc:Subnet
properties:
subnetName: acc-test-subnet
cidrBlock: 172.16.0.0/24
zoneId: ${fooZones.zones[0].id}
vpcId: ${fooVpc.id}
fooGateway:
type: volcengine:nat:Gateway
properties:
vpcId: ${fooVpc.id}
subnetId: ${fooSubnet.id}
spec: Small
natGatewayName: acc-test-ng
description: acc-test
billingType: PostPaid
projectName: default
tags:
- key: k1
value: v1
variables:
fooZones:
fn::invoke:
Function: volcengine:ecs:Zones
Arguments: {}
Create Gateway Resource
new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);
@overload
def Gateway(resource_name: str,
opts: Optional[ResourceOptions] = None,
billing_type: Optional[str] = None,
description: Optional[str] = None,
nat_gateway_name: Optional[str] = None,
period: Optional[int] = None,
project_name: Optional[str] = None,
spec: Optional[str] = None,
subnet_id: Optional[str] = None,
tags: Optional[Sequence[GatewayTagArgs]] = None,
vpc_id: Optional[str] = None)
@overload
def Gateway(resource_name: str,
args: GatewayArgs,
opts: Optional[ResourceOptions] = None)
func NewGateway(ctx *Context, name string, args GatewayArgs, opts ...ResourceOption) (*Gateway, error)
public Gateway(string name, GatewayArgs args, CustomResourceOptions? opts = null)
public Gateway(String name, GatewayArgs args)
public Gateway(String name, GatewayArgs args, CustomResourceOptions options)
type: volcengine:nat:Gateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GatewayArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GatewayArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GatewayArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Gateway Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Gateway resource accepts the following input properties:
- Subnet
Id string The ID of the Subnet.
- Vpc
Id string The ID of the VPC.
- Billing
Type string The billing type of the NatGateway, the value is
PostPaid
orPrePaid
.- Description string
The description of the NatGateway.
- Nat
Gateway stringName The name of the NatGateway.
- Period int
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 ignore_changes ignore changes in fields.- Project
Name string The ProjectName of the NatGateway.
- Spec string
The specification of the NatGateway. Optional choice contains
Small
(default),Medium
,Large
.- List<Volcengine.
Gateway Tag> Tags.
- Subnet
Id string The ID of the Subnet.
- Vpc
Id string The ID of the VPC.
- Billing
Type string The billing type of the NatGateway, the value is
PostPaid
orPrePaid
.- Description string
The description of the NatGateway.
- Nat
Gateway stringName The name of the NatGateway.
- Period int
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 ignore_changes ignore changes in fields.- Project
Name string The ProjectName of the NatGateway.
- Spec string
The specification of the NatGateway. Optional choice contains
Small
(default),Medium
,Large
.- []Gateway
Tag Args Tags.
- subnet
Id String The ID of the Subnet.
- vpc
Id String The ID of the VPC.
- billing
Type String The billing type of the NatGateway, the value is
PostPaid
orPrePaid
.- description String
The description of the NatGateway.
- nat
Gateway StringName The name of the NatGateway.
- period Integer
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 ignore_changes ignore changes in fields.- project
Name String The ProjectName of the NatGateway.
- spec String
The specification of the NatGateway. Optional choice contains
Small
(default),Medium
,Large
.- List<Gateway
Tag> Tags.
- subnet
Id string The ID of the Subnet.
- vpc
Id string The ID of the VPC.
- billing
Type string The billing type of the NatGateway, the value is
PostPaid
orPrePaid
.- description string
The description of the NatGateway.
- nat
Gateway stringName The name of the NatGateway.
- period number
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 ignore_changes ignore changes in fields.- project
Name string The ProjectName of the NatGateway.
- spec string
The specification of the NatGateway. Optional choice contains
Small
(default),Medium
,Large
.- Gateway
Tag[] Tags.
- subnet_
id str The ID of the Subnet.
- vpc_
id str The ID of the VPC.
- billing_
type str The billing type of the NatGateway, the value is
PostPaid
orPrePaid
.- description str
The description of the NatGateway.
- nat_
gateway_ strname The name of the NatGateway.
- period int
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 ignore_changes ignore changes in fields.- project_
name str The ProjectName of the NatGateway.
- spec str
The specification of the NatGateway. Optional choice contains
Small
(default),Medium
,Large
.- Sequence[Gateway
Tag Args] Tags.
- subnet
Id String The ID of the Subnet.
- vpc
Id String The ID of the VPC.
- billing
Type String The billing type of the NatGateway, the value is
PostPaid
orPrePaid
.- description String
The description of the NatGateway.
- nat
Gateway StringName The name of the NatGateway.
- period Number
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 ignore_changes ignore changes in fields.- project
Name String The ProjectName of the NatGateway.
- spec String
The specification of the NatGateway. Optional choice contains
Small
(default),Medium
,Large
.- List<Property Map>
Tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the Gateway resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing Gateway Resource
Get an existing Gateway resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: GatewayState, opts?: CustomResourceOptions): Gateway
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
billing_type: Optional[str] = None,
description: Optional[str] = None,
nat_gateway_name: Optional[str] = None,
period: Optional[int] = None,
project_name: Optional[str] = None,
spec: Optional[str] = None,
subnet_id: Optional[str] = None,
tags: Optional[Sequence[GatewayTagArgs]] = None,
vpc_id: Optional[str] = None) -> Gateway
func GetGateway(ctx *Context, name string, id IDInput, state *GatewayState, opts ...ResourceOption) (*Gateway, error)
public static Gateway Get(string name, Input<string> id, GatewayState? state, CustomResourceOptions? opts = null)
public static Gateway get(String name, Output<String> id, GatewayState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Billing
Type string The billing type of the NatGateway, the value is
PostPaid
orPrePaid
.- Description string
The description of the NatGateway.
- Nat
Gateway stringName The name of the NatGateway.
- Period int
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 ignore_changes ignore changes in fields.- Project
Name string The ProjectName of the NatGateway.
- Spec string
The specification of the NatGateway. Optional choice contains
Small
(default),Medium
,Large
.- Subnet
Id string The ID of the Subnet.
- List<Volcengine.
Gateway Tag> Tags.
- Vpc
Id string The ID of the VPC.
- Billing
Type string The billing type of the NatGateway, the value is
PostPaid
orPrePaid
.- Description string
The description of the NatGateway.
- Nat
Gateway stringName The name of the NatGateway.
- Period int
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 ignore_changes ignore changes in fields.- Project
Name string The ProjectName of the NatGateway.
- Spec string
The specification of the NatGateway. Optional choice contains
Small
(default),Medium
,Large
.- Subnet
Id string The ID of the Subnet.
- []Gateway
Tag Args Tags.
- Vpc
Id string The ID of the VPC.
- billing
Type String The billing type of the NatGateway, the value is
PostPaid
orPrePaid
.- description String
The description of the NatGateway.
- nat
Gateway StringName The name of the NatGateway.
- period Integer
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 ignore_changes ignore changes in fields.- project
Name String The ProjectName of the NatGateway.
- spec String
The specification of the NatGateway. Optional choice contains
Small
(default),Medium
,Large
.- subnet
Id String The ID of the Subnet.
- List<Gateway
Tag> Tags.
- vpc
Id String The ID of the VPC.
- billing
Type string The billing type of the NatGateway, the value is
PostPaid
orPrePaid
.- description string
The description of the NatGateway.
- nat
Gateway stringName The name of the NatGateway.
- period number
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 ignore_changes ignore changes in fields.- project
Name string The ProjectName of the NatGateway.
- spec string
The specification of the NatGateway. Optional choice contains
Small
(default),Medium
,Large
.- subnet
Id string The ID of the Subnet.
- Gateway
Tag[] Tags.
- vpc
Id string The ID of the VPC.
- billing_
type str The billing type of the NatGateway, the value is
PostPaid
orPrePaid
.- description str
The description of the NatGateway.
- nat_
gateway_ strname The name of the NatGateway.
- period int
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 ignore_changes ignore changes in fields.- project_
name str The ProjectName of the NatGateway.
- spec str
The specification of the NatGateway. Optional choice contains
Small
(default),Medium
,Large
.- subnet_
id str The ID of the Subnet.
- Sequence[Gateway
Tag Args] Tags.
- vpc_
id str The ID of the VPC.
- billing
Type String The billing type of the NatGateway, the value is
PostPaid
orPrePaid
.- description String
The description of the NatGateway.
- nat
Gateway StringName The name of the NatGateway.
- period Number
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 ignore_changes ignore changes in fields.- project
Name String The ProjectName of the NatGateway.
- spec String
The specification of the NatGateway. Optional choice contains
Small
(default),Medium
,Large
.- subnet
Id String The ID of the Subnet.
- List<Property Map>
Tags.
- vpc
Id String The ID of the VPC.
Supporting Types
GatewayTag, GatewayTagArgs
Package Details
- Repository
- volcengine volcengine/pulumi-volcengine
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
volcengine
Terraform Provider.