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:



9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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

#arnString

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

Returns:

  • (String)


9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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

#blueprint_idString

The blueprint ID (amazon_linux_2023).

Returns:

  • (String)


9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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

#blueprint_nameString

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

Returns:

  • (String)


9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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

#bundle_idString

The bundle for the instance (micro_x_x).

Returns:

  • (String)


9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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

#created_atTime

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

Returns:

  • (Time)


9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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

#hardwareTypes::InstanceHardware

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



9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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

#ip_address_typeString

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)


9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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

#ipv6_addressesArray<String>

The IPv6 addresses of the instance.

Returns:

  • (Array<String>)


9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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

#is_static_ipBoolean

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

Returns:

  • (Boolean)


9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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

#locationTypes::ResourceLocation

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



9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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

#metadata_optionsTypes::InstanceMetadataOptions

The metadata options for the Amazon Lightsail instance.



9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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

#nameString

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

Returns:

  • (String)


9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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

#networkingTypes::InstanceNetworking

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



9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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

#private_ip_addressString

The private IP address of the instance.

Returns:

  • (String)


9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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

#public_ip_addressString

The public IP address of the instance.

Returns:

  • (String)


9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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

#resource_typeString

The type of resource (usually Instance).

Returns:

  • (String)


9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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

#ssh_key_nameString

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

Returns:

  • (String)


9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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

#stateTypes::InstanceState

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



9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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


9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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



9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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

#usernameString

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

Returns:

  • (String)


9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9948

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