1. Docs
  2. Reference
  3. API
  4. AliCloud
  5. vpc
  6. NatGateway

NatGateway

Create a NatGateway Resource

new NatGateway(name: string, args: NatGatewayArgs, opts?: CustomResourceOptions);
def NatGateway(resource_name, opts=None, bandwidth_packages=None, description=None, instance_charge_type=None, name=None, period=None, spec=None, specification=None, vpc_id=None, __props__=None);
func NewNatGateway(ctx *Context, name string, args NatGatewayArgs, opts ...ResourceOption) (*NatGateway, error)
public NatGateway(string name, NatGatewayArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args NatGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args NatGatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args NatGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

NatGateway Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The NatGateway resource accepts the following input properties:

VpcId string

The VPC ID.

BandwidthPackages List<Pulumi.AliCloud.Vpc.Inputs.NatGatewayBandwidthPackageArgs>

A list of bandwidth packages for the nat gatway. Only support nat gateway created before 00:00 on November 4, 2017. Available in v1.13.0+ and v1.7.1-.

Description string

Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.

InstanceChargeType string

The billing method of the nat gateway. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”.

Name string

Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as “-”,“.”,”_“, and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.

Period int

The duration that you will buy the resource, in month. It is valid when instance_charge_type is PrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.

Spec string

It has been deprecated from provider version 1.7.1, and new field ‘specification’ can replace it.

Deprecated: Field 'spec' has been deprecated from provider version 1.7.1, and new field 'specification' can replace it.

Specification string

The specification of the nat gateway. Valid values are Small, Middle and Large. Default to Small. Details refer to Nat Gateway Specification.

VpcId string

The VPC ID.

BandwidthPackages []NatGatewayBandwidthPackage

A list of bandwidth packages for the nat gatway. Only support nat gateway created before 00:00 on November 4, 2017. Available in v1.13.0+ and v1.7.1-.

Description string

Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.

InstanceChargeType string

The billing method of the nat gateway. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”.

Name string

Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as “-”,“.”,”_“, and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.

Period int

The duration that you will buy the resource, in month. It is valid when instance_charge_type is PrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.

Spec string

It has been deprecated from provider version 1.7.1, and new field ‘specification’ can replace it.

Deprecated: Field 'spec' has been deprecated from provider version 1.7.1, and new field 'specification' can replace it.

Specification string

The specification of the nat gateway. Valid values are Small, Middle and Large. Default to Small. Details refer to Nat Gateway Specification.

vpcId string

The VPC ID.

bandwidthPackages NatGatewayBandwidthPackage[]

A list of bandwidth packages for the nat gatway. Only support nat gateway created before 00:00 on November 4, 2017. Available in v1.13.0+ and v1.7.1-.

description string

Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.

instanceChargeType string

The billing method of the nat gateway. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”.

name string

Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as “-”,“.”,”_“, and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.

period number

The duration that you will buy the resource, in month. It is valid when instance_charge_type is PrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.

spec string

It has been deprecated from provider version 1.7.1, and new field ‘specification’ can replace it.

Deprecated: Field 'spec' has been deprecated from provider version 1.7.1, and new field 'specification' can replace it.

specification string

The specification of the nat gateway. Valid values are Small, Middle and Large. Default to Small. Details refer to Nat Gateway Specification.

vpc_id str

The VPC ID.

bandwidth_packages List[NatGatewayBandwidthPackage]

A list of bandwidth packages for the nat gatway. Only support nat gateway created before 00:00 on November 4, 2017. Available in v1.13.0+ and v1.7.1-.

description str

Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.

instance_charge_type str

The billing method of the nat gateway. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”.

name str

Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as “-”,“.”,”_“, and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.

period float

The duration that you will buy the resource, in month. It is valid when instance_charge_type is PrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.

spec str

It has been deprecated from provider version 1.7.1, and new field ‘specification’ can replace it.

Deprecated: Field 'spec' has been deprecated from provider version 1.7.1, and new field 'specification' can replace it.

specification str

The specification of the nat gateway. Valid values are Small, Middle and Large. Default to Small. Details refer to Nat Gateway Specification.

Outputs

All input properties are implicitly available as output properties. Additionally, the NatGateway resource produces the following output properties:

BandwidthPackageIds string

A list ID of the bandwidth packages, and split them with commas.

ForwardTableIds string

The nat gateway will auto create a snap and forward item, the forward_table_ids is the created one.

Id string
The provider-assigned unique ID for this managed resource.
SnatTableIds string

The nat gateway will auto create a snap and forward item, the snat_table_ids is the created one.

BandwidthPackageIds string

A list ID of the bandwidth packages, and split them with commas.

ForwardTableIds string

The nat gateway will auto create a snap and forward item, the forward_table_ids is the created one.

Id string
The provider-assigned unique ID for this managed resource.
SnatTableIds string

The nat gateway will auto create a snap and forward item, the snat_table_ids is the created one.

bandwidthPackageIds string

A list ID of the bandwidth packages, and split them with commas.

forwardTableIds string

The nat gateway will auto create a snap and forward item, the forward_table_ids is the created one.

id string
The provider-assigned unique ID for this managed resource.
snatTableIds string

The nat gateway will auto create a snap and forward item, the snat_table_ids is the created one.

bandwidth_package_ids str

A list ID of the bandwidth packages, and split them with commas.

forward_table_ids str

The nat gateway will auto create a snap and forward item, the forward_table_ids is the created one.

id str
The provider-assigned unique ID for this managed resource.
snat_table_ids str

The nat gateway will auto create a snap and forward item, the snat_table_ids is the created one.

Look up an Existing NatGateway Resource

Get an existing NatGateway 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?: NatGatewayState, opts?: CustomResourceOptions): NatGateway
static get(resource_name, id, opts=None, bandwidth_package_ids=None, bandwidth_packages=None, description=None, forward_table_ids=None, instance_charge_type=None, name=None, period=None, snat_table_ids=None, spec=None, specification=None, vpc_id=None, __props__=None);
func GetNatGateway(ctx *Context, name string, id IDInput, state *NatGatewayState, opts ...ResourceOption) (*NatGateway, error)
public static NatGateway Get(string name, Input<string> id, NatGatewayState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

BandwidthPackageIds string

A list ID of the bandwidth packages, and split them with commas.

BandwidthPackages List<Pulumi.AliCloud.Vpc.Inputs.NatGatewayBandwidthPackageArgs>

A list of bandwidth packages for the nat gatway. Only support nat gateway created before 00:00 on November 4, 2017. Available in v1.13.0+ and v1.7.1-.

Description string

Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.

ForwardTableIds string

The nat gateway will auto create a snap and forward item, the forward_table_ids is the created one.

InstanceChargeType string

The billing method of the nat gateway. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”.

Name string

Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as “-”,“.”,”_“, and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.

Period int

The duration that you will buy the resource, in month. It is valid when instance_charge_type is PrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.

SnatTableIds string

The nat gateway will auto create a snap and forward item, the snat_table_ids is the created one.

Spec string

It has been deprecated from provider version 1.7.1, and new field ‘specification’ can replace it.

Deprecated: Field 'spec' has been deprecated from provider version 1.7.1, and new field 'specification' can replace it.

Specification string

The specification of the nat gateway. Valid values are Small, Middle and Large. Default to Small. Details refer to Nat Gateway Specification.

VpcId string

The VPC ID.

BandwidthPackageIds string

A list ID of the bandwidth packages, and split them with commas.

BandwidthPackages []NatGatewayBandwidthPackage

A list of bandwidth packages for the nat gatway. Only support nat gateway created before 00:00 on November 4, 2017. Available in v1.13.0+ and v1.7.1-.

Description string

Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.

ForwardTableIds string

The nat gateway will auto create a snap and forward item, the forward_table_ids is the created one.

InstanceChargeType string

The billing method of the nat gateway. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”.

Name string

Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as “-”,“.”,”_“, and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.

Period int

The duration that you will buy the resource, in month. It is valid when instance_charge_type is PrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.

SnatTableIds string

The nat gateway will auto create a snap and forward item, the snat_table_ids is the created one.

Spec string

It has been deprecated from provider version 1.7.1, and new field ‘specification’ can replace it.

Deprecated: Field 'spec' has been deprecated from provider version 1.7.1, and new field 'specification' can replace it.

Specification string

The specification of the nat gateway. Valid values are Small, Middle and Large. Default to Small. Details refer to Nat Gateway Specification.

VpcId string

The VPC ID.

bandwidthPackageIds string

A list ID of the bandwidth packages, and split them with commas.

bandwidthPackages NatGatewayBandwidthPackage[]

A list of bandwidth packages for the nat gatway. Only support nat gateway created before 00:00 on November 4, 2017. Available in v1.13.0+ and v1.7.1-.

description string

Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.

forwardTableIds string

The nat gateway will auto create a snap and forward item, the forward_table_ids is the created one.

instanceChargeType string

The billing method of the nat gateway. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”.

name string

Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as “-”,“.”,”_“, and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.

period number

The duration that you will buy the resource, in month. It is valid when instance_charge_type is PrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.

snatTableIds string

The nat gateway will auto create a snap and forward item, the snat_table_ids is the created one.

spec string

It has been deprecated from provider version 1.7.1, and new field ‘specification’ can replace it.

Deprecated: Field 'spec' has been deprecated from provider version 1.7.1, and new field 'specification' can replace it.

specification string

The specification of the nat gateway. Valid values are Small, Middle and Large. Default to Small. Details refer to Nat Gateway Specification.

vpcId string

The VPC ID.

bandwidth_package_ids str

A list ID of the bandwidth packages, and split them with commas.

bandwidth_packages List[NatGatewayBandwidthPackage]

A list of bandwidth packages for the nat gatway. Only support nat gateway created before 00:00 on November 4, 2017. Available in v1.13.0+ and v1.7.1-.

description str

Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.

forward_table_ids str

The nat gateway will auto create a snap and forward item, the forward_table_ids is the created one.

instance_charge_type str

The billing method of the nat gateway. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”.

name str

Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as “-”,“.”,”_“, and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.

period float

The duration that you will buy the resource, in month. It is valid when instance_charge_type is PrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.

snat_table_ids str

The nat gateway will auto create a snap and forward item, the snat_table_ids is the created one.

spec str

It has been deprecated from provider version 1.7.1, and new field ‘specification’ can replace it.

Deprecated: Field 'spec' has been deprecated from provider version 1.7.1, and new field 'specification' can replace it.

specification str

The specification of the nat gateway. Valid values are Small, Middle and Large. Default to Small. Details refer to Nat Gateway Specification.

vpc_id str

The VPC ID.

Supporting Types

NatGatewayBandwidthPackage

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Bandwidth int
IpCount int
PublicIpAddresses string
Zone string
Bandwidth int
IpCount int
PublicIpAddresses string
Zone string
bandwidth number
ipCount number
publicIpAddresses string
zone string
bandwidth float
ip_count float
publicIpAddresses str
zone str

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.