Instance

Describes an instance (a virtual private server).

addOns

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

Type: Array of AddOn objects

Required: No

arn

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

Type: String

Pattern: .*\S.*

Required: No

blueprintId

The blueprint ID (amazon_linux_2023).

Type: String

Pattern: .*\S.*

Required: No

blueprintName

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

Type: String

Pattern: .*\S.*

Required: No

bundleId

The bundle for the instance (micro_x_x).

Type: String

Pattern: .*\S.*

Required: No

createdAt

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

Type: Timestamp

Required: No

hardware

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

Type: InstanceHardware object

Required: No

ipAddressType

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.

Type: String

Valid Values: dualstack | ipv4 | ipv6

Required: No

ipv6Addresses

The IPv6 addresses of the instance.

Type: Array of strings

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

metadataOptions

The metadata options for the Amazon Lightsail instance.

Type: InstanceMetadataOptions object

Required: No

name

The name the user gave the instance (Amazon_Linux_2023-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

Required: No

sshKeyName

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

Type: String

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

Required: No

state

The status code and the state (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

tags

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

Type: Array of Tag objects

Required: No

username

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

Type: String

Pattern: .*\S.*

Required: No

Instance

Contents

See Also