Class: Aws::Lightsail::Types::Instance

Inherits:

Struct

• Object
• Struct
• Aws::Lightsail::Types::Instance

Defined in:

gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

Describes an instance (a virtual private server).

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #add_ons ⇒ Array<Types::AddOn>

  An array of objects representing the add-ons enabled on the instance.

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the instance (arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).

• #blueprint_id ⇒ String

  The blueprint ID (amazon_linux_2023).

• #blueprint_name ⇒ String

  The friendly name of the blueprint (Amazon Linux 2023).

• #bundle_id ⇒ String

  The bundle for the instance (micro_x_x).

• #created_at ⇒ Time

  The timestamp when the instance was created (1479734909.17) in Unix time format.

• #hardware ⇒ Types::InstanceHardware

  The size of the vCPU and the amount of RAM for the instance.

• #instance_status ⇒ Types::InstanceHealthStatus

  Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

• #ip_address_type ⇒ String

  The IP address type of the instance.

• #ipv6_addresses ⇒ Array<String>

  The IPv6 addresses of the instance.

• #is_static_ip ⇒ Boolean

  A Boolean value indicating whether this instance has a static IP assigned to it.

• #location ⇒ Types::ResourceLocation

  The region name and Availability Zone where the instance is located.

• #metadata_options ⇒ Types::InstanceMetadataOptions

  The metadata options for the Amazon Lightsail instance.

• #name ⇒ String

  The name the user gave the instance (Amazon_Linux_2023-1).

• #networking ⇒ Types::InstanceNetworking

  Information about the public ports and monthly data transfer rates for the instance.

• #private_ip_address ⇒ String

  The private IP address of the instance.

• #public_ip_address ⇒ String

  The public IP address of the instance.

• #resource_type ⇒ String

  The type of resource (usually Instance).

• #ssh_key_name ⇒ String

  The name of the SSH key being used to connect to the instance (LightsailDefaultKeyPair).

• #state ⇒ Types::InstanceState

  The status code and the state (running) for the instance.

• #support_code ⇒ String

  The support code.

• #system_status ⇒ Types::InstanceHealthStatus

  Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

• #tags ⇒ Array<Types::Tag>

  The tag keys and optional values for the resource.

• #username ⇒ String

  The user name for connecting to the instance (ec2-user).

Instance Attribute Details

#add_ons ⇒ Array<Types::AddOn>

An array of objects representing the add-ons enabled on the instance.

Returns:

• (Array<Types::AddOn>)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) of the instance (arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#blueprint_id ⇒ String

The blueprint ID (amazon_linux_2023).

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#blueprint_name ⇒ String

The friendly name of the blueprint (Amazon Linux 2023).

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#bundle_id ⇒ String

The bundle for the instance (micro_x_x).

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The timestamp when the instance was created (1479734909.17) in Unix time format.

Returns:

• (Time)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#hardware ⇒ Types::InstanceHardware

The size of the vCPU and the amount of RAM for the instance.

Returns:

• (Types::InstanceHardware)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#instance_status ⇒ Types::InstanceHealthStatus

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

This value is returned only when you set includeHealthStatus to true in your request.

Returns:

• (Types::InstanceHealthStatus)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address_type ⇒ String

The IP address type of the instance.

The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#ipv6_addresses ⇒ Array<String>

The IPv6 addresses of the instance.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#is_static_ip ⇒ Boolean

A Boolean value indicating whether this instance has a static IP assigned to it.

Returns:

• (Boolean)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#location ⇒ Types::ResourceLocation

The region name and Availability Zone where the instance is located.

Returns:

• (Types::ResourceLocation)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_options ⇒ Types::InstanceMetadataOptions

The metadata options for the Amazon Lightsail instance.

Returns:

• (Types::InstanceMetadataOptions)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name the user gave the instance (Amazon_Linux_2023-1).

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#networking ⇒ Types::InstanceNetworking

Information about the public ports and monthly data transfer rates for the instance.

Returns:

• (Types::InstanceNetworking)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#private_ip_address ⇒ String

The private IP address of the instance.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#public_ip_address ⇒ String

The public IP address of the instance.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

The type of resource (usually Instance).

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#ssh_key_name ⇒ String

The name of the SSH key being used to connect to the instance (LightsailDefaultKeyPair).

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ Types::InstanceState

The status code and the state (running) for the instance.

Returns:

• (Types::InstanceState)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#support_code ⇒ String

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#system_status ⇒ Types::InstanceHealthStatus

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

This value is returned only when you set includeHealthStatus to true in your request.

Returns:

• (Types::InstanceHealthStatus)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end

#username ⇒ String

The user name for connecting to the instance (ec2-user).

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10388

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :add_ons,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_addresses,
  :ip_address_type,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name,
  :metadata_options,
  :instance_status,
  :system_status)
  SENSITIVE = []
  include Aws::Structure
end