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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

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)


63114
63115
63116
63117
63118
63119
63120
63121
# File 'lib/aws-sdk-ec2/types.rb', line 63114

class StopInstancesRequest < Struct.new(
  :instance_ids,
  :hibernate,
  :dry_run,
  :force)
  SENSITIVE = []
  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)


63114
63115
63116
63117
63118
63119
63120
63121
# File 'lib/aws-sdk-ec2/types.rb', line 63114

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

#hibernateBoolean

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 EC2 User Guide*.

Default: ‘false`

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

Returns:

  • (Boolean)


63114
63115
63116
63117
63118
63119
63120
63121
# File 'lib/aws-sdk-ec2/types.rb', line 63114

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

#instance_idsArray<String>

The IDs of the instances.

Returns:

  • (Array<String>)


63114
63115
63116
63117
63118
63119
63120
63121
# File 'lib/aws-sdk-ec2/types.rb', line 63114

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