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
  dry_run: false,
  force: false,
}

Contains the parameters for StopInstances.

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) 


23631
23632
23633
23634
23635
23636
 
# File 'lib/aws-sdk-ec2/types.rb', line 23631

class StopInstancesRequest < Struct.new(
  :instance_ids,
  :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) 


23631
23632
23633
23634
23635
23636
 
# File 'lib/aws-sdk-ec2/types.rb', line 23631

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

#instance_ids ⇒ Array<String>

One or more instance IDs.

Returns:

  • (Array<String>) 


23631
23632
23633
23634
23635
23636
 
# File 'lib/aws-sdk-ec2/types.rb', line 23631

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