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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

Describes the Lightsail load balancer.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)


5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5716

class LoadBalancer < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :dns_name,
  :state,
  :protocol,
  :public_ports,
  :health_check_path,
  :instance_port,
  :instance_health_summary,
  :tls_certificate_summaries,
  :configuration_options)
  include Aws::Structure
end

#configuration_optionsHash<String,String>

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

Returns:

  • (Hash<String,String>)


5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5716

class LoadBalancer < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :dns_name,
  :state,
  :protocol,
  :public_ports,
  :health_check_path,
  :instance_port,
  :instance_health_summary,
  :tls_certificate_summaries,
  :configuration_options)
  include Aws::Structure
end

#created_atTime

The date when your load balancer was created.

Returns:

  • (Time)


5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5716

class LoadBalancer < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :dns_name,
  :state,
  :protocol,
  :public_ports,
  :health_check_path,
  :instance_port,
  :instance_health_summary,
  :tls_certificate_summaries,
  :configuration_options)
  include Aws::Structure
end

#dns_nameString

The DNS name of your Lightsail load balancer.

Returns:

  • (String)


5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5716

class LoadBalancer < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :dns_name,
  :state,
  :protocol,
  :public_ports,
  :health_check_path,
  :instance_port,
  :instance_health_summary,
  :tls_certificate_summaries,
  :configuration_options)
  include Aws::Structure
end

#health_check_pathString

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)


5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5716

class LoadBalancer < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :dns_name,
  :state,
  :protocol,
  :public_ports,
  :health_check_path,
  :instance_port,
  :instance_health_summary,
  :tls_certificate_summaries,
  :configuration_options)
  include Aws::Structure
end

#instance_health_summaryArray<Types::InstanceHealthSummary>

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

Returns:



5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5716

class LoadBalancer < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :dns_name,
  :state,
  :protocol,
  :public_ports,
  :health_check_path,
  :instance_port,
  :instance_health_summary,
  :tls_certificate_summaries,
  :configuration_options)
  include Aws::Structure
end

#instance_portInteger

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)


5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5716

class LoadBalancer < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :dns_name,
  :state,
  :protocol,
  :public_ports,
  :health_check_path,
  :instance_port,
  :instance_health_summary,
  :tls_certificate_summaries,
  :configuration_options)
  include Aws::Structure
end

#locationTypes::ResourceLocation

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



5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5716

class LoadBalancer < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :dns_name,
  :state,
  :protocol,
  :public_ports,
  :health_check_path,
  :instance_port,
  :instance_health_summary,
  :tls_certificate_summaries,
  :configuration_options)
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5716

class LoadBalancer < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :dns_name,
  :state,
  :protocol,
  :public_ports,
  :health_check_path,
  :instance_port,
  :instance_health_summary,
  :tls_certificate_summaries,
  :configuration_options)
  include Aws::Structure
end

#protocolString

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.

Returns:

  • (String)


5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5716

class LoadBalancer < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :dns_name,
  :state,
  :protocol,
  :public_ports,
  :health_check_path,
  :instance_port,
  :instance_health_summary,
  :tls_certificate_summaries,
  :configuration_options)
  include Aws::Structure
end

#public_portsArray<Integer>

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

Returns:

  • (Array<Integer>)


5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5716

class LoadBalancer < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :dns_name,
  :state,
  :protocol,
  :public_ports,
  :health_check_path,
  :instance_port,
  :instance_health_summary,
  :tls_certificate_summaries,
  :configuration_options)
  include Aws::Structure
end

#resource_typeString

The resource type (e.g., LoadBalancer.

Returns:

  • (String)


5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5716

class LoadBalancer < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :dns_name,
  :state,
  :protocol,
  :public_ports,
  :health_check_path,
  :instance_port,
  :instance_health_summary,
  :tls_certificate_summaries,
  :configuration_options)
  include Aws::Structure
end

#stateString

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

Returns:

  • (String)


5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5716

class LoadBalancer < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :dns_name,
  :state,
  :protocol,
  :public_ports,
  :health_check_path,
  :instance_port,
  :instance_health_summary,
  :tls_certificate_summaries,
  :configuration_options)
  include Aws::Structure
end

#support_codeString

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)


5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5716

class LoadBalancer < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :dns_name,
  :state,
  :protocol,
  :public_ports,
  :health_check_path,
  :instance_port,
  :instance_health_summary,
  :tls_certificate_summaries,
  :configuration_options)
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5716

class LoadBalancer < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :dns_name,
  :state,
  :protocol,
  :public_ports,
  :health_check_path,
  :instance_port,
  :instance_health_summary,
  :tls_certificate_summaries,
  :configuration_options)
  include Aws::Structure
end

#tls_certificate_summariesArray<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.



5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5716

class LoadBalancer < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :dns_name,
  :state,
  :protocol,
  :public_ports,
  :health_check_path,
  :instance_port,
  :instance_health_summary,
  :tls_certificate_summaries,
  :configuration_options)
  include Aws::Structure
end