com.amazonaws.services.elasticloadbalancingv2

Class AmazonElasticLoadBalancingClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.elasticloadbalancingv2.AmazonElasticLoadBalancingClient

All Implemented Interfaces:

AmazonElasticLoadBalancing

Direct Known Subclasses:

AmazonElasticLoadBalancingAsyncClient

@ThreadSafe
public class AmazonElasticLoadBalancingClient
extends AmazonWebServiceClient
implements AmazonElasticLoadBalancing

Client for accessing Elastic Load Balancing v2. All service calls made using this client are blocking, and will not return until the service call completes.

Elastic Load Balancing

A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.

Elastic Load Balancing supports two types of load balancers: Classic load balancers and Application load balancers (new). A Classic load balancer makes routing and load balancing decisions either at the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS), and supports either EC2-Classic or a VPC. An Application load balancer makes routing and load balancing decisions at the application layer (HTTP/HTTPS), supports path-based routing, and can route requests to one or more ports on each EC2 instance or container instance in your virtual private cloud (VPC). For more information, see the Elastic Load Balancing User Guide.

This reference covers the 2015-12-01 API, which supports Application load balancers. The 2012-06-01 API supports Classic load balancers.

To get started with an Application load balancer, complete the following tasks:

1. Create a load balancer using CreateLoadBalancer.

2. Create a target group using CreateTargetGroup.

3. Register targets for the target group using RegisterTargets.

4. Create one or more listeners for your load balancer using CreateListener.

5. (Optional) Create one or more rules for content routing based on URL using CreateRule.

To delete an Application load balancer and its related resources, complete the following tasks:

1. Delete the load balancer using DeleteLoadBalancer.

2. Delete the target group using DeleteTargetGroup.

All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.elasticloadbalancingv2.AmazonElasticLoadBalancing

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AmazonElasticLoadBalancingClient() Constructs a new client to invoke service methods on Elastic Load Balancing v2.
AmazonElasticLoadBalancingClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on Elastic Load Balancing v2 using the specified AWS account credentials.
AmazonElasticLoadBalancingClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Elastic Load Balancing v2 using the specified AWS account credentials and client configuration options.
AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on Elastic Load Balancing v2 using the specified AWS account credentials provider.
AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Elastic Load Balancing v2 using the specified AWS account credentials provider and client configuration options.
AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on Elastic Load Balancing v2 using the specified AWS account credentials provider, client configuration options, and request metric collector.
AmazonElasticLoadBalancingClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Elastic Load Balancing v2.

Method Summary

Modifier and Type	Method and Description
AddTagsResult	addTags(AddTagsRequest addTagsRequest) Adds the specified tags to the specified resource.
CreateListenerResult	createListener(CreateListenerRequest createListenerRequest) Creates a listener for the specified Application load balancer.
CreateLoadBalancerResult	createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest) Creates an Application load balancer.
CreateRuleResult	createRule(CreateRuleRequest createRuleRequest) Creates a rule for the specified listener.
CreateTargetGroupResult	createTargetGroup(CreateTargetGroupRequest createTargetGroupRequest) Creates a target group.
DeleteListenerResult	deleteListener(DeleteListenerRequest deleteListenerRequest) Deletes the specified listener.
DeleteLoadBalancerResult	deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest) Deletes the specified load balancer and its attached listeners.
DeleteRuleResult	deleteRule(DeleteRuleRequest deleteRuleRequest) Deletes the specified rule.
DeleteTargetGroupResult	deleteTargetGroup(DeleteTargetGroupRequest deleteTargetGroupRequest) Deletes the specified target group.
DeregisterTargetsResult	deregisterTargets(DeregisterTargetsRequest deregisterTargetsRequest) Deregisters the specified targets from the specified target group.
DescribeListenersResult	describeListeners(DescribeListenersRequest describeListenersRequest) Describes the specified listeners or the listeners for the specified load balancer.
DescribeLoadBalancerAttributesResult	describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest) Describes the attributes for the specified load balancer.
DescribeLoadBalancersResult	describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest) Describes the specified Application load balancers or all of your Application load balancers.
DescribeRulesResult	describeRules(DescribeRulesRequest describeRulesRequest) Describes the specified rules or the rules for the specified listener.
DescribeSSLPoliciesResult	describeSSLPolicies(DescribeSSLPoliciesRequest describeSSLPoliciesRequest) Describes the specified policies or all policies used for SSL negotiation.
DescribeTagsResult	describeTags(DescribeTagsRequest describeTagsRequest) Describes the tags for the specified resources.
DescribeTargetGroupAttributesResult	describeTargetGroupAttributes(DescribeTargetGroupAttributesRequest describeTargetGroupAttributesRequest) Describes the attributes for the specified target group.
DescribeTargetGroupsResult	describeTargetGroups(DescribeTargetGroupsRequest describeTargetGroupsRequest) Describes the specified target groups or all of your target groups.
DescribeTargetHealthResult	describeTargetHealth(DescribeTargetHealthRequest describeTargetHealthRequest) 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 modifyListenerRequest) Modifies the specified properties of the specified listener.
ModifyLoadBalancerAttributesResult	modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest) Modifies the specified attributes of the specified load balancer.
ModifyRuleResult	modifyRule(ModifyRuleRequest modifyRuleRequest) Modifies the specified rule.
ModifyTargetGroupResult	modifyTargetGroup(ModifyTargetGroupRequest modifyTargetGroupRequest) Modifies the health checks used when evaluating the health state of the targets in the specified target group.
ModifyTargetGroupAttributesResult	modifyTargetGroupAttributes(ModifyTargetGroupAttributesRequest modifyTargetGroupAttributesRequest) Modifies the specified attributes of the specified target group.
RegisterTargetsResult	registerTargets(RegisterTargetsRequest registerTargetsRequest) Registers the specified targets with the specified target group.
RemoveTagsResult	removeTags(RemoveTagsRequest removeTagsRequest) Removes the specified tags from the specified resource.
SetRulePrioritiesResult	setRulePriorities(SetRulePrioritiesRequest setRulePrioritiesRequest) Sets the priorities of the specified rules.
SetSecurityGroupsResult	setSecurityGroups(SetSecurityGroupsRequest setSecurityGroupsRequest) Associates the specified security groups with the specified load balancer.
SetSubnetsResult	setSubnets(SetSubnetsRequest setSubnetsRequest) Enables the Availability Zone for the specified subnets for the specified load balancer.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.elasticloadbalancingv2.AmazonElasticLoadBalancing

setEndpoint, setRegion, shutdown

Constructor Detail

AmazonElasticLoadBalancingClient

public AmazonElasticLoadBalancingClient()

Constructs a new client to invoke service methods on Elastic Load Balancing v2. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonElasticLoadBalancingClient

public AmazonElasticLoadBalancingClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on Elastic Load Balancing v2. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to Elastic Load Balancing v2 (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonElasticLoadBalancingClient

public AmazonElasticLoadBalancingClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on Elastic Load Balancing v2 using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonElasticLoadBalancingClient

public AmazonElasticLoadBalancingClient(AWSCredentials awsCredentials,
                                        ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on Elastic Load Balancing v2 using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Elastic Load Balancing v2 (ex: proxy settings, retry counts, etc.).

AmazonElasticLoadBalancingClient

public AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on Elastic Load Balancing v2 using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonElasticLoadBalancingClient

public AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider,
                                        ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on Elastic Load Balancing v2 using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Elastic Load Balancing v2 (ex: proxy settings, retry counts, etc.).

AmazonElasticLoadBalancingClient

public AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider,
                                        ClientConfiguration clientConfiguration,
                                        RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on Elastic Load Balancing v2 using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Elastic Load Balancing v2 (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

addTags

public AddTagsResult addTags(AddTagsRequest addTagsRequest)

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.

Specified by:

addTags in interface AmazonElasticLoadBalancing

Parameters:

addTagsRequest - Contains the parameters for AddTags.

Returns:

Result of the AddTags operation returned by the service.

Throws:

DuplicateTagKeysException - A tag key was specified more than once.

TooManyTagsException - You've reached the limit on the number of tags per load balancer.

LoadBalancerNotFoundException - The specified load balancer does not exist.

TargetGroupNotFoundException - The specified target group does not exist.

createListener

public CreateListenerResult createListener(CreateListenerRequest createListenerRequest)

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.

Specified by:

createListener in interface AmazonElasticLoadBalancing

Parameters:

createListenerRequest - Contains the parameters for CreateListener.

Returns:

Result of the CreateListener operation returned by the service.

Throws:

DuplicateListenerException - A listener with the specified port already exists.

TooManyListenersException - You've reached the limit on the number of listeners per load balancer.

TooManyCertificatesException - You've reached the limit on the number of certificates per listener.

LoadBalancerNotFoundException - The specified load balancer does not exist.

TargetGroupNotFoundException - The specified target group does not exist.

TargetGroupAssociationLimitException - You've reached the limit on the number of load balancers per target group.

InvalidConfigurationRequestException - The requested configuration is not valid.

IncompatibleProtocolsException - The specified configuration is not valid with this protocol.

SSLPolicyNotFoundException - The specified SSL policy does not exist.

CertificateNotFoundException - The specified certificate does not exist.

UnsupportedProtocolException - The specified protocol is not supported.

TooManyRegistrationsForTargetIdException - You've reached the limit on the number of times a target can be registered with a load balancer.

createLoadBalancer

public CreateLoadBalancerResult createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest)

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.

Specified by:

createLoadBalancer in interface AmazonElasticLoadBalancing

Parameters:

createLoadBalancerRequest - Contains the parameters for CreateLoadBalancer.

Returns:

Result of the CreateLoadBalancer operation returned by the service.

Throws:

DuplicateLoadBalancerNameException - A load balancer with the specified name already exists for this account.

TooManyLoadBalancersException - You've reached the limit on the number of load balancers for your AWS account.

InvalidConfigurationRequestException - The requested configuration is not valid.

SubnetNotFoundException - The specified subnet does not exist.

InvalidSubnetException - The specified subnet is out of available addresses.

InvalidSecurityGroupException - The specified security group does not exist.

InvalidSchemeException - The requested scheme is not valid.

TooManyTagsException - You've reached the limit on the number of tags per load balancer.

DuplicateTagKeysException - A tag key was specified more than once.

createRule

public CreateRuleResult createRule(CreateRuleRequest createRuleRequest)

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.

Specified by:

createRule in interface AmazonElasticLoadBalancing

Parameters:

createRuleRequest - Contains the parameters for CreateRule.

Returns:

Result of the CreateRule operation returned by the service.

Throws:

PriorityInUseException - The specified priority is in use.

TooManyTargetGroupsException - You've reached the limit on the number of target groups for your AWS account.

TooManyRulesException - You've reached the limit on the number of rules per load balancer.

TargetGroupAssociationLimitException - You've reached the limit on the number of load balancers per target group.

ListenerNotFoundException - The specified listener does not exist.

TargetGroupNotFoundException - The specified target group does not exist.

InvalidConfigurationRequestException - The requested configuration is not valid.

TooManyRegistrationsForTargetIdException - You've reached the limit on the number of times a target can be registered with a load balancer.

createTargetGroup

public CreateTargetGroupResult createTargetGroup(CreateTargetGroupRequest createTargetGroupRequest)

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.

Specified by:

createTargetGroup in interface AmazonElasticLoadBalancing

Parameters:

createTargetGroupRequest - Contains the parameters for CreateTargetGroup.

Returns:

Result of the CreateTargetGroup operation returned by the service.

Throws:

DuplicateTargetGroupNameException - A target group with the specified name already exists.

TooManyTargetGroupsException - You've reached the limit on the number of target groups for your AWS account.

deleteListener

public DeleteListenerResult deleteListener(DeleteListenerRequest deleteListenerRequest)

Deletes the specified listener.

Alternatively, your listener is deleted when you delete the load balancer it is attached to using DeleteLoadBalancer.

Specified by:

deleteListener in interface AmazonElasticLoadBalancing

Parameters:

deleteListenerRequest - Contains the parameters for DeleteListener.

Returns:

Result of the DeleteListener operation returned by the service.

Throws:

ListenerNotFoundException - The specified listener does not exist.

deleteLoadBalancer

public DeleteLoadBalancerResult deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest)

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.

Specified by:

deleteLoadBalancer in interface AmazonElasticLoadBalancing

Parameters:

deleteLoadBalancerRequest - Contains the parameters for DeleteLoadBalancer.

Returns:

Result of the DeleteLoadBalancer operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

OperationNotPermittedException - This operation is not allowed.

deleteRule

public DeleteRuleResult deleteRule(DeleteRuleRequest deleteRuleRequest)

Deletes the specified rule.

Specified by:

deleteRule in interface AmazonElasticLoadBalancing

Parameters:

deleteRuleRequest - Contains the parameters for DeleteRule.

Returns:

Result of the DeleteRule operation returned by the service.

Throws:

RuleNotFoundException - The specified rule does not exist.

OperationNotPermittedException - This operation is not allowed.

deleteTargetGroup

public DeleteTargetGroupResult deleteTargetGroup(DeleteTargetGroupRequest deleteTargetGroupRequest)

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.

Specified by:

deleteTargetGroup in interface AmazonElasticLoadBalancing

Parameters:

deleteTargetGroupRequest - Contains the parameters for DeleteTargetGroup.

Returns:

Result of the DeleteTargetGroup operation returned by the service.

Throws:

ResourceInUseException - A specified resource is in use.

deregisterTargets

public DeregisterTargetsResult deregisterTargets(DeregisterTargetsRequest deregisterTargetsRequest)

Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.

Specified by:

deregisterTargets in interface AmazonElasticLoadBalancing

Parameters:

deregisterTargetsRequest - Contains the parameters for DeregisterTargets.

Returns:

Result of the DeregisterTargets operation returned by the service.

Throws:

TargetGroupNotFoundException - The specified target group does not exist.

InvalidTargetException - The specified target does not exist or is not in the same VPC as the target group.

describeListeners

public DescribeListenersResult describeListeners(DescribeListenersRequest describeListenersRequest)

Describes the specified listeners or the listeners for the specified load balancer. You must specify either a load balancer or one or more listeners.

Specified by:

describeListeners in interface AmazonElasticLoadBalancing

Parameters:

describeListenersRequest - Contains the parameters for DescribeListeners.

Returns:

Result of the DescribeListeners operation returned by the service.

Throws:

ListenerNotFoundException - The specified listener does not exist.

LoadBalancerNotFoundException - The specified load balancer does not exist.

describeLoadBalancerAttributes

public DescribeLoadBalancerAttributesResult describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest)

