Skip to content

AssignPrivateIpAddresses

This class encapsulates and extends the ROS resource type ALIYUN::ECS::AssignPrivateIpAddresses, which is used to assign one or more secondary private IP addresses to an ENI.

You can specify private IP addresses within the CIDR block of the vSwitch that hosts the ENI. You can also specify the number of private IP addresses for ECS to assign them automatically.

Initializers

import ros_cdk_ecs
ros_cdk_ecs.AssignPrivateIpAddresses(
  scope: Construct,
  id: str,
  network_interface_id: typing.Union[str, IResolvable],
  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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
network_interface_id typing.Union[str, ros_cdk_core.IResolvable] Property networkInterfaceId: The ID of the ENI.
private_ip_addresses 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.
secondary_private_ip_address_count 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 bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

network_interface_idRequired

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

Property networkInterfaceId: The ID of the ENI.


private_ip_addressesOptional

  • 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_countOptional

  • 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_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_ecs
ros_cdk_ecs.AssignPrivateIpAddresses.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_network_interface_id ros_cdk_core.IResolvable Attribute NetworkInterfaceId: The ID of the ENI.
attr_private_ip_addresses ros_cdk_core.IResolvable Attribute PrivateIpAddresses: Assigned private ip addresses.

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_network_interface_idRequired

attr_network_interface_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NetworkInterfaceId: The ID of the ENI.


attr_private_ip_addressesRequired

attr_private_ip_addresses: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PrivateIpAddresses: Assigned private ip addresses.