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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/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.

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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)


23589
23590
23591
23592
23593
23594
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23589

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

#forceBoolean

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)


23589
23590
23591
23592
23593
23594
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23589

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

#instance_idsArray<String>

One or more instance IDs.

Returns:

  • (Array<String>)


23589
23590
23591
23592
23593
23594
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23589

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