AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::OpsWorks::Types::StopInstanceRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb

Overview

Note:

When making an API call, you may pass StopInstanceRequest data as a hash:

{
  instance_id: "String", # required
  force: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#forceBoolean

Specifies whether to force an instance to stop. If the instance's root device type is ebs, or EBS-backed, adding the Force parameter to the StopInstances API call disassociates the AWS OpsWorks Stacks instance from EC2, and forces deletion of only the OpsWorks Stacks instance. You must also delete the formerly-associated instance in EC2 after troubleshooting and replacing the AWS OpsWorks Stacks instance with a new one.

Returns:

  • (Boolean)


6020
6021
6022
6023
6024
6025
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 6020

class StopInstanceRequest < Struct.new(
  :instance_id,
  :force)
  SENSITIVE = []
  include Aws::Structure
end

#instance_idString

The instance ID.

Returns:

  • (String)


6020
6021
6022
6023
6024
6025
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 6020

class StopInstanceRequest < Struct.new(
  :instance_id,
  :force)
  SENSITIVE = []
  include Aws::Structure
end