Elastic Load Balancing
API Reference (API Version 2012-06-01)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

LoadBalancerDescription

Description

Contains the result of a successful invocation of DescribeLoadBalancers.

Contents

AvailabilityZones

Specifies a list of Availability Zones.

Type: String list

Required: No

BackendServerDescriptions

Contains a list of back-end server descriptions.

Type: BackendServerDescription list

Required: No

CanonicalHostedZoneName

Provides the name of the Amazon Route 53 hosted zone that is associated with the LoadBalancer. For information on how to associate your load balancer with a hosted zone, go to Using Domain Names With Elastic Load Balancing in the Elastic Load Balancing Developer Guide.

Type: String

Required: No

CanonicalHostedZoneNameID

Provides the ID of the Amazon Route 53 hosted zone name that is associated with the LoadBalancer. For information on how to associate or disassociate your load balancer with a hosted zone, go to Using Domain Names With Elastic Load Balancing in the Elastic Load Balancing Developer Guide.

Type: String

Required: No

CreatedTime

Provides the date and time the LoadBalancer was created.

Type: DateTime

Required: No

DNSName

Specifies the external DNS name associated with the LoadBalancer.

Type: String

Required: No

HealthCheck

Specifies information regarding the various health probes conducted on the LoadBalancer.

Type: HealthCheck

Required: No

Instances

Provides a list of EC2 instance IDs for the LoadBalancer.

Type: Instance list

Required: No

ListenerDescriptions

LoadBalancerPort, InstancePort, Protocol, InstanceProtocol, and PolicyNames are returned in a list of tuples in the ListenerDescriptions element.

Type: ListenerDescription list

Required: No

LoadBalancerName

Specifies the name associated with the LoadBalancer.

Type: String

Required: No

Policies

Provides a list of policies defined for the LoadBalancer.

Type: Policies

Required: No

Scheme

Specifies the type of LoadBalancer.

If the Scheme is internet-facing, the LoadBalancer has a publicly resolvable DNS name that resolves to public IP addresses.

If the Scheme is internal, the LoadBalancer has a publicly resolvable DNS name that resolves to private IP addresses.

This option is only available for LoadBalancers attached to an Amazon VPC.

Type: String

Required: No

SecurityGroups

The security groups the LoadBalancer is a member of (VPC only).

Type: String list

Required: No

SourceSecurityGroup

The security group that you can use as part of your inbound rules for your LoadBalancer's back-end Amazon EC2 application instances. To only allow traffic from LoadBalancers, add a security group rule to your back end instance that specifies this source security group as the inbound source.

Type: SourceSecurityGroup

Required: No

Subnets

Provides a list of VPC subnet IDs for the LoadBalancer.

Type: String list

Required: No

VPCId

Provides the ID of the VPC attached to the LoadBalancer.

Type: String

Required: No