Class InstanceSecondaryInterfaceSpecificationRequest

java.lang.Object
software.amazon.awssdk.services.ec2.model.InstanceSecondaryInterfaceSpecificationRequest
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InstanceSecondaryInterfaceSpecificationRequest.Builder,InstanceSecondaryInterfaceSpecificationRequest>
@Generated("software.amazon.awssdk:codegen") public final class InstanceSecondaryInterfaceSpecificationRequest extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InstanceSecondaryInterfaceSpecificationRequest.Builder,InstanceSecondaryInterfaceSpecificationRequest>

Describes a secondary interface specification for launching an instance.

See Also:

  • Method Details

    • deleteOnTermination

      public final Boolean deleteOnTermination()

      Indicates whether the secondary interface is deleted when the instance is terminated.

      The only supported value for this field is true.

      Returns:
      Indicates whether the secondary interface is deleted when the instance is terminated.

      The only supported value for this field is true.

    • deviceIndex

      public final Integer deviceIndex()

      The device index for the secondary interface attachment.

      Returns:
      The device index for the secondary interface attachment.

    • 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<InstanceSecondaryInterfacePrivateIpAddressRequest> privateIpAddresses()

      The private IPv4 addresses to assign to the secondary interface.

      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:
      The private IPv4 addresses to assign to the secondary interface.

    • privateIpAddressCount

      public final Integer privateIpAddressCount()

      The number of private IPv4 addresses to assign to the secondary interface.

      Returns:
      The number of private IPv4 addresses to assign to the secondary interface.

    • secondarySubnetId

      public final String secondarySubnetId()

      The ID of the secondary subnet.

      Returns:
      The ID of the secondary subnet.

    • interfaceType

      public final SecondaryInterfaceType interfaceType()

      The type of secondary interface.

      If the service returns an enum value that is not available in the current SDK version, interfaceType will return SecondaryInterfaceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from interfaceTypeAsString().

      Returns:
      The type of secondary interface.
      See Also:

    • interfaceTypeAsString

      public final String interfaceTypeAsString()

      The type of secondary interface.

      If the service returns an enum value that is not available in the current SDK version, interfaceType will return SecondaryInterfaceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from interfaceTypeAsString().

      Returns:
      The type of secondary interface.
      See Also:

    • networkCardIndex

      public final Integer networkCardIndex()

      The index of the network card. The network card must support secondary interfaces.

      Returns:
      The index of the network card. The network card must support secondary interfaces.

    • toBuilder

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

    • builder

      public static InstanceSecondaryInterfaceSpecificationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InstanceSecondaryInterfaceSpecificationRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.