Describes the attributes for the specified load balancer.

Specified by:

describeLoadBalancerAttributes in interface AmazonElasticLoadBalancing

Parameters:

describeLoadBalancerAttributesRequest - Contains the parameters for DescribeLoadBalancerAttributes.

Returns:

Result of the DescribeLoadBalancerAttributes operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

describeLoadBalancers

public DescribeLoadBalancersResult describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest)

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.

Specified by:

describeLoadBalancers in interface AmazonElasticLoadBalancing

Parameters:

describeLoadBalancersRequest - Contains the parameters for DescribeLoadBalancers.

Returns:

Result of the DescribeLoadBalancers operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

describeRules

public DescribeRulesResult describeRules(DescribeRulesRequest describeRulesRequest)

Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.

Specified by:

describeRules in interface AmazonElasticLoadBalancing

Parameters:

describeRulesRequest - Contains the parameters for DescribeRules.

Returns:

Result of the DescribeRules operation returned by the service.

Throws:

ListenerNotFoundException - The specified listener does not exist.

RuleNotFoundException - The specified rule does not exist.

describeSSLPolicies

public DescribeSSLPoliciesResult describeSSLPolicies(DescribeSSLPoliciesRequest describeSSLPoliciesRequest)

Describes the specified policies or all policies used for SSL negotiation.

Note that the only supported policy at this time is ELBSecurityPolicy-2015-05.

Specified by:

describeSSLPolicies in interface AmazonElasticLoadBalancing

Parameters:

describeSSLPoliciesRequest - Contains the parameters for DescribeSSLPolicies.

Returns:

Result of the DescribeSSLPolicies operation returned by the service.

Throws:

SSLPolicyNotFoundException - The specified SSL policy does not exist.

describeTags

public DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest)

Describes the tags for the specified resources.

Specified by:

describeTags in interface AmazonElasticLoadBalancing

Parameters:

describeTagsRequest - Contains the parameters for DescribeTags.

Returns:

Result of the DescribeTags operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

TargetGroupNotFoundException - The specified target group does not exist.

