Class: Aws::ElasticLoadBalancing::Types::LoadBalancerDescription

Inherits:

Struct

• Object
• Struct
• Aws::ElasticLoadBalancing::Types::LoadBalancerDescription

Includes:

Structure

Defined in:

lib/aws-sdk-elasticloadbalancing/types.rb

Overview

Information about a load balancer.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #availability_zones ⇒ Array<String>

  The Availability Zones for the load balancer.

• #backend_server_descriptions ⇒ Array<Types::BackendServerDescription>

  Information about your EC2 instances.

• #canonical_hosted_zone_name ⇒ String

  The DNS name of the load balancer.

• #canonical_hosted_zone_name_id ⇒ String

  The ID of the Amazon Route 53 hosted zone for the load balancer.

• #created_time ⇒ Time

  The date and time the load balancer was created.

• #dns_name ⇒ String

  The DNS name of the load balancer.

• #health_check ⇒ Types::HealthCheck

  Information about the health checks conducted on the load balancer.

• #instances ⇒ Array<Types::Instance>

  The IDs of the instances for the load balancer.

• #listener_descriptions ⇒ Array<Types::ListenerDescription>

  The listeners for the load balancer.

• #load_balancer_name ⇒ String

  The name of the load balancer.

• #policies ⇒ Types::Policies

  The policies defined for the load balancer.

• #scheme ⇒ String

  The type of load balancer.

• #security_groups ⇒ Array<String>

  The security groups for the load balancer.

• #source_security_group ⇒ Types::SourceSecurityGroup

  The security group for the load balancer, which you can use as part of your inbound rules for your registered instances.

• #subnets ⇒ Array<String>

  The IDs of the subnets for the load balancer.

• #vpc_id ⇒ String

  The ID of the VPC for the load balancer.

Instance Attribute Details

#availability_zones ⇒ Array<String>

The Availability Zones for the load balancer.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-elasticloadbalancing/types.rb', line 1757

