/AWS1/CL_LSA=>STOPINSTANCE()
¶
About StopInstance¶
Stops a specific Amazon Lightsail instance that is currently running.
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 Amazon Lightsail Developer Guide.
The stop instance
operation supports tag-based access control via resource
tags applied to the resource identified by instance name
. For more information,
see the Amazon Lightsail Developer Guide.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_INSTANCENAME
TYPE /AWS1/LSARESOURCENAME
/AWS1/LSARESOURCENAME
¶
The name of the instance (a virtual private server) to stop.
Optional arguments:¶
IV_FORCE
TYPE /AWS1/LSABOOLEAN
/AWS1/LSABOOLEAN
¶
When set to
True
, forces a Lightsail instance that is stuck in astopping
state to stop.Only use the
force
parameter if your instance is stuck in thestopping
state. In any other state, your instance should stop normally without adding this parameter to your API request.