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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dry_run ⇒ Boolean

Checks whether you have the required permissions for the operation, 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) 

68409
68410
68411
68412
68413
68414
68415
68416
 
# File 'lib/aws-sdk-ec2/types.rb', line 68409

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

68409
68410
68411
68412
68413
68414
68415
68416
 
# File 'lib/aws-sdk-ec2/types.rb', line 68409

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

Default: ‘false`

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

Returns:

  • (Boolean) 

68409
68410
68411
68412
68413
68414
68415
68416
 
# File 'lib/aws-sdk-ec2/types.rb', line 68409

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

#instance_ids ⇒ Array<String>

The IDs of the instances.

Returns:

  • (Array<String>) 

68409
68410
68411
68412
68413
68414
68415
68416
 
# File 'lib/aws-sdk-ec2/types.rb', line 68409

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