Package software.amazon.awssdk.services.ec2.model

Class LaunchTemplateInstanceNetworkInterfaceSpecificationRequest

java.lang.Object
software.amazon.awssdk.services.ec2.model.LaunchTemplateInstanceNetworkInterfaceSpecificationRequest
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LaunchTemplateInstanceNetworkInterfaceSpecificationRequest.Builder,LaunchTemplateInstanceNetworkInterfaceSpecificationRequest>
@Generated("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:

  • Method Details

    • 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.

      Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.

      Returns:
      Associates a public IPv4 address with eth0 for a new network interface.

      Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.

    • 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. Each network interface requires a device index. If you create a launch template that includes secondary network interfaces but not a primary network interface, then you must add a primary network interface as a launch parameter when you launch an instance from the template.

      Returns:
      The device index for the network interface attachment. Each network interface requires a device index. If you create a launch template that includes secondary network interfaces but not a primary network interface, then you must add a primary network interface as a launch parameter when you launch an instance from the template.

    • 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.

    • primaryIpv6

      public final Boolean primaryIpv6()

      The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances.

      Returns:
      The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances.

    • enaSrdSpecification

      public final EnaSrdSpecificationRequest enaSrdSpecification()

      Configure ENA Express settings for your launch template.

      Returns:
      Configure ENA Express settings for your launch template.

    • connectionTrackingSpecification

      public final ConnectionTrackingSpecificationRequest connectionTrackingSpecification()

      A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.

      Returns:
      A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.

    • toBuilder

      public LaunchTemplateInstanceNetworkInterfaceSpecificationRequest.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<LaunchTemplateInstanceNetworkInterfaceSpecificationRequest.Builder,LaunchTemplateInstanceNetworkInterfaceSpecificationRequest>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.