NatIp

• Implements: INatIp

This class encapsulates and extends the ROS resource type ALIYUN::VPC::NatIp.

Initializers

import ros_cdk_vpc
ros_cdk_vpc.NatIp(
  scope: Construct,
  id: str,
  nat_gateway_id: typing.Union[str, IResolvable],
  nat_ip_cidr: typing.Union[str, IResolvable],
  nat_ip_description: typing.Union[str, IResolvable],
  nat_ip_name: typing.Union[str, IResolvable],
  ipv4_prefix: typing.Union[str, IResolvable] = None,
  ipv4_prefix_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  nat_ip: typing.Union[str, IResolvable] = None,
  nat_ip_cidr_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

nat_gateway_id^Required

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

Property natGatewayId: The ID of the Virtual Private Cloud (VPC) NAT gateway for which you want to create the NAT IP address.

nat_ip_cidr^Required

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

Property natIpCidr: The CIDR block to which the NAT IP address belongs.

nat_ip_description^Required

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

Property natIpDescription: The description of the NAT IP address.

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

nat_ip_name^Required

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

Property natIpName: The name of the NAT IP address.

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. It cannot start with http:// or https://.

ipv4_prefix^Optional

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

Property ipv4Prefix: The IPv4 prefix of the IP address range to be created.

The IPv4 prefix must be within the reserved CIDR block of the switch where the NAT gateway is deployed, and the reserved CIDR block must not be occupied. The prefix length must be /28.

ipv4_prefix_count^Optional

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

Property ipv4PrefixCount: The number of IPv4 prefixes to automatically allocate.

Randomly allocated from the unassigned reserved CIDR blocks of the switch where the NAT gateway is deployed. Valid values: 1 to 10.

nat_ip^Optional

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

Property natIp: The NAT IP address that you want to create.

If you do not specify an IP address, the system selects a random IP address from the specified CIDR block.

nat_ip_cidr_id^Optional

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

Property natIpCidrId: The ID of the CIDR block to which the NAT IP address belongs.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_nat_ip^Required

attr_nat_ip: typing.Union[str, IResolvable]

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

Attribute NatIp: NAT IP address.

attr_nat_ip_id^Required

attr_nat_ip_id: typing.Union[str, IResolvable]

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

Attribute NatIpId: The ID of the NAT IP address.

props^Required

props: NatIpProps

• Type: NatIpProps