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

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

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

Overview

Describes an instance (a virtual private server).

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)


1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1905

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_address,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name)
  include Aws::Structure
end

#blueprint_idString

The blueprint ID (e.g., os_amlinux_2016_03).

Returns:

  • (String)


1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1905

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_address,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name)
  include Aws::Structure
end

#blueprint_nameString

The friendly name of the blueprint (e.g., Amazon Linux).

Returns:

  • (String)


1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1905

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_address,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name)
  include Aws::Structure
end

#bundle_idString

The bundle for the instance (e.g., micro_1_0).

Returns:

  • (String)


1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1905

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_address,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name)
  include Aws::Structure
end

#created_atTime

The timestamp when the instance was created (e.g., 1479734909.17).

Returns:

  • (Time)


1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1905

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_address,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name)
  include Aws::Structure
end

#hardwareTypes::InstanceHardware

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



1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1905

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_address,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name)
  include Aws::Structure
end

#ipv6_addressString

The IPv6 address of the instance.

Returns:

  • (String)


1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1905

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_address,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name)
  include Aws::Structure
end

#is_static_ipBoolean

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

Returns:

  • (Boolean)


1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1905

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_address,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name)
  include Aws::Structure
end

#locationTypes::ResourceLocation

The region name and availability zone where the instance is located.



1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1905

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_address,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name)
  include Aws::Structure
end

#nameString

The name the user gave the instance (e.g., Amazon_Linux-1GB-Virginia-1).

Returns:

  • (String)


1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1905

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_address,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name)
  include Aws::Structure
end

#networkingTypes::InstanceNetworking

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



1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1905

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_address,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name)
  include Aws::Structure
end

#private_ip_addressString

The private IP address of the instance.

Returns:

  • (String)


1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1905

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_address,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name)
  include Aws::Structure
end

#public_ip_addressString

The public IP address of the instance.

Returns:

  • (String)


1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1905

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_address,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name)
  include Aws::Structure
end

#resource_typeString

The type of resource (usually Instance).

Returns:

  • (String)


1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1905

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_address,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name)
  include Aws::Structure
end

#ssh_key_nameString

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

Returns:

  • (String)


1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1905

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_address,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name)
  include Aws::Structure
end

#stateTypes::InstanceState

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



1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1905

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_address,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name)
  include Aws::Structure
end

#support_codeString

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)


1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1905

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_address,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name)
  include Aws::Structure
end

#usernameString

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

Returns:

  • (String)


1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1905

class Instance < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :blueprint_id,
  :blueprint_name,
  :bundle_id,
  :is_static_ip,
  :private_ip_address,
  :public_ip_address,
  :ipv6_address,
  :hardware,
  :networking,
  :state,
  :username,
  :ssh_key_name)
  include Aws::Structure
end