Class ScheduledInstancesNetworkInterface

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

Describes a network interface for a Scheduled Instance.

See Also:

  • Method Details

    • associatePublicIpAddress

      public final Boolean associatePublicIpAddress()

      Indicates whether to assign a public IPv4 address to instances launched in a VPC. The public IPv4 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.

      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:
      Indicates whether to assign a public IPv4 address to instances launched in a VPC. The public IPv4 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.

      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 to delete the interface when the instance is terminated.

      Returns:
      Indicates whether to delete the interface when the instance is terminated.

    • description

      public final String description()

      The description.

      Returns:
      The description.

    • deviceIndex

      public final Integer deviceIndex()

      The index of the device for the network interface attachment.

      Returns:
      The index of the device 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 the 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 the security groups.

    • ipv6AddressCount

      public final Integer ipv6AddressCount()

      The number of IPv6 addresses to assign to the network interface. The IPv6 addresses are automatically selected from the subnet range.

      Returns:
      The number of IPv6 addresses to assign to the network interface. The IPv6 addresses are automatically selected from the subnet range.

    • 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<ScheduledInstancesIpv6Address> ipv6Addresses()

      The specific IPv6 addresses from the subnet range.

      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:
      The specific IPv6 addresses from the subnet range.

    • networkInterfaceId

      public final String networkInterfaceId()

      The ID of the network interface.

      Returns:
      The ID of the network interface.

    • privateIpAddress

      public final String privateIpAddress()

      The IPv4 address of the network interface within the subnet.

      Returns:
      The IPv4 address of the network interface within the subnet.

    • hasPrivateIpAddressConfigs

      public final boolean hasPrivateIpAddressConfigs()
      For responses, this returns true if the service returned a value for the PrivateIpAddressConfigs 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.

    • privateIpAddressConfigs

      public final List<ScheduledInstancesPrivateIpAddressConfig> privateIpAddressConfigs()

      The 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 hasPrivateIpAddressConfigs() method.

      Returns:
      The private IPv4 addresses.

    • secondaryPrivateIpAddressCount

      public final Integer secondaryPrivateIpAddressCount()

      The number of secondary private IPv4 addresses.

      Returns:
      The number of secondary private IPv4 addresses.

    • subnetId

      public final String subnetId()

      The ID of the subnet.

      Returns:
      The ID of the subnet.

    • toBuilder

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

    • builder

      public static ScheduledInstancesNetworkInterface.Builder builder()

    • serializableBuilderClass

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