LaunchTemplateInstanceNetworkInterfaceSpecificationRequest (AWS Java SDK :: Services

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

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

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

The parameters for a network interface.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface LaunchTemplateInstanceNetworkInterfaceSpecificationRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`associateCarrierIpAddress()` Associates a Carrier IP address with eth0 for a new network interface.
`Boolean`	`associatePublicIpAddress()` Associates a public IPv4 address with eth0 for a new network interface.
`static LaunchTemplateInstanceNetworkInterfaceSpecificationRequest.Builder`	`builder()`
`Boolean`	`deleteOnTermination()` Indicates whether the network interface is deleted when the instance is terminated.
`String`	`description()` A description for the network interface.
`Integer`	`deviceIndex()` The device index for the network interface attachment.
`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.
`String`	`interfaceType()` The type of network interface.
`Integer`	`ipv4PrefixCount()` The number of IPv4 prefixes to be automatically assigned to the network interface.
`List<Ipv4PrefixSpecificationRequest>`	`ipv4Prefixes()` One or more IPv4 prefixes to be assigned to the network interface.
`Integer`	`ipv6AddressCount()` The number of IPv6 addresses to assign to a network interface.
`List<InstanceIpv6AddressRequest>`	`ipv6Addresses()` One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet.
`Integer`	`ipv6PrefixCount()` The number of IPv6 prefixes to be automatically assigned to the network interface.
`List<Ipv6PrefixSpecificationRequest>`	`ipv6Prefixes()` One or more IPv6 prefixes to be assigned to the network interface.
`Integer`	`networkCardIndex()` The index of the network card.
`String`	`networkInterfaceId()` The ID of 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 LaunchTemplateInstanceNetworkInterfaceSpecificationRequest.Builder>`	`serializableBuilderClass()`
`String`	`subnetId()` The ID of the subnet for the network interface.
`LaunchTemplateInstanceNetworkInterfaceSpecificationRequest.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
  - associateCarrierIpAddress
```
public final Boolean associateCarrierIpAddress()
```
    Associates a Carrier IP address with eth0 for a new network interface.
    
    Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the Wavelength Developer Guide.
    
    Returns:
    
    Associates a Carrier IP address with eth0 for a new network interface.
    
    Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the Wavelength Developer Guide.
  - associatePublicIpAddress
```
public final Boolean associatePublicIpAddress()
```
    Associates a public IPv4 address with eth0 for a new network interface.
    
    Returns:
    
    Associates a public IPv4 address with eth0 for a new network interface.
  - deleteOnTermination
```
public final Boolean deleteOnTermination()
```
    Indicates whether the network interface is deleted when the instance is terminated.
    
    Returns:
    
    Indicates whether the network interface is deleted when the instance is terminated.
  - description
```
public final String description()
```
    A description for the network interface.
    
    Returns:
    
    A description for the network interface.
  - deviceIndex
```
public final Integer deviceIndex()
```
    The device index for the network interface attachment.
    
    Returns:
    
    The device index for the network interface attachment.
  - 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.
  - interfaceType
```
public final 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
  - 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.
    
    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.
  - 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<InstanceIpv6AddressRequest> 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.
  - networkInterfaceId
```
public final String networkInterfaceId()
```
    The ID of the network interface.
    
    Returns:
    
    The ID of the network interface.
  - privateIpAddress
```
public final String privateIpAddress()
```
    The primary private IPv4 address of the network interface.
    
    Returns:
    
    The primary private IPv4 address of the network interface.
  - 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.
    
    Returns:
    
    The number of secondary private IPv4 addresses to assign to a network interface.
  - subnetId
```
public final String subnetId()
```
    The ID of the subnet for the network interface.
    
    Returns:
    
    The ID of the subnet for the network interface.
  - networkCardIndex
```
public final Integer networkCardIndex()
```
    The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
    
    Returns:
    
    The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
  - 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 to be 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 to be 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 to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefix option.
    
    Returns:
    
    The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefix 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 to be 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 to be 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 to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.
    
    Returns:
    
    The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.
  - toBuilder
```
public LaunchTemplateInstanceNetworkInterfaceSpecificationRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<LaunchTemplateInstanceNetworkInterfaceSpecificationRequest.Builder,LaunchTemplateInstanceNetworkInterfaceSpecificationRequest>
  - builder
```
public static LaunchTemplateInstanceNetworkInterfaceSpecificationRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends LaunchTemplateInstanceNetworkInterfaceSpecificationRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class LaunchTemplateInstanceNetworkInterfaceSpecificationRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

associateCarrierIpAddress

associatePublicIpAddress

deleteOnTermination

description

deviceIndex

hasGroups

groups

interfaceType

ipv6AddressCount

hasIpv6Addresses

ipv6Addresses

networkInterfaceId

privateIpAddress

hasPrivateIpAddresses

privateIpAddresses

secondaryPrivateIpAddressCount

subnetId

networkCardIndex

hasIpv4Prefixes

ipv4Prefixes

ipv4PrefixCount

hasIpv6Prefixes

ipv6Prefixes

ipv6PrefixCount

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields