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).

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#add_onsArray<Types::AddOn>

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

Returns:



10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10996

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)
  SENSITIVE = []
  include Aws::Structure
end

#arnString

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

Returns:

  • (String)


10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10996

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)
  SENSITIVE = []
  include Aws::Structure
end

#blueprint_idString

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

Returns:

  • (String)


10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10996

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)
  SENSITIVE = []
  include Aws::Structure
end

#blueprint_nameString

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

Returns:

  • (String)


10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10996

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)
  SENSITIVE = []
  include Aws::Structure
end

#bundle_idString

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

Returns:

  • (String)


10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10996

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)
  SENSITIVE = []
  include Aws::Structure
end

#created_atTime

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

Returns:

  • (Time)


10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10996

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)
  SENSITIVE = []
  include Aws::Structure
end

#hardwareTypes::InstanceHardware

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



10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10996

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)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address_typeString

The IP address type of the instance.

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

Returns:

  • (String)


10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10996

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)
  SENSITIVE = []
  include Aws::Structure
end

#ipv6_addressesArray<String>

The IPv6 addresses of the instance.

Returns:

  • (Array<String>)


10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10996

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)
  SENSITIVE = []
  include Aws::Structure
end

#is_static_ipBoolean

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

Returns:

  • (Boolean)


10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10996

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)
  SENSITIVE = []
  include Aws::Structure
end

#locationTypes::ResourceLocation

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



10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10996

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)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10996

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)
  SENSITIVE = []
  include Aws::Structure
end

#networkingTypes::InstanceNetworking

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



10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10996

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)
  SENSITIVE = []
  include Aws::Structure
end

#private_ip_addressString

The private IP address of the instance.

Returns:

  • (String)


10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10996

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)
  SENSITIVE = []
  include Aws::Structure
end

#public_ip_addressString

The public IP address of the instance.

Returns:

  • (String)


10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10996

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)
  SENSITIVE = []
  include Aws::Structure
end

#resource_typeString

The type of resource (usually Instance).

Returns:

  • (String)


10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10996

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)
  SENSITIVE = []
  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)


10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10996

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)
  SENSITIVE = []
  include Aws::Structure
end

#stateTypes::InstanceState

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



10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10996

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)
  SENSITIVE = []
  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)


10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10996

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)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<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:



10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10996

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)
  SENSITIVE = []
  include Aws::Structure
end

#usernameString

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

Returns:

  • (String)


10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10996

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)
  SENSITIVE = []
  include Aws::Structure
end