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

vSwitchId^Required

public readonly vSwitchId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The ID of the VSwitch for the elastic network interface.

The private IP addresses for the elastic network interface are assigned from the available CIDR block of the VSwitch.

The elastic network interface and the instance to be attached must be in the same availability zone but can belong to different VSwitches. <\/notice>

deleteOnRelease^Optional

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.

description^Optional

public readonly description: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: The description of the elastic network interface.

The description must be 2 to 256 characters long and cannot start with http:\/\/ or https:\/\/. Default value: empty.

ipv4PrefixCount^Optional

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.

ipv4Prefixes^Optional

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.

ipv6AddressCount^Optional

public readonly ipv6AddressCount: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property ipv6AddressCount: The number of random IPv6 addresses to assign to the elastic network interface.

Valid values: 1 to 10.

You must specify either Ipv6Address.N or Ipv6AddressCount, but not both, to assign IPv6 addresses.

ipv6Addresses^Optional

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.

ipv6PrefixCount^Optional

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.

ipv6Prefixes^Optional

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.

networkInterfaceName^Optional

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 (-).

networkInterfaceTrafficMode^Optional

public readonly networkInterfaceTrafficMode: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property networkInterfaceTrafficMode: The traffic mode of the elastic network interface.

Valid values: - Standard: uses the TCP traffic mode. - HighPerformance: enables the Elastic RDMA Interface (ERI) and uses the RDMA traffic mode.

An elastic network interface in RDMA traffic mode can be attached only to an ERI-supported instance type. The number of these elastic network interfaces that can be attached is limited by the instance family. Default value: Standard.

primaryIpAddress^Optional

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.

privateIpAddresses^Optional

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.

queueNumber^Optional

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.

resourceGroupId^Optional

public readonly resourceGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: Resource group id.

rxQueueSize^Optional

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.

secondaryPrivateIpAddressCount^Optional

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.

securityGroupId^Optional

public readonly securityGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property securityGroupId: The ID of the security group for the elastic network interface.

The security group and the elastic network interface must be in the same VPC.

You must specify either SecurityGroupId or SecurityGroupIds.N, but not both.

securityGroupIds^Optional

public readonly securityGroupIds: IResolvable | string | IResolvable[];

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

Property securityGroupIds: The IDs of one or more security groups to which to add the elastic network interface.

The security groups and the elastic network interface must be in the same VPC. The valid values of N depend on the maximum number of security groups to which an elastic network interface can be added.

You must specify either SecurityGroupId or SecurityGroupIds.N, but not both.

tags^Optional

public readonly tags: TagsProperty[];

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

txQueueSize^Optional

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.