You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EC2::Types::StopInstancesRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StopInstancesRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  instance_ids: ["InstanceId"], # required
  hibernate: false,
  dry_run: false,
  force: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#dry_run ⇒ 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.

Returns:

  • (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

#force ⇒ Boolean

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

Returns:

  • (Boolean) —

    Forces the instances to stop.

#hibernate ⇒ Boolean

Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.

Default: false

Returns:

  • (Boolean) —

    Hibernates the instance if the instance was enabled for hibernation at launch.

#instance_ids ⇒ Array<String>

The IDs of the instances.

Returns:

  • (Array<String>) —

    The IDs of the instances.