Skip to content

NatGateway

This class encapsulates and extends the ROS resource type DATASOURCE::VPC::NatGateway.

Initializers 

from ros_cdk_vpc import datasource
datasource.NatGateway(
  scope: Construct,
  id: str,
  nat_gateway_id: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
nat_gateway_id typing.Union[str, ros_cdk_core.IResolvable] Property natGatewayId: The ID of the NAT gateway.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

nat_gateway_idRequired

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

Property natGatewayId: The ID of the NAT gateway.

refresh_optionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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 

from ros_cdk_vpc import datasource
datasource.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_auto_pay ros_cdk_core.IResolvable Attribute AutoPay: Indicates whether automatic payment is enabled.
attr_business_status ros_cdk_core.IResolvable Attribute BusinessStatus: The status of the NAT gateway.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: The time when the NAT gateway was created.
attr_deletion_protection ros_cdk_core.IResolvable Attribute DeletionProtection: Indicates whether the deletion protection feature is enabled.
attr_description ros_cdk_core.IResolvable Attribute Description: The description of the NAT gateway.
attr_eip_bind_mode ros_cdk_core.IResolvable Attribute EipBindMode: The mode in which the NAT gateway is associated with an elastic IP address (EIP).
attr_expired_time ros_cdk_core.IResolvable Attribute ExpiredTime: The time when the NAT gateway expires.
attr_forward_table_ids ros_cdk_core.IResolvable Attribute ForwardTableIds: The ID of the Destination Network Address Translation (DNAT) table.
attr_icmp_reply_enabled ros_cdk_core.IResolvable Attribute IcmpReplyEnabled: Indicates whether the ICMP non-retrieval feature is enabled.
attr_internet_charge_type ros_cdk_core.IResolvable Attribute InternetChargeType: The metering method of the NAT gateway.
attr_ip_lists ros_cdk_core.IResolvable Attribute IpLists: The list of elastic IP addresses (EIPs) that are associated with the Internet NAT gateway.
attr_nat_gateway_id ros_cdk_core.IResolvable Attribute NatGatewayId: The ID of the NAT gateway.
attr_nat_gateway_name ros_cdk_core.IResolvable Attribute NatGatewayName: The name of the NAT gateway.
attr_nat_gateway_private_info ros_cdk_core.IResolvable Attribute NatGatewayPrivateInfo: The private network information about the enhanced Internet NAT gateway.
attr_nat_type ros_cdk_core.IResolvable Attribute NatType: The type of the NAT gateway.
attr_network_type ros_cdk_core.IResolvable Attribute NetworkType: The type of NAT gateway.
attr_payment_type ros_cdk_core.IResolvable Attribute PaymentType: The billing method of the NAT gateway.
attr_security_protection_enabled ros_cdk_core.IResolvable Attribute SecurityProtectionEnabled: Indicates whether the firewall feature is enabled.
attr_snat_table_ids ros_cdk_core.IResolvable Attribute SnatTableIds: The ID of the SNAT table of the NAT gateway.
attr_spec ros_cdk_core.IResolvable Attribute Spec: The size of the NAT gateway.
attr_vpc_id ros_cdk_core.IResolvable Attribute VpcId: The ID of the VPC where the NAT gateway is deployed.

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_auto_payRequired 

attr_auto_pay: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AutoPay: Indicates whether automatic payment is enabled.

Valid values: false: no true: yes

attr_business_statusRequired 

attr_business_status: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BusinessStatus: The status of the NAT gateway.

Valid values: Normal: normal FinancialLocked: locked due to overdue payments

attr_create_timeRequired 

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: The time when the NAT gateway was created.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

attr_deletion_protectionRequired 

attr_deletion_protection: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DeletionProtection: Indicates whether the deletion protection feature is enabled.

Valid values: true: yes false: no

attr_descriptionRequired 

attr_description: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Description: The description of the NAT gateway.

attr_eip_bind_modeRequired 

attr_eip_bind_mode: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EipBindMode: The mode in which the NAT gateway is associated with an elastic IP address (EIP).

Valid values: MULTI_BINDED: multi-EIP-to-ENI mode* NAT: NAT mode, which is compatible with IPv4 addresses.

attr_expired_timeRequired 

attr_expired_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ExpiredTime: The time when the NAT gateway expires.

attr_forward_table_idsRequired 

attr_forward_table_ids: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ForwardTableIds: The ID of the Destination Network Address Translation (DNAT) table.

attr_icmp_reply_enabledRequired 

attr_icmp_reply_enabled: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute IcmpReplyEnabled: Indicates whether the ICMP non-retrieval feature is enabled.

Valid values: true: yes false: no

attr_internet_charge_typeRequired 

attr_internet_charge_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InternetChargeType: The metering method of the NAT gateway.

Valid values: PayBySpec: pay-by-specification PayByLcu: pay-by-CU

attr_ip_listsRequired 

attr_ip_lists: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute IpLists: The list of elastic IP addresses (EIPs) that are associated with the Internet NAT gateway.

attr_nat_gateway_idRequired 

attr_nat_gateway_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NatGatewayId: The ID of the NAT gateway.

attr_nat_gateway_nameRequired 

attr_nat_gateway_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NatGatewayName: The name of the NAT gateway.

The name must be 1 to 128 characters in length, and cannot start with http:// or https://. If this parameter is not set, the system automatically assigns a name to the NAT gateway.

attr_nat_gateway_private_infoRequired 

attr_nat_gateway_private_info: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NatGatewayPrivateInfo: The private network information about the enhanced Internet NAT gateway.

attr_nat_typeRequired 

attr_nat_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NatType: The type of the NAT gateway.

The value is set to Enhanced (enhanced NAT gateway).

attr_network_typeRequired 

attr_network_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NetworkType: The type of NAT gateway.

Valid values: internet: an Internet NAT gateway intranet: a VPC NAT gateway

attr_payment_typeRequired 

attr_payment_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PaymentType: The billing method of the NAT gateway.

Valid values: PrePaid: subscription PostPaid: pay-as-you-go.

attr_security_protection_enabledRequired 

attr_security_protection_enabled: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SecurityProtectionEnabled: Indicates whether the firewall feature is enabled.

Valid values: false: no true: yes

attr_snat_table_idsRequired 

attr_snat_table_ids: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SnatTableIds: The ID of the SNAT table of the NAT gateway.

attr_specRequired 

attr_spec: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Spec: The size of the NAT gateway.

An empty value is returned for the parameter. If InternetChargeType is set to PayByLcu, an empty value is returned.

attr_vpc_idRequired 

attr_vpc_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcId: The ID of the VPC where the NAT gateway is deployed.