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

Class: Aws::Lightsail::Types::StopInstanceRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

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

{
  instance_name: "ResourceName", # required
  force: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#force ⇒ 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.

Returns:

  • (Boolean) —

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

#instance_name ⇒ String

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

Returns:

  • (String) —

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