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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes an instance (a virtual private server).

Returned by:

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)

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

#blueprint_idString

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

Returns:

  • (String)

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

#blueprint_nameString

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

Returns:

  • (String)

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

#bundle_idString

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

Returns:

  • (String)

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

#created_atTime

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

Returns:

  • (Time)

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

#hardwareTypes::InstanceHardware

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

Returns:

#ipv6_addressString

The IPv6 address of the instance.

Returns:

  • (String)

    The IPv6 address of the instance.

#is_static_ipBoolean

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

Returns:

  • (Boolean)

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

#locationTypes::ResourceLocation

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

Returns:

#nameString

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

Returns:

  • (String)

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

#networkingTypes::InstanceNetworking

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

Returns:

#private_ip_addressString

The private IP address of the instance.

Returns:

  • (String)

    The private IP address of the instance.

#public_ip_addressString

The public IP address of the instance.

Returns:

  • (String)

    The public IP address of the instance.

#resource_typeString

The type of resource (usually Instance).

Possible values:

  • Instance
  • StaticIp
  • KeyPair
  • InstanceSnapshot
  • Domain
  • PeeredVpc

Returns:

  • (String)

    The type of resource (usually Instance).

#ssh_key_nameString

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

Returns:

  • (String)

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

#stateTypes::InstanceState

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

Returns:

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

    The support code.

#usernameString

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

Returns:

  • (String)

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