public class AbstractAmazonElasticLoadBalancing extends Object implements AmazonElasticLoadBalancing
AmazonElasticLoadBalancing
. Convenient
method forms pass through to the corresponding overload that takes a request
object, which throws an UnsupportedOperationException
.Modifier | Constructor and Description |
---|---|
protected |
AbstractAmazonElasticLoadBalancing() |
Modifier and Type | Method and Description |
---|---|
AddTagsResult |
addTags(AddTagsRequest request)
Adds the specified tags to the specified load balancer.
|
ApplySecurityGroupsToLoadBalancerResult |
applySecurityGroupsToLoadBalancer(ApplySecurityGroupsToLoadBalancerRequest request)
Associates one or more security groups with your load balancer in a
virtual private cloud (VPC).
|
AttachLoadBalancerToSubnetsResult |
attachLoadBalancerToSubnets(AttachLoadBalancerToSubnetsRequest request)
Adds one or more subnets to the set of configured subnets for the
specified load balancer.
|
ConfigureHealthCheckResult |
configureHealthCheck(ConfigureHealthCheckRequest request)
Specifies the health check settings to use when evaluating the health
state of your back-end instances.
|
CreateAppCookieStickinessPolicyResult |
createAppCookieStickinessPolicy(CreateAppCookieStickinessPolicyRequest request)
Generates a stickiness policy with sticky session lifetimes that follow
that of an application-generated cookie.
|
CreateLBCookieStickinessPolicyResult |
createLBCookieStickinessPolicy(CreateLBCookieStickinessPolicyRequest request)
Generates a stickiness policy with sticky session lifetimes controlled by
the lifetime of the browser (user-agent) or a specified expiration
period.
|
CreateLoadBalancerResult |
createLoadBalancer(CreateLoadBalancerRequest request)
Creates a load balancer.
|
CreateLoadBalancerListenersResult |
createLoadBalancerListeners(CreateLoadBalancerListenersRequest request)
Creates one or more listeners for the specified load balancer.
|
CreateLoadBalancerPolicyResult |
createLoadBalancerPolicy(CreateLoadBalancerPolicyRequest request)
Creates a policy with the specified attributes for the specified load
balancer.
|
DeleteLoadBalancerResult |
deleteLoadBalancer(DeleteLoadBalancerRequest request)
Deletes the specified load balancer.
|
DeleteLoadBalancerListenersResult |
deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest request)
Deletes the specified listeners from the specified load balancer.
|
DeleteLoadBalancerPolicyResult |
deleteLoadBalancerPolicy(DeleteLoadBalancerPolicyRequest request)
Deletes the specified policy from the specified load balancer.
|
DeregisterInstancesFromLoadBalancerResult |
deregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest request)
Deregisters the specified instances from the specified load balancer.
|
DescribeInstanceHealthResult |
describeInstanceHealth(DescribeInstanceHealthRequest request)
Describes the state of the specified instances with respect to the
specified load balancer.
|
DescribeLoadBalancerAttributesResult |
describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest request)
Describes the attributes for the specified load balancer.
|
DescribeLoadBalancerPoliciesResult |
describeLoadBalancerPolicies()
Simplified method form for invoking the DescribeLoadBalancerPolicies
operation.
|
DescribeLoadBalancerPoliciesResult |
describeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest request)
Describes the specified policies.
|
DescribeLoadBalancerPolicyTypesResult |
describeLoadBalancerPolicyTypes()
Simplified method form for invoking the DescribeLoadBalancerPolicyTypes
operation.
|
DescribeLoadBalancerPolicyTypesResult |
describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest request)
Describes the specified load balancer policy types.
|
DescribeLoadBalancersResult |
describeLoadBalancers()
Simplified method form for invoking the DescribeLoadBalancers operation.
|
DescribeLoadBalancersResult |
describeLoadBalancers(DescribeLoadBalancersRequest request)
Describes the specified the load balancers.
|
DescribeTagsResult |
describeTags(DescribeTagsRequest request)
Describes the tags associated with the specified load balancers.
|
DetachLoadBalancerFromSubnetsResult |
detachLoadBalancerFromSubnets(DetachLoadBalancerFromSubnetsRequest request)
Removes the specified subnets from the set of configured subnets for the
load balancer.
|
DisableAvailabilityZonesForLoadBalancerResult |
disableAvailabilityZonesForLoadBalancer(DisableAvailabilityZonesForLoadBalancerRequest request)
Removes the specified Availability Zones from the set of Availability
Zones for the specified load balancer.
|
EnableAvailabilityZonesForLoadBalancerResult |
enableAvailabilityZonesForLoadBalancer(EnableAvailabilityZonesForLoadBalancerRequest request)
Adds the specified Availability Zones to the set of Availability Zones
for the specified load balancer.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request,
typically used for debugging issues where a service isn't acting as
expected.
|
ModifyLoadBalancerAttributesResult |
modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest request)
Modifies the attributes of the specified load balancer.
|
RegisterInstancesWithLoadBalancerResult |
registerInstancesWithLoadBalancer(RegisterInstancesWithLoadBalancerRequest request)
Adds the specified instances to the specified load balancer.
|
RemoveTagsResult |
removeTags(RemoveTagsRequest request)
Removes one or more tags from the specified load balancer.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client
("elasticloadbalancing.amazonaws.com").
|
SetLoadBalancerListenerSSLCertificateResult |
setLoadBalancerListenerSSLCertificate(SetLoadBalancerListenerSSLCertificateRequest request)
Sets the certificate that terminates the specified listener's SSL
connections.
|
SetLoadBalancerPoliciesForBackendServerResult |
setLoadBalancerPoliciesForBackendServer(SetLoadBalancerPoliciesForBackendServerRequest request)
Replaces the set of policies associated with the specified port on which
the back-end server is listening with a new set of policies.
|
SetLoadBalancerPoliciesOfListenerResult |
setLoadBalancerPoliciesOfListener(SetLoadBalancerPoliciesOfListenerRequest request)
Associates, updates, or disables a policy with a listener for the
specified load balancer.
|
void |
setRegion(Region region)
An alternative to
AmazonElasticLoadBalancing.setEndpoint(String) ,
sets the regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
protected AbstractAmazonElasticLoadBalancing()
public void setEndpoint(String endpoint)
AmazonElasticLoadBalancing
Callers can pass in just the endpoint (ex:
"elasticloadbalancing.amazonaws.com") or a full URL, including the
protocol (ex: "elasticloadbalancing.amazonaws.com"). If the protocol is
not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AmazonElasticLoadBalancing
endpoint
- The endpoint (ex: "elasticloadbalancing.amazonaws.com") or a full
URL, including the protocol (ex:
"elasticloadbalancing.amazonaws.com") of the region specific AWS
endpoint this client will communicate with.public void setRegion(Region region)
AmazonElasticLoadBalancing
AmazonElasticLoadBalancing.setEndpoint(String)
,
sets the regional endpoint for this client's service calls. Callers can
use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AmazonElasticLoadBalancing
region
- The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions)
for
accessing a given region. Must not be null and must be a region
where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public AddTagsResult addTags(AddTagsRequest request)
AmazonElasticLoadBalancing
Adds the specified tags to the specified load balancer. Each load balancer can have a maximum of 10 tags.
Each tag consists of a key and an optional value. If a tag with the same
key is already associated with the load balancer, AddTags
updates its value.
For more information, see Tag Your Load Balancer in the Elastic Load Balancing Developer Guide.
addTags
in interface AmazonElasticLoadBalancing
public ApplySecurityGroupsToLoadBalancerResult applySecurityGroupsToLoadBalancer(ApplySecurityGroupsToLoadBalancerRequest request)
AmazonElasticLoadBalancing
Associates one or more security groups with your load balancer in a virtual private cloud (VPC). The specified security groups override the previously associated security groups.
For more information, see Security Groups for Load Balancers in a VPC in the Elastic Load Balancing Developer Guide.
applySecurityGroupsToLoadBalancer
in interface AmazonElasticLoadBalancing
public AttachLoadBalancerToSubnetsResult attachLoadBalancerToSubnets(AttachLoadBalancerToSubnetsRequest request)
AmazonElasticLoadBalancing
Adds one or more subnets to the set of configured subnets for the specified load balancer.
The load balancer evenly distributes requests across all registered subnets. For more information, see Add or Remove Subnets for Your Load Balancer in a VPC in the Elastic Load Balancing Developer Guide.
attachLoadBalancerToSubnets
in interface AmazonElasticLoadBalancing
public ConfigureHealthCheckResult configureHealthCheck(ConfigureHealthCheckRequest request)
AmazonElasticLoadBalancing
Specifies the health check settings to use when evaluating the health state of your back-end instances.
For more information, see Configure Health Checks in the Elastic Load Balancing Developer Guide.
configureHealthCheck
in interface AmazonElasticLoadBalancing
public CreateAppCookieStickinessPolicyResult createAppCookieStickinessPolicy(CreateAppCookieStickinessPolicyRequest request)
AmazonElasticLoadBalancing
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, AWSELB
, 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.
For more information, see Application-Controlled Session Stickiness in the Elastic Load Balancing Developer Guide.
createAppCookieStickinessPolicy
in interface AmazonElasticLoadBalancing
public CreateLBCookieStickinessPolicyResult createLBCookieStickinessPolicy(CreateLBCookieStickinessPolicyRequest request)
AmazonElasticLoadBalancing
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 back-end 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 Duration-Based Session Stickiness in the Elastic Load Balancing Developer Guide.
createLBCookieStickinessPolicy
in interface AmazonElasticLoadBalancing
public CreateLoadBalancerResult createLoadBalancer(CreateLoadBalancerRequest request)
AmazonElasticLoadBalancing
Creates a load balancer.
If the call completes successfully, a new load balancer is created with a unique Domain Name Service (DNS) name. The load balancer receives incoming traffic and routes it to the registered instances. For more information, see How Elastic Load Balancing Works in the Elastic Load Balancing Developer Guide.
You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see Elastic Load Balancing Limits in the Elastic Load Balancing Developer Guide.
createLoadBalancer
in interface AmazonElasticLoadBalancing
public CreateLoadBalancerListenersResult createLoadBalancerListeners(CreateLoadBalancerListenersRequest request)
AmazonElasticLoadBalancing
Creates one or more listeners for the specified load balancer. If a listener with the specified port does not already exist, it is 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.
createLoadBalancerListeners
in interface AmazonElasticLoadBalancing
public CreateLoadBalancerPolicyResult createLoadBalancerPolicy(CreateLoadBalancerPolicyRequest request)
AmazonElasticLoadBalancing
Creates a policy with the specified attributes for the specified load balancer.
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 the policy type.
createLoadBalancerPolicy
in interface AmazonElasticLoadBalancing
public DeleteLoadBalancerResult deleteLoadBalancer(DeleteLoadBalancerRequest request)
AmazonElasticLoadBalancing
Deletes the specified load balancer.
If you are attempting to recreate a load balancer, you must reconfigure all settings. The DNS name associated with a deleted load balancer are no longer usable. The name and associated DNS record of the deleted load balancer no longer exist and traffic sent to any of its IP addresses is no longer delivered to back-end instances.
If the load balancer does not exist or has already been deleted, the call
to DeleteLoadBalancer
still succeeds.
deleteLoadBalancer
in interface AmazonElasticLoadBalancing
public DeleteLoadBalancerListenersResult deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest request)
AmazonElasticLoadBalancing
Deletes the specified listeners from the specified load balancer.
deleteLoadBalancerListeners
in interface AmazonElasticLoadBalancing
public DeleteLoadBalancerPolicyResult deleteLoadBalancerPolicy(DeleteLoadBalancerPolicyRequest request)
AmazonElasticLoadBalancing
Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners.
deleteLoadBalancerPolicy
in interface AmazonElasticLoadBalancing
request
- =public DeregisterInstancesFromLoadBalancerResult deregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest request)
AmazonElasticLoadBalancing
Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer.
You can use DescribeLoadBalancers to verify that the instance is deregistered from the load balancer.
For more information, see Deregister and Register Amazon EC2 Instances in the Elastic Load Balancing Developer Guide.
deregisterInstancesFromLoadBalancer
in interface AmazonElasticLoadBalancing
public DescribeInstanceHealthResult describeInstanceHealth(DescribeInstanceHealthRequest request)
AmazonElasticLoadBalancing
Describes the state of the specified instances with respect to the specified load balancer. If no instances are specified, the call describes the state of all instances that are currently registered with the load balancer. If instances are specified, their state is returned even if they are no longer registered with the load balancer. The state of terminated instances is not returned.
describeInstanceHealth
in interface AmazonElasticLoadBalancing
public DescribeLoadBalancerAttributesResult describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest request)
AmazonElasticLoadBalancing
Describes the attributes for the specified load balancer.
describeLoadBalancerAttributes
in interface AmazonElasticLoadBalancing
public DescribeLoadBalancerPoliciesResult describeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest request)
AmazonElasticLoadBalancing
Describes the specified policies.
If you specify a load balancer name, the action returns the descriptions
of all 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 sample policies. The names of the sample policies
have the ELBSample-
prefix.
describeLoadBalancerPolicies
in interface AmazonElasticLoadBalancing
public DescribeLoadBalancerPoliciesResult describeLoadBalancerPolicies()
AmazonElasticLoadBalancing
describeLoadBalancerPolicies
in interface AmazonElasticLoadBalancing
AmazonElasticLoadBalancing.describeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest)
public DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest request)
AmazonElasticLoadBalancing
Describes the specified load balancer policy types.
You can use these policy types with CreateLoadBalancerPolicy to create policy configurations for a load balancer.
describeLoadBalancerPolicyTypes
in interface AmazonElasticLoadBalancing
public DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes()
AmazonElasticLoadBalancing
public DescribeLoadBalancersResult describeLoadBalancers(DescribeLoadBalancersRequest request)
AmazonElasticLoadBalancing
Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.
describeLoadBalancers
in interface AmazonElasticLoadBalancing
public DescribeLoadBalancersResult describeLoadBalancers()
AmazonElasticLoadBalancing
describeLoadBalancers
in interface AmazonElasticLoadBalancing
AmazonElasticLoadBalancing.describeLoadBalancers(DescribeLoadBalancersRequest)
public DescribeTagsResult describeTags(DescribeTagsRequest request)
AmazonElasticLoadBalancing
Describes the tags associated with the specified load balancers.
describeTags
in interface AmazonElasticLoadBalancing
public DetachLoadBalancerFromSubnetsResult detachLoadBalancerFromSubnets(DetachLoadBalancerFromSubnetsRequest request)
AmazonElasticLoadBalancing
Removes the specified subnets from the set of configured subnets for the load balancer.
After a subnet is removed, all EC2 instances registered with the load
balancer in the removed subnet go into the OutOfService
state. Then, the load balancer balances the traffic among the remaining
routable subnets.
detachLoadBalancerFromSubnets
in interface AmazonElasticLoadBalancing
public DisableAvailabilityZonesForLoadBalancerResult disableAvailabilityZonesForLoadBalancer(DisableAvailabilityZonesForLoadBalancerRequest request)
AmazonElasticLoadBalancing
Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer.
There must be at least one Availability Zone registered with a load
balancer at all times. After an Availability Zone is removed, all
instances registered with the load balancer that are in the removed
Availability Zone go into the OutOfService
state. Then, the
load balancer attempts to equally balance the traffic among its remaining
Availability Zones.
For more information, see Disable an Availability Zone from a Load-Balanced Application in the Elastic Load Balancing Developer Guide.
disableAvailabilityZonesForLoadBalancer
in interface AmazonElasticLoadBalancing
public EnableAvailabilityZonesForLoadBalancerResult enableAvailabilityZonesForLoadBalancer(EnableAvailabilityZonesForLoadBalancerRequest request)
AmazonElasticLoadBalancing
Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer.
The load balancer evenly distributes requests across all its registered Availability Zones that contain instances.
For more information, see Add Availability Zone in the Elastic Load Balancing Developer Guide.
enableAvailabilityZonesForLoadBalancer
in interface AmazonElasticLoadBalancing
public ModifyLoadBalancerAttributesResult modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest request)
AmazonElasticLoadBalancing
Modifies the attributes of the 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 in the Elastic Load Balancing Developer Guide:
modifyLoadBalancerAttributes
in interface AmazonElasticLoadBalancing
public RegisterInstancesWithLoadBalancerResult registerInstancesWithLoadBalancer(RegisterInstancesWithLoadBalancerRequest request)
AmazonElasticLoadBalancing
Adds the specified instances to the specified load balancer.
The instance must be a running instance in the same network as the load balancer (EC2-Classic or the same VPC). If you have EC2-Classic instances and a load balancer in a VPC with ClassicLink enabled, you can link the EC2-Classic instances to that VPC and then register the linked EC2-Classic instances with the load balancer in the VPC.
Note that RegisterInstanceWithLoadBalancer
completes when
the request has been registered. Instance registration takes a little
time to complete. To check the state of the registered instances, use
DescribeLoadBalancers or DescribeInstanceHealth.
After the instance is registered, it starts receiving traffic and
requests from the load balancer. Any instance that is not in one of the
Availability Zones registered for the load balancer is moved to the
OutOfService
state. If an Availability Zone is added to the
load balancer later, any instances registered with the load balancer move
to the InService
state.
If you stop an instance registered with a load balancer and then start it, 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 use the following sequence: stop the instance, deregister the instance, start the instance, and then register the instance. To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer.
For more information, see Deregister and Register EC2 Instances in the Elastic Load Balancing Developer Guide.
registerInstancesWithLoadBalancer
in interface AmazonElasticLoadBalancing
public RemoveTagsResult removeTags(RemoveTagsRequest request)
AmazonElasticLoadBalancing
Removes one or more tags from the specified load balancer.
removeTags
in interface AmazonElasticLoadBalancing
public SetLoadBalancerListenerSSLCertificateResult setLoadBalancerListenerSSLCertificate(SetLoadBalancerListenerSSLCertificateRequest request)
AmazonElasticLoadBalancing
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 about updating your SSL certificate, see Updating an SSL Certificate for a Load Balancer in the Elastic Load Balancing Developer Guide.
setLoadBalancerListenerSSLCertificate
in interface AmazonElasticLoadBalancing
public SetLoadBalancerPoliciesForBackendServerResult setLoadBalancerPoliciesForBackendServer(SetLoadBalancerPoliciesForBackendServerRequest request)
AmazonElasticLoadBalancing
Replaces the set of policies associated with the specified port on which the back-end server is listening with a new set of policies. 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.
Each time you use SetLoadBalancerPoliciesForBackendServer
to
enable the policies, use the PolicyNames
parameter to list
the policies that you want to enable.
You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies to verify that the policy is associated with the back-end server.
setLoadBalancerPoliciesForBackendServer
in interface AmazonElasticLoadBalancing
public SetLoadBalancerPoliciesOfListenerResult setLoadBalancerPoliciesOfListener(SetLoadBalancerPoliciesOfListenerRequest request)
AmazonElasticLoadBalancing
Associates, updates, or disables a policy with a listener for the specified load balancer. You can associate multiple policies with a listener.
setLoadBalancerPoliciesOfListener
in interface AmazonElasticLoadBalancing
public void shutdown()
AmazonElasticLoadBalancing
shutdown
in interface AmazonElasticLoadBalancing
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonElasticLoadBalancing
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AmazonElasticLoadBalancing
request
- The originally executed request.Copyright © 2016. All rights reserved.