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

LoadBalancer

Describes the Lightsail load balancer.

Contents

arn

The Amazon Resource Name (ARN) of the load balancer.

Type: String

Pattern: .*\S.*

Required: No

configurationOptions

A string to string map of the configuration options for your load balancer. Valid values are listed below.

Type: String to string map

Valid Keys: HealthCheckPath | SessionStickinessEnabled | SessionStickiness_LB_CookieDurationSeconds

Required: No

createdAt

The date when your load balancer was created.

Type: Timestamp

Required: No

dnsName

The DNS name of your Lightsail load balancer.

Type: String

Pattern: .*\S.*

Required: No

healthCheckPath

The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page.

Type: String

Pattern: .*\S.*

Required: No

instanceHealthSummary

An array of InstanceHealthSummary objects describing the health of the load balancer.

Type: Array of InstanceHealthSummary objects

Required: No

instancePort

The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.

Type: Integer

Required: No

location

The AWS Region where your load balancer was created (e.g., us-east-2a). Lightsail automatically creates your load balancer across Availability Zones.

Type: ResourceLocation object

Required: No

name

The name of the load balancer (e.g., my-load-balancer).

Type: String

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

Required: No

protocol

The protocol you have enabled for your load balancer. Valid values are below.

You can't just have HTTP_HTTPS, but you can have just HTTP.

Type: String

Valid Values: HTTP_HTTPS | HTTP

Required: No

publicPorts

An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.

Type: Array of integers

Valid Range: Minimum value of 0. Maximum value of 65535.

Required: No

resourceType

The resource type (e.g., LoadBalancer.

Type: String

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

Required: No

state

The status of your load balancer. Valid values are below.

Type: String

Valid Values: active | provisioning | active_impaired | failed | unknown

Required: No

supportCode

The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.

Type: String

Required: No

tlsCertificateSummaries

An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true, the certificate is attached to the load balancer.

Type: Array of LoadBalancerTlsCertificateSummary objects

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: