Class ModifyInstanceMaintenanceOptionsRequest

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.ModifyInstanceMaintenanceOptionsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ModifyInstanceMaintenanceOptionsRequest.Builder,ModifyInstanceMaintenanceOptionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyInstanceMaintenanceOptionsRequest extends Ec2Request implements ToCopyableBuilder<ModifyInstanceMaintenanceOptionsRequest.Builder,ModifyInstanceMaintenanceOptionsRequest>

  • Method Details

    • instanceId

      public final String instanceId()

      The ID of the instance.

      Returns:
      The ID of the instance.

    • autoRecovery

      public final InstanceAutoRecoveryState autoRecovery()

      Disables the automatic recovery behavior of your instance or sets it to default.

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

      Returns:
      Disables the automatic recovery behavior of your instance or sets it to default.
      See Also:

    • autoRecoveryAsString

      public final String autoRecoveryAsString()

      Disables the automatic recovery behavior of your instance or sets it to default.

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

      Returns:
      Disables the automatic recovery behavior of your instance or sets it to default.
      See Also:

    • rebootMigration

      public final InstanceRebootMigrationState rebootMigration()

      Specifies whether to attempt reboot migration during a user-initiated reboot of an instance that has a scheduled system-reboot event:

      • default - Amazon EC2 attempts to migrate the instance to new hardware (reboot migration). If successful, the system-reboot event is cleared. If unsuccessful, an in-place reboot occurs and the event remains scheduled.

      • disabled - Amazon EC2 keeps the instance on the same hardware (in-place reboot). The system-reboot event remains scheduled.

      This setting only applies to supported instances that have a scheduled reboot event. For more information, see Enable or disable reboot migration in the Amazon EC2 User Guide.

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

      Returns:
      Specifies whether to attempt reboot migration during a user-initiated reboot of an instance that has a scheduled system-reboot event:

      • default - Amazon EC2 attempts to migrate the instance to new hardware (reboot migration). If successful, the system-reboot event is cleared. If unsuccessful, an in-place reboot occurs and the event remains scheduled.

      • disabled - Amazon EC2 keeps the instance on the same hardware (in-place reboot). The system-reboot event remains scheduled.

      This setting only applies to supported instances that have a scheduled reboot event. For more information, see Enable or disable reboot migration in the Amazon EC2 User Guide.

      See Also:

    • rebootMigrationAsString

      public final String rebootMigrationAsString()

      Specifies whether to attempt reboot migration during a user-initiated reboot of an instance that has a scheduled system-reboot event:

      • default - Amazon EC2 attempts to migrate the instance to new hardware (reboot migration). If successful, the system-reboot event is cleared. If unsuccessful, an in-place reboot occurs and the event remains scheduled.

      • disabled - Amazon EC2 keeps the instance on the same hardware (in-place reboot). The system-reboot event remains scheduled.

      This setting only applies to supported instances that have a scheduled reboot event. For more information, see Enable or disable reboot migration in the Amazon EC2 User Guide.

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

      Returns:
      Specifies whether to attempt reboot migration during a user-initiated reboot of an instance that has a scheduled system-reboot event:

      • default - Amazon EC2 attempts to migrate the instance to new hardware (reboot migration). If successful, the system-reboot event is cleared. If unsuccessful, an in-place reboot occurs and the event remains scheduled.

      • disabled - Amazon EC2 keeps the instance on the same hardware (in-place reboot). The system-reboot event remains scheduled.

      This setting only applies to supported instances that have a scheduled reboot event. For more information, see Enable or disable reboot migration in the Amazon EC2 User Guide.

      See Also:

    • dryRun

      public final Boolean dryRun()

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Returns:
      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • toBuilder

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

    • builder

      public static ModifyInstanceMaintenanceOptionsRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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