Menu
Amazon Lightsail
REST API Reference (API Version 2016-11-28)

Instance

Describes an instance (a virtual private server).

Contents

arn

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

Type: String

Pattern: .*\S.*

Required: No

blueprintId

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

Type: String

Pattern: .*\S.*

Required: No

blueprintName

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

Type: String

Pattern: .*\S.*

Required: No

bundleId

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

Type: String

Pattern: .*\S.*

Required: No

createdAt

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

Type: Timestamp

Required: No

hardware

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

Type: InstanceHardware object

Required: No

ipv6Address

The IPv6 address of the instance.

Type: String

Pattern: ([A-F0-9]{1,4}:){7}[A-F0-9]{1,4}

Required: No

isStaticIp

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

Type: Boolean

Required: No

location

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

Type: ResourceLocation object

Required: No

name

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

Type: String

Pattern: \w[\w\-]*\w

Required: No

networking

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

Type: InstanceNetworking object

Required: No

privateIpAddress

The private IP address of the instance.

Type: String

Pattern: ([0-9]{1,3}\.){3}[0-9]{1,3}

Required: No

publicIpAddress

The public IP address of the instance.

Type: String

Pattern: ([0-9]{1,3}\.){3}[0-9]{1,3}

Required: No

resourceType

The type of resource (usually Instance).

Type: String

Valid Values: Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc

Required: No

sshKeyName

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

Type: String

Pattern: \w[\w\-]*\w

Required: No

state

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

Type: InstanceState object

Required: No

supportCode

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.

Type: String

Required: No

username

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

Type: String

Pattern: .*\S.*

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: