Adds one or more tags for the specified load balancer. Each load balancer can have a maximum of 10 tags. Each tag consists of a key and an optional value.
Tag keys must be unique for each load balancer. If a tag with the same key is already associated with the load balancer, this action will update the value of the key.
For more information, see Tagging in the Elastic Load Balancing Developer Guide.
", "ApplySecurityGroupsToLoadBalancer": "Associates one or more security groups with your load balancer in Amazon Virtual Private Cloud (Amazon VPC). The provided security group IDs will override any currently applied security groups.
For more information, see Manage Security Groups in Amazon VPC in the Elastic Load Balancing Developer Guide.
", "AttachLoadBalancerToSubnets": "Adds one or more subnets to the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer.
The load balancers evenly distribute requests across all of the registered subnets. For more information, see Deploy Elastic Load Balancing in Amazon VPC in the Elastic Load Balancing Developer Guide.
", "ConfigureHealthCheck": "Specifies the health check settings to use for evaluating the health state of your back-end instances.
For more information, see Health Check in the Elastic Load Balancing Developer Guide.
", "CreateAppCookieStickinessPolicy": "Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners.
This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application cookie.
If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued.
AWSELB. This is the default behavior for many common web browsers. For more information, see Enabling Application-Controlled Session Stickiness in the Elastic Load Balancing Developer Guide.
", "CreateLBCookieStickinessPolicy": "Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners.
When a load balancer implements this policy, the load balancer uses a special cookie to track the backend server instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load balancing algorithm.
A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration.
For more information, see Enabling Duration-Based Session Stickiness in the Elastic Load Balancing Developer Guide.
", "CreateLoadBalancer": "Creates a new load balancer.
After the call has completed successfully, a new load balancer is created with a unique Domain Name Service (DNS) name. The DNS name includes the name of the AWS region in which the load balance was created. For example, if your load balancer was created in the United States, the DNS name might end with either of the following:
For information about the AWS regions supported by Elastic Load Balancing, see Regions and Endpoints.
You can create up to 20 load balancers per region per account.
Elastic Load Balancing supports load balancing your Amazon EC2 instances launched within any one of the following platforms:
For information on creating and managing your load balancers in EC2-Classic, see Deploy Elastic Load Balancing in Amazon EC2-Classic.
For information on creating and managing your load balancers in EC2-VPC, see Deploy Elastic Load Balancing in Amazon VPC.
Creates one or more listeners on a load balancer for the specified port. If a listener with the given port does not already exist, it will be created; otherwise, the properties of the new listener must match the properties of the existing listener.
For more information, see Add a Listener to Your Load Balancer in the Elastic Load Balancing Developer Guide.
", "CreateLoadBalancerPolicy": "Creates a new policy that contains the necessary attributes depending on the policy type. Policies are settings that are saved for your load balancer and that can be applied to the front-end listener, or the back-end application server, depending on your policy type.
", "DeleteLoadBalancer": "Deletes the specified load balancer.
If attempting to recreate the load balancer, you must reconfigure all the settings. The DNS name associated with a deleted load balancer will no longer be usable. Once deleted, the name and associated DNS record of the load balancer no longer exist and traffic sent to any of its IP addresses will no longer be delivered to back-end instances.
To successfully call this API, you must provide the same account credentials as were used to create the load balancer.
DeleteLoadBalancer action still succeeds. Deletes listeners from the load balancer for the specified port.
", "DeleteLoadBalancerPolicy": "Deletes a policy from the load balancer. The specified policy must not be enabled for any listeners.
", "DeregisterInstancesFromLoadBalancer": "Deregisters instances from the load balancer. Once the instance is deregistered, it will stop receiving traffic from the load balancer.
In order to successfully call this API, the same account credentials as those used to create the load balancer must be provided.
For more information, see De-register and Register Amazon EC2 Instances in the Elastic Load Balancing Developer Guide.
You can use DescribeLoadBalancers to verify if the instance is deregistered from the load balancer.
", "DescribeInstanceHealth": "Returns the current state of the specified instances registered with the specified load balancer. If no instances are specified, the state of all the instances registered with the load balancer is returned.
Returns detailed information about all of the attributes associated with the specified load balancer.
", "DescribeLoadBalancerPolicies": "Returns detailed descriptions of the policies. If you specify a load balancer name, the action returns the descriptions of all the policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all the sample policies. The names of the sample policies have the ELBSample- prefix.
Returns meta-information on the specified load balancer policies defined by the Elastic Load Balancing service. The policy types that are returned from this action can be used in a CreateLoadBalancerPolicy action to instantiate specific policy configurations that will be applied to a load balancer.
", "DescribeLoadBalancers": "Returns detailed configuration information for all the load balancers created for the account. If you specify load balancer names, the action returns configuration information of the specified load balancers.
Describes the tags associated with one or more load balancers.
", "DetachLoadBalancerFromSubnets": "Removes subnets from the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer.
After a subnet is removed all of the EC2 instances registered with the load balancer that are in the removed subnet will go into the OutOfService state. When a subnet is removed, the load balancer will balance the traffic among the remaining routable subnets for the load balancer.
", "DisableAvailabilityZonesForLoadBalancer": "Removes the specified EC2 Availability Zones from the set of configured Availability Zones for the load balancer.
There must be at least one Availability Zone registered with a load balancer at all times. Once an Availability Zone is removed, all the instances registered with the load balancer that are in the removed Availability Zone go into the OutOfService state. Upon Availability Zone removal, the load balancer attempts to equally balance the traffic among its remaining usable Availability Zones. Trying to remove an Availability Zone that was not associated with the load balancer does nothing.
For more information, see Disable an Availability Zone from a Load-Balanced Application in the Elastic Load Balancing Developer Guide.
", "EnableAvailabilityZonesForLoadBalancer": "Adds one or more EC2 Availability Zones to the load balancer.
The load balancer evenly distributes requests across all its registered Availability Zones that contain instances.
For more information, see Expand a Load Balanced Application to an Additional Availability Zone in the Elastic Load Balancing Developer Guide.
", "ModifyLoadBalancerAttributes": "Modifies the attributes of a specified load balancer.
You can modify the load balancer attributes, such as AccessLogs, ConnectionDraining, and CrossZoneLoadBalancing by either enabling or disabling them. Or, you can modify the load balancer attribute ConnectionSettings by specifying an idle connection timeout value for your load balancer.
For more information, see the following:
", "RegisterInstancesWithLoadBalancer": "Adds new instances to the load balancer.
Once the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in any of the Availability Zones registered for the load balancer will be moved to the OutOfService state. It will move to the InService state when the Availability Zone is added to the load balancer.
When an instance registered with a load balancer is stopped and then restarted, the IP addresses associated with the instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to the instances. We recommend that you de-register your Amazon EC2 instances from your load balancer after you stop your instance, and then register the load balancer with your instance after you've restarted. To de-register your instances from load balancer, use DeregisterInstancesFromLoadBalancer action.
For more information, see De-register and Register Amazon EC2 Instances in the Elastic Load Balancing Developer Guide.
You can use DescribeLoadBalancers or DescribeInstanceHealth action to check the state of the newly registered instances.
", "RemoveTags": "Removes one or more tags from the specified load balancer.
", "SetLoadBalancerListenerSSLCertificate": "Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port.
For more information on updating your SSL certificate, see Updating an SSL Certificate for a Load Balancer in the Elastic Load Balancing Developer Guide.
", "SetLoadBalancerPoliciesForBackendServer": "Replaces the current set of policies associated with a port on which the back-end server is listening with a new set of policies. After the policies have been created using CreateLoadBalancerPolicy, they can be applied here as a list. At this time, only the back-end server authentication policy type can be applied to the back-end ports; this policy type is composed of multiple public key policies.
The SetLoadBalancerPoliciesForBackendServer replaces the current set of policies associated with the specified instance port. Every time you use this action to enable the policies, use the PolicyNames parameter to list all the policies you want to enable.
You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies action to verify that the policy has been associated with the back-end server.
", "SetLoadBalancerPoliciesOfListener": "Associates, updates, or disables a policy with a listener on the load balancer. You can associate multiple policies with a listener.
" }, "service": "Elastic Load Balancing is a way to automatically distribute incoming web traffic across applications that run on multiple Amazon Elastic Compute Cloud (Amazon EC2) instances.
You can create, access, and manage Elastic Load Balancing using the AWS Management Console, the AWS Command Line Interface (AWS CLI), the Query API, or the AWS SDKs. For more information about Elastic Load Balancing interfaces, see Accessing Elastic Load Balancing.
This reference guide contains documentation for the Query API and the AWS CLI commands, to manage Elastic Load Balancing.
For detailed information about Elastic Load Balancing features and their associated actions or commands, go to Managing Load Balancers in the Elastic Load Balancing Developer Guide.
This reference guide is based on the current WSDL, which is available at: .
Endpoints
The examples in this guide assume that your load balancers are created in the US East (Northern Virginia) region and use us-east-1 as the endpoint.
You can create your load balancers in other AWS regions. For information about regions and endpoints supported by Elastic Load Balancing, see Regions and Endpoints in the Amazon Web Services General Reference.
Idempotency
All Elastic Load Balancing Query API actions and AWS CLI commands are designed to be idempotent. An idempotent action or command completes no more than one time. If you repeat a request or a command using the same values the action will succeed with a 200 OK response code.
", "shapes": { "AccessLog": { "base": "The AccessLog data type.
The name of the load balancer attribute. If enabled, the load balancer captures detailed information of all the requests and delivers the information to the Amazon S3 bucket that you specify.
For more information, see Enable Access Logs.
" } }, "AccessLogEnabled": { "base": null, "refs": { "AccessLog$Enabled": "Specifies whether access log is enabled for the load balancer.
" } }, "AccessLogInterval": { "base": null, "refs": { "AccessLog$EmitInterval": "The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.
Default: 60 minutes
" } }, "AccessLogPrefix": { "base": null, "refs": { "AccessLog$S3BucketPrefix": "The logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod. If the prefix is not provided, the log is placed at the root level of the bucket.
The name associated with the load balancer.
", "ApplySecurityGroupsToLoadBalancerInput$LoadBalancerName": "The name associated with the load balancer. The name must be unique within the set of load balancers associated with your AWS account.
", "AttachLoadBalancerToSubnetsInput$LoadBalancerName": "The name associated with the load balancer. The name must be unique within the set of load balancers associated with your AWS account.
", "ConfigureHealthCheckInput$LoadBalancerName": "The mnemonic name associated with the load balancer. The name must be unique within the set of load balancers associated with your AWS account.
", "CreateAccessPointInput$LoadBalancerName": "The name associated with the load balancer.
The name must be unique within your set of load balancers, must have a maximum of 32 characters, and must only contain alphanumeric characters or hyphens.
", "CreateAppCookieStickinessPolicyInput$LoadBalancerName": "The name of the load balancer.
", "CreateLBCookieStickinessPolicyInput$LoadBalancerName": "The name associated with the load balancer.
", "CreateLoadBalancerListenerInput$LoadBalancerName": "The name of the load balancer.
", "CreateLoadBalancerPolicyInput$LoadBalancerName": "The name associated with the LoadBalancer for which the policy is being created.
", "DeleteAccessPointInput$LoadBalancerName": "The name associated with the load balancer.
", "DeleteLoadBalancerListenerInput$LoadBalancerName": "The mnemonic name associated with the load balancer.
", "DeleteLoadBalancerPolicyInput$LoadBalancerName": "The mnemonic name associated with the load balancer.
", "DeregisterEndPointsInput$LoadBalancerName": "The name associated with the load balancer.
", "DescribeEndPointStateInput$LoadBalancerName": "The name of the load balancer.
", "DescribeLoadBalancerAttributesInput$LoadBalancerName": "The name of the load balancer.
", "DescribeLoadBalancerPoliciesInput$LoadBalancerName": "The mnemonic name associated with the load balancer. If no name is specified, the operation returns the attributes of either all the sample policies pre-defined by Elastic Load Balancing or the specified sample polices.
", "DetachLoadBalancerFromSubnetsInput$LoadBalancerName": "The name associated with the load balancer to be detached.
", "LoadBalancerDescription$LoadBalancerName": "Specifies the name associated with the load balancer.
", "LoadBalancerNames$member": null, "LoadBalancerNamesMax20$member": null, "ModifyLoadBalancerAttributesInput$LoadBalancerName": "The name of the load balancer.
", "ModifyLoadBalancerAttributesOutput$LoadBalancerName": "The name of the load balancer.
", "RegisterEndPointsInput$LoadBalancerName": "The name associated with the load balancer. The name must be unique within your set of load balancers.
", "RemoveAvailabilityZonesInput$LoadBalancerName": "The name associated with the load balancer.
", "SetLoadBalancerListenerSSLCertificateInput$LoadBalancerName": "The name of the load balancer.
", "SetLoadBalancerPoliciesForBackendServerInput$LoadBalancerName": "The mnemonic name associated with the load balancer. This name must be unique within the set of your load balancers.
", "SetLoadBalancerPoliciesOfListenerInput$LoadBalancerName": "The name of the load balancer.
", "TagDescription$LoadBalancerName": "The name of the load balancer.
" } }, "AccessPointNotFoundException": { "base": "The specified load balancer could not be found.
", "refs": { } }, "AccessPointPort": { "base": null, "refs": { "Listener$LoadBalancerPort": "Specifies the port on which the load balancer is listening - 25, 80, 443, 465, 587, or 1024-65535. This property cannot be modified for the life of the load balancer.
", "Ports$member": null, "SetLoadBalancerListenerSSLCertificateInput$LoadBalancerPort": "The port that uses the specified SSL certificate.
", "SetLoadBalancerPoliciesOfListenerInput$LoadBalancerPort": "The external port of the load balancer to associate the policy.
" } }, "AddAvailabilityZonesInput": { "base": "The input for the EnableAvailabilityZonesForLoadBalancer action.
", "refs": { } }, "AddAvailabilityZonesOutput": { "base": "The output for the EnableAvailabilityZonesForLoadBalancer action.
", "refs": { } }, "AddTagsInput": { "base": "The input for the AddTags action", "refs": { } }, "AddTagsOutput": { "base": "The output for the AddTags action.", "refs": { } }, "AdditionalAttribute": { "base": "The AdditionalAttribute data type.
This parameter is reserved for future use.
" } }, "AppCookieStickinessPolicies": { "base": null, "refs": { "Policies$AppCookieStickinessPolicies": "A list of the AppCookieStickinessPolicy objects created with CreateAppCookieStickinessPolicy.
" } }, "AppCookieStickinessPolicy": { "base": "The AppCookieStickinessPolicy data type.
", "refs": { "AppCookieStickinessPolicies$member": null } }, "ApplySecurityGroupsToLoadBalancerInput": { "base": "The input for the ApplySecurityGroupsToLoadBalancer action.
", "refs": { } }, "ApplySecurityGroupsToLoadBalancerOutput": { "base": "The out for the ApplySecurityGroupsToLoadBalancer action.
", "refs": { } }, "AttachLoadBalancerToSubnetsInput": { "base": "The input for the AttachLoadBalancerToSubnets action.
", "refs": { } }, "AttachLoadBalancerToSubnetsOutput": { "base": "The output for the AttachLoadBalancerToSubnets action.
", "refs": { } }, "AttributeName": { "base": null, "refs": { "PolicyAttribute$AttributeName": "The name of the attribute associated with the policy.
", "PolicyAttributeDescription$AttributeName": "The name of the attribute associated with the policy.
", "PolicyAttributeTypeDescription$AttributeName": "The name of the attribute associated with the policy type.
" } }, "AttributeType": { "base": null, "refs": { "PolicyAttributeTypeDescription$AttributeType": "The type of attribute. For example, Boolean, Integer, etc.
" } }, "AttributeValue": { "base": null, "refs": { "PolicyAttribute$AttributeValue": "The value of the attribute associated with the policy.
", "PolicyAttributeDescription$AttributeValue": "The value of the attribute associated with the policy.
" } }, "AvailabilityZone": { "base": null, "refs": { "AvailabilityZones$member": null } }, "AvailabilityZones": { "base": null, "refs": { "AddAvailabilityZonesInput$AvailabilityZones": "A list of new Availability Zones for the load balancer. Each Availability Zone must be in the same region as the load balancer.
", "AddAvailabilityZonesOutput$AvailabilityZones": "An updated list of Availability Zones for the load balancer.
", "CreateAccessPointInput$AvailabilityZones": "A list of Availability Zones.
At least one Availability Zone must be specified. Specified Availability Zones must be in the same EC2 Region as the load balancer. Traffic will be equally distributed across all zones.
You can later add more Availability Zones after the creation of the load balancer by calling EnableAvailabilityZonesForLoadBalancer action.
", "LoadBalancerDescription$AvailabilityZones": "Specifies a list of Availability Zones.
", "RemoveAvailabilityZonesInput$AvailabilityZones": "A list of Availability Zones to be removed from the load balancer.
A list of updated Availability Zones for the load balancer.
" } }, "BackendServerDescription": { "base": "This data type is used as a response element in the DescribeLoadBalancers action to describe the configuration of the back-end server.
", "refs": { "BackendServerDescriptions$member": null } }, "BackendServerDescriptions": { "base": null, "refs": { "LoadBalancerDescription$BackendServerDescriptions": "Contains a list of back-end server descriptions.
" } }, "Cardinality": { "base": null, "refs": { "PolicyAttributeTypeDescription$Cardinality": "The cardinality of the attribute. Valid Values:
The specified SSL ID does not refer to a valid SSL certificate in the AWS Identity and Access Management Service.
", "refs": { } }, "ConfigureHealthCheckInput": { "base": "Input for the ConfigureHealthCheck action.
", "refs": { } }, "ConfigureHealthCheckOutput": { "base": "The output for the ConfigureHealthCheck action.
", "refs": { } }, "ConnectionDraining": { "base": "The ConnectionDraining data type.
The name of the load balancer attribute. If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy back-end instance.
For more information, see Enable Connection Draining.
" } }, "ConnectionDrainingEnabled": { "base": null, "refs": { "ConnectionDraining$Enabled": "Specifies whether connection draining is enabled for the load balancer.
" } }, "ConnectionDrainingTimeout": { "base": null, "refs": { "ConnectionDraining$Timeout": "Specifies the maximum time (in seconds) to keep the existing connections open before deregistering the instances.
" } }, "ConnectionSettings": { "base": "The ConnectionSettings data type.
The name of the load balancer attribute.
By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. If the ConnectionSettings attribute is set, Elastic Load Balancing will allow the connections to remain idle (no data is sent over the connection) for the specified duration.
For more information, see Configure Idle Connection Timeout.
" } }, "CookieExpirationPeriod": { "base": null, "refs": { "CreateLBCookieStickinessPolicyInput$CookieExpirationPeriod": "The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the sticky session will last for the duration of the browser session.
", "LBCookieStickinessPolicy$CookieExpirationPeriod": "The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the stickiness session will last for the duration of the browser session.
" } }, "CookieName": { "base": null, "refs": { "AppCookieStickinessPolicy$CookieName": "The name of the application cookie used for stickiness.
", "CreateAppCookieStickinessPolicyInput$CookieName": "Name of the application cookie used for stickiness.
" } }, "CreateAccessPointInput": { "base": "The input for the CreateLoadBalancer action.
", "refs": { } }, "CreateAccessPointOutput": { "base": "The output for the CreateLoadBalancer action.
", "refs": { } }, "CreateAppCookieStickinessPolicyInput": { "base": "The input for the CreateAppCookieStickinessPolicy action.
", "refs": { } }, "CreateAppCookieStickinessPolicyOutput": { "base": "The output for the CreateAppCookieStickinessPolicy action.
", "refs": { } }, "CreateLBCookieStickinessPolicyInput": { "base": "The input for the CreateLBCookieStickinessPolicy action.
", "refs": { } }, "CreateLBCookieStickinessPolicyOutput": { "base": "The output for the CreateLBCookieStickinessPolicy action.
", "refs": { } }, "CreateLoadBalancerListenerInput": { "base": "The input for the CreateLoadBalancerListeners action.
", "refs": { } }, "CreateLoadBalancerListenerOutput": { "base": "The output for the CreateLoadBalancerListeners action.
", "refs": { } }, "CreateLoadBalancerPolicyInput": { "base": null, "refs": { } }, "CreateLoadBalancerPolicyOutput": { "base": "The output for the CreateLoadBalancerPolicy action.
", "refs": { } }, "CreatedTime": { "base": null, "refs": { "LoadBalancerDescription$CreatedTime": "Provides the date and time the load balancer was created.
" } }, "CrossZoneLoadBalancing": { "base": "The CrossZoneLoadBalancing data type.
The name of the load balancer attribute. If enabled, the load balancer routes the request traffic evenly across all back-end instances regardless of the Availability Zones.
For more information, see Enable Cross-Zone Load Balancing.
" } }, "CrossZoneLoadBalancingEnabled": { "base": null, "refs": { "CrossZoneLoadBalancing$Enabled": "Specifies whether cross-zone load balancing is enabled for the load balancer.
" } }, "DNSName": { "base": null, "refs": { "CreateAccessPointOutput$DNSName": "The DNS name for the load balancer.
", "LoadBalancerDescription$DNSName": "Specifies the external DNS name associated with the load balancer.
", "LoadBalancerDescription$CanonicalHostedZoneName": "Provides the name of the Amazon Route 53 hosted zone that is associated with the load balancer. 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.
", "LoadBalancerDescription$CanonicalHostedZoneNameID": "Provides the ID of the Amazon Route 53 hosted zone name that is associated with the load balancer. 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.
" } }, "DefaultValue": { "base": null, "refs": { "PolicyAttributeTypeDescription$DefaultValue": "The default value of the attribute, if applicable.
" } }, "DeleteAccessPointInput": { "base": "The input for the DeleteLoadBalancer action.
", "refs": { } }, "DeleteAccessPointOutput": { "base": "The output for the DeleteLoadBalancer action.
", "refs": { } }, "DeleteLoadBalancerListenerInput": { "base": "The input for the DeleteLoadBalancerListeners action.
", "refs": { } }, "DeleteLoadBalancerListenerOutput": { "base": "The output for the DeleteLoadBalancerListeners action.
", "refs": { } }, "DeleteLoadBalancerPolicyInput": { "base": "The input for the DeleteLoadBalancerPolicy action.
", "refs": { } }, "DeleteLoadBalancerPolicyOutput": { "base": "The output for the DeleteLoadBalancerPolicy action.
", "refs": { } }, "DeregisterEndPointsInput": { "base": "The input for the DeregisterInstancesFromLoadBalancer action.
", "refs": { } }, "DeregisterEndPointsOutput": { "base": "The output for the DeregisterInstancesFromLoadBalancer action.
", "refs": { } }, "DescribeAccessPointsInput": { "base": "The input for the DescribeLoadBalancers action.
", "refs": { } }, "DescribeAccessPointsOutput": { "base": "The output for the DescribeLoadBalancers action.
", "refs": { } }, "DescribeEndPointStateInput": { "base": "The input for the DescribeEndPointState action.
", "refs": { } }, "DescribeEndPointStateOutput": { "base": "The output for the DescribeInstanceHealth action.
", "refs": { } }, "DescribeLoadBalancerAttributesInput": { "base": "The input for the DescribeLoadBalancerAttributes action.
", "refs": { } }, "DescribeLoadBalancerAttributesOutput": { "base": "The following element is returned in a structure named DescribeLoadBalancerAttributesResult.
The output for the DescribeLoadBalancerPolicies action.
", "refs": { } }, "DescribeLoadBalancerPolicyTypesInput": { "base": null, "refs": { } }, "DescribeLoadBalancerPolicyTypesOutput": { "base": "The output for the DescribeLoadBalancerPolicyTypes action.
", "refs": { } }, "DescribeTagsInput": { "base": "The input for the DescribeTags action.
", "refs": { } }, "DescribeTagsOutput": { "base": "The output for the DescribeTags action.
", "refs": { } }, "Description": { "base": null, "refs": { "InstanceState$Description": "Provides a description of the instance state.
", "PolicyAttributeTypeDescription$Description": "A human-readable description of the attribute.
", "PolicyTypeDescription$Description": "A human-readable description of the policy type.
" } }, "DetachLoadBalancerFromSubnetsInput": { "base": "The input for the DetachLoadBalancerFromSubnets action.
", "refs": { } }, "DetachLoadBalancerFromSubnetsOutput": { "base": "The output for the DetachLoadBalancerFromSubnets action.
", "refs": { } }, "DuplicateAccessPointNameException": { "base": "The load balancer name already exists for this account. Please choose another name.
", "refs": { } }, "DuplicateListenerException": { "base": " A Listener already exists for the given LoadBalancerName and LoadBalancerPort, but with a different InstancePort, Protocol, or SSLCertificateId.
Policy with the same name exists for this load balancer. Please choose another name.
", "refs": { } }, "DuplicateTagKeysException": { "base": "The same tag key specified multiple times.
", "refs": { } }, "EndPointPort": { "base": null, "refs": { "SetLoadBalancerPoliciesForBackendServerInput$InstancePort": "The port number associated with the back-end server.
" } }, "HealthCheck": { "base": "The HealthCheck data type.
", "refs": { "ConfigureHealthCheckInput$HealthCheck": "A structure containing the configuration information for the new healthcheck.
", "ConfigureHealthCheckOutput$HealthCheck": "The updated healthcheck for the instances.
", "LoadBalancerDescription$HealthCheck": "Specifies information regarding the various health probes conducted on the load balancer.
" } }, "HealthCheckInterval": { "base": null, "refs": { "HealthCheck$Interval": "Specifies the approximate interval, in seconds, between health checks of an individual instance.
" } }, "HealthCheckTarget": { "base": null, "refs": { "HealthCheck$Target": "Specifies the instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.
TCP is the default, specified as a TCP: port pair, for example \"TCP:5000\". In this case a healthcheck simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP or HTTPS protocol, the situation is different. You have to include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example \"HTTP:80/weather/us/wa/seattle\". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than \"200 OK\" within the timeout period is considered unhealthy.
The total length of the HTTP ping target needs to be 1024 16-bit Unicode characters or less.
Specifies the amount of time, in seconds, during which no response means a failed health probe.
Specifies the number of consecutive health probe successes required before moving the instance to the Healthy state.
" } }, "IdleTimeout": { "base": null, "refs": { "ConnectionSettings$IdleTimeout": "Specifies the time (in seconds) the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.
" } }, "Instance": { "base": "The Instance data type.
", "refs": { "Instances$member": null } }, "InstanceId": { "base": null, "refs": { "Instance$InstanceId": "Provides an EC2 instance ID.
", "InstanceState$InstanceId": "Provides an EC2 instance ID.
" } }, "InstancePort": { "base": null, "refs": { "BackendServerDescription$InstancePort": "Provides the port on which the back-end server is listening.
", "Listener$InstancePort": "Specifies the port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535. This property cannot be modified for the life of the load balancer.
" } }, "InstanceState": { "base": "The InstanceState data type.
", "refs": { "InstanceStates$member": null } }, "InstanceStates": { "base": null, "refs": { "DescribeEndPointStateOutput$InstanceStates": "A list containing health information for the specified instances.
" } }, "Instances": { "base": null, "refs": { "DeregisterEndPointsInput$Instances": "A list of EC2 instance IDs consisting of all instances to be deregistered.
", "DeregisterEndPointsOutput$Instances": "An updated list of remaining instances registered with the load balancer.
", "DescribeEndPointStateInput$Instances": "A list of instance IDs whose states are being queried.
", "LoadBalancerDescription$Instances": "Provides a list of EC2 instance IDs for the load balancer.
", "RegisterEndPointsInput$Instances": "A list of instance IDs that should be registered with the load balancer.
", "RegisterEndPointsOutput$Instances": "An updated list of instances for the load balancer.
" } }, "InvalidConfigurationRequestException": { "base": "Requested configuration change is invalid.
", "refs": { } }, "InvalidEndPointException": { "base": "The specified EndPoint is not valid.
", "refs": { } }, "InvalidSchemeException": { "base": "Invalid value for scheme. Scheme can only be specified for load balancers in VPC.
", "refs": { } }, "InvalidSecurityGroupException": { "base": "One or more specified security groups do not exist.
", "refs": { } }, "InvalidSubnetException": { "base": "The VPC has no Internet gateway.
", "refs": { } }, "LBCookieStickinessPolicies": { "base": null, "refs": { "Policies$LBCookieStickinessPolicies": "A list of LBCookieStickinessPolicy objects created with CreateAppCookieStickinessPolicy.
" } }, "LBCookieStickinessPolicy": { "base": "The LBCookieStickinessPolicy data type.
", "refs": { "LBCookieStickinessPolicies$member": null } }, "Listener": { "base": "The Listener data type.
For information about the protocols and the ports supported by Elastic Load Balancing, see Listener Configurations for Elastic Load Balancing.
", "refs": { "ListenerDescription$Listener": null, "Listeners$member": null } }, "ListenerDescription": { "base": "The ListenerDescription data type.
", "refs": { "ListenerDescriptions$member": null } }, "ListenerDescriptions": { "base": null, "refs": { "LoadBalancerDescription$ListenerDescriptions": "LoadBalancerPort, InstancePort, Protocol, InstanceProtocol, and PolicyNames are returned in a list of tuples in the ListenerDescriptions element.
" } }, "ListenerNotFoundException": { "base": "Load balancer does not have a listener configured at the given port.
", "refs": { } }, "Listeners": { "base": null, "refs": { "CreateAccessPointInput$Listeners": "A list of the following tuples: Protocol, LoadBalancerPort, InstanceProtocol, InstancePort, and SSLCertificateId.
For information about the protocols and the ports supported by Elastic Load Balancing, see Listener Configurations for Elastic Load Balancing.
", "CreateLoadBalancerListenerInput$Listeners": " A list of LoadBalancerPort, InstancePort, Protocol, InstanceProtocol, and SSLCertificateId items.
The specified load balancer attribute could not be found.
", "refs": { } }, "LoadBalancerAttributes": { "base": "The LoadBalancerAttributes data type.
The load balancer attributes structure.
", "ModifyLoadBalancerAttributesInput$LoadBalancerAttributes": "Attributes of the load balancer.
", "ModifyLoadBalancerAttributesOutput$LoadBalancerAttributes": null } }, "LoadBalancerDescription": { "base": "Contains the result of a successful invocation of DescribeLoadBalancers.
", "refs": { "LoadBalancerDescriptions$member": null } }, "LoadBalancerDescriptions": { "base": null, "refs": { "DescribeAccessPointsOutput$LoadBalancerDescriptions": "A list of load balancer description structures.
" } }, "LoadBalancerNames": { "base": null, "refs": { "AddTagsInput$LoadBalancerNames": "The name of the load balancer to tag. You can specify a maximum of one load balancer name.
", "DescribeAccessPointsInput$LoadBalancerNames": "A list of load balancer names associated with the account.
", "RemoveTagsInput$LoadBalancerNames": "The name of the load balancer. You can specify a maximum of one load balancer name.
" } }, "LoadBalancerNamesMax20": { "base": null, "refs": { "DescribeTagsInput$LoadBalancerNames": "The names of the load balancers.
" } }, "LoadBalancerScheme": { "base": null, "refs": { "CreateAccessPointInput$Scheme": "The type of a load balancer.
By default, Elastic Load Balancing creates an Internet-facing load balancer with a publicly resolvable DNS name, which resolves to public IP addresses. For more information about Internet-facing and Internal load balancers, see Internet-facing and Internal Load Balancers.
Specify the value internal for this option to create an internal load balancer with a DNS name that resolves to private IP addresses.
This option is only available for load balancers created within EC2-VPC.
Specifies the type of load balancer.
If the Scheme is internet-facing, the load balancer has a publicly resolvable DNS name that resolves to public IP addresses.
If the Scheme is internal, the load balancer has a publicly resolvable DNS name that resolves to private IP addresses.
This option is only available for load balancers attached to an Amazon VPC.
" } }, "Marker": { "base": null, "refs": { "DescribeAccessPointsInput$Marker": "An optional parameter used for pagination of results from this call. If specified, the response includes only records beyond the marker.
", "DescribeAccessPointsOutput$NextMarker": "Specifies the value of next marker if the request returned more than one page of results.
" } }, "ModifyLoadBalancerAttributesInput": { "base": "The input for the ModifyLoadBalancerAttributes action.
", "refs": { } }, "ModifyLoadBalancerAttributesOutput": { "base": "The output for the ModifyLoadBalancerAttributes action.
", "refs": { } }, "PageSize": { "base": null, "refs": { "DescribeAccessPointsInput$PageSize": "The number of results returned in each page. The default is 400. You cannot specify a page size greater than 400 or less than 1.
" } }, "Policies": { "base": "The policies data type.
", "refs": { "LoadBalancerDescription$Policies": "Provides a list of policies defined for the load balancer.
" } }, "PolicyAttribute": { "base": "The PolicyAttribute data type. This data type contains a key/value pair that defines properties of a specific policy.
", "refs": { "PolicyAttributes$member": null } }, "PolicyAttributeDescription": { "base": " The PolicyAttributeDescription data type. This data type is used to describe the attributes and values associated with a policy.
A list of policy attribute description structures.
" } }, "PolicyAttributeTypeDescription": { "base": " The PolicyAttributeTypeDescription data type. This data type is used to describe values that are acceptable for the policy attribute.
The description of the policy attributes associated with the load balancer policies defined by the Elastic Load Balancing service.
" } }, "PolicyAttributes": { "base": null, "refs": { "CreateLoadBalancerPolicyInput$PolicyAttributes": "A list of attributes associated with the policy being created.
" } }, "PolicyDescription": { "base": " The PolicyDescription data type.
A list of policy description structures.
" } }, "PolicyName": { "base": null, "refs": { "AppCookieStickinessPolicy$PolicyName": "The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.
", "CreateAppCookieStickinessPolicyInput$PolicyName": "The name of the policy being created. The name must be unique within the set of policies for this load balancer.
", "CreateLBCookieStickinessPolicyInput$PolicyName": "The name of the policy being created. The name must be unique within the set of policies for this load balancer.
", "CreateLoadBalancerPolicyInput$PolicyName": "The name of the load balancer policy being created. The name must be unique within the set of policies for this load balancer.
", "DeleteLoadBalancerPolicyInput$PolicyName": "The mnemonic name for the policy being deleted.
", "LBCookieStickinessPolicy$PolicyName": "The name for the policy being created. The name must be unique within the set of policies for this load balancer.
", "PolicyDescription$PolicyName": "The name of the policy associated with the load balancer.
", "PolicyNames$member": null } }, "PolicyNames": { "base": null, "refs": { "BackendServerDescription$PolicyNames": "Provides a list of policy names enabled for the back-end server.
", "DescribeLoadBalancerPoliciesInput$PolicyNames": "The names of load balancer policies you've created or Elastic Load Balancing sample policy names.
", "ListenerDescription$PolicyNames": "A list of policies enabled for this listener. An empty list indicates that no policies are enabled.
", "Policies$OtherPolicies": "A list of policy names other than the stickiness policies.
", "SetLoadBalancerPoliciesForBackendServerInput$PolicyNames": "List of policy names to be set. If the list is empty, then all current polices are removed from the back-end server.
", "SetLoadBalancerPoliciesOfListenerInput$PolicyNames": "List of policies to be associated with the listener. If the list is empty, the current policy is removed from the listener.
" } }, "PolicyNotFoundException": { "base": "One or more specified policies were not found.
", "refs": { } }, "PolicyTypeDescription": { "base": "The PolicyTypeDescription data type.
", "refs": { "PolicyTypeDescriptions$member": null } }, "PolicyTypeDescriptions": { "base": null, "refs": { "DescribeLoadBalancerPolicyTypesOutput$PolicyTypeDescriptions": "List of policy type description structures of the specified policy type. If no policy type names are specified, returns the description of all the policy types defined by Elastic Load Balancing service.
" } }, "PolicyTypeName": { "base": null, "refs": { "CreateLoadBalancerPolicyInput$PolicyTypeName": "The name of the base policy type being used to create this policy. To get the list of policy types, use the DescribeLoadBalancerPolicyTypes action.
", "PolicyDescription$PolicyTypeName": "The name of the policy type associated with the load balancer.
", "PolicyTypeDescription$PolicyTypeName": "The name of the policy type.
", "PolicyTypeNames$member": null } }, "PolicyTypeNames": { "base": null, "refs": { "DescribeLoadBalancerPolicyTypesInput$PolicyTypeNames": "Specifies the name of the policy types. If no names are specified, returns the description of all the policy types defined by Elastic Load Balancing service.
" } }, "PolicyTypeNotFoundException": { "base": "One or more of the specified policy types do not exist.
", "refs": { } }, "Ports": { "base": null, "refs": { "DeleteLoadBalancerListenerInput$LoadBalancerPorts": "The client port number(s) of the load balancer listener(s) to be removed.
" } }, "Protocol": { "base": null, "refs": { "Listener$Protocol": "Specifies the load balancer transport protocol to use for routing - HTTP, HTTPS, TCP or SSL. This property cannot be modified for the life of the load balancer.
", "Listener$InstanceProtocol": "Specifies the protocol to use for routing traffic to back-end instances - HTTP, HTTPS, TCP, or SSL. This property cannot be modified for the life of the load balancer.
InstanceProtocol has to be at the same protocol layer, i.e., HTTP or HTTPS. Likewise, if the front-end protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL. InstancePort whose InstanceProtocol is secure, i.e., HTTPS or SSL, the listener's InstanceProtocol has to be secure, i.e., HTTPS or SSL. If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be either HTTP or TCP. Provides information about the cause of OutOfService instances. Specifically, it indicates whether the cause is Elastic Load Balancing or the instance behind the load balancer.
Valid value: ELB|Instance|N/A
The input for the RegisterInstancesWithLoadBalancer action.
", "refs": { } }, "RegisterEndPointsOutput": { "base": "The output for the RegisterInstancesWithLoadBalancer action.
", "refs": { } }, "RemoveAvailabilityZonesInput": { "base": "The input for the DisableAvailabilityZonesForLoadBalancer action.
", "refs": { } }, "RemoveAvailabilityZonesOutput": { "base": "The output for the DisableAvailabilityZonesForLoadBalancer action.
", "refs": { } }, "RemoveTagsInput": { "base": "The input for the RemoveTags action.
", "refs": { } }, "RemoveTagsOutput": { "base": "The output for the RemoveTags action.
", "refs": { } }, "S3BucketName": { "base": null, "refs": { "AccessLog$S3BucketName": "The name of the Amazon S3 bucket where the access logs are stored.
" } }, "SSLCertificateId": { "base": null, "refs": { "Listener$SSLCertificateId": "The ARN string of the server certificate. To get the ARN of the server certificate, call the AWS Identity and Access Management UploadServerCertificate API.
", "SetLoadBalancerListenerSSLCertificateInput$SSLCertificateId": "The Amazon Resource Number (ARN) of the SSL certificate chain to use. For more information on SSL certificates, see Managing Server Certificates in the AWS Identity and Access Management User Guide.
" } }, "SecurityGroupId": { "base": null, "refs": { "SecurityGroups$member": null } }, "SecurityGroupName": { "base": null, "refs": { "SourceSecurityGroup$GroupName": " Name of the source security group. Use this value for the --source-group parameter of the ec2-authorize command in the Amazon EC2 command line tool.
Owner of the source security group. Use this value for the --source-group-user parameter of the ec2-authorize command in the Amazon EC2 command line tool.
A list of security group IDs to associate with your load balancer in VPC. The security group IDs must be provided as the ID and not the security group name (For example, sg-1234).
", "ApplySecurityGroupsToLoadBalancerOutput$SecurityGroups": "A list of security group IDs associated with your load balancer.
", "CreateAccessPointInput$SecurityGroups": "The security groups to assign to your load balancer within your VPC.
", "LoadBalancerDescription$SecurityGroups": "The security groups the load balancer is a member of (VPC only).
" } }, "SetLoadBalancerListenerSSLCertificateInput": { "base": "The input for the SetLoadBalancerListenerSSLCertificate action.
", "refs": { } }, "SetLoadBalancerListenerSSLCertificateOutput": { "base": "The output for the SetLoadBalancerListenerSSLCertificate action.
", "refs": { } }, "SetLoadBalancerPoliciesForBackendServerInput": { "base": "The input for the SetLoadBalancerPoliciesForBackendServer action.
", "refs": { } }, "SetLoadBalancerPoliciesForBackendServerOutput": { "base": "The output for the SetLoadBalancerPoliciesForBackendServer action.
", "refs": { } }, "SetLoadBalancerPoliciesOfListenerInput": { "base": "The input for the SetLoadBalancerPoliciesOfListener action.
", "refs": { } }, "SetLoadBalancerPoliciesOfListenerOutput": { "base": "The output for the SetLoadBalancerPoliciesOfListener action.
", "refs": { } }, "SourceSecurityGroup": { "base": "This data type is used as a response element in the DescribeLoadBalancers action. For information about Elastic Load Balancing security groups, go to Using Security Groups With Elastic Load Balancing in the Elastic Load Balancing Developer Guide.
", "refs": { "LoadBalancerDescription$SourceSecurityGroup": "The security group that you can use as part of your inbound rules for your load balancer's back-end Amazon EC2 application instances. To only allow traffic from load balancers, add a security group rule to your back end instance that specifies this source security group as the inbound source.
" } }, "State": { "base": null, "refs": { "InstanceState$State": "Specifies the current state of the instance.
Valid value: InService|OutOfService|Unknown
Reserved for future use.
", "AdditionalAttribute$Value": "Reserved for future use.
" } }, "SubnetId": { "base": null, "refs": { "Subnets$member": null } }, "SubnetNotFoundException": { "base": "One or more subnets were not found.
", "refs": { } }, "Subnets": { "base": null, "refs": { "AttachLoadBalancerToSubnetsInput$Subnets": "A list of subnet IDs to add for the load balancer. You can add only one subnet per Availability Zone.
", "AttachLoadBalancerToSubnetsOutput$Subnets": "A list of subnet IDs attached to the load balancer.
", "CreateAccessPointInput$Subnets": "A list of subnet IDs in your VPC to attach to your load balancer. Specify one subnet per Availability Zone.
", "DetachLoadBalancerFromSubnetsInput$Subnets": "A list of subnet IDs to remove from the set of configured subnets for the load balancer.
", "DetachLoadBalancerFromSubnetsOutput$Subnets": "A list of subnet IDs the load balancer is now attached to.
", "LoadBalancerDescription$Subnets": "Provides a list of VPC subnet IDs for the load balancer.
" } }, "Tag": { "base": "Metadata assigned to a load balancer consisting of key-value pair.
For more information, see Tagging in the Elastic Load Balancing Developer Guide.
", "refs": { "TagList$member": null } }, "TagDescription": { "base": "The descriptions of all the tags associated with load balancer.
", "refs": { "TagDescriptions$member": null } }, "TagDescriptions": { "base": null, "refs": { "DescribeTagsOutput$TagDescriptions": "A list of tag description structures.
" } }, "TagKey": { "base": null, "refs": { "Tag$Key": "The key of the tag.
", "TagKeyOnly$Key": "The name of the key.
" } }, "TagKeyList": { "base": null, "refs": { "RemoveTagsInput$Tags": "A list of tag keys to remove.
" } }, "TagKeyOnly": { "base": "The key of a tag to be removed.
", "refs": { "TagKeyList$member": null } }, "TagList": { "base": null, "refs": { "AddTagsInput$Tags": "A list of tags for each load balancer.
", "CreateAccessPointInput$Tags": "A list of tags to assign to the load balancer.
For more information about setting tags for your load balancer, see Tagging.
", "TagDescription$Tags": "List of tags associated with the load balancer.
" } }, "TagValue": { "base": null, "refs": { "Tag$Value": "The value of the tag.
" } }, "TooManyAccessPointsException": { "base": "The quota for the number of load balancers has already been reached.
", "refs": { } }, "TooManyPoliciesException": { "base": "Quota for number of policies for this load balancer has already been reached.
", "refs": { } }, "TooManyTagsException": { "base": "The quota for the number of tags that can be assigned to a load balancer has been reached.
", "refs": { } }, "UnhealthyThreshold": { "base": null, "refs": { "HealthCheck$UnhealthyThreshold": "Specifies the number of consecutive health probe failures required before moving the instance to the Unhealthy state.
" } }, "VPCId": { "base": null, "refs": { "LoadBalancerDescription$VPCId": "Provides the ID of the VPC attached to the load balancer.
" } } } }