Skip to content

StopInstanceRequest

Source code in docs_src/capo_lightsail/types/stop_instance_request.py 
14
15
16
17
18
class StopInstanceRequest(TypedDict, closed=True):
    instance_name: "capo_lightsail.types.resource_name.ResourceName"
    """<p>The name of the instance (a virtual private server) to stop.</p>"""
    force: NotRequired["capo_lightsail.types.boolean.boolean"]
    """<p>When set to <code>True</code>, forces a Lightsail instance that is stuck in a <code>stopping</code> state to stop.</p> <important> <p>Only use the <code>force</code> parameter if your instance is stuck in the <code>stopping</code> state. In any other state, your instance should stop normally without adding this parameter to your API request.</p> </important>"""

force instance-attribute 

force: NotRequired[boolean]

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.

instance_name instance-attribute 

instance_name: ResourceName

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