Skip to content

NatGatewayProps

Properties for defining a NatGateway.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-vpc-natgateway

Initializer 

import { NatGatewayProps } from '@alicloud/ros-cdk-vpc'
const natGatewayProps: NatGatewayProps = { ... }

Properties

Name Type Description
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The VPC id to create NAT gateway.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The VSwitch id to create NAT gateway.
autoPay boolean | @alicloud/ros-cdk-core.IResolvable Property autoPay: Specifies whether to enable automatic payment.
deletionForce boolean | @alicloud/ros-cdk-core.IResolvable Property deletionForce: Whether force delete the relative snat and dnat entries in the net gateway and unbind eips.
deletionProtection boolean | @alicloud/ros-cdk-core.IResolvable Property deletionProtection: Whether to enable deletion protection.
description string | @alicloud/ros-cdk-core.IResolvable Property description: Description of the NAT gateway, [2, 256] characters.
duration number | @alicloud/ros-cdk-core.IResolvable Property duration: The subscription duration.
eipBindMode string | @alicloud/ros-cdk-core.IResolvable Property eipBindMode: The mode in which the EIP is associated with the NAT gateway.
icmpReplyEnabled boolean | @alicloud/ros-cdk-core.IResolvable Property icmpReplyEnabled: Specifies whether to enable the ICMP non-retrieval feature.
instanceChargeType string | @alicloud/ros-cdk-core.IResolvable Property instanceChargeType: The billing method.
internetChargeType string | @alicloud/ros-cdk-core.IResolvable Property internetChargeType: The billing method for the NAT gateway.
natGatewayName string | @alicloud/ros-cdk-core.IResolvable Property natGatewayName: Display name of the NAT gateway, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'.
natType string | @alicloud/ros-cdk-core.IResolvable Property natType: The type of the NAT gateway.
networkType string | @alicloud/ros-cdk-core.IResolvable Property networkType: The type of the created NAT gateway.
pricingCycle string | @alicloud/ros-cdk-core.IResolvable Property pricingCycle: Price cycle of the resource.
securityProtectionEnabled boolean | @alicloud/ros-cdk-core.IResolvable Property securityProtectionEnabled: Specifies whether to enable the firewall feature.
tags TagsProperty[] Property tags: Tags to attach to natgateway.

vpcIdRequired 

public readonly vpcId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vpcId: The VPC id to create NAT gateway.

vSwitchIdRequired 

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The VSwitch id to create NAT gateway.

autoPayOptional 

public readonly autoPay: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property autoPay: Specifies whether to enable automatic payment.

Default is true.

deletionForceOptional 

public readonly deletionForce: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property deletionForce: Whether force delete the relative snat and dnat entries in the net gateway and unbind eips.

Default value is false.

deletionProtectionOptional 

public readonly deletionProtection: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property deletionProtection: Whether to enable deletion protection.

Default to False.

descriptionOptional 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: Description of the NAT gateway, [2, 256] characters.

Do not fill or empty, the default is empty.

durationOptional 

public readonly duration: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property duration: The subscription duration.

While choose by pay by month, it could be from 1 to 9 or 12, 24, 36. While choose pay by year, it could be from 1 to 3.

eipBindModeOptional 

public readonly eipBindMode: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property eipBindMode: The mode in which the EIP is associated with the NAT gateway.

Valid values:MULTI_BINDED (default): the multi-EIP-to-ENI mode. NAT: NAT mode. IPv4 gateways are supported. Note If the EIP is associated with the NAT gateway in NAT mode, the EIP occupies a private IP address of the vSwitch to which the NAT gateway belongs. Make sure that the vSwitch has sufficient private IP addresses. Otherwise, the EIP cannot be associated with the NAT gateway. In NAT mode, a maximum number of 50 EIPs can be associated with each NAT gateway.

icmpReplyEnabledOptional 

public readonly icmpReplyEnabled: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property icmpReplyEnabled: Specifies whether to enable the ICMP non-retrieval feature.

Default: True

instanceChargeTypeOptional 

public readonly instanceChargeType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceChargeType: The billing method.

The default value is PostPaid (which means pay-as-you-go).

internetChargeTypeOptional 

public readonly internetChargeType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property internetChargeType: The billing method for the NAT gateway.

Valid values: PayBySpec: billed on a pay-by-specification basis.

natGatewayNameOptional 

public readonly natGatewayName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property natGatewayName: Display name of the NAT gateway, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'.

natTypeOptional 

public readonly natType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property natType: The type of the NAT gateway.

Valid values: - Enhanced: enhanced NAT gateway.

networkTypeOptional 

public readonly networkType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property networkType: The type of the created NAT gateway.

Internet: public network NAT gateway. Intranet: VPC NAT gateway.

pricingCycleOptional 

public readonly pricingCycle: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property pricingCycle: Price cycle of the resource.

This property has no default value.

securityProtectionEnabledOptional 

public readonly securityProtectionEnabled: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property securityProtectionEnabled: Specifies whether to enable the firewall feature.

Default: False

tagsOptional 

public readonly tags: TagsProperty[];

Property tags: Tags to attach to natgateway.

Max support 20 tags to add during create natgateway. Each tag with two properties Key and Value, and Key is required.