ListenerNotFoundException - The specified listener does not exist.

RuleNotFoundException - The specified rule does not exist.

describeTargetGroupAttributes

public DescribeTargetGroupAttributesResult describeTargetGroupAttributes(DescribeTargetGroupAttributesRequest describeTargetGroupAttributesRequest)

Describes the attributes for the specified target group.

Specified by:

describeTargetGroupAttributes in interface AmazonElasticLoadBalancing

Parameters:

describeTargetGroupAttributesRequest - Contains the parameters for DescribeTargetGroupAttributes.

Returns:

Result of the DescribeTargetGroupAttributes operation returned by the service.

Throws:

TargetGroupNotFoundException - The specified target group does not exist.

describeTargetGroups

public DescribeTargetGroupsResult describeTargetGroups(DescribeTargetGroupsRequest describeTargetGroupsRequest)

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.

Specified by:

describeTargetGroups in interface AmazonElasticLoadBalancing

Parameters:

describeTargetGroupsRequest - Contains the parameters for DescribeTargetGroups.

Returns:

Result of the DescribeTargetGroups operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

TargetGroupNotFoundException - The specified target group does not exist.

describeTargetHealth

public DescribeTargetHealthResult describeTargetHealth(DescribeTargetHealthRequest describeTargetHealthRequest)

Describes the health of the specified targets or all of your targets.

Specified by:

describeTargetHealth in interface AmazonElasticLoadBalancing

Parameters:

describeTargetHealthRequest - Contains the parameters for DescribeTargetHealth.

Returns:

Result of the DescribeTargetHealth operation returned by the service.

Throws:

InvalidTargetException - The specified target does not exist or is not in the same VPC as the target group.

TargetGroupNotFoundException - The specified target group does not exist.

HealthUnavailableException - The health of the specified targets could not be retrieved due to an internal error.

modifyListener

public ModifyListenerResult modifyListener(ModifyListenerRequest modifyListenerRequest)

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.

Specified by:

modifyListener in interface AmazonElasticLoadBalancing

Parameters:

modifyListenerRequest - Contains the parameters for ModifyListener.

Returns:

Result of the ModifyListener operation returned by the service.

Throws:

DuplicateListenerException - A listener with the specified port already exists.

TooManyListenersException - You've reached the limit on the number of listeners per load balancer.

TooManyCertificatesException - You've reached the limit on the number of certificates per listener.

ListenerNotFoundException - The specified listener does not exist.

TargetGroupNotFoundException - The specified target group does not exist.

TargetGroupAssociationLimitException - You've reached the limit on the number of load balancers per target group.

IncompatibleProtocolsException - The specified configuration is not valid with this protocol.

SSLPolicyNotFoundException - The specified SSL policy does not exist.

CertificateNotFoundException - The specified certificate does not exist.

InvalidConfigurationRequestException - The requested configuration is not valid.

UnsupportedProtocolException - The specified protocol is not supported.

TooManyRegistrationsForTargetIdException - You've reached the limit on the number of times a target can be registered with a load balancer.

modifyLoadBalancerAttributes

public ModifyLoadBalancerAttributesResult modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest)

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.

Specified by:

modifyLoadBalancerAttributes in interface AmazonElasticLoadBalancing

Parameters:

modifyLoadBalancerAttributesRequest - Contains the parameters for ModifyLoadBalancerAttributes.

Returns:

Result of the ModifyLoadBalancerAttributes operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

InvalidConfigurationRequestException - The requested configuration is not valid.

modifyRule

public ModifyRuleResult modifyRule(ModifyRuleRequest modifyRuleRequest)

Modifies the specified rule.

Any existing properties that you do not modify retain their current values.

To modify the default action, use ModifyListener.

Specified by:

modifyRule in interface AmazonElasticLoadBalancing

Parameters:

modifyRuleRequest - Contains the parameters for ModifyRules.

Returns:

Result of the ModifyRule operation returned by the service.

Throws:

TargetGroupAssociationLimitException - You've reached the limit on the number of load balancers per target group.

RuleNotFoundException - The specified rule does not exist.

OperationNotPermittedException - This operation is not allowed.

TooManyRegistrationsForTargetIdException - You've reached the limit on the number of times a target can be registered with a load balancer.

