/
docs-2.json
1788 lines (1788 loc) · 114 KB
/
docs-2.json
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
{
"version": "2.0",
"service": "<fullname>Elastic Load Balancing</fullname> <p>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.</p> <p>Elastic Load Balancing supports the following types of load balancers: Application Load Balancers, Network Load Balancers, Gateway Load Balancers, and Classic Load Balancers. This reference covers the following load balancer types:</p> <ul> <li> <p>Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS.</p> </li> <li> <p>Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP.</p> </li> <li> <p>Gateway Load Balancer - Operates at the network layer (layer 3).</p> </li> </ul> <p>For more information, see the <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/\">Elastic Load Balancing User Guide</a>.</p> <p>All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.</p>",
"operations": {
"AddListenerCertificates": "<p>Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.</p> <p>If the certificate in already in the certificate list, the call is successful but the certificate is not added again.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html\">HTTPS listeners</a> in the <i>Application Load Balancers Guide</i> or <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html\">TLS listeners</a> in the <i>Network Load Balancers Guide</i>.</p>",
"AddTags": "<p>Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, and rules.</p> <p>Each tag consists of a key and an optional value. If a resource already has a tag with the same key, <code>AddTags</code> updates its value.</p>",
"CreateListener": "<p>Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.</p> <p>For more information, see the following:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html\">Listeners for your Application Load Balancers</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-listeners.html\">Listeners for your Network Load Balancers</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/gateway-listeners.html\">Listeners for your Gateway Load Balancers</a> </p> </li> </ul> <p>This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds.</p>",
"CreateLoadBalancer": "<p>Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.</p> <p>For more information, see the following:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html\">Application Load Balancers</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancers.html\">Network Load Balancers</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/gateway-load-balancers.html\">Gateway Load Balancers</a> </p> </li> </ul> <p>This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds.</p>",
"CreateRule": "<p>Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.</p> <p>Each rule consists of a priority, one or more actions, and one or more conditions. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#listener-rules\">Listener rules</a> in the <i>Application Load Balancers Guide</i>.</p>",
"CreateTargetGroup": "<p>Creates a target group.</p> <p>For more information, see the following:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html\">Target groups for your Application Load Balancers</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html\">Target groups for your Network Load Balancers</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/target-groups.html\">Target groups for your Gateway Load Balancers</a> </p> </li> </ul> <p>This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds.</p>",
"DeleteListener": "<p>Deletes the specified listener.</p> <p>Alternatively, your listener is deleted when you delete the load balancer to which it is attached.</p>",
"DeleteLoadBalancer": "<p>Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. Deleting a load balancer also deletes its listeners.</p> <p>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.</p> <p>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.</p>",
"DeleteRule": "<p>Deletes the specified rule.</p> <p>You can't delete the default rule.</p>",
"DeleteTargetGroup": "<p>Deletes the specified target group.</p> <p>You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks. Deleting a target group does not affect its registered targets. For example, any EC2 instances continue to run until you stop or terminate them.</p>",
"DeregisterTargets": "<p>Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.</p>",
"DescribeAccountLimits": "<p>Describes the current Elastic Load Balancing resource limits for your Amazon Web Services account.</p> <p>For more information, see the following:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html\">Quotas for your Application Load Balancers</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-limits.html\">Quotas for your Network Load Balancers</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/quotas-limits.html\">Quotas for your Gateway Load Balancers</a> </p> </li> </ul>",
"DescribeListenerCertificates": "<p>Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.</p> <p>If the default certificate is also in the certificate list, it appears twice in the results (once with <code>IsDefault</code> set to true and once with <code>IsDefault</code> set to false).</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#https-listener-certificates\">SSL certificates</a> in the <i>Application Load Balancers Guide</i> or <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#tls-listener-certificate\">Server certificates</a> in the <i>Network Load Balancers Guide</i>.</p>",
"DescribeListeners": "<p>Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. You must specify either a load balancer or one or more listeners.</p>",
"DescribeLoadBalancerAttributes": "<p>Describes the attributes for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.</p> <p>For more information, see the following:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html#load-balancer-attributes\">Load balancer attributes</a> in the <i>Application Load Balancers Guide</i> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancers.html#load-balancer-attributes\">Load balancer attributes</a> in the <i>Network Load Balancers Guide</i> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/gateway-load-balancers.html#load-balancer-attributes\">Load balancer attributes</a> in the <i>Gateway Load Balancers Guide</i> </p> </li> </ul>",
"DescribeLoadBalancers": "<p>Describes the specified load balancers or all of your load balancers.</p>",
"DescribeRules": "<p>Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.</p>",
"DescribeSSLPolicies": "<p>Describes the specified policies or all policies used for SSL negotiation.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies\">Security policies</a> in the <i>Application Load Balancers Guide</i> or <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies\">Security policies</a> in the <i>Network Load Balancers Guide</i>.</p>",
"DescribeTags": "<p>Describes the tags for the specified Elastic Load Balancing resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.</p>",
"DescribeTargetGroupAttributes": "<p>Describes the attributes for the specified target group.</p> <p>For more information, see the following:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html#target-group-attributes\">Target group attributes</a> in the <i>Application Load Balancers Guide</i> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html#target-group-attributes\">Target group attributes</a> in the <i>Network Load Balancers Guide</i> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/target-groups.html#target-group-attributes\">Target group attributes</a> in the <i>Gateway Load Balancers Guide</i> </p> </li> </ul>",
"DescribeTargetGroups": "<p>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.</p>",
"DescribeTargetHealth": "<p>Describes the health of the specified targets or all of your targets.</p>",
"ModifyListener": "<p>Replaces the specified properties of the specified listener. Any properties that you do not specify remain unchanged.</p> <p>Changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy and default certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and default certificate properties.</p> <p>To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action.</p>",
"ModifyLoadBalancerAttributes": "<p>Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.</p> <p>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.</p>",
"ModifyRule": "<p>Replaces the specified properties of the specified rule. Any properties that you do not specify are unchanged.</p> <p>To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action.</p>",
"ModifyTargetGroup": "<p>Modifies the health checks used when evaluating the health state of the targets in the specified target group.</p>",
"ModifyTargetGroupAttributes": "<p>Modifies the specified attributes of the specified target group.</p>",
"RegisterTargets": "<p>Registers the specified targets with the specified target group.</p> <p>If the target is an EC2 instance, it must be in the <code>running</code> state when you register it.</p> <p>By default, the load balancer routes requests to registered targets using the protocol and port for the target group. Alternatively, you can override the port for a target when you register it. You can register each EC2 instance or IP address with the same target group multiple times using different ports.</p> <p>With a Network Load Balancer, you cannot register instances by instance ID if they have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. You can register instances of these types by IP address.</p>",
"RemoveListenerCertificates": "<p>Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.</p>",
"RemoveTags": "<p>Removes the specified tags from the specified Elastic Load Balancing resources. You can remove the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.</p>",
"SetIpAddressType": "<p>Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer.</p>",
"SetRulePriorities": "<p>Sets the priorities of the specified rules.</p> <p>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.</p>",
"SetSecurityGroups": "<p>Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups.</p> <p>You can't specify a security group for a Network Load Balancer or Gateway Load Balancer.</p>",
"SetSubnets": "<p>Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer or Network Load Balancer. The specified subnets replace the previously enabled subnets.</p> <p>When you specify subnets for a Network Load Balancer, you must include all subnets that were enabled previously, with their existing configurations, plus any additional subnets.</p>"
},
"shapes": {
"ALPNPolicyNotSupportedException": {
"base": "<p>The specified ALPN policy is not supported.</p>",
"refs": {
}
},
"Action": {
"base": "<p>Information about an action.</p> <p>Each rule must include exactly one of the following types of actions: <code>forward</code>, <code>fixed-response</code>, or <code>redirect</code>, and it must be the last action to be performed.</p>",
"refs": {
"Actions$member": null
}
},
"ActionOrder": {
"base": null,
"refs": {
"Action$Order": "<p>The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.</p>"
}
},
"ActionTypeEnum": {
"base": null,
"refs": {
"Action$Type": "<p>The type of action.</p>"
}
},
"Actions": {
"base": null,
"refs": {
"CreateListenerInput$DefaultActions": "<p>The actions for the default rule.</p>",
"CreateRuleInput$Actions": "<p>The actions.</p>",
"Listener$DefaultActions": "<p>The default actions for the listener.</p>",
"ModifyListenerInput$DefaultActions": "<p>The actions for the default rule.</p>",
"ModifyRuleInput$Actions": "<p>The actions.</p>",
"Rule$Actions": "<p>The actions. Each rule must include exactly one of the following types of actions: <code>forward</code>, <code>redirect</code>, or <code>fixed-response</code>, and it must be the last action to be performed.</p>"
}
},
"AddListenerCertificatesInput": {
"base": null,
"refs": {
}
},
"AddListenerCertificatesOutput": {
"base": null,
"refs": {
}
},
"AddTagsInput": {
"base": null,
"refs": {
}
},
"AddTagsOutput": {
"base": null,
"refs": {
}
},
"AllocationId": {
"base": null,
"refs": {
"LoadBalancerAddress$AllocationId": "<p>[Network Load Balancers] The allocation ID of the Elastic IP address for an internal-facing load balancer.</p>",
"SubnetMapping$AllocationId": "<p>[Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer.</p>"
}
},
"AllocationIdNotFoundException": {
"base": "<p>The specified allocation ID does not exist.</p>",
"refs": {
}
},
"AlpnPolicyName": {
"base": null,
"refs": {
"CreateListenerInput$AlpnPolicy": "<p>[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values:</p> <ul> <li> <p> <code>HTTP1Only</code> </p> </li> <li> <p> <code>HTTP2Only</code> </p> </li> <li> <p> <code>HTTP2Optional</code> </p> </li> <li> <p> <code>HTTP2Preferred</code> </p> </li> <li> <p> <code>None</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#alpn-policies\">ALPN policies</a> in the <i>Network Load Balancers Guide</i>.</p>",
"Listener$AlpnPolicy": "<p>[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.</p>",
"ModifyListenerInput$AlpnPolicy": "<p>[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values:</p> <ul> <li> <p> <code>HTTP1Only</code> </p> </li> <li> <p> <code>HTTP2Only</code> </p> </li> <li> <p> <code>HTTP2Optional</code> </p> </li> <li> <p> <code>HTTP2Preferred</code> </p> </li> <li> <p> <code>None</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#alpn-policies\">ALPN policies</a> in the <i>Network Load Balancers Guide</i>.</p>"
}
},
"AlpnPolicyValue": {
"base": null,
"refs": {
"AlpnPolicyName$member": null
}
},
"AuthenticateCognitoActionAuthenticationRequestExtraParams": {
"base": null,
"refs": {
"AuthenticateCognitoActionConfig$AuthenticationRequestExtraParams": "<p>The query parameters (up to 10) to include in the redirect request to the authorization endpoint.</p>"
}
},
"AuthenticateCognitoActionAuthenticationRequestParamName": {
"base": null,
"refs": {
"AuthenticateCognitoActionAuthenticationRequestExtraParams$key": null
}
},
"AuthenticateCognitoActionAuthenticationRequestParamValue": {
"base": null,
"refs": {
"AuthenticateCognitoActionAuthenticationRequestExtraParams$value": null
}
},
"AuthenticateCognitoActionConditionalBehaviorEnum": {
"base": null,
"refs": {
"AuthenticateCognitoActionConfig$OnUnauthenticatedRequest": "<p>The behavior if the user is not authenticated. The following are possible values:</p> <ul> <li> <p>deny<code/> - Return an HTTP 401 Unauthorized error.</p> </li> <li> <p>allow<code/> - Allow the request to be forwarded to the target.</p> </li> <li> <p>authenticate<code/> - Redirect the request to the IdP authorization endpoint. This is the default value.</p> </li> </ul>"
}
},
"AuthenticateCognitoActionConfig": {
"base": "<p>Request parameters to use when integrating with Amazon Cognito to authenticate users.</p>",
"refs": {
"Action$AuthenticateCognitoConfig": "<p>[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when <code>Type</code> is <code>authenticate-cognito</code>.</p>"
}
},
"AuthenticateCognitoActionScope": {
"base": null,
"refs": {
"AuthenticateCognitoActionConfig$Scope": "<p>The set of user claims to be requested from the IdP. The default is <code>openid</code>.</p> <p>To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.</p>"
}
},
"AuthenticateCognitoActionSessionCookieName": {
"base": null,
"refs": {
"AuthenticateCognitoActionConfig$SessionCookieName": "<p>The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.</p>"
}
},
"AuthenticateCognitoActionSessionTimeout": {
"base": null,
"refs": {
"AuthenticateCognitoActionConfig$SessionTimeout": "<p>The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).</p>"
}
},
"AuthenticateCognitoActionUserPoolArn": {
"base": null,
"refs": {
"AuthenticateCognitoActionConfig$UserPoolArn": "<p>The Amazon Resource Name (ARN) of the Amazon Cognito user pool.</p>"
}
},
"AuthenticateCognitoActionUserPoolClientId": {
"base": null,
"refs": {
"AuthenticateCognitoActionConfig$UserPoolClientId": "<p>The ID of the Amazon Cognito user pool client.</p>"
}
},
"AuthenticateCognitoActionUserPoolDomain": {
"base": null,
"refs": {
"AuthenticateCognitoActionConfig$UserPoolDomain": "<p>The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.</p>"
}
},
"AuthenticateOidcActionAuthenticationRequestExtraParams": {
"base": null,
"refs": {
"AuthenticateOidcActionConfig$AuthenticationRequestExtraParams": "<p>The query parameters (up to 10) to include in the redirect request to the authorization endpoint.</p>"
}
},
"AuthenticateOidcActionAuthenticationRequestParamName": {
"base": null,
"refs": {
"AuthenticateOidcActionAuthenticationRequestExtraParams$key": null
}
},
"AuthenticateOidcActionAuthenticationRequestParamValue": {
"base": null,
"refs": {
"AuthenticateOidcActionAuthenticationRequestExtraParams$value": null
}
},
"AuthenticateOidcActionAuthorizationEndpoint": {
"base": null,
"refs": {
"AuthenticateOidcActionConfig$AuthorizationEndpoint": "<p>The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.</p>"
}
},
"AuthenticateOidcActionClientId": {
"base": null,
"refs": {
"AuthenticateOidcActionConfig$ClientId": "<p>The OAuth 2.0 client identifier.</p>"
}
},
"AuthenticateOidcActionClientSecret": {
"base": null,
"refs": {
"AuthenticateOidcActionConfig$ClientSecret": "<p>The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set <code>UseExistingClientSecret</code> to true.</p>"
}
},
"AuthenticateOidcActionConditionalBehaviorEnum": {
"base": null,
"refs": {
"AuthenticateOidcActionConfig$OnUnauthenticatedRequest": "<p>The behavior if the user is not authenticated. The following are possible values:</p> <ul> <li> <p>deny<code/> - Return an HTTP 401 Unauthorized error.</p> </li> <li> <p>allow<code/> - Allow the request to be forwarded to the target.</p> </li> <li> <p>authenticate<code/> - Redirect the request to the IdP authorization endpoint. This is the default value.</p> </li> </ul>"
}
},
"AuthenticateOidcActionConfig": {
"base": "<p>Request parameters when using an identity provider (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.</p>",
"refs": {
"Action$AuthenticateOidcConfig": "<p>[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when <code>Type</code> is <code>authenticate-oidc</code>.</p>"
}
},
"AuthenticateOidcActionIssuer": {
"base": null,
"refs": {
"AuthenticateOidcActionConfig$Issuer": "<p>The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.</p>"
}
},
"AuthenticateOidcActionScope": {
"base": null,
"refs": {
"AuthenticateOidcActionConfig$Scope": "<p>The set of user claims to be requested from the IdP. The default is <code>openid</code>.</p> <p>To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.</p>"
}
},
"AuthenticateOidcActionSessionCookieName": {
"base": null,
"refs": {
"AuthenticateOidcActionConfig$SessionCookieName": "<p>The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.</p>"
}
},
"AuthenticateOidcActionSessionTimeout": {
"base": null,
"refs": {
"AuthenticateOidcActionConfig$SessionTimeout": "<p>The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).</p>"
}
},
"AuthenticateOidcActionTokenEndpoint": {
"base": null,
"refs": {
"AuthenticateOidcActionConfig$TokenEndpoint": "<p>The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.</p>"
}
},
"AuthenticateOidcActionUseExistingClientSecret": {
"base": null,
"refs": {
"AuthenticateOidcActionConfig$UseExistingClientSecret": "<p>Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.</p>"
}
},
"AuthenticateOidcActionUserInfoEndpoint": {
"base": null,
"refs": {
"AuthenticateOidcActionConfig$UserInfoEndpoint": "<p>The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.</p>"
}
},
"AvailabilityZone": {
"base": "<p>Information about an Availability Zone.</p>",
"refs": {
"AvailabilityZones$member": null
}
},
"AvailabilityZoneNotSupportedException": {
"base": "<p>The specified Availability Zone is not supported.</p>",
"refs": {
}
},
"AvailabilityZones": {
"base": null,
"refs": {
"LoadBalancer$AvailabilityZones": "<p>The subnets for the load balancer.</p>",
"SetSubnetsOutput$AvailabilityZones": "<p>Information about the subnets.</p>"
}
},
"CanonicalHostedZoneId": {
"base": null,
"refs": {
"LoadBalancer$CanonicalHostedZoneId": "<p>The ID of the Amazon Route 53 hosted zone associated with the load balancer.</p>"
}
},
"Certificate": {
"base": "<p>Information about an SSL server certificate.</p>",
"refs": {
"CertificateList$member": null
}
},
"CertificateArn": {
"base": null,
"refs": {
"Certificate$CertificateArn": "<p>The Amazon Resource Name (ARN) of the certificate.</p>"
}
},
"CertificateList": {
"base": null,
"refs": {
"AddListenerCertificatesInput$Certificates": "<p>The certificate to add. You can specify one certificate per call. Set <code>CertificateArn</code> to the certificate ARN but do not set <code>IsDefault</code>.</p>",
"AddListenerCertificatesOutput$Certificates": "<p>Information about the certificates in the certificate list.</p>",
"CreateListenerInput$Certificates": "<p>[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set <code>CertificateArn</code> to the certificate ARN but do not set <code>IsDefault</code>.</p>",
"DescribeListenerCertificatesOutput$Certificates": "<p>Information about the certificates.</p>",
"Listener$Certificates": "<p>[HTTPS or TLS listener] The default certificate for the listener.</p>",
"ModifyListenerInput$Certificates": "<p>[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set <code>CertificateArn</code> to the certificate ARN but do not set <code>IsDefault</code>.</p>",
"RemoveListenerCertificatesInput$Certificates": "<p>The certificate to remove. You can specify one certificate per call. Set <code>CertificateArn</code> to the certificate ARN but do not set <code>IsDefault</code>.</p>"
}
},
"CertificateNotFoundException": {
"base": "<p>The specified certificate does not exist.</p>",
"refs": {
}
},
"Cipher": {
"base": "<p>Information about a cipher used in a policy.</p>",
"refs": {
"Ciphers$member": null
}
},
"CipherName": {
"base": null,
"refs": {
"Cipher$Name": "<p>The name of the cipher.</p>"
}
},
"CipherPriority": {
"base": null,
"refs": {
"Cipher$Priority": "<p>The priority of the cipher.</p>"
}
},
"Ciphers": {
"base": null,
"refs": {
"SslPolicy$Ciphers": "<p>The ciphers.</p>"
}
},
"ConditionFieldName": {
"base": null,
"refs": {
"RuleCondition$Field": "<p>The field in the HTTP request. The following are the possible values:</p> <ul> <li> <p> <code>http-header</code> </p> </li> <li> <p> <code>http-request-method</code> </p> </li> <li> <p> <code>host-header</code> </p> </li> <li> <p> <code>path-pattern</code> </p> </li> <li> <p> <code>query-string</code> </p> </li> <li> <p> <code>source-ip</code> </p> </li> </ul>"
}
},
"CreateListenerInput": {
"base": null,
"refs": {
}
},
"CreateListenerOutput": {
"base": null,
"refs": {
}
},
"CreateLoadBalancerInput": {
"base": null,
"refs": {
}
},
"CreateLoadBalancerOutput": {
"base": null,
"refs": {
}
},
"CreateRuleInput": {
"base": null,
"refs": {
}
},
"CreateRuleOutput": {
"base": null,
"refs": {
}
},
"CreateTargetGroupInput": {
"base": null,
"refs": {
}
},
"CreateTargetGroupOutput": {
"base": null,
"refs": {
}
},
"CreatedTime": {
"base": null,
"refs": {
"LoadBalancer$CreatedTime": "<p>The date and time the load balancer was created.</p>"
}
},
"CustomerOwnedIpv4Pool": {
"base": null,
"refs": {
"CreateLoadBalancerInput$CustomerOwnedIpv4Pool": "<p>[Application Load Balancers on Outposts] The ID of the customer-owned address pool (CoIP pool).</p>",
"LoadBalancer$CustomerOwnedIpv4Pool": "<p>[Application Load Balancers on Outposts] The ID of the customer-owned address pool.</p>"
}
},
"DNSName": {
"base": null,
"refs": {
"LoadBalancer$DNSName": "<p>The public DNS name of the load balancer.</p>"
}
},
"Default": {
"base": null,
"refs": {
"Certificate$IsDefault": "<p>Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.</p>"
}
},
"DeleteListenerInput": {
"base": null,
"refs": {
}
},
"DeleteListenerOutput": {
"base": null,
"refs": {
}
},
"DeleteLoadBalancerInput": {
"base": null,
"refs": {
}
},
"DeleteLoadBalancerOutput": {
"base": null,
"refs": {
}
},
"DeleteRuleInput": {
"base": null,
"refs": {
}
},
"DeleteRuleOutput": {
"base": null,
"refs": {
}
},
"DeleteTargetGroupInput": {
"base": null,
"refs": {
}
},
"DeleteTargetGroupOutput": {
"base": null,
"refs": {
}
},
"DeregisterTargetsInput": {
"base": null,
"refs": {
}
},
"DeregisterTargetsOutput": {
"base": null,
"refs": {
}
},
"DescribeAccountLimitsInput": {
"base": null,
"refs": {
}
},
"DescribeAccountLimitsOutput": {
"base": null,
"refs": {
}
},
"DescribeListenerCertificatesInput": {
"base": null,
"refs": {
}
},
"DescribeListenerCertificatesOutput": {
"base": null,
"refs": {
}
},
"DescribeListenersInput": {
"base": null,
"refs": {
}
},
"DescribeListenersOutput": {
"base": null,
"refs": {
}
},
"DescribeLoadBalancerAttributesInput": {
"base": null,
"refs": {
}
},
"DescribeLoadBalancerAttributesOutput": {
"base": null,
"refs": {
}
},
"DescribeLoadBalancersInput": {
"base": null,
"refs": {
}
},
"DescribeLoadBalancersOutput": {
"base": null,
"refs": {
}
},
"DescribeRulesInput": {
"base": null,
"refs": {
}
},
"DescribeRulesOutput": {
"base": null,
"refs": {
}
},
"DescribeSSLPoliciesInput": {
"base": null,
"refs": {
}
},
"DescribeSSLPoliciesOutput": {
"base": null,
"refs": {
}
},
"DescribeTagsInput": {
"base": null,
"refs": {
}
},
"DescribeTagsOutput": {
"base": null,
"refs": {
}
},
"DescribeTargetGroupAttributesInput": {
"base": null,
"refs": {
}
},
"DescribeTargetGroupAttributesOutput": {
"base": null,
"refs": {
}
},
"DescribeTargetGroupsInput": {
"base": null,
"refs": {
}
},
"DescribeTargetGroupsOutput": {
"base": null,
"refs": {
}
},
"DescribeTargetHealthInput": {
"base": null,
"refs": {
}
},
"DescribeTargetHealthOutput": {
"base": null,
"refs": {
}
},
"Description": {
"base": null,
"refs": {
"TargetHealth$Description": "<p>A description of the target health that provides additional details. If the state is <code>healthy</code>, a description is not provided.</p>"
}
},
"DuplicateListenerException": {
"base": "<p>A listener with the specified port already exists.</p>",
"refs": {
}
},
"DuplicateLoadBalancerNameException": {
"base": "<p>A load balancer with the specified name already exists.</p>",
"refs": {
}
},
"DuplicateTagKeysException": {
"base": "<p>A tag key was specified more than once.</p>",
"refs": {
}
},
"DuplicateTargetGroupNameException": {
"base": "<p>A target group with the specified name already exists.</p>",
"refs": {
}
},
"FixedResponseActionConfig": {
"base": "<p>Information about an action that returns a custom HTTP response.</p>",
"refs": {
"Action$FixedResponseConfig": "<p>[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when <code>Type</code> is <code>fixed-response</code>.</p>"
}
},
"FixedResponseActionContentType": {
"base": null,
"refs": {
"FixedResponseActionConfig$ContentType": "<p>The content type.</p> <p>Valid Values: text/plain | text/css | text/html | application/javascript | application/json</p>"
}
},
"FixedResponseActionMessage": {
"base": null,
"refs": {
"FixedResponseActionConfig$MessageBody": "<p>The message.</p>"
}
},
"FixedResponseActionStatusCode": {
"base": null,
"refs": {
"FixedResponseActionConfig$StatusCode": "<p>The HTTP response code (2XX, 4XX, or 5XX).</p>"
}
},
"ForwardActionConfig": {
"base": "<p>Information about a forward action.</p>",
"refs": {
"Action$ForwardConfig": "<p>Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when <code>Type</code> is <code>forward</code>. If you specify both <code>ForwardConfig</code> and <code>TargetGroupArn</code>, you can specify only one target group using <code>ForwardConfig</code> and it must be the same target group specified in <code>TargetGroupArn</code>.</p>"
}
},
"GrpcCode": {
"base": null,
"refs": {
"Matcher$GrpcCode": "<p>You can specify values between 0 and 99. You can specify multiple values (for example, \"0,1\") or a range of values (for example, \"0-5\"). The default value is 12.</p>"
}
},
"HealthCheckEnabled": {
"base": null,
"refs": {
"CreateTargetGroupInput$HealthCheckEnabled": "<p>Indicates whether health checks are enabled. If the target type is <code>lambda</code>, health checks are disabled by default but can be enabled. If the target type is <code>instance</code>, <code>ip</code>, or <code>alb</code>, health checks are always enabled and cannot be disabled.</p>",
"ModifyTargetGroupInput$HealthCheckEnabled": "<p>Indicates whether health checks are enabled.</p>",
"TargetGroup$HealthCheckEnabled": "<p>Indicates whether health checks are enabled.</p>"
}
},
"HealthCheckIntervalSeconds": {
"base": null,
"refs": {
"CreateTargetGroupInput$HealthCheckIntervalSeconds": "<p>The approximate amount of time, in seconds, between health checks of an individual target. If the target group protocol is TCP, TLS, UDP, or TCP_UDP, the supported values are 10 and 30 seconds. If the target group protocol is HTTP or HTTPS, the default is 30 seconds. If the target group protocol is GENEVE, the default is 10 seconds. If the target type is <code>lambda</code>, the default is 35 seconds.</p>",
"ModifyTargetGroupInput$HealthCheckIntervalSeconds": "<p>The approximate amount of time, in seconds, between health checks of an individual target. For TCP health checks, the supported values are 10 or 30 seconds.</p> <p>With Network Load Balancers, you can't modify this setting.</p>",
"TargetGroup$HealthCheckIntervalSeconds": "<p>The approximate amount of time, in seconds, between health checks of an individual target.</p>"
}
},
"HealthCheckPort": {
"base": null,
"refs": {
"CreateTargetGroupInput$HealthCheckPort": "<p>The port the load balancer uses when performing health checks on targets. If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the default is <code>traffic-port</code>, which is the port on which each target receives traffic from the load balancer. If the protocol is GENEVE, the default is port 80.</p>",
"ModifyTargetGroupInput$HealthCheckPort": "<p>The port the load balancer uses when performing health checks on targets.</p>",
"TargetGroup$HealthCheckPort": "<p>The port to use to connect with the target.</p>",
"TargetHealthDescription$HealthCheckPort": "<p>The port to use to connect with the target.</p>"
}
},
"HealthCheckThresholdCount": {
"base": null,
"refs": {
"CreateTargetGroupInput$HealthyThresholdCount": "<p>The number of consecutive health checks successes required before considering an unhealthy target healthy. For target groups with a protocol of HTTP or HTTPS, the default is 5. For target groups with a protocol of TCP, TLS, or GENEVE, the default is 3. If the target type is <code>lambda</code>, the default is 5.</p>",
"CreateTargetGroupInput$UnhealthyThresholdCount": "<p>The number of consecutive health check failures required before considering a target unhealthy. If the target group protocol is HTTP or HTTPS, the default is 2. If the target group protocol is TCP or TLS, this value must be the same as the healthy threshold count. If the target group protocol is GENEVE, the default is 3. If the target type is <code>lambda</code>, the default is 2.</p>",
"ModifyTargetGroupInput$HealthyThresholdCount": "<p>The number of consecutive health checks successes required before considering an unhealthy target healthy.</p>",
"ModifyTargetGroupInput$UnhealthyThresholdCount": "<p>The number of consecutive health check failures required before considering the target unhealthy. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count.</p>",
"TargetGroup$HealthyThresholdCount": "<p>The number of consecutive health checks successes required before considering an unhealthy target healthy.</p>",
"TargetGroup$UnhealthyThresholdCount": "<p>The number of consecutive health check failures required before considering the target unhealthy.</p>"
}
},
"HealthCheckTimeoutSeconds": {
"base": null,
"refs": {
"CreateTargetGroupInput$HealthCheckTimeoutSeconds": "<p>The amount of time, in seconds, during which no response from a target means a failed health check. For target groups with a protocol of HTTP, HTTPS, or GENEVE, the default is 5 seconds. For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks. If the target type is <code>lambda</code>, the default is 30 seconds.</p>",
"ModifyTargetGroupInput$HealthCheckTimeoutSeconds": "<p>[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.</p> <p>With Network Load Balancers, you can't modify this setting.</p>",
"TargetGroup$HealthCheckTimeoutSeconds": "<p>The amount of time, in seconds, during which no response means a failed health check.</p>"
}
},
"HealthUnavailableException": {
"base": "<p>The health of the specified targets could not be retrieved due to an internal error.</p>",
"refs": {
}
},
"HostHeaderConditionConfig": {
"base": "<p>Information about a host header condition.</p>",
"refs": {
"RuleCondition$HostHeaderConfig": "<p>Information for a host header condition. Specify only when <code>Field</code> is <code>host-header</code>.</p>"
}
},
"HttpCode": {
"base": null,
"refs": {
"Matcher$HttpCode": "<p>For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, \"200,202\") or a range of values (for example, \"200-299\").</p> <p>For Network Load Balancers and Gateway Load Balancers, this must be \"200–399\".</p> <p>Note that when using shorthand syntax, some values such as commas need to be escaped.</p>"
}
},
"HttpHeaderConditionConfig": {
"base": "<p>Information about an HTTP header condition.</p> <p>There is a set of standard HTTP header fields. You can also define custom HTTP header fields.</p>",
"refs": {
"RuleCondition$HttpHeaderConfig": "<p>Information for an HTTP header condition. Specify only when <code>Field</code> is <code>http-header</code>.</p>"
}
},
"HttpHeaderConditionName": {
"base": null,
"refs": {
"HttpHeaderConditionConfig$HttpHeaderName": "<p>The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported.</p> <p>You can't use an HTTP header condition to specify the host header. Use <a>HostHeaderConditionConfig</a> to specify a host header condition.</p>"
}
},
"HttpRequestMethodConditionConfig": {
"base": "<p>Information about an HTTP method condition.</p> <p>HTTP defines a set of request methods, also referred to as HTTP verbs. For more information, see the <a href=\"https://www.iana.org/assignments/http-methods/http-methods.xhtml\">HTTP Method Registry</a>. You can also define custom HTTP methods.</p>",
"refs": {
"RuleCondition$HttpRequestMethodConfig": "<p>Information for an HTTP method condition. Specify only when <code>Field</code> is <code>http-request-method</code>.</p>"
}
},
"IPv6Address": {
"base": null,
"refs": {
"LoadBalancerAddress$IPv6Address": "<p>[Network Load Balancers] The IPv6 address.</p>",
"SubnetMapping$IPv6Address": "<p>[Network Load Balancers] The IPv6 address.</p>"
}
},
"IncompatibleProtocolsException": {
"base": "<p>The specified configuration is not valid with this protocol.</p>",
"refs": {
}
},
"InvalidConfigurationRequestException": {
"base": "<p>The requested configuration is not valid.</p>",
"refs": {
}
},
"InvalidLoadBalancerActionException": {
"base": "<p>The requested action is not valid.</p>",
"refs": {
}
},
"InvalidSchemeException": {
"base": "<p>The requested scheme is not valid.</p>",
"refs": {
}
},
"InvalidSecurityGroupException": {
"base": "<p>The specified security group does not exist.</p>",
"refs": {
}
},
"InvalidSubnetException": {
"base": "<p>The specified subnet is out of available addresses.</p>",
"refs": {
}
},
"InvalidTargetException": {
"base": "<p>The specified target does not exist, is not in the same VPC as the target group, or has an unsupported instance type.</p>",
"refs": {
}
},
"IpAddress": {
"base": null,
"refs": {
"LoadBalancerAddress$IpAddress": "<p>The static IP address.</p>"
}
},
"IpAddressType": {
"base": null,
"refs": {
"CreateLoadBalancerInput$IpAddressType": "<p>The type of IP addresses used by the subnets for your load balancer. The possible values are <code>ipv4</code> (for IPv4 addresses) and <code>dualstack</code> (for IPv4 and IPv6 addresses). Internal load balancers must use <code>ipv4</code>.</p>",
"LoadBalancer$IpAddressType": "<p>The type of IP addresses used by the subnets for your load balancer. The possible values are <code>ipv4</code> (for IPv4 addresses) and <code>dualstack</code> (for IPv4 and IPv6 addresses).</p>",
"SetIpAddressTypeInput$IpAddressType": "<p>The IP address type. The possible values are <code>ipv4</code> (for IPv4 addresses) and <code>dualstack</code> (for IPv4 and IPv6 addresses). Internal load balancers must use <code>ipv4</code>. You can’t specify <code>dualstack</code> for a load balancer with a UDP or TCP_UDP listener.</p>",
"SetIpAddressTypeOutput$IpAddressType": "<p>The IP address type.</p>",
"SetSubnetsInput$IpAddressType": "<p>[Network Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are <code>ipv4</code> (for IPv4 addresses) and <code>dualstack</code> (for IPv4 and IPv6 addresses). You can’t specify <code>dualstack</code> for a load balancer with a UDP or TCP_UDP listener. Internal load balancers must use <code>ipv4</code>.</p>",
"SetSubnetsOutput$IpAddressType": "<p>[Network Load Balancers] The IP address type.</p>"
}
},
"IsDefault": {
"base": null,
"refs": {
"Rule$IsDefault": "<p>Indicates whether this is the default rule.</p>"
}
},
"Limit": {
"base": "<p>Information about an Elastic Load Balancing resource limit for your Amazon Web Services account.</p>",
"refs": {
"Limits$member": null
}
},
"Limits": {
"base": null,
"refs": {
"DescribeAccountLimitsOutput$Limits": "<p>Information about the limits.</p>"
}
},
"ListOfString": {
"base": null,
"refs": {
"HostHeaderConditionConfig$Values": "<p>One or more host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).</p> <p>If you specify multiple strings, the condition is satisfied if one of the strings matches the host name.</p>",
"HttpHeaderConditionConfig$Values": "<p>One or more strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).</p> <p>If the same header appears multiple times in the request, we search them in order until a match is found.</p> <p>If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.</p>",
"HttpRequestMethodConditionConfig$Values": "<p>The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match.</p> <p>If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached.</p>",
"PathPatternConditionConfig$Values": "<p>One or more path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).</p> <p>If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. To compare against the query string, use <a>QueryStringConditionConfig</a>.</p>",
"RuleCondition$Values": "<p>The condition value. Specify only when <code>Field</code> is <code>host-header</code> or <code>path-pattern</code>. Alternatively, to specify multiple host names or multiple path patterns, use <code>HostHeaderConfig</code> or <code>PathPatternConfig</code>.</p> <p>If <code>Field</code> is <code>host-header</code> and you are not using <code>HostHeaderConfig</code>, you can specify a single host name (for example, my.example.com) in <code>Values</code>. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>- .</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul> <p>If <code>Field</code> is <code>path-pattern</code> and you are not using <code>PathPatternConfig</code>, you can specify a single path pattern (for example, /img/*) in <code>Values</code>. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>_ - . $ / ~ \" ' @ : +</p> </li> <li> <p>& (using &amp;)</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul>",
"SourceIpConditionConfig$Values": "<p>One or more source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.</p> <p>If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use <a>HttpHeaderConditionConfig</a>.</p>",
"SslPolicy$SupportedLoadBalancerTypes": "<p> The supported load balancers. </p>"
}
},
"Listener": {
"base": "<p>Information about a listener.</p>",
"refs": {
"Listeners$member": null
}
},
"ListenerArn": {
"base": null,
"refs": {
"AddListenerCertificatesInput$ListenerArn": "<p>The Amazon Resource Name (ARN) of the listener.</p>",
"CreateRuleInput$ListenerArn": "<p>The Amazon Resource Name (ARN) of the listener.</p>",
"DeleteListenerInput$ListenerArn": "<p>The Amazon Resource Name (ARN) of the listener.</p>",
"DescribeListenerCertificatesInput$ListenerArn": "<p>The Amazon Resource Names (ARN) of the listener.</p>",
"DescribeRulesInput$ListenerArn": "<p>The Amazon Resource Name (ARN) of the listener.</p>",
"Listener$ListenerArn": "<p>The Amazon Resource Name (ARN) of the listener.</p>",
"ListenerArns$member": null,
"ModifyListenerInput$ListenerArn": "<p>The Amazon Resource Name (ARN) of the listener.</p>",
"RemoveListenerCertificatesInput$ListenerArn": "<p>The Amazon Resource Name (ARN) of the listener.</p>"
}
},
"ListenerArns": {
"base": null,
"refs": {
"DescribeListenersInput$ListenerArns": "<p>The Amazon Resource Names (ARN) of the listeners.</p>"
}
},
"ListenerNotFoundException": {
"base": "<p>The specified listener does not exist.</p>",
"refs": {
}
},
"Listeners": {
"base": null,
"refs": {
"CreateListenerOutput$Listeners": "<p>Information about the listener.</p>",
"DescribeListenersOutput$Listeners": "<p>Information about the listeners.</p>",
"ModifyListenerOutput$Listeners": "<p>Information about the modified listener.</p>"
}
},
"LoadBalancer": {
"base": "<p>Information about a load balancer.</p>",
"refs": {
"LoadBalancers$member": null
}
},
"LoadBalancerAddress": {
"base": "<p>Information about a static IP address for a load balancer.</p>",
"refs": {
"LoadBalancerAddresses$member": null
}
},
"LoadBalancerAddresses": {
"base": null,
"refs": {
"AvailabilityZone$LoadBalancerAddresses": "<p>[Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one Elastic IP address per Availability Zone when you create an internal-facing load balancer. For internal load balancers, you can specify a private IP address from the IPv4 range of the subnet.</p>"
}
},
"LoadBalancerArn": {
"base": null,
"refs": {
"CreateListenerInput$LoadBalancerArn": "<p>The Amazon Resource Name (ARN) of the load balancer.</p>",
"DeleteLoadBalancerInput$LoadBalancerArn": "<p>The Amazon Resource Name (ARN) of the load balancer.</p>",
"DescribeListenersInput$LoadBalancerArn": "<p>The Amazon Resource Name (ARN) of the load balancer.</p>",
"DescribeLoadBalancerAttributesInput$LoadBalancerArn": "<p>The Amazon Resource Name (ARN) of the load balancer.</p>",
"DescribeTargetGroupsInput$LoadBalancerArn": "<p>The Amazon Resource Name (ARN) of the load balancer.</p>",
"Listener$LoadBalancerArn": "<p>The Amazon Resource Name (ARN) of the load balancer.</p>",
"LoadBalancer$LoadBalancerArn": "<p>The Amazon Resource Name (ARN) of the load balancer.</p>",
"LoadBalancerArns$member": null,
"ModifyLoadBalancerAttributesInput$LoadBalancerArn": "<p>The Amazon Resource Name (ARN) of the load balancer.</p>",
"SetIpAddressTypeInput$LoadBalancerArn": "<p>The Amazon Resource Name (ARN) of the load balancer.</p>",
"SetSecurityGroupsInput$LoadBalancerArn": "<p>The Amazon Resource Name (ARN) of the load balancer.</p>",
"SetSubnetsInput$LoadBalancerArn": "<p>The Amazon Resource Name (ARN) of the load balancer.</p>"
}
},
"LoadBalancerArns": {
"base": null,
"refs": {
"DescribeLoadBalancersInput$LoadBalancerArns": "<p>The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.</p>",
"TargetGroup$LoadBalancerArns": "<p>The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.</p>"
}
},
"LoadBalancerAttribute": {
"base": "<p>Information about a load balancer attribute.</p>",
"refs": {
"LoadBalancerAttributes$member": null
}
},
"LoadBalancerAttributeKey": {
"base": null,
"refs": {
"LoadBalancerAttribute$Key": "<p>The name of the attribute.</p> <p>The following attribute is supported by all load balancers:</p> <ul> <li> <p> <code>deletion_protection.enabled</code> - Indicates whether deletion protection is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> </ul> <p>The following attributes are supported by both Application Load Balancers and Network Load Balancers:</p> <ul> <li> <p> <code>access_logs.s3.enabled</code> - Indicates whether access logs are enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> <li> <p> <code>access_logs.s3.bucket</code> - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.</p> </li> <li> <p> <code>access_logs.s3.prefix</code> - The prefix for the location in the S3 bucket for the access logs.</p> </li> </ul> <p>The following attributes are supported by only Application Load Balancers:</p> <ul> <li> <p> <code>idle_timeout.timeout_seconds</code> - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.</p> </li> <li> <p> <code>routing.http.desync_mitigation_mode</code> - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are <code>monitor</code>, <code>defensive</code>, and <code>strictest</code>. The default is <code>defensive</code>.</p> </li> <li> <p> <code>routing.http.drop_invalid_header_fields.enabled</code> - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (<code>true</code>) or routed to targets (<code>false</code>). The default is <code>false</code>.</p> </li> <li> <p> <code>routing.http.x_amzn_tls_version_and_cipher_suite.enabled</code> - Indicates whether the two headers (<code>x-amzn-tls-version</code> and <code>x-amzn-tls-cipher-suite</code>), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The <code>x-amzn-tls-version</code> header has information about the TLS protocol version negotiated with the client, and the <code>x-amzn-tls-cipher-suite</code> header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are <code>true</code> and <code>false</code>. The default is <code>false</code>.</p> </li> <li> <p> <code>routing.http.xff_client_port.enabled</code> - Indicates whether the <code>X-Forwarded-For</code> header should preserve the source port that the client used to connect to the load balancer. The possible values are <code>true</code> and <code>false</code>. The default is <code>false</code>.</p> </li> <li> <p> <code>routing.http2.enabled</code> - Indicates whether HTTP/2 is enabled. The possible values are <code>true</code> and <code>false</code>. The default is <code>true</code>. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens.</p> </li> <li> <p> <code>waf.fail_open.enabled</code> - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to Amazon Web Services WAF. The possible values are <code>true</code> and <code>false</code>. The default is <code>false</code>.</p> </li> </ul> <p>The following attribute is supported by Network Load Balancers and Gateway Load Balancers:</p> <ul> <li> <p> <code>load_balancing.cross_zone.enabled</code> - Indicates whether cross-zone load balancing is enabled. The possible values are <code>true</code> and <code>false</code>. The default is <code>false</code>.</p> </li> </ul>"
}
},
"LoadBalancerAttributeValue": {
"base": null,
"refs": {
"LoadBalancerAttribute$Value": "<p>The value of the attribute.</p>"
}
},
"LoadBalancerAttributes": {
"base": null,
"refs": {
"DescribeLoadBalancerAttributesOutput$Attributes": "<p>Information about the load balancer attributes.</p>",
"ModifyLoadBalancerAttributesInput$Attributes": "<p>The load balancer attributes.</p>",
"ModifyLoadBalancerAttributesOutput$Attributes": "<p>Information about the load balancer attributes.</p>"
}
},
"LoadBalancerName": {
"base": null,
"refs": {
"CreateLoadBalancerInput$Name": "<p>The name of the load balancer.</p> <p>This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with \"internal-\".</p>",
"LoadBalancer$LoadBalancerName": "<p>The name of the load balancer.</p>",
"LoadBalancerNames$member": null
}
},
"LoadBalancerNames": {
"base": null,
"refs": {
"DescribeLoadBalancersInput$Names": "<p>The names of the load balancers.</p>"
}
},
"LoadBalancerNotFoundException": {
"base": "<p>The specified load balancer does not exist.</p>",
"refs": {
}
},
"LoadBalancerSchemeEnum": {
"base": null,
"refs": {
"CreateLoadBalancerInput$Scheme": "<p>The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.</p> <p>The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.</p> <p>The default is an Internet-facing load balancer.</p> <p>You cannot specify a scheme for a Gateway Load Balancer.</p>",
"LoadBalancer$Scheme": "<p>The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.</p> <p>The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.</p>"
}
},
"LoadBalancerState": {
"base": "<p>Information about the state of the load balancer.</p>",
"refs": {
"LoadBalancer$State": "<p>The state of the load balancer.</p>"
}
},
"LoadBalancerStateEnum": {
"base": null,
"refs": {
"LoadBalancerState$Code": "<p>The state code. The initial state of the load balancer is <code>provisioning</code>. After the load balancer is fully set up and ready to route traffic, its state is <code>active</code>. If load balancer is routing traffic but does not have the resources it needs to scale, its state is<code>active_impaired</code>. If the load balancer could not be set up, its state is <code>failed</code>.</p>"
}
},
"LoadBalancerTypeEnum": {
"base": null,
"refs": {
"CreateLoadBalancerInput$Type": "<p>The type of load balancer. The default is <code>application</code>.</p>",
"DescribeSSLPoliciesInput$LoadBalancerType": "<p> The type of load balancer. The default lists the SSL policies for all load balancers.</p>",
"LoadBalancer$Type": "<p>The type of load balancer.</p>"
}
},
"LoadBalancers": {
"base": null,
"refs": {
"CreateLoadBalancerOutput$LoadBalancers": "<p>Information about the load balancer.</p>",
"DescribeLoadBalancersOutput$LoadBalancers": "<p>Information about the load balancers.</p>"
}
},
"Marker": {
"base": null,
"refs": {
"DescribeAccountLimitsInput$Marker": "<p>The marker for the next set of results. (You received this marker from a previous call.)</p>",
"DescribeAccountLimitsOutput$NextMarker": "<p>If there are additional results, this is the marker for the next set of results. Otherwise, this is null.</p>",
"DescribeListenerCertificatesInput$Marker": "<p>The marker for the next set of results. (You received this marker from a previous call.)</p>",
"DescribeListenerCertificatesOutput$NextMarker": "<p>If there are additional results, this is the marker for the next set of results. Otherwise, this is null.</p>",
"DescribeListenersInput$Marker": "<p>The marker for the next set of results. (You received this marker from a previous call.)</p>",
"DescribeListenersOutput$NextMarker": "<p>If there are additional results, this is the marker for the next set of results. Otherwise, this is null.</p>",
"DescribeLoadBalancersInput$Marker": "<p>The marker for the next set of results. (You received this marker from a previous call.)</p>",
"DescribeLoadBalancersOutput$NextMarker": "<p>If there are additional results, this is the marker for the next set of results. Otherwise, this is null.</p>",
"DescribeRulesInput$Marker": "<p>The marker for the next set of results. (You received this marker from a previous call.)</p>",
"DescribeRulesOutput$NextMarker": "<p>If there are additional results, this is the marker for the next set of results. Otherwise, this is null.</p>",
"DescribeSSLPoliciesInput$Marker": "<p>The marker for the next set of results. (You received this marker from a previous call.)</p>",
"DescribeSSLPoliciesOutput$NextMarker": "<p>If there are additional results, this is the marker for the next set of results. Otherwise, this is null.</p>",
"DescribeTargetGroupsInput$Marker": "<p>The marker for the next set of results. (You received this marker from a previous call.)</p>",
"DescribeTargetGroupsOutput$NextMarker": "<p>If there are additional results, this is the marker for the next set of results. Otherwise, this is null.</p>"
}
},
"Matcher": {
"base": "<p>The codes to use when checking for a successful response from a target. If the protocol version is gRPC, these are gRPC codes. Otherwise, these are HTTP codes. </p>",
"refs": {
"CreateTargetGroupInput$Matcher": "<p>[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.</p>",
"ModifyTargetGroupInput$Matcher": "<p>[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.</p> <p>With Network Load Balancers, you can't modify this setting.</p>",
"TargetGroup$Matcher": "<p>The HTTP or gRPC codes to use when checking for a successful response from a target.</p>"
}