You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:

Struct

Object
Struct
Aws::OpsWorks::Types::StopInstanceRequest

show all

Defined in:: (unknown)

Overview

Note:

When passing StopInstanceRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

Instance Attribute Summary collapse

#force ⇒ Boolean
Specifies whether to force an instance to stop.
#instance_id ⇒ String
The instance ID.

Instance Attribute Details

#force ⇒ `Boolean`

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) —
Specifies whether to force an instance to stop.

#instance_id ⇒ `String`

The instance ID.