opsworks_stop_instance: Stops a specified instance

Description Usage Arguments Value Request syntax

View source: R/opsworks_operations.R

Description

Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Usage

1
opsworks_stop_instance(InstanceId, Force)

Arguments

InstanceId

[required] The instance ID.

Force

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.

Value

An empty list.

Request syntax

1
2
3
4
svc$stop_instance(
  InstanceId = "string",
  Force = TRUE|FALSE
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.