EC2 / Client / modify_instance_maintenance_options

modify_instance_maintenance_options

EC2.Client.modify_instance_maintenance_options(**kwargs)

Modifies the recovery behavior of your instance to disable simplified automatic recovery or set the recovery behavior to default. The default configuration will not enable simplified automatic recovery for an unsupported instance type. For more information, see Simplified automatic recovery.

Modifies the reboot migration behavior during a user-initiated reboot of an instance that has a pending system-reboot event. For more information, see Enable or disable reboot migration.

See also: AWS API Documentation

Request Syntax

response = client.modify_instance_maintenance_options(
    InstanceId='string',
    AutoRecovery='disabled'|'default',
    RebootMigration='disabled'|'default',
    DryRun=True|False
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The ID of the instance.

  • AutoRecovery (string) – Disables the automatic recovery behavior of your instance or sets it to default.

  • RebootMigration (string) –

    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.

  • DryRun (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'InstanceId': 'string',
    'AutoRecovery': 'disabled'|'default',
    'RebootMigration': 'disabled'|'default'
}

Response Structure

  • (dict) –

    • InstanceId (string) –

      The ID of the instance.

    • AutoRecovery (string) –

      Provides information on the current automatic recovery behavior of your instance.

    • RebootMigration (string) –

      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.