class LoadBalancerDescription < Struct.new(
  :load_balancer_name,
  :dns_name,
  :canonical_hosted_zone_name,
  :canonical_hosted_zone_name_id,
  :listener_descriptions,
  :policies,
  :backend_server_descriptions,
  :availability_zones,
  :subnets,
  :vpc_id,
  :instances,
  :health_check,
  :source_security_group,
  :security_groups,
  :created_time,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end

#backend_server_descriptions ⇒ Array<Types::BackendServerDescription>

Information about your EC2 instances.

Returns:

• (Array<Types::BackendServerDescription>)

# File 'lib/aws-sdk-elasticloadbalancing/types.rb', line 1757

class LoadBalancerDescription < Struct.new(
  :load_balancer_name,
  :dns_name,
  :canonical_hosted_zone_name,
  :canonical_hosted_zone_name_id,
  :listener_descriptions,
  :policies,
  :backend_server_descriptions,
  :availability_zones,
  :subnets,
  :vpc_id,
  :instances,
  :health_check,
  :source_security_group,
  :security_groups,
  :created_time,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end

#canonical_hosted_zone_name ⇒ String

The DNS name of the load balancer.

For more information, see [Configure a Custom Domain Name] in the *Classic Load Balancers Guide*.

[1]: docs.aws.amazon.com/elasticloadbalancing/latest/classic/using-domain-names-with-elb.html

Returns:

• (String)

# File 'lib/aws-sdk-elasticloadbalancing/types.rb', line 1757

class LoadBalancerDescription < Struct.new(
  :load_balancer_name,
  :dns_name,
  :canonical_hosted_zone_name,
  :canonical_hosted_zone_name_id,
  :listener_descriptions,
  :policies,
  :backend_server_descriptions,
  :availability_zones,
  :subnets,
  :vpc_id,
  :instances,
  :health_check,
  :source_security_group,
  :security_groups,
  :created_time,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end

#canonical_hosted_zone_name_id ⇒ String

The ID of the Amazon Route 53 hosted zone for the load balancer.

Returns:

• (String)

# File 'lib/aws-sdk-elasticloadbalancing/types.rb', line 1757

class LoadBalancerDescription < Struct.new(
  :load_balancer_name,
  :dns_name,
  :canonical_hosted_zone_name,
  :canonical_hosted_zone_name_id,
  :listener_descriptions,
  :policies,
  :backend_server_descriptions,
  :availability_zones,
  :subnets,
  :vpc_id,
  :instances,
  :health_check,
  :source_security_group,
  :security_groups,
  :created_time,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end

#created_time ⇒ Time

The date and time the load balancer was created.

Returns:

• (Time)

# File 'lib/aws-sdk-elasticloadbalancing/types.rb', line 1757

class LoadBalancerDescription < Struct.new(
  :load_balancer_name,
  :dns_name,
  :canonical_hosted_zone_name,
  :canonical_hosted_zone_name_id,
  :listener_descriptions,
  :policies,
  :backend_server_descriptions,
  :availability_zones,
  :subnets,
  :vpc_id,
  :instances,
  :health_check,
  :source_security_group,
  :security_groups,
  :created_time,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end

#dns_name ⇒ String

The DNS name of the load balancer.

Returns:

• (String)

# File 'lib/aws-sdk-elasticloadbalancing/types.rb', line 1757

class LoadBalancerDescription < Struct.new(
  :load_balancer_name,
  :dns_name,
  :canonical_hosted_zone_name,
  :canonical_hosted_zone_name_id,
  :listener_descriptions,
  :policies,
  :backend_server_descriptions,
  :availability_zones,
  :subnets,
  :vpc_id,
  :instances,
  :health_check,
  :source_security_group,
  :security_groups,
  :created_time,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end

#health_check ⇒ Types::HealthCheck

Information about the health checks conducted on the load balancer.

Returns:

• (Types::HealthCheck)

# File 'lib/aws-sdk-elasticloadbalancing/types.rb', line 1757

class LoadBalancerDescription < Struct.new(
  :load_balancer_name,
  :dns_name,
  :canonical_hosted_zone_name,
  :canonical_hosted_zone_name_id,
  :listener_descriptions,
  :policies,
  :backend_server_descriptions,
  :availability_zones,
  :subnets,
  :vpc_id,
  :instances,
  :health_check,
  :source_security_group,
  :security_groups,
  :created_time,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end

#instances ⇒ Array<Types::Instance>

The IDs of the instances for the load balancer.

Returns:

• (Array<Types::Instance>)

# File 'lib/aws-sdk-elasticloadbalancing/types.rb', line 1757

class LoadBalancerDescription < Struct.new(
  :load_balancer_name,
  :dns_name,
  :canonical_hosted_zone_name,
  :canonical_hosted_zone_name_id,
  :listener_descriptions,
  :policies,
  :backend_server_descriptions,
  :availability_zones,
  :subnets,
  :vpc_id,
  :instances,
  :health_check,
  :source_security_group,
  :security_groups,
  :created_time,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end

#listener_descriptions ⇒ Array<Types::ListenerDescription>

The listeners for the load balancer.

Returns:

• (Array<Types::ListenerDescription>)

# File 'lib/aws-sdk-elasticloadbalancing/types.rb', line 1757

class LoadBalancerDescription < Struct.new(
  :load_balancer_name,
  :dns_name,
  :canonical_hosted_zone_name,
  :canonical_hosted_zone_name_id,
  :listener_descriptions,
  :policies,
  :backend_server_descriptions,
  :availability_zones,
  :subnets,
  :vpc_id,
  :instances,
  :health_check,
  :source_security_group,
  :security_groups,
  :created_time,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end

#load_balancer_name ⇒ String

The name of the load balancer.

Returns:

• (String)

# File 'lib/aws-sdk-elasticloadbalancing/types.rb', line 1757

class LoadBalancerDescription < Struct.new(
  :load_balancer_name,
  :dns_name,
  :canonical_hosted_zone_name,
  :canonical_hosted_zone_name_id,
  :listener_descriptions,
  :policies,
  :backend_server_descriptions,
  :availability_zones,
  :subnets,
  :vpc_id,
  :instances,
  :health_check,
  :source_security_group,
  :security_groups,
  :created_time,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end

#policies ⇒ Types::Policies

The policies defined for the load balancer.

Returns:

• (Types::Policies)

# File 'lib/aws-sdk-elasticloadbalancing/types.rb', line 1757

class LoadBalancerDescription < Struct.new(
  :load_balancer_name,
  :dns_name,
  :canonical_hosted_zone_name,
  :canonical_hosted_zone_name_id,
  :listener_descriptions,
  :policies,
  :backend_server_descriptions,
  :availability_zones,
  :subnets,
  :vpc_id,
  :instances,
  :health_check,
  :source_security_group,
  :security_groups,
  :created_time,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end

#scheme ⇒ String

The type of load balancer. Valid only for load balancers in a VPC.

If ‘Scheme` is `internet-facing`, the load balancer has a public DNS name that resolves to a public IP address.

If ‘Scheme` is `internal`, the load balancer has a public DNS name that resolves to a private IP address.

Returns:

• (String)

# File 'lib/aws-sdk-elasticloadbalancing/types.rb', line 1757

class LoadBalancerDescription < Struct.new(
  :load_balancer_name,
  :dns_name,
  :canonical_hosted_zone_name,
  :canonical_hosted_zone_name_id,
  :listener_descriptions,
  :policies,
  :backend_server_descriptions,
  :availability_zones,
  :subnets,
  :vpc_id,
  :instances,
  :health_check,
  :source_security_group,
  :security_groups,
  :created_time,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end

#security_groups ⇒ Array<String>

The security groups for the load balancer. Valid only for load balancers in a VPC.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-elasticloadbalancing/types.rb', line 1757

class LoadBalancerDescription < Struct.new(
  :load_balancer_name,
  :dns_name,
  :canonical_hosted_zone_name,
  :canonical_hosted_zone_name_id,
  :listener_descriptions,
  :policies,
  :backend_server_descriptions,
  :availability_zones,
  :subnets,
  :vpc_id,
  :instances,
  :health_check,
  :source_security_group,
  :security_groups,
  :created_time,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end

#source_security_group ⇒ Types::SourceSecurityGroup

The security group for the load balancer, which you can use as part of your inbound rules for your registered instances. To only allow traffic from load balancers, add a security group rule that specifies this source security group as the inbound source.

Returns:

• (Types::SourceSecurityGroup)

# File 'lib/aws-sdk-elasticloadbalancing/types.rb', line 1757

class LoadBalancerDescription < Struct.new(
  :load_balancer_name,
  :dns_name,
  :canonical_hosted_zone_name,
  :canonical_hosted_zone_name_id,
  :listener_descriptions,
  :policies,
  :backend_server_descriptions,
  :availability_zones,
  :subnets,
  :vpc_id,
  :instances,
  :health_check,
  :source_security_group,
  :security_groups,
  :created_time,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end

#subnets ⇒ Array<String>

The IDs of the subnets for the load balancer.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-elasticloadbalancing/types.rb', line 1757

class LoadBalancerDescription < Struct.new(
  :load_balancer_name,
  :dns_name,
  :canonical_hosted_zone_name,
  :canonical_hosted_zone_name_id,
  :listener_descriptions,
  :policies,
  :backend_server_descriptions,
  :availability_zones,
  :subnets,
  :vpc_id,
  :instances,
  :health_check,
  :source_security_group,
  :security_groups,
  :created_time,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ String

The ID of the VPC for the load balancer.

Returns:

• (String)

# File 'lib/aws-sdk-elasticloadbalancing/types.rb', line 1757

class LoadBalancerDescription < Struct.new(
  :load_balancer_name,
  :dns_name,
  :canonical_hosted_zone_name,
  :canonical_hosted_zone_name_id,
  :listener_descriptions,
  :policies,
  :backend_server_descriptions,
  :availability_zones,
  :subnets,
  :vpc_id,
  :instances,
  :health_check,
  :source_security_group,
  :security_groups,
  :created_time,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end