software.amazon.awssdk.services.ec2.model

Class CreateNetworkInterfaceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.CreateNetworkInterfaceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateNetworkInterfaceRequest.Builder,CreateNetworkInterfaceRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateNetworkInterfaceRequest
extends Ec2Request
implements ToCopyableBuilder<CreateNetworkInterfaceRequest.Builder,CreateNetworkInterfaceRequest>

Contains the parameters for CreateNetworkInterface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateNetworkInterfaceRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateNetworkInterfaceRequest.Builder	builder()
String	description() A description for the network interface.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<String>	groups() The IDs of one or more security groups.
int	hashCode()
NetworkInterfaceCreationType	interfaceType() Indicates the type of network interface.
String	interfaceTypeAsString() Indicates the type of network interface.
Integer	ipv6AddressCount() The number of IPv6 addresses to assign to a network interface.
List<InstanceIpv6Address>	ipv6Addresses() One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet.
String	privateIpAddress() The primary private IPv4 address of the network interface.
List<PrivateIpAddressSpecification>	privateIpAddresses() One or more private IPv4 addresses.
List<SdkField<?>>	sdkFields()
Integer	secondaryPrivateIpAddressCount() The number of secondary private IPv4 addresses to assign to a network interface.
static Class<? extends CreateNetworkInterfaceRequest.Builder>	serializableBuilderClass()
String	subnetId() The ID of the subnet to associate with the network interface.
CreateNetworkInterfaceRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

description

public String description()

A description for the network interface.

Returns:

A description for the network interface.

groups

public List<String> groups()

The IDs of one or more security groups.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The IDs of one or more security groups.

ipv6AddressCount

public Integer ipv6AddressCount()

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true, you can specify 0 to override this setting.

Returns:

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true, you can specify 0 to override this setting.

ipv6Addresses

public List<InstanceIpv6Address> ipv6Addresses()

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.

privateIpAddress

public String privateIpAddress()

The primary private IPv4 address of the network interface. If you don't specify an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

Returns:

The primary private IPv4 address of the network interface. If you don't specify an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

privateIpAddresses

public List<PrivateIpAddressSpecification> privateIpAddresses()

One or more private IPv4 addresses.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

One or more private IPv4 addresses.

secondaryPrivateIpAddressCount

public Integer secondaryPrivateIpAddressCount()

The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.

Returns:

The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.

interfaceType

public NetworkInterfaceCreationType interfaceType()

Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

If the service returns an enum value that is not available in the current SDK version, interfaceType will return NetworkInterfaceCreationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from interfaceTypeAsString().

Returns:

Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

See Also:

NetworkInterfaceCreationType

interfaceTypeAsString

public String interfaceTypeAsString()

Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

If the service returns an enum value that is not available in the current SDK version, interfaceType will return NetworkInterfaceCreationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from interfaceTypeAsString().

Returns:

Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

See Also:

NetworkInterfaceCreationType

subnetId

public String subnetId()

The ID of the subnet to associate with the network interface.

Returns:

The ID of the subnet to associate with the network interface.

toBuilder

public CreateNetworkInterfaceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateNetworkInterfaceRequest.Builder,CreateNetworkInterfaceRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static CreateNetworkInterfaceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateNetworkInterfaceRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo