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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

Note:

When making an API call, you may pass StopInstanceRequest data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#forceBoolean

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)


4333
4334
4335
4336
4337
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4333

class StopInstanceRequest < Struct.new(
  :instance_name,
  :force)
  include Aws::Structure
end

#instance_nameString

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

Returns:

  • (String)


4333
4334
4335
4336
4337
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4333

class StopInstanceRequest < Struct.new(
  :instance_name,
  :force)
  include Aws::Structure
end