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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass StopInstancesRequest data as a hash:

{
  instance_ids: ["String"], # 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) 


35223
35224
35225
35226
35227
35228
35229
 
# File 'lib/aws-sdk-ec2/types.rb', line 35223

class StopInstancesRequest < Struct.new(
  :instance_ids,
  :hibernate,
  :dry_run,
  :force)
  include Aws::Structure
end

#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) 


35223
35224
35225
35226
35227
35228
35229
 
# File 'lib/aws-sdk-ec2/types.rb', line 35223

class StopInstancesRequest < Struct.new(
  :instance_ids,
  :hibernate,
  :dry_run,
  :force)
  include Aws::Structure
end

#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`

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html

Returns:

  • (Boolean) 


35223
35224
35225
35226
35227
35228
35229
 
# File 'lib/aws-sdk-ec2/types.rb', line 35223

class StopInstancesRequest < Struct.new(
  :instance_ids,
  :hibernate,
  :dry_run,
  :force)
  include Aws::Structure
end

#instance_ids ⇒ Array<String>

One or more instance IDs.

Returns:

  • (Array<String>) 


35223
35224
35225
35226
35227
35228
35229
 
# File 'lib/aws-sdk-ec2/types.rb', line 35223

class StopInstancesRequest < Struct.new(
  :instance_ids,
  :hibernate,
  :dry_run,
  :force)
  include Aws::Structure
end