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

Class ModifyHostsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ec2.model.Ec2Request
software.amazon.awssdk.services.ec2.model.ModifyHostsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ModifyHostsRequest.Builder,ModifyHostsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyHostsRequest extends Ec2Request implements ToCopyableBuilder<ModifyHostsRequest.Builder,ModifyHostsRequest>

  • Method Details

    • autoPlacement

      public final AutoPlacement autoPlacement()

      Specify whether to enable or disable auto-placement.

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

      Returns:
      Specify whether to enable or disable auto-placement.
      See Also:

    • autoPlacementAsString

      public final String autoPlacementAsString()

      Specify whether to enable or disable auto-placement.

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

      Returns:
      Specify whether to enable or disable auto-placement.
      See Also:

    • hasHostIds

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

    • hostIds

      public final List<String> hostIds()

      The IDs of the Dedicated Hosts to modify.

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

      Returns:
      The IDs of the Dedicated Hosts to modify.

    • hostRecovery

      public final HostRecovery hostRecovery()

      Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see Host recovery in the Amazon EC2 User Guide.

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

      Returns:
      Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see Host recovery in the Amazon EC2 User Guide.
      See Also:

    • hostRecoveryAsString

      public final String hostRecoveryAsString()

      Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see Host recovery in the Amazon EC2 User Guide.

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

      Returns:
      Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see Host recovery in the Amazon EC2 User Guide.
      See Also:

    • instanceType

      public final String instanceType()

      Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support only a specific instance type.

      If you want to modify a Dedicated Host to support multiple instance types in its current instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.

      Returns:
      Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support only a specific instance type.

      If you want to modify a Dedicated Host to support multiple instance types in its current instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.

    • instanceFamily

      public final String instanceFamily()

      Specifies the instance family to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support multiple instance types within its current instance family.

      If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.

      Returns:
      Specifies the instance family to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support multiple instance types within its current instance family.

      If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.

    • hostMaintenance

      public final HostMaintenance hostMaintenance()

      Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.

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

      Returns:
      Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.
      See Also:

    • hostMaintenanceAsString

      public final String hostMaintenanceAsString()

      Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.

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

      Returns:
      Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.
      See Also:

    • toBuilder

      public ModifyHostsRequest.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<ModifyHostsRequest.Builder,ModifyHostsRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • builder

      public static ModifyHostsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModifyHostsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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