com.aliyun.sdk.service.ecs20140526.models

类 RunInstancesRequest.NetworkInterface.Builder

java.lang.Object

com.aliyun.sdk.service.ecs20140526.models.RunInstancesRequest.NetworkInterface.Builder

封闭类:

RunInstancesRequest.NetworkInterface

public static final class RunInstancesRequest.NetworkInterface.Builder
extends Object

构造器概要

构造器

构造器和说明
Builder()

方法概要

限定符和类型	方法和说明
RunInstancesRequest.NetworkInterface	build()
RunInstancesRequest.NetworkInterface.Builder	deleteOnRelease(Boolean deleteOnRelease) Specifies whether to release ENI N when the associated instance is released.
RunInstancesRequest.NetworkInterface.Builder	description(String description) The description of ENI N.
RunInstancesRequest.NetworkInterface.Builder	instanceType(String instanceType) The type of ENI N.
RunInstancesRequest.NetworkInterface.Builder	ipv6Address(List<String> ipv6Address) The IPv6 addresses to assign to the primary ENI.
RunInstancesRequest.NetworkInterface.Builder	ipv6AddressCount(Long ipv6AddressCount) The number of IPv6 addresses to randomly generate for the primary ENI.
RunInstancesRequest.NetworkInterface.Builder	networkCardIndex(Integer networkCardIndex) The index of the network card for ENI N.
RunInstancesRequest.NetworkInterface.Builder	networkInterfaceId(String networkInterfaceId) The ID of ENI N to attach to the instance.
RunInstancesRequest.NetworkInterface.Builder	networkInterfaceName(String networkInterfaceName) The name of ENI N.
RunInstancesRequest.NetworkInterface.Builder	networkInterfaceTrafficMode(String networkInterfaceTrafficMode) The communication mode of ENI N.
RunInstancesRequest.NetworkInterface.Builder	primaryIpAddress(String primaryIpAddress) The primary IP address to assign to ENI N.
RunInstancesRequest.NetworkInterface.Builder	queueNumber(Integer queueNumber) The number of queues supported by ENI N.
RunInstancesRequest.NetworkInterface.Builder	queuePairNumber(Long queuePairNumber) The number of queues supported by the ERI.
RunInstancesRequest.NetworkInterface.Builder	rxQueueSize(Integer rxQueueSize) The receive (Rx) queue depth of ENI N.
RunInstancesRequest.NetworkInterface.Builder	securityGroupId(String securityGroupId) The ID of the security group to which to assign ENI N.
RunInstancesRequest.NetworkInterface.Builder	securityGroupIds(List<String> securityGroupIds) The IDs of security groups to which to assign ENI N.
RunInstancesRequest.NetworkInterface.Builder	txQueueSize(Integer txQueueSize) The Tx queue depth of ENI N.
RunInstancesRequest.NetworkInterface.Builder	vSwitchId(String vSwitchId) The ID of the vSwitch to which to connect ENI N.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

Builder

public Builder()

方法详细资料

deleteOnRelease

public RunInstancesRequest.NetworkInterface.Builder deleteOnRelease(Boolean deleteOnRelease)

Specifies whether to release ENI N when the associated instance is released. Valid values:

* true * false Default value: true. > This parameter takes effect only for secondary ENIs.

description

public RunInstancesRequest.NetworkInterface.Builder description(String description)

The description of ENI N.

