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

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

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

Overview

Information about a load balancer.

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zonesArray<String>

The Availability Zones for the load balancer.

Returns:

  • (Array<String>)


1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1599

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)
  include Aws::Structure
end

#backend_server_descriptionsArray<Types::BackendServerDescription>

Information about your EC2 instances.



1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1599

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)
  include Aws::Structure
end

#canonical_hosted_zone_nameString

The DNS name of the load balancer.

For more information, see Configure a Custom Domain Name in the Classic Load Balancer Guide.

Returns:

  • (String)


1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1599

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)
  include Aws::Structure
end

#canonical_hosted_zone_name_idString

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

Returns:

  • (String)


1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1599

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)
  include Aws::Structure
end

#created_timeTime

The date and time the load balancer was created.

Returns:

  • (Time)


1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1599

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)
  include Aws::Structure
end

#dns_nameString

The DNS name of the load balancer.

Returns:

  • (String)


1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1599

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)
  include Aws::Structure
end

#health_checkTypes::HealthCheck

Information about the health checks conducted on the load balancer.

Returns:



1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1599

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)
  include Aws::Structure
end

#instancesArray<Types::Instance>

The IDs of the instances for the load balancer.

Returns:



1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1599

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)
  include Aws::Structure
end

#listener_descriptionsArray<Types::ListenerDescription>

The listeners for the load balancer.

Returns:



1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1599

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)
  include Aws::Structure
end

#load_balancer_nameString

The name of the load balancer.

Returns:

  • (String)


1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1599

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)
  include Aws::Structure
end

#policiesTypes::Policies

The policies defined for the load balancer.

Returns:



1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1599

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)
  include Aws::Structure
end

#schemeString

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)


1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1599

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)
  include Aws::Structure
end

#security_groupsArray<String>

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

Returns:

  • (Array<String>)


1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1599

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)
  include Aws::Structure
end

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



1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1599

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)
  include Aws::Structure
end

#subnetsArray<String>

The IDs of the subnets for the load balancer.

Returns:

  • (Array<String>)


1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1599

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)
  include Aws::Structure
end

#vpc_idString

The ID of the VPC for the load balancer.

Returns:

  • (String)


1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1599

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)
  include Aws::Structure
end