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

StaticIp

Describes the static IP.

Contents

arn

The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).

Type: String

Pattern: .*\S.*

Required: No

attachedTo

The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Ohio-1).

Type: String

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

Required: No

createdAt

The timestamp when the static IP was created (e.g., 1479735304.222).

Type: Timestamp

Required: No

ipAddress

The static IP address.

Type: String

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

Required: No

isAttached

A Boolean value indicating whether the static IP is attached.

Type: Boolean

Required: No

location

The region and Availability Zone where the static IP was created.

Type: ResourceLocation object

Required: No

name

The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE).

Type: String

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

Required: No

resourceType

The resource type (usually StaticIp).

Type: String

Valid Values: Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot

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

See Also

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

On this page: