Skip to content

NatGatewayProps

Properties for defining a NatGateway.

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

Initializer 

import ros_cdk_vpc
ros_cdk_vpc.NatGatewayProps(
  vpc_id: typing.Union[str, IResolvable],
  v_switch_id: typing.Union[str, IResolvable],
  auto_pay: typing.Union[bool, IResolvable] = None,
  deletion_force: typing.Union[bool, IResolvable] = None,
  deletion_protection: typing.Union[bool, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  eip_bind_mode: typing.Union[str, IResolvable] = None,
  icmp_reply_enabled: typing.Union[bool, IResolvable] = None,
  instance_charge_type: typing.Union[str, IResolvable] = None,
  internet_charge_type: typing.Union[str, IResolvable] = None,
  nat_gateway_name: typing.Union[str, IResolvable] = None,
  nat_type: typing.Union[str, IResolvable] = None,
  network_type: typing.Union[str, IResolvable] = None,
  pricing_cycle: typing.Union[str, IResolvable] = None,
  security_protection_enabled: typing.Union[bool, IResolvable] = None,
  tags: typing.List[TagsProperty] = None
)

Properties

Name Type Description
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The VPC id to create NAT gateway.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: The VSwitch id to create NAT gateway.
auto_pay typing.Union[bool, ros_cdk_core.IResolvable] Property autoPay: Specifies whether to enable automatic payment.
deletion_force typing.Union[bool, ros_cdk_core.IResolvable] Property deletionForce: Whether force delete the relative snat and dnat entries in the net gateway and unbind eips.
deletion_protection typing.Union[bool, ros_cdk_core.IResolvable] Property deletionProtection: Whether to enable deletion protection.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: Description of the NAT gateway, [2, 256] characters.
duration typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property duration: The subscription duration.
eip_bind_mode typing.Union[str, ros_cdk_core.IResolvable] Property eipBindMode: The mode in which the EIP is associated with the NAT gateway.
icmp_reply_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property icmpReplyEnabled: Specifies whether to enable the ICMP non-retrieval feature.
instance_charge_type typing.Union[str, ros_cdk_core.IResolvable] Property instanceChargeType: The billing method.
internet_charge_type typing.Union[str, ros_cdk_core.IResolvable] Property internetChargeType: The billing method for the NAT gateway.
nat_gateway_name typing.Union[str, 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 '.', '-'.
nat_type typing.Union[str, ros_cdk_core.IResolvable] Property natType: The type of the NAT gateway.
network_type typing.Union[str, ros_cdk_core.IResolvable] Property networkType: The type of the created NAT gateway.
pricing_cycle typing.Union[str, ros_cdk_core.IResolvable] Property pricingCycle: Price cycle of the resource.
security_protection_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property securityProtectionEnabled: Specifies whether to enable the firewall feature.
tags typing.List[TagsProperty] Property tags: Tags to attach to natgateway.

vpc_idRequired 

vpc_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vpcId: The VPC id to create NAT gateway.

v_switch_idRequired 

v_switch_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vSwitchId: The VSwitch id to create NAT gateway.

auto_payOptional 

auto_pay: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property autoPay: Specifies whether to enable automatic payment.

Default is true.

deletion_forceOptional 

deletion_force: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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.

deletion_protectionOptional 

deletion_protection: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property deletionProtection: Whether to enable deletion protection.

Default to False.

descriptionOptional 

description: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

Do not fill or empty, the default is empty.

durationOptional 

duration: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.

eip_bind_modeOptional 

eip_bind_mode: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

icmp_reply_enabledOptional 

icmp_reply_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

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

Default: True

instance_charge_typeOptional 

instance_charge_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceChargeType: The billing method.

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

internet_charge_typeOptional 

internet_charge_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property internetChargeType: The billing method for the NAT gateway.

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

nat_gateway_nameOptional 

nat_gateway_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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 '.', '-'.

nat_typeOptional 

nat_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property natType: The type of the NAT gateway.

Valid values:

  • Enhanced: enhanced NAT gateway.

network_typeOptional 

network_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property networkType: The type of the created NAT gateway.

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

pricing_cycleOptional 

pricing_cycle: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property pricingCycle: Price cycle of the resource.

This property has no default value.

security_protection_enabledOptional 

security_protection_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property securityProtectionEnabled: Specifies whether to enable the firewall feature.

Default: False

tagsOptional 

tags: typing.List[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.