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) 


70642
70643
70644
70645
70646
70647
70648
70649
 
# File 'lib/aws-sdk-ec2/types.rb', line 70642

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

#force ⇒ Boolean

Forces the instance to stop. The instance will first attempt a graceful shutdown, which includes flushing file system caches and metadata. If the graceful shutdown fails to complete within the timeout period, the instance shuts down forcibly without flushing the file system caches and metadata.

After using this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. For more information, see [Troubleshoot Amazon EC2 instance stop issues] in the *Amazon EC2 User Guide*.

Default: ‘false`

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

Returns:

  • (Boolean) 


70642
70643
70644
70645
70646
70647
70648
70649
 
# File 'lib/aws-sdk-ec2/types.rb', line 70642

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) 


70642
70643
70644
70645
70646
70647
70648
70649
 
# File 'lib/aws-sdk-ec2/types.rb', line 70642

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


70642
70643
70644
70645
70646
70647
70648
70649
 
# File 'lib/aws-sdk-ec2/types.rb', line 70642

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