NetworkInterfaces

This class encapsulates and extends the ROS resource type DATASOURCE::ECS::NetworkInterfaces, which is used to query the details of elastic network interfaces (ENIs).

Initializers

from ros_cdk_ecs import datasource
datasource.NetworkInterfaces(
  scope: Construct,
  id: str,
  instance_id: typing.Union[str, IResolvable] = None,
  ipv6_addresses: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  network_interface_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  network_interface_name: typing.Union[str, IResolvable] = None,
  primary_ip_address: typing.Union[str, IResolvable] = None,
  private_ip_addresses: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  security_group_id: typing.Union[str, IResolvable] = None,
  service_managed: typing.Union[bool, IResolvable] = None,
  status: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  type: typing.Union[str, IResolvable] = None,
  vpc_id: typing.Union[str, IResolvable] = None,
  v_switch_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_id	typing.Union[str, ros_cdk_core.IResolvable]	Property instanceId: The ID of the instance to which the ENI is bound.
ipv6_addresses	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	Property ipv6Addresses: IPv6 address N of the ENI.
network_interface_ids	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	Property networkInterfaceIds: The ID of ENI N.
network_interface_name	typing.Union[str, ros_cdk_core.IResolvable]	Property networkInterfaceName: The name of the ENI.
primary_ip_address	typing.Union[str, ros_cdk_core.IResolvable]	Property primaryIpAddress: The primary private IPv4 address of the ENI.
private_ip_addresses	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	Property privateIpAddresses: Secondary private IPv4 address N of the ENI.
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 eni belongs.
security_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property securityGroupId: The ID of the security group to which the secondary ENI belongs.
service_managed	typing.Union[bool, ros_cdk_core.IResolvable]	Property serviceManaged: Specifies whether the user is an Alibaba Cloud service or a distributor.
status	typing.Union[str, ros_cdk_core.IResolvable]	Property status: The state of the ENI.
tags	typing.List[ros_cdk_ecs.datasource.RosNetworkInterfaces.TagsProperty]	Property tags: Tags of eni.
type	typing.Union[str, ros_cdk_core.IResolvable]	Property type: The type of the ENI.
vpc_id	typing.Union[str, ros_cdk_core.IResolvable]	Property vpcId: The ID of the virtual private cloud (VPC) to which the ENI belongs.
v_switch_id	typing.Union[str, ros_cdk_core.IResolvable]	Property vSwitchId: The ID of the vSwitch to which the ENI is connected.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

instance_id^Optional

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

Property instanceId: The ID of the instance to which the ENI is bound.

---

ipv6_addresses^Optional

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

Property ipv6Addresses: IPv6 address N of the ENI.

You can specify multiple IPv6 addresses. Valid values of N: 1 to 100.

---

network_interface_ids^Optional

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

Property networkInterfaceIds: The ID of ENI N.

Valid values of N: 1 to 100.

---

network_interface_name^Optional

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

Property networkInterfaceName: The name of the ENI.

---

primary_ip_address^Optional

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

Property primaryIpAddress: The primary private IPv4 address of the ENI.

---

private_ip_addresses^Optional

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

Property privateIpAddresses: Secondary private IPv4 address N of the ENI.

Valid values of N: 1 to 100.

---

refresh_options^Optional

• 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_id^Optional

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

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

If this parameter is specified to query resources,up to 1,000 resources that belong to the specified resource group can be displayed in the response.

---

security_group_id^Optional

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

Property securityGroupId: The ID of the security group to which the secondary ENI belongs.

To query the details of secondary ENIs based on the ID of a security group, specify this parameter. To query the details of primary ENIs based on the ID of a security group, call the DescribeInstances operation and specify the SecurityGroupId parameter.

---

service_managed^Optional

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

Property serviceManaged: Specifies whether the user is an Alibaba Cloud service or a distributor.

---

status^Optional

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

Property status: The state of the ENI.

Valid values: Creating: The ENI is being created. Available: The ENI is not bound to an instance. Attaching: The ENI is being bound to an instance. InUse: The ENI is bound to an instance. Detaching: The ENI is being unbound from an instance. Deleting: The ENI is being deleted. CreateFailed: The ENI cannot be created. This parameter is empty by default, which indicates that ENIs in all states are queried.

---

tags^Optional

• Type: typing.List[ros_cdk_ecs.datasource.RosNetworkInterfaces.TagsProperty]

Property tags: Tags of eni.

---

type^Optional

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

Property type: The type of the ENI.

Valid values: Primary Secondary This parameter is empty by default, which indicates that both primary and secondary ENIs are queried.

---

vpc_id^Optional

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

Property vpcId: The ID of the virtual private cloud (VPC) to which the ENI belongs.

---

v_switch_id^Optional

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

Property vSwitchId: The ID of the vSwitch to which the ENI is connected.

---

enable_resource_property_constraint^Optional

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

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

---

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

Name	Description
is_construct	Return whether the given object is a Construct.

---

is_construct

from ros_cdk_ecs import datasource
datasource.NetworkInterfaces.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• 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_ids	ros_cdk_core.IResolvable	Attribute NetworkInterfaceIds: The list of NetworkInterfaceIds.
attr_network_interfaces	ros_cdk_core.IResolvable	Attribute NetworkInterfaces: The list of NetworkInterfaces.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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_ids^Required

attr_network_interface_ids: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute NetworkInterfaceIds: The list of NetworkInterfaceIds.

---

attr_network_interfaces^Required

attr_network_interfaces: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute NetworkInterfaces: The list of NetworkInterfaces.

---