Skip to content

NatGateways

This class encapsulates and extends the ROS resource type DATASOURCE::VPC::NatGateways, which is used to query NAT gateways.

Initializers 

from ros_cdk_vpc import datasource
datasource.NatGateways(
  scope: Construct,
  id: str,
  instance_charge_type: typing.Union[str, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  nat_gateway_id: typing.Union[str, IResolvable] = None,
  nat_type: typing.Union[str, IResolvable] = None,
  network_type: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  status: typing.Union[str, IResolvable] = None,
  vpc_id: typing.Union[str, IResolvable] = None,
  zone_id: 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.
instance_charge_type typing.Union[str, ros_cdk_core.IResolvable] Property instanceChargeType: The billing method of the NAT gateway.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the NAT gateway.
nat_gateway_id typing.Union[str, ros_cdk_core.IResolvable] Property natGatewayId: The ID of the NAT gateway.
nat_type typing.Union[str, ros_cdk_core.IResolvable] Property natType: The type of NAT gateway.
network_type typing.Union[str, ros_cdk_core.IResolvable] Property networkType: The type 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.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group to which the NAT gateway belongs.
status typing.Union[str, ros_cdk_core.IResolvable] Property status: The status of the NAT gateway.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of the VPC to which the NAT gateway belongs.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The ID of the zone to which the NAT gateway belongs.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

instance_charge_typeOptional

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

Property instanceChargeType: The billing method of the NAT gateway.

Set the value to PostPaid, which specifies the pay-as-you-go billing method.

nameOptional

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

Property name: The name of the NAT gateway.

nat_gateway_idOptional

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

Property natGatewayId: The ID of the NAT gateway.

nat_typeOptional

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

Property natType: The type of NAT gateway.

Set the value to Enhanced (enhanced NAT gateway).

network_typeOptional

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

Property networkType: The type of the NAT gateway.

Valid values: internet: an Internet NAT gateway intranet: a VPC 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.

resource_group_idOptional

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

Property resourceGroupId: The ID of the resource group to which the NAT gateway belongs.

statusOptional

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

Property status: The status of the NAT gateway.

Valid values: Creating: After you send a request to create a NAT gateway, the system creates the NAT gateway in the background. The NAT gateway remains in the Creating state until the operation is completed. Available: The NAT gateway remains in a stable state after the NAT gateway is created. Modifying: After you send a request to modify a NAT gateway, the system modifies the NAT gateway in the background. The NAT gateway remains in the Modifying state until the operation is completed. Deleting: After you send a request to delete a NAT gateway, the system deletes the NAT gateway in the background. The NAT gateway remains in the Deleting state until the operation is completed. Converting: After you send a request to upgrade a standard NAT gateway to an enhanced NAT gateway, the system upgrades the NAT gateway in the background. The NAT gateway remains in the Converting state until the operation is completed.

vpc_idOptional

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

Property vpcId: The ID of the VPC to which the NAT gateway belongs.

zone_idOptional

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

Property zoneId: The ID of the zone to which the NAT gateway belongs.

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.NatGateways.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_nat_gateway_ids ros_cdk_core.IResolvable Attribute NatGatewayIds: The list of The nat gateway ids.
attr_nat_gateways ros_cdk_core.IResolvable Attribute NatGateways: The list of The nat gateways.

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_nat_gateway_idsRequired 

attr_nat_gateway_ids: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NatGatewayIds: The list of The nat gateway ids.

attr_nat_gatewaysRequired 

attr_nat_gateways: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NatGateways: The list of The nat gateways.