Skip to content

NetworkInterfaceProps

Properties for defining a NetworkInterface.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ecs-networkinterface

Initializer 

import { NetworkInterfaceProps } from '@alicloud/ros-cdk-ecs'
const networkInterfaceProps: NetworkInterfaceProps = { ... }

Properties

Name Type Description
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: VSwitch ID of the specified VPC.
deleteOnRelease boolean | @alicloud/ros-cdk-core.IResolvable Property deleteOnRelease: Specifies whether to delete the ENI when the instance is released.
description string | @alicloud/ros-cdk-core.IResolvable Property description: Description of your ENI.
ipv4PrefixCount number | @alicloud/ros-cdk-core.IResolvable Property ipv4PrefixCount: Specifies one or more IPv4 prefixes for the elastic network interface.
ipv4Prefixes @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property ipv4Prefixes: Specifies one or more IPv4 prefixes for the elastic network interface.
ipv6AddressCount number | @alicloud/ros-cdk-core.IResolvable Property ipv6AddressCount: The number of randomly generated IPv6 addresses that are assigned to the ENI.
ipv6Addresses @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property ipv6Addresses: The IPv6 address N to assign to the ENI.
ipv6PrefixCount number | @alicloud/ros-cdk-core.IResolvable Property ipv6PrefixCount: Specifies one or more IPv6 prefixes for the elastic network interface.
ipv6Prefixes @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property ipv6Prefixes: Specifies one or more IPv6 prefixes for the elastic network interface.
networkInterfaceName string | @alicloud/ros-cdk-core.IResolvable Property networkInterfaceName: Name of your ENI.
networkInterfaceTrafficMode string | @alicloud/ros-cdk-core.IResolvable Property networkInterfaceTrafficMode: The communication mode of the ENI.
primaryIpAddress string | @alicloud/ros-cdk-core.IResolvable Property primaryIpAddress: The primary private IP address of the ENI.
privateIpAddresses @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property privateIpAddresses: Specifies secondary private IP addresses of the ENI.
queueNumber number | @alicloud/ros-cdk-core.IResolvable Property queueNumber: The number of queues that are supported by the ENI.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: Resource group id.
rxQueueSize number | @alicloud/ros-cdk-core.IResolvable Property rxQueueSize: Elastic network card inbound queue depth.
secondaryPrivateIpAddressCount number | @alicloud/ros-cdk-core.IResolvable Property secondaryPrivateIpAddressCount: The number of private IP addresses that can be created automatically by ECS.
securityGroupId string | @alicloud/ros-cdk-core.IResolvable Property securityGroupId: The ID of the security group that the ENI joins.
securityGroupIds @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property securityGroupIds: The IDs of the security groups that the ENI joins.
tags TagsProperty[] Property tags: Tags to attach to instance.
txQueueSize number | @alicloud/ros-cdk-core.IResolvable Property txQueueSize: Elastic network card outbound queue depth.

vSwitchIdRequired 

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: VSwitch ID of the specified VPC.

Specifies the switch ID for the VPC.

deleteOnReleaseOptional 

public readonly deleteOnRelease: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property deleteOnRelease: Specifies whether to delete the ENI when the instance is released.

descriptionOptional 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: Description of your ENI.

It is a string of [2, 256] English or Chinese characters.

ipv4PrefixCountOptional 

public readonly ipv4PrefixCount: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property ipv4PrefixCount: Specifies one or more IPv4 prefixes for the elastic network interface.

Range: 1-10 Note: If you need to set an IPv4 prefix for an elastic network interface, you must set either Ipv4Prefixes or Ipv4PrefixCount, but not both.

ipv4PrefixesOptional 

public readonly ipv4Prefixes: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

Property ipv4Prefixes: Specifies one or more IPv4 prefixes for the elastic network interface.

ipv6AddressCountOptional 

public readonly ipv6AddressCount: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property ipv6AddressCount: The number of randomly generated IPv6 addresses that are assigned to the ENI.

ipv6AddressesOptional 

public readonly ipv6Addresses: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

Property ipv6Addresses: The IPv6 address N to assign to the ENI.

ipv6PrefixCountOptional 

public readonly ipv6PrefixCount: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property ipv6PrefixCount: Specifies one or more IPv6 prefixes for the elastic network interface.

Range: 1-10 Note: If you need to set an IPv6 prefix for an elastic network interface, you must set either Ipv6Prefixes or Ipv6PrefixCount, but not both.

ipv6PrefixesOptional 

public readonly ipv6Prefixes: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

Property ipv6Prefixes: Specifies one or more IPv6 prefixes for the elastic network interface.

networkInterfaceNameOptional 

public readonly networkInterfaceName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property networkInterfaceName: Name of your ENI.

It is a string of [2, 128] Chinese or English characters. It must begin with a letter and can contain numbers, underscores (_), colons (:), or hyphens (-).

networkInterfaceTrafficModeOptional 

public readonly networkInterfaceTrafficMode: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property networkInterfaceTrafficMode: The communication mode of the ENI.

Valid values: Standard: uses the TCP communication mode. HighPerformance: enables the Elastic RDMA Interface (ERI) and uses the remote direct memory access (RDMA) communication mode.

primaryIpAddressOptional 

public readonly primaryIpAddress: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

The specified IP address must have the same Host ID as the VSwitch. If no IP addresses are specified, a random network ID is assigned for the ENI.

privateIpAddressesOptional 

public readonly privateIpAddresses: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

Property privateIpAddresses: Specifies secondary private IP addresses of the ENI.

This IP address must be an available IP address in the CIDR block of the VSwitch to which the ENI belongs.

queueNumberOptional 

public readonly queueNumber: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property queueNumber: The number of queues that are supported by the ENI.

Valid values: 1 to 2048. When you attach the ENI to an instance, make sure that the value of this parameter is less than the maximum number of queues per ENI that is allowed for the instance type. To view the maximum number of queues per ENI allowed for an instance type, you can call DescribeInstanceTypes and then check the return value of MaximumQueueNumberPerEni. By default, this parameter is empty. If you do not specify this parameter, the default number of queues per ENI for the instance type of an instance is used when you attach the ENI to the instance. To learn about the default number of queues per ENI for an instance type, you can call DescribeInstanceTypes and then check the return value of SecondaryEniQueueNumber.

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: Resource group id.

rxQueueSizeOptional 

public readonly rxQueueSize: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property rxQueueSize: Elastic network card inbound queue depth.

Note: The inbound queue depth of the network card must be equal to the outbound queue depth, ranging from 8192 to 16384, and must be a power of two. Larger inbound queue depth can improve inbound throughput, but it consumes more memory.

secondaryPrivateIpAddressCountOptional 

public readonly secondaryPrivateIpAddressCount: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property secondaryPrivateIpAddressCount: The number of private IP addresses that can be created automatically by ECS.

securityGroupIdOptional 

public readonly securityGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property securityGroupId: The ID of the security group that the ENI joins.

The security group and the ENI must be in a same VPC.

securityGroupIdsOptional 

public readonly securityGroupIds: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

Property securityGroupIds: The IDs of the security groups that the ENI joins.

The security groups and the ENI must belong to the same VPC.

tagsOptional 

public readonly tags: TagsProperty[];

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

txQueueSizeOptional 

public readonly txQueueSize: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property txQueueSize: Elastic network card outbound queue depth.

Note: The outbound queue depth of the network card must be equal to the inbound queue depth, ranging from 8192 to 16384, and must be a power of two. Larger outbound queue depth can improve outbound throughput, but it consumes more memory.