InstanceNetworkInterfaceSpecification (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ec2.model.InstanceNetworkInterfaceSpecification

All Implemented Interfaces:

Serializable
```
public class InstanceNetworkInterfaceSpecification
extends Object
implements Serializable
```
Instance Network Interface Specification

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

InstanceNetworkInterfaceSpecification()

Constructors
Constructor and Description
`InstanceNetworkInterfaceSpecification()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Boolean`	`getAssociatePublicIpAddress()` Indicates whether to assign a public IP address to an instance in a VPC.
`Boolean`	`getDeleteOnTermination()` Returns the value of the DeleteOnTermination property for this object.
`String`	`getDescription()` A description.
`Integer`	`getDeviceIndex()` The device index.
`List<String>`	`getGroups()` Returns the value of the Groups property for this object.
`String`	`getNetworkInterfaceId()` An existing interface to attach to a single instance.
`String`	`getPrivateIpAddress()` The primary private IP address.
`List<PrivateIpAddressSpecification>`	`getPrivateIpAddresses()` Returns the value of the PrivateIpAddresses property for this object.
`Integer`	`getSecondaryPrivateIpAddressCount()` Returns the value of the SecondaryPrivateIpAddressCount property for this object.
`String`	`getSubnetId()` The subnet ID.
`int`	`hashCode()`
`Boolean`	`isAssociatePublicIpAddress()` Indicates whether to assign a public IP address to an instance in a VPC.
`Boolean`	`isDeleteOnTermination()` Returns the value of the DeleteOnTermination property for this object.
`void`	`setAssociatePublicIpAddress(Boolean associatePublicIpAddress)` Indicates whether to assign a public IP address to an instance in a VPC.
`void`	`setDeleteOnTermination(Boolean deleteOnTermination)` Sets the value of the DeleteOnTermination property for this object.
`void`	`setDescription(String description)` A description.
`void`	`setDeviceIndex(Integer deviceIndex)` The device index.
`void`	`setGroups(Collection<String> groups)` Sets the value of the Groups property for this object.
`void`	`setNetworkInterfaceId(String networkInterfaceId)` An existing interface to attach to a single instance.
`void`	`setPrivateIpAddress(String privateIpAddress)` The primary private IP address.
`void`	`setPrivateIpAddresses(Collection<PrivateIpAddressSpecification> privateIpAddresses)` Sets the value of the PrivateIpAddresses property for this object.
`void`	`setSecondaryPrivateIpAddressCount(Integer secondaryPrivateIpAddressCount)` Sets the value of the SecondaryPrivateIpAddressCount property for this object.
`void`	`setSubnetId(String subnetId)` The subnet ID.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`InstanceNetworkInterfaceSpecification`	`withAssociatePublicIpAddress(Boolean associatePublicIpAddress)` Indicates whether to assign a public IP address to an instance in a VPC.
`InstanceNetworkInterfaceSpecification`	`withDeleteOnTermination(Boolean deleteOnTermination)` Sets the value of the DeleteOnTermination property for this object.
`InstanceNetworkInterfaceSpecification`	`withDescription(String description)` A description.
`InstanceNetworkInterfaceSpecification`	`withDeviceIndex(Integer deviceIndex)` The device index.
`InstanceNetworkInterfaceSpecification`	`withGroups(Collection<String> groups)` Sets the value of the Groups property for this object.
`InstanceNetworkInterfaceSpecification`	`withGroups(String... groups)` Sets the value of the Groups property for this object.
`InstanceNetworkInterfaceSpecification`	`withNetworkInterfaceId(String networkInterfaceId)` An existing interface to attach to a single instance.
`InstanceNetworkInterfaceSpecification`	`withPrivateIpAddress(String privateIpAddress)` The primary private IP address.
`InstanceNetworkInterfaceSpecification`	`withPrivateIpAddresses(Collection<PrivateIpAddressSpecification> privateIpAddresses)` Sets the value of the PrivateIpAddresses property for this object.
`InstanceNetworkInterfaceSpecification`	`withPrivateIpAddresses(PrivateIpAddressSpecification... privateIpAddresses)` Sets the value of the PrivateIpAddresses property for this object.
`InstanceNetworkInterfaceSpecification`	`withSecondaryPrivateIpAddressCount(Integer secondaryPrivateIpAddressCount)` Sets the value of the SecondaryPrivateIpAddressCount property for this object.
`InstanceNetworkInterfaceSpecification`	`withSubnetId(String subnetId)` The subnet ID.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - InstanceNetworkInterfaceSpecification
```
public InstanceNetworkInterfaceSpecification()
```
- Method Detail
  - getNetworkInterfaceId
```
public String getNetworkInterfaceId()
```
    An existing interface to attach to a single instance. Requires n=1 instances.
    
    Returns:
    An existing interface to attach to a single instance. Requires n=1 instances.
  - setNetworkInterfaceId
```
public void setNetworkInterfaceId(String networkInterfaceId)
```
    An existing interface to attach to a single instance. Requires n=1 instances.
    
    Parameters:
    networkInterfaceId - An existing interface to attach to a single instance. Requires n=1 instances.
  - withNetworkInterfaceId
```
public InstanceNetworkInterfaceSpecification withNetworkInterfaceId(String networkInterfaceId)
```
    An existing interface to attach to a single instance. Requires n=1 instances.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    networkInterfaceId - An existing interface to attach to a single instance. Requires n=1 instances.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDeviceIndex
```
public Integer getDeviceIndex()
```
    The device index. Applies to both attaching an existing network interface and when creating a network interface.
    Condition: If you are specifying a network interface in the request, you must provide the device index.
    
    Returns:
    The device index. Applies to both attaching an existing network interface and when creating a network interface.
    Condition: If you are specifying a network interface in the request, you must provide the device index.
  - setDeviceIndex
```
public void setDeviceIndex(Integer deviceIndex)
```
    The device index. Applies to both attaching an existing network interface and when creating a network interface.
    Condition: If you are specifying a network interface in the request, you must provide the device index.
    
    Parameters:
    deviceIndex - The device index. Applies to both attaching an existing network interface and when creating a network interface.
    Condition: If you are specifying a network interface in the request, you must provide the device index.
  - withDeviceIndex
```
public InstanceNetworkInterfaceSpecification withDeviceIndex(Integer deviceIndex)
```
    The device index. Applies to both attaching an existing network interface and when creating a network interface.
    Condition: If you are specifying a network interface in the request, you must provide the device index.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    deviceIndex - The device index. Applies to both attaching an existing network interface and when creating a network interface.
    Condition: If you are specifying a network interface in the request, you must provide the device index.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSubnetId
```
public String getSubnetId()
```
    The subnet ID. Applies only when creating a network interface.
    
    Returns:
    The subnet ID. Applies only when creating a network interface.
  - setSubnetId
```
public void setSubnetId(String subnetId)
```
    The subnet ID. Applies only when creating a network interface.
    
    Parameters:
    subnetId - The subnet ID. Applies only when creating a network interface.
  - withSubnetId
```
public InstanceNetworkInterfaceSpecification withSubnetId(String subnetId)
```
    The subnet ID. Applies only when creating a network interface.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    subnetId - The subnet ID. Applies only when creating a network interface.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDescription
```
public String getDescription()
```
    A description. Applies only when creating a network interface.
    
    Returns:
    A description. Applies only when creating a network interface.
  - setDescription
```
public void setDescription(String description)
```
    A description. Applies only when creating a network interface.
    
    Parameters:
    description - A description. Applies only when creating a network interface.
  - withDescription
```
public InstanceNetworkInterfaceSpecification withDescription(String description)
```
    A description. Applies only when creating a network interface.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    description - A description. Applies only when creating a network interface.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getPrivateIpAddress
```
public String getPrivateIpAddress()
```
    The primary private IP address. Applies only when creating a network interface. Requires n=1 network interfaces in launch.
    
    Returns:
    The primary private IP address. Applies only when creating a network interface. Requires n=1 network interfaces in launch.
  - setPrivateIpAddress
```
public void setPrivateIpAddress(String privateIpAddress)
```
    The primary private IP address. Applies only when creating a network interface. Requires n=1 network interfaces in launch.
    
    Parameters:
    privateIpAddress - The primary private IP address. Applies only when creating a network interface. Requires n=1 network interfaces in launch.
  - withPrivateIpAddress
```
public InstanceNetworkInterfaceSpecification withPrivateIpAddress(String privateIpAddress)
```
    The primary private IP address. Applies only when creating a network interface. Requires n=1 network interfaces in launch.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    privateIpAddress - The primary private IP address. Applies only when creating a network interface. Requires n=1 network interfaces in launch.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getGroups
```
public List<String> getGroups()
```
    Returns the value of the Groups property for this object.
    
    Returns:
    The value of the Groups property for this object.
  - setGroups
```
public void setGroups(Collection<String> groups)
```
    Sets the value of the Groups property for this object.
    
    Parameters:
    groups - The new value for the Groups property for this object.
  - withGroups
```
public InstanceNetworkInterfaceSpecification withGroups(String... groups)
```
    Sets the value of the Groups property for this object.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    groups - The new value for the Groups property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withGroups
```
public InstanceNetworkInterfaceSpecification withGroups(Collection<String> groups)
```
    Sets the value of the Groups property for this object.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    groups - The new value for the Groups property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - isDeleteOnTermination
```
public Boolean isDeleteOnTermination()
```
    Returns the value of the DeleteOnTermination property for this object.
    
    Returns:
    The value of the DeleteOnTermination property for this object.
  - setDeleteOnTermination
```
public void setDeleteOnTermination(Boolean deleteOnTermination)
```
    Sets the value of the DeleteOnTermination property for this object.
    
    Parameters:
    deleteOnTermination - The new value for the DeleteOnTermination property for this object.
  - withDeleteOnTermination
```
public InstanceNetworkInterfaceSpecification withDeleteOnTermination(Boolean deleteOnTermination)
```
    Sets the value of the DeleteOnTermination property for this object.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    deleteOnTermination - The new value for the DeleteOnTermination property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDeleteOnTermination
```
public Boolean getDeleteOnTermination()
```
    Returns the value of the DeleteOnTermination property for this object.
    
    Returns:
    The value of the DeleteOnTermination property for this object.
  - getPrivateIpAddresses
```
public List<PrivateIpAddressSpecification> getPrivateIpAddresses()
```
    Returns the value of the PrivateIpAddresses property for this object.
    
    Returns:
    The value of the PrivateIpAddresses property for this object.
  - setPrivateIpAddresses
```
public void setPrivateIpAddresses(Collection<PrivateIpAddressSpecification> privateIpAddresses)
```
    Sets the value of the PrivateIpAddresses property for this object.
    
    Parameters:
    privateIpAddresses - The new value for the PrivateIpAddresses property for this object.
  - withPrivateIpAddresses
```
public InstanceNetworkInterfaceSpecification withPrivateIpAddresses(PrivateIpAddressSpecification... privateIpAddresses)
```
    Sets the value of the PrivateIpAddresses property for this object.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    privateIpAddresses - The new value for the PrivateIpAddresses property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withPrivateIpAddresses
```
public InstanceNetworkInterfaceSpecification withPrivateIpAddresses(Collection<PrivateIpAddressSpecification> privateIpAddresses)
```
    Sets the value of the PrivateIpAddresses property for this object.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    privateIpAddresses - The new value for the PrivateIpAddresses property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSecondaryPrivateIpAddressCount
```
public Integer getSecondaryPrivateIpAddressCount()
```
    Returns the value of the SecondaryPrivateIpAddressCount property for this object.
    
    Returns:
    The value of the SecondaryPrivateIpAddressCount property for this object.
  - setSecondaryPrivateIpAddressCount
```
public void setSecondaryPrivateIpAddressCount(Integer secondaryPrivateIpAddressCount)
```
    Sets the value of the SecondaryPrivateIpAddressCount property for this object.
    
    Parameters:
    secondaryPrivateIpAddressCount - The new value for the SecondaryPrivateIpAddressCount property for this object.
  - withSecondaryPrivateIpAddressCount
```
public InstanceNetworkInterfaceSpecification withSecondaryPrivateIpAddressCount(Integer secondaryPrivateIpAddressCount)
```
    Sets the value of the SecondaryPrivateIpAddressCount property for this object.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    secondaryPrivateIpAddressCount - The new value for the SecondaryPrivateIpAddressCount property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - isAssociatePublicIpAddress
```
public Boolean isAssociatePublicIpAddress()
```
    Indicates whether to assign a public IP address to an instance in a VPC. The public IP address is associated with a specific network interface. If set to true, the following rules apply:
    1. Can only be associated with a single network interface with the device index of 0. You can't associate a public IP address with a second network interface, and you can't associate a public IP address if you are launching more than one network interface.
    2. Can only be associated with a new network interface, not an existing one.
    Default: If launching into a default subnet, the default value is true. If launching into a nondefault subnet, the default value is false.
    Returns:
    Indicates whether to assign a public IP address to an instance in a VPC. The public IP address is associated with a specific network interface. If set to true, the following rules apply:
    
    Can only be associated with a single network interface with the device index of 0. You can't associate a public IP address with a second network interface, and you can't associate a public IP address if you are launching more than one network interface.
    
    Can only be associated with a new network interface, not an existing one.
    
    Default: If launching into a default subnet, the default value is true. If launching into a nondefault subnet, the default value is false.
  - setAssociatePublicIpAddress
```
public void setAssociatePublicIpAddress(Boolean associatePublicIpAddress)
```
    Indicates whether to assign a public IP address to an instance in a VPC. The public IP address is associated with a specific network interface. If set to true, the following rules apply:
    1. Can only be associated with a single network interface with the device index of 0. You can't associate a public IP address with a second network interface, and you can't associate a public IP address if you are launching more than one network interface.
    2. Can only be associated with a new network interface, not an existing one.
    Default: If launching into a default subnet, the default value is true. If launching into a nondefault subnet, the default value is false.
    Parameters:
    associatePublicIpAddress - Indicates whether to assign a public IP address to an instance in a VPC. The public IP address is associated with a specific network interface. If set to true, the following rules apply:
    
    Can only be associated with a single network interface with the device index of 0. You can't associate a public IP address with a second network interface, and you can't associate a public IP address if you are launching more than one network interface.
    
    Can only be associated with a new network interface, not an existing one.
    
    Default: If launching into a default subnet, the default value is true. If launching into a nondefault subnet, the default value is false.
  - withAssociatePublicIpAddress
```
public InstanceNetworkInterfaceSpecification withAssociatePublicIpAddress(Boolean associatePublicIpAddress)
```
    Indicates whether to assign a public IP address to an instance in a VPC. The public IP address is associated with a specific network interface. If set to true, the following rules apply:
    1. Can only be associated with a single network interface with the device index of 0. You can't associate a public IP address with a second network interface, and you can't associate a public IP address if you are launching more than one network interface.
    2. Can only be associated with a new network interface, not an existing one.
    Default: If launching into a default subnet, the default value is true. If launching into a nondefault subnet, the default value is false.
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    associatePublicIpAddress - Indicates whether to assign a public IP address to an instance in a VPC. The public IP address is associated with a specific network interface. If set to true, the following rules apply:
    
    Can only be associated with a single network interface with the device index of 0. You can't associate a public IP address with a second network interface, and you can't associate a public IP address if you are launching more than one network interface.
    
    Can only be associated with a new network interface, not an existing one.
    
    Default: If launching into a default subnet, the default value is true. If launching into a nondefault subnet, the default value is false.
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getAssociatePublicIpAddress
```
public Boolean getAssociatePublicIpAddress()
```
    Indicates whether to assign a public IP address to an instance in a VPC. The public IP address is associated with a specific network interface. If set to true, the following rules apply:
    1. Can only be associated with a single network interface with the device index of 0. You can't associate a public IP address with a second network interface, and you can't associate a public IP address if you are launching more than one network interface.
    2. Can only be associated with a new network interface, not an existing one.
    Default: If launching into a default subnet, the default value is true. If launching into a nondefault subnet, the default value is false.
    Returns:
    Indicates whether to assign a public IP address to an instance in a VPC. The public IP address is associated with a specific network interface. If set to true, the following rules apply:
    
    Can only be associated with a single network interface with the device index of 0. You can't associate a public IP address with a second network interface, and you can't associate a public IP address if you are launching more than one network interface.
    
    Can only be associated with a new network interface, not an existing one.
    
    Default: If launching into a default subnet, the default value is true. If launching into a nondefault subnet, the default value is false.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class InstanceNetworkInterfaceSpecification

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InstanceNetworkInterfaceSpecification

Method Detail

getNetworkInterfaceId

setNetworkInterfaceId

withNetworkInterfaceId

getDeviceIndex

setDeviceIndex

withDeviceIndex

getSubnetId

setSubnetId

withSubnetId

getDescription

setDescription

withDescription

getPrivateIpAddress

setPrivateIpAddress

withPrivateIpAddress

getGroups

setGroups

withGroups

withGroups

isDeleteOnTermination

setDeleteOnTermination

withDeleteOnTermination

getDeleteOnTermination

getPrivateIpAddresses

setPrivateIpAddresses

withPrivateIpAddresses

withPrivateIpAddresses

getSecondaryPrivateIpAddressCount

setSecondaryPrivateIpAddressCount

withSecondaryPrivateIpAddressCount

isAssociatePublicIpAddress

setAssociatePublicIpAddress

withAssociatePublicIpAddress

getAssociatePublicIpAddress

toString

hashCode

equals