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

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

Overview

Describes a load balancer.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)


12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12167

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


12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12167

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_atTime

The date when your load balancer was created.

Returns:

  • (Time)


12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12167

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_nameString

The DNS name of your Lightsail load balancer.

Returns:

  • (String)


12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12167

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


12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12167

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_enabledBoolean

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

Returns:

  • (Boolean)


12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12167

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_summaryArray<Types::InstanceHealthSummary>

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

Returns:



12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12167

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


12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12167

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_typeString

The IP address type of the load balancer.

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

Returns:

  • (String)


12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12167

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

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



12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12167

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

#nameString

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

Returns:

  • (String)


12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12167

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

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


12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12167

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


12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12167

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_typeString

The resource type (e.g., LoadBalancer.

Returns:

  • (String)


12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12167

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

#stateString

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

Returns:

  • (String)


12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12167

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


12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12167

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

#tagsArray<Types::Tag>

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

Returns:



12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12167

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_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.



12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12167

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_nameString

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

Returns:

  • (String)


12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12167

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