paws.compute (version 0.1.0)

lightsail_stop_instance: Stops a specific Amazon Lightsail instance that is currently running

Description

Stops a specific Amazon Lightsail instance that is currently running.

Usage

lightsail_stop_instance(instanceName, force)

Arguments

instanceName

[required] The name of the instance (a virtual private server) to stop.

force

When set to True, forces a Lightsail instance that is stuck in a stopping state to stop.

Only use the force parameter if your instance is stuck in the stopping state. In any other state, your instance should stop normally without adding this parameter to your API request.

Request syntax

svc$stop_instance(
  instanceName = "string",
  force = TRUE|FALSE
)

Details

When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide.

The stop instance operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.