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: ["InstanceId"], # required
  hibernate: false,
  dry_run: false,
  force: false,
}

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)


54717
54718
54719
54720
54721
54722
54723
54724
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 54717

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)


54717
54718
54719
54720
54721
54722
54723
54724
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 54717

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

Returns:

  • (Boolean)


54717
54718
54719
54720
54721
54722
54723
54724
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 54717

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


54717
54718
54719
54720
54721
54722
54723
54724
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 54717

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