AssignPrivateIpAddresses

• Implements: IAssignPrivateIpAddresses

This class encapsulates and extends the ROS resource type ALIYUN::ECS::AssignPrivateIpAddresses, which is used to assign secondary private IP addresses to an elastic network interface (ENI).

You can specify available private IP addresses within the CIDR block of the vSwitch that is associated with the ENI. Alternatively, you can specify a number to have the specified number of private IP addresses automatically assigned to the ENI.

Initializers

import ros_cdk_ecs
ros_cdk_ecs.AssignPrivateIpAddresses(
  scope: Construct,
  id: str,
  network_interface_id: typing.Union[str, IResolvable],
  ipv4_prefix_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  ipv4_prefixes: typing.Union[typing.List[typing.Any], IResolvable] = None,
  private_ip_addresses: typing.Union[typing.List[typing.Any], IResolvable] = None,
  secondary_private_ip_address_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

network_interface_id^Required

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

Property networkInterfaceId: The ID of the ENI.

ipv4_prefix_count^Optional

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

Property ipv4PrefixCount: The specified number of IPv4 prefixes to be assigned to the ENI.

ipv4_prefixes^Optional

• Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]

Property ipv4Prefixes: One or multiple IPv4 prefixes to be assigned to the ENI.

private_ip_addresses^Optional

• Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]

Property privateIpAddresses: One or multiple secondary private IP addresses selected from the CIDR block of the VSwitch that hosts the ENI.

Valid values of number of private ip addresses: When the ENI is in the Available state: 1 to 10. When the ENI is in the InUse state: limited by the instance type. For more information, see Instance type families. You must specify either the PrivateIpAddresses parameter or the SecondaryPrivateIpAddressCount parameter to assign secondary private IP addresses.

secondary_private_ip_address_count^Optional

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

Property secondaryPrivateIpAddressCount: The specified number of private IP addresses to be assigned by the ECS instance.

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_ecs
ros_cdk_ecs.AssignPrivateIpAddresses.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_network_interface_id^Required

attr_network_interface_id: typing.Union[str, IResolvable]

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

Attribute NetworkInterfaceId: The ID of the ENI.

attr_private_ip_addresses^Required

attr_private_ip_addresses: typing.Union[str, IResolvable]

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

Attribute PrivateIpAddresses: Assigned private ip addresses.

props^Required

props: AssignPrivateIpAddressesProps

• Type: AssignPrivateIpAddressesProps