forked from aws/aws-sdk-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAmazonElasticLoadBalancing.java
More file actions
1010 lines (976 loc) · 49.1 KB
/
AmazonElasticLoadBalancing.java
File metadata and controls
1010 lines (976 loc) · 49.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2010-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.elasticloadbalancing;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.elasticloadbalancing.model.*;
/**
* Interface for accessing AmazonElasticLoadBalancing.
* Elastic Load Balancing <p>
* Elastic Load Balancing is a cost-effective and easy to use web service to help you improve availability and scalability of your application. It makes
* it easy for you to distribute application loads between two or more EC2 instances. Elastic Load Balancing enables availability through redundancy and
* supports traffic growth of your application.
* </p>
* <p>
* This guide provides detailed information about Elastic Load Balancing actions, data types, parameters, and errors.
* </p>
* <p>
* Query requests are HTTP or HTTPS requests that use the HTTP verb GET or POST and a Query parameter named Action or Operation. Action is used
* throughout this documentation, although Operation is supported for backward compatibility with other AWS Query APIs.
* </p>
* <p>
* This reference guide is based on the current WSDL, which is available at:
* </p>
* <p>
* For detailed information on constructing a query request using the actions, data types, and parameters mentioned in this guide, go to <a
* href="http://docs.amazonwebservices.com/ElasticLoadBalancing/latest/DeveloperGuide/using-query-api.html"> Using the Query API </a> in the <i>Elastic
* Load Balancing Developer Guide</i> .
* </p>
* <p>
* For detailed information about Elastic Load Balancing features and their associated API calls, go to <a
* href="http://docs.amazonwebservices.com/ElasticLoadBalancing/latest/DeveloperGuide/UserScenarios.html"> Using Elastic Load Balancing </a> in the
* <i>Elastic Load Balancing Developer Guide</i> .
* </p>
*/
public interface AmazonElasticLoadBalancing {
/**
* Overrides the default endpoint for this client ("https://elasticloadbalancing.amazonaws.com").
* Callers can use this method to control which AWS region they want to work with.
* <p>
* Callers can pass in just the endpoint (ex: "elasticloadbalancing.amazonaws.com") or a full
* URL, including the protocol (ex: "https://elasticloadbalancing.amazonaws.com"). If the
* protocol is not specified here, the default protocol from this client's
* {@link ClientConfiguration} will be used, which by default is HTTPS.
* <p>
* 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:
* <a href="http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912">
* http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912</a>
* <p>
* <b>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.</b>
*
* @param endpoint
* The endpoint (ex: "elasticloadbalancing.amazonaws.com") or a full URL,
* including the protocol (ex: "https://elasticloadbalancing.amazonaws.com") of
* the region specific AWS endpoint this client will communicate
* with.
*
* @throws IllegalArgumentException
* If any problems are detected with the specified endpoint.
*/
public void setEndpoint(String endpoint) throws java.lang.IllegalArgumentException;
/**
* An alternative to {@link 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.
* <p>
* By default, all service endpoints in all regions use the https protocol.
* To use http instead, specify it in the {@link ClientConfiguration}
* supplied at construction.
* <p>
* <b>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.</b>
*
* @param region
* The region this client will communicate with. See
* {@link Region#getRegion(com.amazonaws.regions.Regions)} for
* accessing a given region.
* @throws java.lang.IllegalArgumentException
* If the given region is null, or if this service isn't
* available in the given region. See
* {@link Region#isServiceSupported(String)}
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
*/
public void setRegion(Region region) throws java.lang.IllegalArgumentException;
/**
* <p>
* Returns meta-information on the specified LoadBalancer 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 an Elastic LoadBalancer.
* </p>
*
* @param describeLoadBalancerPolicyTypesRequest Container for the
* necessary parameters to execute the DescribeLoadBalancerPolicyTypes
* service method on AmazonElasticLoadBalancing.
*
* @return The response from the DescribeLoadBalancerPolicyTypes service
* method, as returned by AmazonElasticLoadBalancing.
*
* @throws PolicyTypeNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest describeLoadBalancerPolicyTypesRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Enables the client to define an application healthcheck for the
* instances.
* </p>
*
* @param configureHealthCheckRequest Container for the necessary
* parameters to execute the ConfigureHealthCheck service method on
* AmazonElasticLoadBalancing.
*
* @return The response from the ConfigureHealthCheck service method, as
* returned by AmazonElasticLoadBalancing.
*
* @throws LoadBalancerNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public ConfigureHealthCheckResult configureHealthCheck(ConfigureHealthCheckRequest configureHealthCheckRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Removes subnets from the set of configured subnets in the VPC for the
* LoadBalancer.
* </p>
* <p>
* After a subnet is removed all of the EndPoints registered with the
* LoadBalancer that are in the removed subnet will go into the
* <i>OutOfService</i> state. When a subnet is removed, the LoadBalancer
* will balance the traffic among the remaining routable subnets for the
* LoadBalancer.
* </p>
*
* @param detachLoadBalancerFromSubnetsRequest Container for the
* necessary parameters to execute the DetachLoadBalancerFromSubnets
* service method on AmazonElasticLoadBalancing.
*
* @return The response from the DetachLoadBalancerFromSubnets service
* method, as returned by AmazonElasticLoadBalancing.
*
* @throws InvalidConfigurationRequestException
* @throws LoadBalancerNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DetachLoadBalancerFromSubnetsResult detachLoadBalancerFromSubnets(DetachLoadBalancerFromSubnetsRequest detachLoadBalancerFromSubnetsRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Returns detailed descriptions of the policies. If you specify a
* LoadBalancer name, the operation returns either the descriptions of
* the specified policies, or descriptions of all the policies created
* for the LoadBalancer. If you don't specify a LoadBalancer name, the
* operation returns descriptions of the specified sample policies, or
* descriptions of all the sample policies. The names of the sample
* policies have the <code>ELBSample-</code> prefix.
* </p>
*
* @param describeLoadBalancerPoliciesRequest Container for the necessary
* parameters to execute the DescribeLoadBalancerPolicies service method
* on AmazonElasticLoadBalancing.
*
* @return The response from the DescribeLoadBalancerPolicies service
* method, as returned by AmazonElasticLoadBalancing.
*
* @throws PolicyNotFoundException
* @throws LoadBalancerNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeLoadBalancerPoliciesResult describeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest describeLoadBalancerPoliciesRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Associates, updates, or disables a policy with a listener on the
* LoadBalancer. You can associate multiple policies with a listener.
* </p>
*
* @param setLoadBalancerPoliciesOfListenerRequest Container for the
* necessary parameters to execute the SetLoadBalancerPoliciesOfListener
* service method on AmazonElasticLoadBalancing.
*
* @return The response from the SetLoadBalancerPoliciesOfListener
* service method, as returned by AmazonElasticLoadBalancing.
*
* @throws PolicyNotFoundException
* @throws InvalidConfigurationRequestException
* @throws LoadBalancerNotFoundException
* @throws ListenerNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public SetLoadBalancerPoliciesOfListenerResult setLoadBalancerPoliciesOfListener(SetLoadBalancerPoliciesOfListenerRequest setLoadBalancerPoliciesOfListenerRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Removes the specified EC2 Availability Zones from the set of
* configured Availability Zones for the LoadBalancer.
* </p>
* <p>
* There must be at least one Availability Zone registered with a
* LoadBalancer at all times. A client cannot remove all the Availability
* Zones from a LoadBalancer. Once an Availability Zone is removed, all
* the instances registered with the LoadBalancer that are in the removed
* Availability Zone go into the OutOfService state. Upon Availability
* Zone removal, the LoadBalancer attempts to equally balance the traffic
* among its remaining usable Availability Zones. Trying to remove an
* Availability Zone that was not associated with the LoadBalancer does
* nothing.
* </p>
* <p>
* <b>NOTE:</b> In order for this call to be successful, the client must
* have created the LoadBalancer. The client must provide the same
* account credentials as those that were used to create the
* LoadBalancer.
* </p>
*
* @param disableAvailabilityZonesForLoadBalancerRequest Container for
* the necessary parameters to execute the
* DisableAvailabilityZonesForLoadBalancer service method on
* AmazonElasticLoadBalancing.
*
* @return The response from the DisableAvailabilityZonesForLoadBalancer
* service method, as returned by AmazonElasticLoadBalancing.
*
* @throws InvalidConfigurationRequestException
* @throws LoadBalancerNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DisableAvailabilityZonesForLoadBalancerResult disableAvailabilityZonesForLoadBalancer(DisableAvailabilityZonesForLoadBalancerRequest disableAvailabilityZonesForLoadBalancerRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Returns the current state of the instances of the specified
* LoadBalancer. If no instances are specified, the state of all the
* instances for the LoadBalancer is returned.
* </p>
* <p>
* <b>NOTE:</b> The client must have created the specified input
* LoadBalancer in order to retrieve this information; the client must
* provide the same account credentials as those that were used to create
* the LoadBalancer.
* </p>
*
* @param describeInstanceHealthRequest Container for the necessary
* parameters to execute the DescribeInstanceHealth service method on
* AmazonElasticLoadBalancing.
*
* @return The response from the DescribeInstanceHealth service method,
* as returned by AmazonElasticLoadBalancing.
*
* @throws LoadBalancerNotFoundException
* @throws InvalidInstanceException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeInstanceHealthResult describeInstanceHealth(DescribeInstanceHealthRequest describeInstanceHealthRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Deletes a policy from the LoadBalancer. The specified policy must not
* be enabled for any listeners.
* </p>
*
* @param deleteLoadBalancerPolicyRequest Container for the necessary
* parameters to execute the DeleteLoadBalancerPolicy service method on
* AmazonElasticLoadBalancing.
*
* @return The response from the DeleteLoadBalancerPolicy service method,
* as returned by AmazonElasticLoadBalancing.
*
* @throws InvalidConfigurationRequestException
* @throws LoadBalancerNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DeleteLoadBalancerPolicyResult deleteLoadBalancerPolicy(DeleteLoadBalancerPolicyRequest deleteLoadBalancerPolicyRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Creates a new policy that contains the necessary attributes depending
* on the policy type. Policies are settings that are saved for your
* Elastic LoadBalancer and that can be applied to the front-end
* listener, or the back-end application server, depending on your policy
* type.
* </p>
*
* @param createLoadBalancerPolicyRequest Container for the necessary
* parameters to execute the CreateLoadBalancerPolicy service method on
* AmazonElasticLoadBalancing.
*
* @return The response from the CreateLoadBalancerPolicy service method,
* as returned by AmazonElasticLoadBalancing.
*
* @throws PolicyTypeNotFoundException
* @throws InvalidConfigurationRequestException
* @throws DuplicatePolicyNameException
* @throws TooManyPoliciesException
* @throws LoadBalancerNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public CreateLoadBalancerPolicyResult createLoadBalancerPolicy(CreateLoadBalancerPolicyRequest createLoadBalancerPolicyRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Adds one or more EC2 Availability Zones to the LoadBalancer.
* </p>
* <p>
* The LoadBalancer evenly distributes requests across all its
* registered Availability Zones that contain instances. As a result, the
* client must ensure that its LoadBalancer is appropriately scaled for
* each registered Availability Zone.
* </p>
* <p>
* <b>NOTE:</b> The new EC2 Availability Zones to be added must be in the
* same EC2 Region as the Availability Zones for which the LoadBalancer
* was created.
* </p>
*
* @param enableAvailabilityZonesForLoadBalancerRequest Container for the
* necessary parameters to execute the
* EnableAvailabilityZonesForLoadBalancer service method on
* AmazonElasticLoadBalancing.
*
* @return The response from the EnableAvailabilityZonesForLoadBalancer
* service method, as returned by AmazonElasticLoadBalancing.
*
* @throws LoadBalancerNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public EnableAvailabilityZonesForLoadBalancerResult enableAvailabilityZonesForLoadBalancer(EnableAvailabilityZonesForLoadBalancerRequest enableAvailabilityZonesForLoadBalancerRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Creates one or more listeners on a LoadBalancer 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.
* </p>
*
* @param createLoadBalancerListenersRequest Container for the necessary
* parameters to execute the CreateLoadBalancerListeners service method
* on AmazonElasticLoadBalancing.
*
* @throws InvalidConfigurationRequestException
* @throws DuplicateListenerException
* @throws CertificateNotFoundException
* @throws LoadBalancerNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public void createLoadBalancerListeners(CreateLoadBalancerListenersRequest createLoadBalancerListenersRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Creates a new LoadBalancer.
* </p>
* <p>
* After the call has completed successfully, a new LoadBalancer is
* created; however, it will not be usable until at least one instance
* has been registered. When the LoadBalancer creation is completed, the
* client can check whether or not it is usable by using the
* DescribeInstanceHealth API. The LoadBalancer is usable as soon as any
* registered instance is <i>InService</i> .
*
* </p>
* <p>
* <b>NOTE:</b> Currently, the client's quota of LoadBalancers is limited
* to ten per Region.
* </p>
* <p>
* <b>NOTE:</b> LoadBalancer DNS names vary depending on the Region
* they're created in. For LoadBalancers created in the United States,
* the DNS name ends with: us-east-1.elb.amazonaws.com (for the US
* Standard Region) us-west-1.elb.amazonaws.com (for the Northern
* California Region) For LoadBalancers created in the EU (Ireland)
* Region, the DNS name ends with: eu-west-1.elb.amazonaws.com
* </p>
*
* @param createLoadBalancerRequest Container for the necessary
* parameters to execute the CreateLoadBalancer service method on
* AmazonElasticLoadBalancing.
*
* @return The response from the CreateLoadBalancer service method, as
* returned by AmazonElasticLoadBalancing.
*
* @throws InvalidSubnetException
* @throws InvalidConfigurationRequestException
* @throws InvalidSecurityGroupException
* @throws CertificateNotFoundException
* @throws InvalidSchemeException
* @throws DuplicateLoadBalancerNameException
* @throws TooManyLoadBalancersException
* @throws SubnetNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public CreateLoadBalancerResult createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Deletes the specified LoadBalancer.
* </p>
* <p>
* If attempting to recreate the LoadBalancer, the client must
* reconfigure all the settings. The DNS name associated with a deleted
* LoadBalancer will no longer be usable. Once deleted, the name and
* associated DNS record of the LoadBalancer no longer exist and traffic
* sent to any of its IP addresses will no longer be delivered to client
* instances. The client will not receive the same DNS name even if a new
* LoadBalancer with same LoadBalancerName is created.
* </p>
* <p>
* To successfully call this API, the client must provide the same
* account credentials as were used to create the LoadBalancer.
* </p>
* <p>
* <b>NOTE:</b> By design, if the LoadBalancer does not exist or has
* already been deleted, DeleteLoadBalancer still succeeds.
* </p>
*
* @param deleteLoadBalancerRequest Container for the necessary
* parameters to execute the DeleteLoadBalancer service method on
* AmazonElasticLoadBalancing.
*
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public void deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* 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.
* </p>
*
* @param setLoadBalancerPoliciesForBackendServerRequest Container for
* the necessary parameters to execute the
* SetLoadBalancerPoliciesForBackendServer service method on
* AmazonElasticLoadBalancing.
*
* @return The response from the SetLoadBalancerPoliciesForBackendServer
* service method, as returned by AmazonElasticLoadBalancing.
*
* @throws PolicyNotFoundException
* @throws InvalidConfigurationRequestException
* @throws LoadBalancerNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public SetLoadBalancerPoliciesForBackendServerResult setLoadBalancerPoliciesForBackendServer(SetLoadBalancerPoliciesForBackendServerRequest setLoadBalancerPoliciesForBackendServerRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Deletes listeners from the LoadBalancer for the specified port.
* </p>
*
* @param deleteLoadBalancerListenersRequest Container for the necessary
* parameters to execute the DeleteLoadBalancerListeners service method
* on AmazonElasticLoadBalancing.
*
* @throws LoadBalancerNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public void deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest deleteLoadBalancerListenersRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Deregisters instances from the LoadBalancer. Once the instance is
* deregistered, it will stop receiving traffic from the LoadBalancer.
* </p>
* <p>
* In order to successfully call this API, the same account credentials
* as those used to create the LoadBalancer must be provided.
* </p>
*
* @param deregisterInstancesFromLoadBalancerRequest Container for the
* necessary parameters to execute the
* DeregisterInstancesFromLoadBalancer service method on
* AmazonElasticLoadBalancing.
*
* @return The response from the DeregisterInstancesFromLoadBalancer
* service method, as returned by AmazonElasticLoadBalancing.
*
* @throws LoadBalancerNotFoundException
* @throws InvalidInstanceException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DeregisterInstancesFromLoadBalancerResult deregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest deregisterInstancesFromLoadBalancerRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Sets the certificate that terminates the specified listener's SSL
* connections. The specified certificate replaces any prior certificate
* that was used on the same LoadBalancer and port.
* </p>
*
* @param setLoadBalancerListenerSSLCertificateRequest Container for the
* necessary parameters to execute the
* SetLoadBalancerListenerSSLCertificate service method on
* AmazonElasticLoadBalancing.
*
* @throws InvalidConfigurationRequestException
* @throws CertificateNotFoundException
* @throws LoadBalancerNotFoundException
* @throws ListenerNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public void setLoadBalancerListenerSSLCertificate(SetLoadBalancerListenerSSLCertificateRequest setLoadBalancerListenerSSLCertificateRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* 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.
* </p>
* <p>
* When a LoadBalancer implements this policy, the LoadBalancer uses a
* special cookie to track the backend server instance for each request.
* When the LoadBalancer receives a request, it first checks to see if
* this cookie is present in the request. If so, the LoadBalancer sends
* the request to the application server specified in the cookie. If not,
* the LoadBalancer sends the request to a server that is chosen based on
* the existing load balancing algorithm.
* </p>
* <p>
* 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.
* </p>
*
* @param createLBCookieStickinessPolicyRequest Container for the
* necessary parameters to execute the CreateLBCookieStickinessPolicy
* service method on AmazonElasticLoadBalancing.
*
* @return The response from the CreateLBCookieStickinessPolicy service
* method, as returned by AmazonElasticLoadBalancing.
*
* @throws InvalidConfigurationRequestException
* @throws DuplicatePolicyNameException
* @throws TooManyPoliciesException
* @throws LoadBalancerNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public CreateLBCookieStickinessPolicyResult createLBCookieStickinessPolicy(CreateLBCookieStickinessPolicyRequest createLBCookieStickinessPolicyRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Adds one or more subnets to the set of configured subnets in the VPC
* for the LoadBalancer.
* </p>
* <p>
* The Loadbalancers evenly distribute requests across all of the
* registered subnets.
* </p>
*
* @param attachLoadBalancerToSubnetsRequest Container for the necessary
* parameters to execute the AttachLoadBalancerToSubnets service method
* on AmazonElasticLoadBalancing.
*
* @return The response from the AttachLoadBalancerToSubnets service
* method, as returned by AmazonElasticLoadBalancing.
*
* @throws InvalidSubnetException
* @throws InvalidConfigurationRequestException
* @throws LoadBalancerNotFoundException
* @throws SubnetNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public AttachLoadBalancerToSubnetsResult attachLoadBalancerToSubnets(AttachLoadBalancerToSubnetsRequest attachLoadBalancerToSubnetsRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* 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.
* </p>
* <p>
* 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 LoadBalancer only inserts a new stickiness cookie when the
* application response includes a new application cookie.
* </p>
* <p>
* If the application cookie is explicitly removed or expires, the
* session stops being sticky until a new application cookie is issued.
* </p>
* <p>
* <b>NOTE:</b> An application client must receive and send two cookies:
* the application-generated cookie and the special Elastic Load
* Balancing cookie named AWSELB. This is the default behavior for many
* common web browsers.
* </p>
*
* @param createAppCookieStickinessPolicyRequest Container for the
* necessary parameters to execute the CreateAppCookieStickinessPolicy
* service method on AmazonElasticLoadBalancing.
*
* @return The response from the CreateAppCookieStickinessPolicy service
* method, as returned by AmazonElasticLoadBalancing.
*
* @throws InvalidConfigurationRequestException
* @throws DuplicatePolicyNameException
* @throws TooManyPoliciesException
* @throws LoadBalancerNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public CreateAppCookieStickinessPolicyResult createAppCookieStickinessPolicy(CreateAppCookieStickinessPolicyRequest createAppCookieStickinessPolicyRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Adds new instances to the LoadBalancer.
* </p>
* <p>
* Once the instance is registered, it starts receiving traffic and
* requests from the LoadBalancer. Any instance that is not in any of the
* Availability Zones registered for the LoadBalancer will be moved to
* the <i>OutOfService</i> state. It will move to the <i>InService</i>
* state when the Availability Zone is added to the LoadBalancer.
* </p>
* <p>
* <b>NOTE:</b> In order for this call to be successful, the client must
* have created the LoadBalancer. The client must provide the same
* account credentials as those that were used to create the
* LoadBalancer.
* </p>
* <p>
* <b>NOTE:</b> Completion of this API does not guarantee that operation
* has completed. Rather, it means that the request has been registered
* and the changes will happen shortly.
* </p>
*
* @param registerInstancesWithLoadBalancerRequest Container for the
* necessary parameters to execute the RegisterInstancesWithLoadBalancer
* service method on AmazonElasticLoadBalancing.
*
* @return The response from the RegisterInstancesWithLoadBalancer
* service method, as returned by AmazonElasticLoadBalancing.
*
* @throws LoadBalancerNotFoundException
* @throws InvalidInstanceException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public RegisterInstancesWithLoadBalancerResult registerInstancesWithLoadBalancer(RegisterInstancesWithLoadBalancerRequest registerInstancesWithLoadBalancerRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Associates one or more security groups with your LoadBalancer in VPC.
* The provided security group IDs will override any currently applied
* security groups.
* </p>
*
* @param applySecurityGroupsToLoadBalancerRequest Container for the
* necessary parameters to execute the ApplySecurityGroupsToLoadBalancer
* service method on AmazonElasticLoadBalancing.
*
* @return The response from the ApplySecurityGroupsToLoadBalancer
* service method, as returned by AmazonElasticLoadBalancing.
*
* @throws InvalidConfigurationRequestException
* @throws InvalidSecurityGroupException
* @throws LoadBalancerNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public ApplySecurityGroupsToLoadBalancerResult applySecurityGroupsToLoadBalancer(ApplySecurityGroupsToLoadBalancerRequest applySecurityGroupsToLoadBalancerRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Returns detailed configuration information for the specified
* LoadBalancers. If no LoadBalancers are specified, the operation
* returns configuration information for all LoadBalancers created by the
* caller.
* </p>
* <p>
* <b>NOTE:</b> The client must have created the specified input
* LoadBalancers in order to retrieve this information; the client must
* provide the same account credentials as those that were used to create
* the LoadBalancer.
* </p>
*
* @param describeLoadBalancersRequest Container for the necessary
* parameters to execute the DescribeLoadBalancers service method on
* AmazonElasticLoadBalancing.
*
* @return The response from the DescribeLoadBalancers service method, as
* returned by AmazonElasticLoadBalancing.
*
* @throws LoadBalancerNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeLoadBalancersResult describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Returns meta-information on the specified LoadBalancer 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 an Elastic LoadBalancer.
* </p>
*
* @return The response from the DescribeLoadBalancerPolicyTypes service
* method, as returned by AmazonElasticLoadBalancing.
*
* @throws PolicyTypeNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes() throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Returns detailed descriptions of the policies. If you specify a
* LoadBalancer name, the operation returns either the descriptions of
* the specified policies, or descriptions of all the policies created
* for the LoadBalancer. If you don't specify a LoadBalancer name, the
* operation returns descriptions of the specified sample policies, or
* descriptions of all the sample policies. The names of the sample
* policies have the <code>ELBSample-</code> prefix.
* </p>
*
* @return The response from the DescribeLoadBalancerPolicies service
* method, as returned by AmazonElasticLoadBalancing.
*
* @throws PolicyNotFoundException
* @throws LoadBalancerNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeLoadBalancerPoliciesResult describeLoadBalancerPolicies() throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Returns detailed configuration information for the specified
* LoadBalancers. If no LoadBalancers are specified, the operation
* returns configuration information for all LoadBalancers created by the
* caller.
* </p>
* <p>
* <b>NOTE:</b> The client must have created the specified input
* LoadBalancers in order to retrieve this information; the client must
* provide the same account credentials as those that were used to create
* the LoadBalancer.
* </p>
*
* @return The response from the DescribeLoadBalancers service method, as
* returned by AmazonElasticLoadBalancing.
*
* @throws LoadBalancerNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeLoadBalancersResult describeLoadBalancers() throws AmazonServiceException, AmazonClientException;
/**
* Shuts down this client object, releasing any resources that might be held
* open. This is an optional method, and callers are not expected to call
* it, but can if they want to explicitly release any open resources. Once a
* client has been shutdown, it should not be used to make any more
* requests.
*/
public void shutdown();
/**
* 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.
* <p>
* 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.
*