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

Inherits:

Struct

• Object
• Struct
• Aws::Lightsail::Types::LoadBalancer

Includes:

Structure

Defined in:

lib/aws-sdk-lightsail/types.rb

Overview

Describes a load balancer.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ 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.

• #created_at ⇒ Time

  The date when your load balancer was created.

• #dns_name ⇒ String

  The DNS name of your Lightsail load balancer.

• #health_check_path ⇒ String

  The path you specified to perform your health checks.

• #https_redirection_enabled ⇒ Boolean

  A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.

• #instance_health_summary ⇒ Array<Types::InstanceHealthSummary>

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

• #instance_port ⇒ Integer

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

• #ip_address_type ⇒ String

  The IP address type of the load balancer.

• #location ⇒ Types::ResourceLocation

  The AWS Region where your load balancer was created (‘us-east-2a`).

• #name ⇒ String

  The name of the load balancer (‘my-load-balancer`).

• #protocol ⇒ String

  The protocol you have enabled for your load balancer.

• #public_ports ⇒ Array<Integer>

  An array of public port settings for your load balancer.

• #resource_type ⇒ String

  The resource type (‘LoadBalancer`..

• #state ⇒ String

  The status of your load balancer.

• #support_code ⇒ String

  The support code.

• #tags ⇒ 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.

• #tls_policy_name ⇒ String

  The name of the TLS security policy for the load balancer.

Instance Attribute Details

#arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 11199

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,
  :ip_address_type,
  :https_redirection_enabled,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#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>)

# File 'lib/aws-sdk-lightsail/types.rb', line 11199

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,
  :ip_address_type,
  :https_redirection_enabled,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The date when your load balancer was created.

Returns:

• (Time)

# File 'lib/aws-sdk-lightsail/types.rb', line 11199

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,
  :ip_address_type,
  :https_redirection_enabled,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#dns_name ⇒ String

The DNS name of your Lightsail load balancer.

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 11199

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,
  :ip_address_type,
  :https_redirection_enabled,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-lightsail/types.rb', line 11199

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,
  :ip_address_type,
  :https_redirection_enabled,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#https_redirection_enabled ⇒ Boolean

A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.

Returns:

• (Boolean)

# File 'lib/aws-sdk-lightsail/types.rb', line 11199

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,
  :ip_address_type,
  :https_redirection_enabled,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#instance_health_summary ⇒ Array<Types::InstanceHealthSummary>

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

Returns:

• (Array<Types::InstanceHealthSummary>)

# File 'lib/aws-sdk-lightsail/types.rb', line 11199

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,
  :ip_address_type,
  :https_redirection_enabled,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-lightsail/types.rb', line 11199

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,
  :ip_address_type,
  :https_redirection_enabled,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address_type ⇒ String

The IP address type of the load balancer.

The possible values are ‘ipv4` for IPv4 only, `ipv6` for IPv6 only, and `dualstack` for IPv4 and IPv6.

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 11199

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,
  :ip_address_type,
  :https_redirection_enabled,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#location ⇒ Types::ResourceLocation

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

Returns:

• (Types::ResourceLocation)

# File 'lib/aws-sdk-lightsail/types.rb', line 11199

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,
  :ip_address_type,
  :https_redirection_enabled,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the load balancer (‘my-load-balancer`).

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 11199

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,
  :ip_address_type,
  :https_redirection_enabled,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 11199

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,
  :ip_address_type,
  :https_redirection_enabled,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#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>)

# File 'lib/aws-sdk-lightsail/types.rb', line 11199

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,
  :ip_address_type,
  :https_redirection_enabled,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

The resource type (‘LoadBalancer`.

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 11199

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,
  :ip_address_type,
  :https_redirection_enabled,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 11199

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,
  :ip_address_type,
  :https_redirection_enabled,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-lightsail/types.rb', line 11199

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,
  :ip_address_type,
  :https_redirection_enabled,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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

[1]: lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-lightsail/types.rb', line 11199

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,
  :ip_address_type,
  :https_redirection_enabled,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#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:

• (Array<Types::LoadBalancerTlsCertificateSummary>)

# File 'lib/aws-sdk-lightsail/types.rb', line 11199

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,
  :ip_address_type,
  :https_redirection_enabled,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#tls_policy_name ⇒ String

The name of the TLS security policy for the load balancer.

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 11199

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,
  :ip_address_type,
  :https_redirection_enabled,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end