modifyTargetGroup

public ModifyTargetGroupResult modifyTargetGroup(ModifyTargetGroupRequest modifyTargetGroupRequest)

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.

Specified by:

modifyTargetGroup in interface AmazonElasticLoadBalancing

Parameters:

modifyTargetGroupRequest - Contains the parameters for ModifyTargetGroup.

Returns:

Result of the ModifyTargetGroup operation returned by the service.

Throws:

TargetGroupNotFoundException - The specified target group does not exist.

modifyTargetGroupAttributes

public ModifyTargetGroupAttributesResult modifyTargetGroupAttributes(ModifyTargetGroupAttributesRequest modifyTargetGroupAttributesRequest)

Modifies the specified attributes of the specified target group.

Specified by:

modifyTargetGroupAttributes in interface AmazonElasticLoadBalancing

Parameters:

modifyTargetGroupAttributesRequest - Contains the parameters for ModifyTargetGroupAttributes.

Returns:

Result of the ModifyTargetGroupAttributes operation returned by the service.

Throws:

TargetGroupNotFoundException - The specified target group does not exist.

registerTargets

public RegisterTargetsResult registerTargets(RegisterTargetsRequest registerTargetsRequest)

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.

Specified by:

registerTargets in interface AmazonElasticLoadBalancing

Parameters:

registerTargetsRequest - Contains the parameters for RegisterTargets.

Returns:

Result of the RegisterTargets operation returned by the service.

Throws:

TargetGroupNotFoundException - The specified target group does not exist.

TooManyTargetsException - You've reached the limit on the number of targets.

InvalidTargetException - The specified target does not exist or is not in the same VPC as the target group.

TooManyRegistrationsForTargetIdException - You've reached the limit on the number of times a target can be registered with a load balancer.

removeTags

public RemoveTagsResult removeTags(RemoveTagsRequest removeTagsRequest)

Removes the specified tags from the specified resource.

To list the current tags for your resources, use DescribeTags.

Specified by:

removeTags in interface AmazonElasticLoadBalancing

Parameters:

removeTagsRequest - Contains the parameters for RemoveTags.

Returns:

Result of the RemoveTags operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

TargetGroupNotFoundException - The specified target group does not exist.

ListenerNotFoundException - The specified listener does not exist.

RuleNotFoundException - The specified rule does not exist.

TooManyTagsException - You've reached the limit on the number of tags per load balancer.

setRulePriorities

public SetRulePrioritiesResult setRulePriorities(SetRulePrioritiesRequest setRulePrioritiesRequest)

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.

Specified by:

setRulePriorities in interface AmazonElasticLoadBalancing

Parameters:

setRulePrioritiesRequest - Contains the parameters for SetRulePriorities.

Returns:

Result of the SetRulePriorities operation returned by the service.

Throws:

RuleNotFoundException - The specified rule does not exist.

PriorityInUseException - The specified priority is in use.

OperationNotPermittedException - This operation is not allowed.

setSecurityGroups

public SetSecurityGroupsResult setSecurityGroups(SetSecurityGroupsRequest setSecurityGroupsRequest)

Associates the specified security groups with the specified load balancer. The specified security groups override the previously associated security groups.

Specified by:

setSecurityGroups in interface AmazonElasticLoadBalancing

Parameters:

setSecurityGroupsRequest - Contains the parameters for SetSecurityGroups.

Returns:

Result of the SetSecurityGroups operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

InvalidConfigurationRequestException - The requested configuration is not valid.

InvalidSecurityGroupException - The specified security group does not exist.

setSubnets

public SetSubnetsResult setSubnets(SetSubnetsRequest setSubnetsRequest)

Enables the Availability Zone for the specified subnets for the specified load balancer. The specified subnets replace the previously enabled subnets.

Specified by:

setSubnets in interface AmazonElasticLoadBalancing

Parameters:

setSubnetsRequest - Contains the parameters for SetSubnets.

Returns:

Result of the SetSubnets operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

InvalidConfigurationRequestException - The requested configuration is not valid.

SubnetNotFoundException - The specified subnet does not exist.

InvalidSubnetException - The specified subnet is out of available addresses.

getCachedResponseMetadata

public 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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonElasticLoadBalancing

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.