Skip to content

NatIpCidr

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

Initializers 

import ros_cdk_vpc
ros_cdk_vpc.NatIpCidr(
  scope: Construct,
  id: str,
  nat_gateway_id: typing.Union[str, IResolvable],
  nat_ip_cidr: typing.Union[str, IResolvable],
  nat_ip_cidr_description: typing.Union[str, IResolvable],
  nat_ip_cidr_name: typing.Union[str, IResolvable],
  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 Virtual Private Cloud (VPC) NAT gateway with which you want to associate the CIDR block.
nat_ip_cidr typing.Union[str, ros_cdk_core.IResolvable] Property natIpCidr: The NAT CIDR block that you want to associate with the NAT gateway.
nat_ip_cidr_description typing.Union[str, ros_cdk_core.IResolvable] Property natIpCidrDescription: The description of the NAT CIDR block.
nat_ip_cidr_name typing.Union[str, ros_cdk_core.IResolvable] Property natIpCidrName: The name of the CIDR block.
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 Virtual Private Cloud (VPC) NAT gateway with which you want to associate the CIDR block.

nat_ip_cidrRequired

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

Property natIpCidr: The NAT CIDR block that you want to associate with the NAT gateway.

The new CIDR block must meet the following conditions: The NAT CIDR block must fall within 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, or their subnets. The subnet mask must be 16 to 32 bits in length. The NAT CIDR block cannot overlap with the private CIDR block of the VPC to which the NAT gateway belongs. If you want to use other IP addresses from the private CIDR block of the VPC to provide NAT services, create a vSwitch and attach the vSwitch to another VPC NAT gateway. If you want to use public IP addresses to provide NAT services, make sure that the public IP addresses fall within a customer CIDR block of the VPC to which the VPC NAT gateway belongs. For more information, see What is customer CIDR block?.

nat_ip_cidr_descriptionRequired

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

Property natIpCidrDescription: The description of the NAT CIDR block.

The description must be 2 to 256 characters in length and start with a letter. The description cannot start with http:// or https://.

nat_ip_cidr_nameRequired

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

Property natIpCidrName: The name of the CIDR block.

The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter. The name must start with a letter and cannot start with http:// or https://.

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.NatIpCidr.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_ip_cidr_id ros_cdk_core.IResolvable Attribute NatIpCidrId: The ID of the NAT CIDR block.

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_ip_cidr_idRequired 

attr_nat_ip_cidr_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NatIpCidrId: The ID of the NAT CIDR block.