Skip to content

NatGateway

This class encapsulates and extends the ROS resource type ALIYUN::VPC::NatGateway, which is used to create a NAT gateway.

Initializers 

import ros_cdk_vpc
ros_cdk_vpc.NatGateway(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No 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.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

vpc_idRequired

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

Property vpcId: The VPC id to create NAT gateway.

v_switch_idRequired

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

Property vSwitchId: The VSwitch id to create NAT gateway.

auto_payOptional

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

Property autoPay: Specifies whether to enable automatic payment.

Default is true.

deletion_forceOptional

  • 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

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

Property deletionProtection: Whether to enable deletion protection.

Default to False.

descriptionOptional

  • 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

  • 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

  • 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

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

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

Default: True

instance_charge_typeOptional

  • 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

  • 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

  • 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

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

Property natType: The type of the NAT gateway.

Valid values:

  • Enhanced: enhanced NAT gateway.

network_typeOptional

  • 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

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

Property pricingCycle: Price cycle of the resource.

This property has no default value.

security_protection_enabledOptional

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

Property securityProtectionEnabled: Specifies whether to enable the firewall feature.

Default: False

tagsOptional

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.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

import ros_cdk_vpc
ros_cdk_vpc.NatGateway.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_forward_table_id ros_cdk_core.IResolvable Attribute ForwardTableId: The forward table id.
attr_nat_gateway_id ros_cdk_core.IResolvable Attribute NatGatewayId: The Id of created NAT gateway.
attr_s_nat_table_id ros_cdk_core.IResolvable Attribute SNatTableId: The SNAT table id.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_forward_table_idRequired 

attr_forward_table_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ForwardTableId: The forward table id.

attr_nat_gateway_idRequired 

attr_nat_gateway_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NatGatewayId: The Id of created NAT gateway.

attr_s_nat_table_idRequired 

attr_s_nat_table_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SNatTableId: The SNAT table id.