When you specify this parameter, take note of the following items: * The value of N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see [Overview of instance families](~~25378~~) or call the [DescribeInstanceTypes](~~2679699~~) operation. * The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`. * If you set `NetworkInterface.N.InstanceType` to `Primary`, you do not need to specify this parameter.

instanceType

public RunInstancesRequest.NetworkInterface.Builder instanceType(String instanceType)

The type of ENI N. The value of N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see [Overview of instance families](~~25378~~) or call the [DescribeInstanceTypes](~~2679699~~) operation.

Valid values: * Primary: primary ENI. * Secondary: secondary ENI. Default value: Secondary.

ipv6Address

public RunInstancesRequest.NetworkInterface.Builder ipv6Address(List<String> ipv6Address)

The IPv6 addresses to assign to the primary ENI. You can assign up to 10 IPv6 addresses to the primary ENI. Valid values of the second N: 1 to 10.

Example: `Ipv6Address.1=2001:db8:1234:1a00::***`. When you specify this parameter, take note of the following items: * This parameter is valid only when `NetworkInterface.N.InstanceType` is set to `Primary`. If you set `NetworkInterface.N.InstanceType` to `Secondary` or leave NetworkInterface.N.InstanceType empty, you cannot specify this parameter. * If you specify this parameter, you must set `Amount` to 1 and cannot specify `Ipv6AddressCount`, `Ipv6Address.N`, or `NetworkInterface.N.Ipv6AddressCount`.

ipv6AddressCount

public RunInstancesRequest.NetworkInterface.Builder ipv6AddressCount(Long ipv6AddressCount)

The number of IPv6 addresses to randomly generate for the primary ENI. Valid values: 1 to 10.

When you specify this parameter, take note of the following items: * This parameter is valid only when `NetworkInterface.N.InstanceType` is set to `Primary`. If you set `NetworkInterface.N.InstanceType` to `Secondary` or leave NetworkInterface.N.InstanceType empty, you cannot specify this parameter. * If you specify this parameter, you cannot specify `Ipv6AddressCount`, `Ipv6Address.N`, or `NetworkInterface.N.Ipv6Address.N`.

networkCardIndex

public RunInstancesRequest.NetworkInterface.Builder networkCardIndex(Integer networkCardIndex)

The index of the network card for ENI N.

When you specify this parameter, take note of the following items: * You can specify network card indexes only for instances of specific instance types. * If you set NetworkInterface.N.InstanceType to Primary, you can set NetworkInterface.N.NetworkCardIndex only to 0 for instance types that support network cards. * If you set NetworkInterface.N.InstanceType to Secondary or do not specify the parameter, you can specify NetworkInterface.N.NetworkCardIndex based on instance types if the instance types support network cards. For more information, see [Overview of instance families](~~25378~~).

networkInterfaceId

public RunInstancesRequest.NetworkInterface.Builder networkInterfaceId(String networkInterfaceId)

The ID of ENI N to attach to the instance.

> This parameter takes effect only for secondary ENIs. After you specify an existing secondary ENI, you cannot specify other ENI creation parameters.

networkInterfaceName

public RunInstancesRequest.NetworkInterface.Builder networkInterfaceName(String networkInterfaceName)

The name of ENI N. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (\_), periods (.), and hyphens (-).

When you specify this parameter, take note of the following items: * The value of N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see [Overview of instance families](~~25378~~) or call the [DescribeInstanceTypes](~~2679699~~) operation. * If you set `NetworkInterface.N.InstanceType` to `Primary`, you do not need to specify this parameter.

networkInterfaceTrafficMode

public RunInstancesRequest.NetworkInterface.Builder networkInterfaceTrafficMode(String networkInterfaceTrafficMode)

The communication mode of ENI N. Valid values:

* Standard: uses the TCP communication mode. * HighPerformance: uses the remote direct memory access (RDMA) communication mode with Elastic RDMA Interface (ERI) enabled. Default value: Standard. > The number of ERIs on an instance cannot exceed the maximum number of ERIs that the instance type supports. For more information, see [Overview of instance families](~~25378~~).

primaryIpAddress

public RunInstancesRequest.NetworkInterface.Builder primaryIpAddress(String primaryIpAddress)

The primary IP address to assign to ENI N.

When you specify this parameter, take note of the following items: * The value of N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see [Overview of instance families](~~25378~~) or call the [DescribeInstanceTypes](~~2679699~~) operation. * If the value of N is 1, you can configure a primary or secondary ENI. If you specify this parameter, set `Amount` to a numeric value greater than 1, and set NetworkInterface.N.InstanceType to Primary, the specified number of instances are created and consecutive primary IP addresses starting from the specified IP address are assigned to the instances. In this case, you cannot attach secondary ENIs to the instances. * If you specify this parameter, set `Amount` to a numeric value greater than 1, and set NetworkInterface.N.InstanceType to Primary, you cannot set `NetworkInterface.2.InstanceType` to Secondary to attach a secondary ENI. * If you set `NetworkInterface.N.InstanceType` to `Primary`, this parameter is equivalent to `PrivateIpAddress`. You cannot specify both this parameter and `PrivateIpAddress` in the same request. * If you set `NetworkInterface.N.InstanceType` to `Secondary` or leave NetworkInterface.N.InstanceType empty, the specified primary IP address is assigned to the secondary ENI. The default value is an IP address that is randomly selected from within the CIDR block of the vSwitch to which to connect the secondary ENI. > * The first IP address and last three IP addresses of each vSwitch CIDR block are reserved. You cannot specify the IP addresses. For example, if a vSwitch CIDR block is 192.168.1.0/24, the following IP addresses are reserved: 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255.

queueNumber

public RunInstancesRequest.NetworkInterface.Builder queueNumber(Integer queueNumber)

The number of queues supported by ENI N.

When you specify this parameter, take note of the following items: * The value of N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see [Overview of instance families](~~25378~~) or call the [DescribeInstanceTypes](~~2679699~~) operation. * The value of this parameter cannot exceed the maximum number of queues allowed per ENI. * The total number of queues for all ENIs on the instance cannot exceed the queue quota for the instance type. To query the maximum number of queues per ENI and the queue quota for an instance type, you can call the [DescribeInstanceTypes](~~25620~~) operation and check the `MaximumQueueNumberPerEni` and `TotalEniQueueQuantity` values in the response. * If you specify this parameter and set `NetworkInterface.N.InstanceType` to `Primary`, you cannot specify `NetworkInterfaceQueueNumber`.

queuePairNumber

public RunInstancesRequest.NetworkInterface.Builder queuePairNumber(Long queuePairNumber)

The number of queues supported by the ERI.

rxQueueSize

public RunInstancesRequest.NetworkInterface.Builder rxQueueSize(Integer rxQueueSize)

The receive (Rx) queue depth of ENI N.

When you specify this parameter, take note of the following items: * The Rx queue depth of an ENI must be the same as the transmit (Tx) queue depth of the ENI. Valid values: powers of 2 in the range of 8192 to 16384. * A larger Rx queue depth yields higher inbound throughput but consumes more memory.

securityGroupId

public RunInstancesRequest.NetworkInterface.Builder securityGroupId(String securityGroupId)

The ID of the security group to which to assign ENI N.

When you specify this parameter, take note of the following items: * The value of N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see [Overview of instance families](~~25378~~) or call the [DescribeInstanceTypes](~~2679699~~) operation. * If you set `NetworkInterface.N.InstanceType` to `Primary`, you must specify this parameter. In this case, this parameter is equivalent to `SecurityGroupId` and you cannot specify `SecurityGroupId`, `SecurityGroupIds.N`, or `NetworkInterface.N.SecurityGroupIds.N`. * If you set `NetworkInterface.N.InstanceType` to `Secondary` or leave NetworkInterface.N.InstanceType empty, you do not need to specify this parameter. The default value is the ID of the security group to which to assign the instance.

securityGroupIds

public RunInstancesRequest.NetworkInterface.Builder securityGroupIds(List<String> securityGroupIds)

The IDs of security groups to which to assign ENI N.

* The value of the first N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see [Overview of instance families](~~25378~~) or call the [DescribeInstanceTypes](~~2679699~~) operation. * The second N indicates that one or more security group IDs can be specified. The valid values of the second N vary based on the maximum number of security groups to which an instance can belong. For more information, see the [Security group limits](~~25412#SecurityGroupQuota1~~) section of the "Limits" topic. When you specify this parameter, take note of the following items: * If you set `NetworkInterface.N.InstanceType` to `Primary`, you must specify this parameter or `NetworkInterface.N.SecurityGroupId`. In this case, this parameter is equivalent to `SecurityGroupIds.N`, and you cannot specify `SecurityGroupId`, `SecurityGroupIds.N`, or `NetworkInterface.N.SecurityGroupId`. * If you set `NetworkInterface.N.InstanceType` to `Secondary` or leave NetworkInterface.N.InstanceType empty, you do not need to specify this parameter. The default value is the ID of the security group to which to assign the instance.

txQueueSize

public RunInstancesRequest.NetworkInterface.Builder txQueueSize(Integer txQueueSize)

The Tx queue depth of ENI N.

When you specify this parameter, take note of the following items: * The Tx queue depth of an ENI must be the same as the Rx queue depth of the ENI. Valid values: powers of 2 in the range of 8192 to 16384. * A larger Tx queue depth yields higher outbound throughput but consumes more memory.

vSwitchId

public RunInstancesRequest.NetworkInterface.Builder vSwitchId(String vSwitchId)

The ID of the vSwitch to which to connect ENI N.

When you specify this parameter, take note of the following items: * The value of N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see [Overview of instance families](~~25378~~) or call the [DescribeInstanceTypes](~~2679699~~) operation. * If you set `NetworkInterface.N.InstanceType` to `Primary`, you must specify this parameter. In this case, this parameter is equivalent to `VSwitchId`. You cannot specify both NetworkInterface.N.VSwitchId and `VSwitchId` in the same request. * If you set `NetworkInterface.N.InstanceType` to `Secondary` or leave NetworkInterface.N.InstanceType empty, you do not need to specify this parameter. The default value is the VSwitchId value.

build

public RunInstancesRequest.NetworkInterface build()