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

Class: Aws::Lightsail::Types::LoadBalancer

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

Overview

Describes the Lightsail load balancer.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

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

Returns:

  • (String) —

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

#configuration_options ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) —

    A string to string map of the configuration options for your load balancer.

#created_at ⇒ Time

The date when your load balancer was created.

Returns:

  • (Time) —

    The date when your load balancer was created.

#dns_name ⇒ String

The DNS name of your Lightsail load balancer.

Returns:

  • (String) —

    The DNS name of your Lightsail load balancer.

#health_check_path ⇒ String

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.

Returns:

  • (String) —

    The path you specified to perform your health checks.

#instance_health_summary ⇒ Array<Types::InstanceHealthSummary>

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

Returns:

#instance_port ⇒ Integer

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.

Returns:

  • (Integer) —

    The port where the load balancer will direct traffic to your Lightsail instances.

#location ⇒ Types::ResourceLocation

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

Returns:

#name ⇒ String

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

Returns:

  • (String) —

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

#protocol ⇒ String

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.

Possible values:

  • HTTP_HTTPS
  • HTTP

Returns:

  • (String) —

    The protocol you have enabled for your load balancer.

#public_ports ⇒ Array<Integer>

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

Returns:

  • (Array<Integer>) —

    An array of public port settings for your load balancer.

#resource_type ⇒ String

The resource type (e.g., LoadBalancer.

Possible values:

  • ContainerService
  • Instance
  • StaticIp
  • KeyPair
  • InstanceSnapshot
  • Domain
  • PeeredVpc
  • LoadBalancer
  • LoadBalancerTlsCertificate
  • Disk
  • DiskSnapshot
  • RelationalDatabase
  • RelationalDatabaseSnapshot
  • ExportSnapshotRecord
  • CloudFormationStackRecord
  • Alarm
  • ContactMethod
  • Distribution
  • Certificate

Returns:

  • (String) —

    The resource type (e.g., LoadBalancer..

#state ⇒ String

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

Possible values:

  • active
  • provisioning
  • active_impaired
  • failed
  • unknown

Returns:

  • (String) —

    The status of your load balancer.

#support_code ⇒ String

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.

Returns:

  • (String) —

    The support code.

#tags ⇒ Array<Types::Tag>

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

Returns:

  • (Array<Types::Tag>) —

    The tag keys and optional values for the resource.

#tls_certificate_summaries ⇒ Array<Types::LoadBalancerTlsCertificateSummary>

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.

Returns: