InstanceNetworkInterfaceSpecification (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.ec2.model.InstanceNetworkInterfaceSpecification

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<InstanceNetworkInterfaceSpecification.Builder,InstanceNetworkInterfaceSpecification>

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

Describes a network interface.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface InstanceNetworkInterfaceSpecification.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`InstanceNetworkInterfaceSpecification.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 position of the network interface in the attachment order.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`List<String>`	`groups()` The IDs of the security groups for the network interface.
`boolean`	`hasGroups()` Returns true if the Groups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasIpv6Addresses()` Returns true if the Ipv6Addresses property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasPrivateIpAddresses()` Returns true if the PrivateIpAddresses property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`interfaceType()` The type of network interface.
`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.
`List<SdkField<?>>`	`sdkFields()`
`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 interface.
`InstanceNetworkInterfaceSpecification.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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
  - 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 position of the network interface in the attachment order. A primary network interface has a device index of 0.
    
    If you specify a network interface when launching an instance, you must specify the device index.
    
    Returns:
    
    The position of the network interface in the attachment order. A primary network interface has a device index of 0.
    
    If you specify a network interface when launching an instance, you must specify the device index.
  - hasGroups
```
public boolean hasGroups()
```
    Returns true if the Groups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasGroups() to see if a value was sent in this field.
    
    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.
  - hasIpv6Addresses
```
public boolean hasIpv6Addresses()
```
    Returns true if the Ipv6Addresses property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasIpv6Addresses() to see if a value was sent in this field.
    
    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.
    
    If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
    
    Returns:
    
    The ID of the network interface.
    
    If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
  - 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.
  - hasPrivateIpAddresses
```
public boolean hasPrivateIpAddresses()
```
    Returns true if the PrivateIpAddresses property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasPrivateIpAddresses() to see if a value was sent in this field.
    
    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 interface. Applies only if creating a network interface when launching an instance.
    
    Returns:
    
    The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
  - interfaceType
```
public String interfaceType()
```
    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 you are not creating an EFA, specify interface or omit this parameter.
    
    Valid values: interface | efa
    
    Returns:
    
    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 you are not creating an EFA, specify interface or omit this parameter.
    
    Valid values: interface | efa
  - toBuilder
```
public InstanceNetworkInterfaceSpecification.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<InstanceNetworkInterfaceSpecification.Builder,InstanceNetworkInterfaceSpecification>
  - 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
  - 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)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class InstanceNetworkInterfaceSpecification

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

associatePublicIpAddress

deleteOnTermination

description

deviceIndex

hasGroups

groups

ipv6AddressCount

hasIpv6Addresses

ipv6Addresses

networkInterfaceId

privateIpAddress

hasPrivateIpAddresses

privateIpAddresses

secondaryPrivateIpAddressCount

subnetId

interfaceType

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields