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	clientToken() Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
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.
boolean	hasGroups() For responses, this returns true if the service returned a value for the Groups property.
int	hashCode()
boolean	hasIpv4Prefixes() For responses, this returns true if the service returned a value for the Ipv4Prefixes property.
boolean	hasIpv6Addresses() For responses, this returns true if the service returned a value for the Ipv6Addresses property.
boolean	hasIpv6Prefixes() For responses, this returns true if the service returned a value for the Ipv6Prefixes property.
boolean	hasPrivateIpAddresses() For responses, this returns true if the service returned a value for the PrivateIpAddresses property.
boolean	hasTagSpecifications() For responses, this returns true if the service returned a value for the TagSpecifications property.
NetworkInterfaceCreationType	interfaceType() The type of network interface.
String	interfaceTypeAsString() The type of network interface.
Integer	ipv4PrefixCount() The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface.
List<Ipv4PrefixSpecificationRequest>	ipv4Prefixes() One or more IPv4 prefixes assigned to the 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.
Integer	ipv6PrefixCount() The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface.
List<Ipv6PrefixSpecificationRequest>	ipv6Prefixes() One or more IPv6 prefixes assigned to the network interface.
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.
List<TagSpecification>	tagSpecifications() The tags to apply to the new 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 final String description()

A description for the network interface.

Returns:

A description for the network interface.

hasGroups

public final boolean hasGroups()

For responses, this returns true if the service returned a value for the Groups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

groups

public final 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGroups() method.

Returns:

The IDs of one or more security groups.

ipv6AddressCount

public final 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.

hasIpv6Addresses

public final boolean hasIpv6Addresses()

For responses, this returns true if the service returned a value for the Ipv6Addresses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

ipv6Addresses

public final 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIpv6Addresses() method.

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

hasPrivateIpAddresses

public final boolean hasPrivateIpAddresses()

For responses, this returns true if the service returned a value for the PrivateIpAddresses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

privateIpAddresses

public final List<PrivateIpAddressSpecification> privateIpAddresses()

One or more private IPv4 addresses.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPrivateIpAddresses() method.

Returns:

One or more private IPv4 addresses.

secondaryPrivateIpAddressCount

public final 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.

hasIpv4Prefixes

public final boolean hasIpv4Prefixes()

For responses, this returns true if the service returned a value for the Ipv4Prefixes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

ipv4Prefixes

public final List<Ipv4PrefixSpecificationRequest> ipv4Prefixes()

One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIpv4Prefixes() method.

Returns:

One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

ipv4PrefixCount

public final Integer ipv4PrefixCount()

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.

Returns:

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.

hasIpv6Prefixes

public final boolean hasIpv6Prefixes()

For responses, this returns true if the service returned a value for the Ipv6Prefixes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

ipv6Prefixes

public final List<Ipv6PrefixSpecificationRequest> ipv6Prefixes()

One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIpv6Prefixes() method.

Returns:

One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

ipv6PrefixCount

public final Integer ipv6PrefixCount()

The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option.

Returns:

The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option.

interfaceType

public final NetworkInterfaceCreationType interfaceType()

The type of network interface. The default is interface.

The only supported values are efa and trunk.

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:

The type of network interface. The default is interface.

The only supported values are efa and trunk.

See Also:

NetworkInterfaceCreationType

interfaceTypeAsString

public final String interfaceTypeAsString()

The type of network interface. The default is interface.

The only supported values are efa and trunk.

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:

The type of network interface. The default is interface.

The only supported values are efa and trunk.

See Also:

NetworkInterfaceCreationType

subnetId

public final 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.

hasTagSpecifications

public final boolean hasTagSpecifications()

For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tagSpecifications

public final List<TagSpecification> tagSpecifications()

The tags to apply to the new network interface.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagSpecifications() method.

Returns:

The tags to apply to the new network interface.

clientToken

public final String clientToken()

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Returns:

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

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 final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo