software.amazon.awssdk.services.ec2.model

Class InstanceNetworkInterfaceSpecification

java.lang.Object

software.amazon.awssdk.services.ec2.model.InstanceNetworkInterfaceSpecification

All Implemented Interfaces:

ToCopyableBuilder<InstanceNetworkInterfaceSpecification.Builder,InstanceNetworkInterfaceSpecification>

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

Describes a network interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InstanceNetworkInterfaceSpecification.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	associatePublicIpAddress() Indicates whether to assign a public IPv4 address to an instance you launch in a VPC.
static InstanceNetworkInterfaceSpecification.Builder	builder()
Boolean	deleteOnTermination() If set to true, the interface is deleted when the instance is terminated.
String	description() The description of the network interface.
Integer	deviceIndex() The index of the device on the instance for the network interface attachment.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<String>	groups() The IDs of the security groups for the network interface.
int	hashCode()
Integer	ipv6AddressCount() A number of IPv6 addresses to assign to the network interface.
List<InstanceIpv6Address>	ipv6Addresses() One or more IPv6 addresses to assign to the network interface.
String	networkInterfaceId() The ID of the network interface.
String	privateIpAddress() The private IPv4 address of the network interface.
List<PrivateIpAddressSpecification>	privateIpAddresses() One or more private IPv4 addresses to assign to the network interface.
Integer	secondaryPrivateIpAddressCount() The number of secondary private IPv4 addresses.
static Class<? extends InstanceNetworkInterfaceSpecification.Builder>	serializableBuilderClass()
String	subnetId() The ID of the subnet associated with the network string.
InstanceNetworkInterfaceSpecification.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

associatePublicIpAddress

public Boolean associatePublicIpAddress()

Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

Returns:

Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

deleteOnTermination

public Boolean deleteOnTermination()

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

Returns:

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

description

public String description()

The description of the network interface. Applies only if creating a network interface when launching an instance.

Returns:

The description of the network interface. Applies only if creating a network interface when launching an instance.

deviceIndex

public Integer deviceIndex()

The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.

Returns:

The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.

groups

public List<String> groups()

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

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

Returns:

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

ipv6AddressCount

public Integer ipv6AddressCount()

A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.

Returns:

A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.

ipv6Addresses

public List<InstanceIpv6Address> ipv6Addresses()

One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

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

Returns:

One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

networkInterfaceId

public String networkInterfaceId()

The ID of the network interface.

Returns:

The ID of the network interface.

privateIpAddress

public String privateIpAddress()

The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Returns:

The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.

privateIpAddresses

public List<PrivateIpAddressSpecification> privateIpAddresses()

One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.

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

Returns:

One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.

secondaryPrivateIpAddressCount

public Integer secondaryPrivateIpAddressCount()

The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Returns:

The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.

subnetId

public String subnetId()

The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.

Returns:

The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.

toBuilder

public InstanceNetworkInterfaceSpecification.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<InstanceNetworkInterfaceSpecification.Builder,InstanceNetworkInterfaceSpecification>

Returns:

a builder for type T

builder

public static InstanceNetworkInterfaceSpecification.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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