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
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AddTagsResult |
addTags(AddTagsRequest request)
Adds the specified tags to the specified resource.
|
CreateListenerResult |
createListener(CreateListenerRequest request)
Creates a listener for the specified Application load balancer.
|
CreateLoadBalancerResult |
createLoadBalancer(CreateLoadBalancerRequest request)
Creates an Application load balancer.
|
CreateRuleResult |
createRule(CreateRuleRequest request)
Creates a rule for the specified listener.
|
CreateTargetGroupResult |
createTargetGroup(CreateTargetGroupRequest request)
Creates a target group.
|
DeleteListenerResult |
deleteListener(DeleteListenerRequest request)
Deletes the specified listener.
|
DeleteLoadBalancerResult |
deleteLoadBalancer(DeleteLoadBalancerRequest request)
Deletes the specified load balancer and its attached listeners.
|
DeleteRuleResult |
deleteRule(DeleteRuleRequest request)
Deletes the specified rule.
|
DeleteTargetGroupResult |
deleteTargetGroup(DeleteTargetGroupRequest request)
Deletes the specified target group.
|
DeregisterTargetsResult |
deregisterTargets(DeregisterTargetsRequest request)
Deregisters the specified targets from the specified target group.
|
DescribeListenersResult |
describeListeners(DescribeListenersRequest request)
Describes the specified listeners or the listeners for the specified load
balancer.
|
DescribeLoadBalancerAttributesResult |
describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest request)
Describes the attributes for the specified load balancer.
|
DescribeLoadBalancersResult |
describeLoadBalancers(DescribeLoadBalancersRequest request)
Describes the specified Application load balancers or all of your
Application load balancers.
|
DescribeRulesResult |
describeRules(DescribeRulesRequest request)
Describes the specified rules or the rules for the specified listener.
|
DescribeSSLPoliciesResult |
describeSSLPolicies(DescribeSSLPoliciesRequest request)
Describes the specified policies or all policies used for SSL
negotiation.
|
DescribeTagsResult |
describeTags(DescribeTagsRequest request)
Describes the tags for the specified resources.
|
DescribeTargetGroupAttributesResult |
describeTargetGroupAttributes(DescribeTargetGroupAttributesRequest request)
Describes the attributes for the specified target group.
|
DescribeTargetGroupsResult |
describeTargetGroups(DescribeTargetGroupsRequest request)
Describes the specified target groups or all of your target groups.
|
DescribeTargetHealthResult |
describeTargetHealth(DescribeTargetHealthRequest request)
Describes the health of the specified targets or all of your targets.
|
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.
|
ModifyListenerResult |
modifyListener(ModifyListenerRequest request)
Modifies the specified properties of the specified listener.
|
ModifyLoadBalancerAttributesResult |
modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest request)
Modifies the specified attributes of the specified load balancer.
|
ModifyRuleResult |
modifyRule(ModifyRuleRequest request)
Modifies the specified rule.
|
ModifyTargetGroupResult |
modifyTargetGroup(ModifyTargetGroupRequest request)
Modifies the health checks used when evaluating the health state of the
targets in the specified target group.
|
ModifyTargetGroupAttributesResult |
modifyTargetGroupAttributes(ModifyTargetGroupAttributesRequest request)
Modifies the specified attributes of the specified target group.
|
RegisterTargetsResult |
registerTargets(RegisterTargetsRequest request)
Registers the specified targets with the specified target group.
|
RemoveTagsResult |
removeTags(RemoveTagsRequest request)
Removes the specified tags from the specified resource.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client
("elasticloadbalancing.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AmazonElasticLoadBalancing.setEndpoint(String) ,
sets the regional endpoint for this client's service calls. |
SetRulePrioritiesResult |
setRulePriorities(SetRulePrioritiesRequest request)
Sets the priorities of the specified rules.
|
SetSecurityGroupsResult |
setSecurityGroups(SetSecurityGroupsRequest request)
Associates the specified security groups with the specified load
balancer.
|
SetSubnetsResult |
setSubnets(SetSubnetsRequest request)
Enables the Availability Zone for the specified subnets for the specified
load balancer.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
public void setEndpoint(String endpoint)
AmazonElasticLoadBalancing
Callers can pass in just the endpoint (ex:
"elasticloadbalancing.us-east-1.amazonaws.com") or a full URL, including
the protocol (ex: "elasticloadbalancing.us-east-1.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.us-east-1.amazonaws.com")
or a full URL, including the protocol (ex:
"elasticloadbalancing.us-east-1.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 resource. You can tag your Application load balancers and your target groups.
Each tag consists of a key and an optional value. If a resource already
has a tag with the same key, AddTags
updates its value.
To list the current tags for your resources, use DescribeTags. To remove tags from your resources, use RemoveTags.
addTags
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for AddTags.public CreateListenerResult createListener(CreateListenerRequest request)
AmazonElasticLoadBalancing
Creates a listener for the specified Application load balancer.
To update a listener, use ModifyListener. When you are finished with a listener, you can delete it using DeleteListener. If you are finished with both the listener and the load balancer, you can delete them both using DeleteLoadBalancer.
For more information, see Listeners for Your Application Load Balancers in the Application Load Balancers Guide.
createListener
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for CreateListener.public CreateLoadBalancerResult createLoadBalancer(CreateLoadBalancerRequest request)
AmazonElasticLoadBalancing
Creates an Application load balancer.
To create listeners for your load balancer, use CreateListener. You can add security groups, subnets, and tags when you create your load balancer, or you can add them later using SetSecurityGroups, SetSubnets, and AddTags.
To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer.
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 Limits for Your Application Load Balancer in the Application Load Balancers Guide.
createLoadBalancer
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for CreateLoadBalancer.public CreateRuleResult createRule(CreateRuleRequest request)
AmazonElasticLoadBalancing
Creates a rule for the specified listener.
A rule consists conditions and actions. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, the specified actions are taken. If no rule's conditions are met, the default actions for the listener are taken.
To view your current rules, use DescribeRules. To update a rule, use ModifyRule. To set the priorities of your rules, use SetRulePriorities. To delete a rule, use DeleteRule.
createRule
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for CreateRule.public CreateTargetGroupResult createTargetGroup(CreateTargetGroupRequest request)
AmazonElasticLoadBalancing
Creates a target group.
To register targets with the target group, use RegisterTargets. To update the health check settings for the target group, use ModifyTargetGroup. To monitor the health of targets in the target group, use DescribeTargetHealth.
To route traffic to the targets in a target group, specify the target group in an action using CreateListener or CreateRule.
To delete a target group, use DeleteTargetGroup.
For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide.
createTargetGroup
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for CreateTargetGroup.public DeleteListenerResult deleteListener(DeleteListenerRequest request)
AmazonElasticLoadBalancing
Deletes the specified listener.
Alternatively, your listener is deleted when you delete the load balancer it is attached to using DeleteLoadBalancer.
deleteListener
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for DeleteListener.public DeleteLoadBalancerResult deleteLoadBalancer(DeleteLoadBalancerRequest request)
AmazonElasticLoadBalancing
Deletes the specified load balancer and its attached listeners.
You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.
Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.
deleteLoadBalancer
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for DeleteLoadBalancer.public DeleteRuleResult deleteRule(DeleteRuleRequest request)
AmazonElasticLoadBalancing
Deletes the specified rule.
deleteRule
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for DeleteRule.public DeleteTargetGroupResult deleteTargetGroup(DeleteTargetGroupRequest request)
AmazonElasticLoadBalancing
Deletes the specified target group.
You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks.
deleteTargetGroup
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for DeleteTargetGroup.public DeregisterTargetsResult deregisterTargets(DeregisterTargetsRequest request)
AmazonElasticLoadBalancing
Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.
deregisterTargets
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for DeregisterTargets.public DescribeListenersResult describeListeners(DescribeListenersRequest request)
AmazonElasticLoadBalancing
Describes the specified listeners or the listeners for the specified load balancer. You must specify either a load balancer or one or more listeners.
describeListeners
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for DescribeListeners.public DescribeLoadBalancerAttributesResult describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest request)
AmazonElasticLoadBalancing
Describes the attributes for the specified load balancer.
describeLoadBalancerAttributes
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for DescribeLoadBalancerAttributes.public DescribeLoadBalancersResult describeLoadBalancers(DescribeLoadBalancersRequest request)
AmazonElasticLoadBalancing
Describes the specified Application load balancers or all of your Application load balancers.
To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes.
describeLoadBalancers
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for DescribeLoadBalancers.public DescribeRulesResult describeRules(DescribeRulesRequest request)
AmazonElasticLoadBalancing
Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.
describeRules
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for DescribeRules.public DescribeSSLPoliciesResult describeSSLPolicies(DescribeSSLPoliciesRequest request)
AmazonElasticLoadBalancing
Describes the specified policies or all policies used for SSL negotiation.
Note that the only supported policy at this time is ELBSecurityPolicy-2015-05.
describeSSLPolicies
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for DescribeSSLPolicies.public DescribeTagsResult describeTags(DescribeTagsRequest request)
AmazonElasticLoadBalancing
Describes the tags for the specified resources.
describeTags
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for DescribeTags.public DescribeTargetGroupAttributesResult describeTargetGroupAttributes(DescribeTargetGroupAttributesRequest request)
AmazonElasticLoadBalancing
Describes the attributes for the specified target group.
describeTargetGroupAttributes
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for DescribeTargetGroupAttributes.public DescribeTargetGroupsResult describeTargetGroups(DescribeTargetGroupsRequest request)
AmazonElasticLoadBalancing
Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.
To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes.
describeTargetGroups
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for DescribeTargetGroups.public DescribeTargetHealthResult describeTargetHealth(DescribeTargetHealthRequest request)
AmazonElasticLoadBalancing
Describes the health of the specified targets or all of your targets.
describeTargetHealth
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for DescribeTargetHealth.public ModifyListenerResult modifyListener(ModifyListenerRequest request)
AmazonElasticLoadBalancing
Modifies the specified properties of the specified listener.
Any properties that you do not specify retain their current values. However, changing the protocol from HTTPS to HTTP removes the security policy and SSL certificate properties. If you change the protocol from HTTP to HTTPS, you must add the security policy.
modifyListener
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for ModifyListener.public ModifyLoadBalancerAttributesResult modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest request)
AmazonElasticLoadBalancing
Modifies the specified attributes of the specified load balancer.
If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values.
modifyLoadBalancerAttributes
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for ModifyLoadBalancerAttributes.public ModifyRuleResult modifyRule(ModifyRuleRequest request)
AmazonElasticLoadBalancing
Modifies the specified rule.
Any existing properties that you do not modify retain their current values.
To modify the default action, use ModifyListener.
modifyRule
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for ModifyRules.public ModifyTargetGroupResult modifyTargetGroup(ModifyTargetGroupRequest request)
AmazonElasticLoadBalancing
Modifies the health checks used when evaluating the health state of the targets in the specified target group.
To monitor the health of the targets, use DescribeTargetHealth.
modifyTargetGroup
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for ModifyTargetGroup.public ModifyTargetGroupAttributesResult modifyTargetGroupAttributes(ModifyTargetGroupAttributesRequest request)
AmazonElasticLoadBalancing
Modifies the specified attributes of the specified target group.
modifyTargetGroupAttributes
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for ModifyTargetGroupAttributes.public RegisterTargetsResult registerTargets(RegisterTargetsRequest request)
AmazonElasticLoadBalancing
Registers the specified targets with the specified target group.
The target must be in the virtual private cloud (VPC) that you specified for the target group.
To remove a target from a target group, use DeregisterTargets.
registerTargets
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for RegisterTargets.public RemoveTagsResult removeTags(RemoveTagsRequest request)
AmazonElasticLoadBalancing
Removes the specified tags from the specified resource.
To list the current tags for your resources, use DescribeTags.
removeTags
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for RemoveTags.public SetRulePrioritiesResult setRulePriorities(SetRulePrioritiesRequest request)
AmazonElasticLoadBalancing
Sets the priorities of the specified rules.
You can reorder the rules as long as there are no priority conflicts in the new order. Any existing rules that you do not specify retain their current priority.
setRulePriorities
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for SetRulePriorities.public SetSecurityGroupsResult setSecurityGroups(SetSecurityGroupsRequest request)
AmazonElasticLoadBalancing
Associates the specified security groups with the specified load balancer. The specified security groups override the previously associated security groups.
setSecurityGroups
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for SetSecurityGroups.public SetSubnetsResult setSubnets(SetSubnetsRequest request)
AmazonElasticLoadBalancing
Enables the Availability Zone for the specified subnets for the specified load balancer. The specified subnets replace the previously enabled subnets.
setSubnets
in interface AmazonElasticLoadBalancing
request
- Contains the parameters for SetSubnets.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 © 2013 Amazon Web Services, Inc. All Rights Reserved.