@aws-sdk/client-elastic-load-balancing-v2 3.379.1 → 3.382.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -20,23 +20,28 @@ export type AuthenticateCognitoActionConditionalBehaviorEnum = (typeof Authentic
20
20
  */
21
21
  export interface AuthenticateCognitoActionConfig {
22
22
  /**
23
+ * @public
23
24
  * <p>The Amazon Resource Name (ARN) of the Amazon Cognito user pool.</p>
24
25
  */
25
26
  UserPoolArn: string | undefined;
26
27
  /**
28
+ * @public
27
29
  * <p>The ID of the Amazon Cognito user pool client.</p>
28
30
  */
29
31
  UserPoolClientId: string | undefined;
30
32
  /**
33
+ * @public
31
34
  * <p>The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.</p>
32
35
  */
33
36
  UserPoolDomain: string | undefined;
34
37
  /**
38
+ * @public
35
39
  * <p>The name of the cookie used to maintain session information. The default is
36
40
  * AWSELBAuthSessionCookie.</p>
37
41
  */
38
42
  SessionCookieName?: string;
39
43
  /**
44
+ * @public
40
45
  * <p>The set of user claims to be requested from the IdP. The default is
41
46
  * <code>openid</code>.</p>
42
47
  * <p>To verify which scope values your IdP supports and how to separate multiple values, see
@@ -44,16 +49,19 @@ export interface AuthenticateCognitoActionConfig {
44
49
  */
45
50
  Scope?: string;
46
51
  /**
52
+ * @public
47
53
  * <p>The maximum duration of the authentication session, in seconds. The default is 604800
48
54
  * seconds (7 days).</p>
49
55
  */
50
56
  SessionTimeout?: number;
51
57
  /**
58
+ * @public
52
59
  * <p>The query parameters (up to 10) to include in the redirect request to the authorization
53
60
  * endpoint.</p>
54
61
  */
55
62
  AuthenticationRequestExtraParams?: Record<string, string>;
56
63
  /**
64
+ * @public
57
65
  * <p>The behavior if the user is not authenticated. The following are possible values:</p>
58
66
  * <ul>
59
67
  * <li>
@@ -90,41 +98,49 @@ export type AuthenticateOidcActionConditionalBehaviorEnum = (typeof Authenticate
90
98
  */
91
99
  export interface AuthenticateOidcActionConfig {
92
100
  /**
101
+ * @public
93
102
  * <p>The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS
94
103
  * protocol, the domain, and the path.</p>
95
104
  */
96
105
  Issuer: string | undefined;
97
106
  /**
107
+ * @public
98
108
  * <p>The authorization endpoint of the IdP. This must be a full URL, including the HTTPS
99
109
  * protocol, the domain, and the path.</p>
100
110
  */
101
111
  AuthorizationEndpoint: string | undefined;
102
112
  /**
113
+ * @public
103
114
  * <p>The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the
104
115
  * domain, and the path.</p>
105
116
  */
106
117
  TokenEndpoint: string | undefined;
107
118
  /**
119
+ * @public
108
120
  * <p>The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol,
109
121
  * the domain, and the path.</p>
110
122
  */
111
123
  UserInfoEndpoint: string | undefined;
112
124
  /**
125
+ * @public
113
126
  * <p>The OAuth 2.0 client identifier.</p>
114
127
  */
115
128
  ClientId: string | undefined;
116
129
  /**
130
+ * @public
117
131
  * <p>The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you
118
132
  * are modifying a rule, you can omit this parameter if you set
119
133
  * <code>UseExistingClientSecret</code> to true.</p>
120
134
  */
121
135
  ClientSecret?: string;
122
136
  /**
137
+ * @public
123
138
  * <p>The name of the cookie used to maintain session information. The default is
124
139
  * AWSELBAuthSessionCookie.</p>
125
140
  */
126
141
  SessionCookieName?: string;
127
142
  /**
143
+ * @public
128
144
  * <p>The set of user claims to be requested from the IdP. The default is
129
145
  * <code>openid</code>.</p>
130
146
  * <p>To verify which scope values your IdP supports and how to separate multiple values, see
@@ -132,16 +148,19 @@ export interface AuthenticateOidcActionConfig {
132
148
  */
133
149
  Scope?: string;
134
150
  /**
151
+ * @public
135
152
  * <p>The maximum duration of the authentication session, in seconds. The default is 604800
136
153
  * seconds (7 days).</p>
137
154
  */
138
155
  SessionTimeout?: number;
139
156
  /**
157
+ * @public
140
158
  * <p>The query parameters (up to 10) to include in the redirect request to the authorization
141
159
  * endpoint.</p>
142
160
  */
143
161
  AuthenticationRequestExtraParams?: Record<string, string>;
144
162
  /**
163
+ * @public
145
164
  * <p>The behavior if the user is not authenticated. The following are possible values:</p>
146
165
  * <ul>
147
166
  * <li>
@@ -158,6 +177,7 @@ export interface AuthenticateOidcActionConfig {
158
177
  */
159
178
  OnUnauthenticatedRequest?: AuthenticateOidcActionConditionalBehaviorEnum | string;
160
179
  /**
180
+ * @public
161
181
  * <p>Indicates whether to use the existing client secret when modifying a rule. If you are
162
182
  * creating a rule, you can omit this parameter or set it to false.</p>
163
183
  */
@@ -169,14 +189,17 @@ export interface AuthenticateOidcActionConfig {
169
189
  */
170
190
  export interface FixedResponseActionConfig {
171
191
  /**
192
+ * @public
172
193
  * <p>The message.</p>
173
194
  */
174
195
  MessageBody?: string;
175
196
  /**
197
+ * @public
176
198
  * <p>The HTTP response code (2XX, 4XX, or 5XX).</p>
177
199
  */
178
200
  StatusCode: string | undefined;
179
201
  /**
202
+ * @public
180
203
  * <p>The content type.</p>
181
204
  * <p>Valid Values: text/plain | text/css | text/html | application/javascript |
182
205
  * application/json</p>
@@ -190,10 +213,12 @@ export interface FixedResponseActionConfig {
190
213
  */
191
214
  export interface TargetGroupTuple {
192
215
  /**
216
+ * @public
193
217
  * <p>The Amazon Resource Name (ARN) of the target group.</p>
194
218
  */
195
219
  TargetGroupArn?: string;
196
220
  /**
221
+ * @public
197
222
  * <p>The weight. The range is 0 to 999.</p>
198
223
  */
199
224
  Weight?: number;
@@ -204,10 +229,12 @@ export interface TargetGroupTuple {
204
229
  */
205
230
  export interface TargetGroupStickinessConfig {
206
231
  /**
232
+ * @public
207
233
  * <p>Indicates whether target group stickiness is enabled.</p>
208
234
  */
209
235
  Enabled?: boolean;
210
236
  /**
237
+ * @public
211
238
  * <p>The time period, in seconds, during which requests from a client should be routed to the
212
239
  * same target group. The range is 1-604800 seconds (7 days).</p>
213
240
  */
@@ -219,11 +246,13 @@ export interface TargetGroupStickinessConfig {
219
246
  */
220
247
  export interface ForwardActionConfig {
221
248
  /**
249
+ * @public
222
250
  * <p>The target groups. For Network Load Balancers, you can specify a single target
223
251
  * group.</p>
224
252
  */
225
253
  TargetGroups?: TargetGroupTuple[];
226
254
  /**
255
+ * @public
227
256
  * <p>The target group stickiness for the rule.</p>
228
257
  */
229
258
  TargetGroupStickinessConfig?: TargetGroupStickinessConfig;
@@ -269,31 +298,37 @@ export type RedirectActionStatusCodeEnum = (typeof RedirectActionStatusCodeEnum)
269
298
  */
270
299
  export interface RedirectActionConfig {
271
300
  /**
301
+ * @public
272
302
  * <p>The protocol. You can specify HTTP, HTTPS, or #\{protocol\}. You can redirect HTTP to HTTP,
273
303
  * HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.</p>
274
304
  */
275
305
  Protocol?: string;
276
306
  /**
307
+ * @public
277
308
  * <p>The port. You can specify a value from 1 to 65535 or #\{port\}.</p>
278
309
  */
279
310
  Port?: string;
280
311
  /**
312
+ * @public
281
313
  * <p>The hostname. This component is not percent-encoded. The hostname can contain
282
314
  * #\{host\}.</p>
283
315
  */
284
316
  Host?: string;
285
317
  /**
318
+ * @public
286
319
  * <p>The absolute path, starting with the leading "/". This component is not percent-encoded.
287
320
  * The path can contain #\{host\}, #\{path\}, and #\{port\}.</p>
288
321
  */
289
322
  Path?: string;
290
323
  /**
324
+ * @public
291
325
  * <p>The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include
292
326
  * the leading "?", as it is automatically added. You can specify any of the reserved
293
327
  * keywords.</p>
294
328
  */
295
329
  Query?: string;
296
330
  /**
331
+ * @public
297
332
  * <p>The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP
298
333
  * 302).</p>
299
334
  */
@@ -323,41 +358,49 @@ export type ActionTypeEnum = (typeof ActionTypeEnum)[keyof typeof ActionTypeEnum
323
358
  */
324
359
  export interface Action {
325
360
  /**
361
+ * @public
326
362
  * <p>The type of action.</p>
327
363
  */
328
364
  Type: ActionTypeEnum | string | undefined;
329
365
  /**
366
+ * @public
330
367
  * <p>The Amazon Resource Name (ARN) of the target group. Specify only when <code>Type</code> is
331
368
  * <code>forward</code> and you want to route to a single target group. To route to one or more
332
369
  * target groups, use <code>ForwardConfig</code> instead.</p>
333
370
  */
334
371
  TargetGroupArn?: string;
335
372
  /**
373
+ * @public
336
374
  * <p>[HTTPS listeners] Information about an identity provider that is compliant with OpenID
337
375
  * Connect (OIDC). Specify only when <code>Type</code> is <code>authenticate-oidc</code>.</p>
338
376
  */
339
377
  AuthenticateOidcConfig?: AuthenticateOidcActionConfig;
340
378
  /**
379
+ * @public
341
380
  * <p>[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only
342
381
  * when <code>Type</code> is <code>authenticate-cognito</code>.</p>
343
382
  */
344
383
  AuthenticateCognitoConfig?: AuthenticateCognitoActionConfig;
345
384
  /**
385
+ * @public
346
386
  * <p>The order for the action. This value is required for rules with multiple actions. The
347
387
  * action with the lowest value for order is performed first.</p>
348
388
  */
349
389
  Order?: number;
350
390
  /**
391
+ * @public
351
392
  * <p>[Application Load Balancer] Information for creating a redirect action. Specify only when
352
393
  * <code>Type</code> is <code>redirect</code>.</p>
353
394
  */
354
395
  RedirectConfig?: RedirectActionConfig;
355
396
  /**
397
+ * @public
356
398
  * <p>[Application Load Balancer] Information for creating an action that returns a custom HTTP
357
399
  * response. Specify only when <code>Type</code> is <code>fixed-response</code>.</p>
358
400
  */
359
401
  FixedResponseConfig?: FixedResponseActionConfig;
360
402
  /**
403
+ * @public
361
404
  * <p>Information for creating an action that distributes requests among one or more target
362
405
  * groups. For Network Load Balancers, you can specify a single target group. Specify only when
363
406
  * <code>Type</code> is <code>forward</code>. If you specify both <code>ForwardConfig</code>
@@ -373,10 +416,12 @@ export interface Action {
373
416
  */
374
417
  export interface Certificate {
375
418
  /**
419
+ * @public
376
420
  * <p>The Amazon Resource Name (ARN) of the certificate.</p>
377
421
  */
378
422
  CertificateArn?: string;
379
423
  /**
424
+ * @public
380
425
  * <p>Indicates whether the certificate is the default certificate. Do not set this value when
381
426
  * specifying a certificate as an input. This value is not included in the output when describing
382
427
  * a listener, but is included when describing listener certificates.</p>
@@ -388,10 +433,12 @@ export interface Certificate {
388
433
  */
389
434
  export interface AddListenerCertificatesInput {
390
435
  /**
436
+ * @public
391
437
  * <p>The Amazon Resource Name (ARN) of the listener.</p>
392
438
  */
393
439
  ListenerArn: string | undefined;
394
440
  /**
441
+ * @public
395
442
  * <p>The certificate to add. You can specify one certificate per call. Set
396
443
  * <code>CertificateArn</code> to the certificate ARN but do not set
397
444
  * <code>IsDefault</code>.</p>
@@ -403,6 +450,7 @@ export interface AddListenerCertificatesInput {
403
450
  */
404
451
  export interface AddListenerCertificatesOutput {
405
452
  /**
453
+ * @public
406
454
  * <p>Information about the certificates in the certificate list.</p>
407
455
  */
408
456
  Certificates?: Certificate[];
@@ -452,10 +500,12 @@ export declare class TooManyCertificatesException extends __BaseException {
452
500
  */
453
501
  export interface Tag {
454
502
  /**
503
+ * @public
455
504
  * <p>The key of the tag.</p>
456
505
  */
457
506
  Key: string | undefined;
458
507
  /**
508
+ * @public
459
509
  * <p>The value of the tag.</p>
460
510
  */
461
511
  Value?: string;
@@ -465,10 +515,12 @@ export interface Tag {
465
515
  */
466
516
  export interface AddTagsInput {
467
517
  /**
518
+ * @public
468
519
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
469
520
  */
470
521
  ResourceArns: string[] | undefined;
471
522
  /**
523
+ * @public
472
524
  * <p>The tags.</p>
473
525
  */
474
526
  Tags: Tag[] | undefined;
@@ -575,19 +627,23 @@ export declare class ALPNPolicyNotSupportedException extends __BaseException {
575
627
  */
576
628
  export interface LoadBalancerAddress {
577
629
  /**
630
+ * @public
578
631
  * <p>The static IP address.</p>
579
632
  */
580
633
  IpAddress?: string;
581
634
  /**
635
+ * @public
582
636
  * <p>[Network Load Balancers] The allocation ID of the Elastic IP address for an
583
637
  * internal-facing load balancer.</p>
584
638
  */
585
639
  AllocationId?: string;
586
640
  /**
641
+ * @public
587
642
  * <p>[Network Load Balancers] The private IPv4 address for an internal load balancer.</p>
588
643
  */
589
644
  PrivateIPv4Address?: string;
590
645
  /**
646
+ * @public
591
647
  * <p>[Network Load Balancers] The IPv6 address.</p>
592
648
  */
593
649
  IPv6Address?: string;
@@ -598,18 +654,22 @@ export interface LoadBalancerAddress {
598
654
  */
599
655
  export interface AvailabilityZone {
600
656
  /**
657
+ * @public
601
658
  * <p>The name of the Availability Zone.</p>
602
659
  */
603
660
  ZoneName?: string;
604
661
  /**
662
+ * @public
605
663
  * <p>The ID of the subnet. You can specify one subnet per Availability Zone.</p>
606
664
  */
607
665
  SubnetId?: string;
608
666
  /**
667
+ * @public
609
668
  * <p>[Application Load Balancers on Outposts] The ID of the Outpost.</p>
610
669
  */
611
670
  OutpostId?: string;
612
671
  /**
672
+ * @public
613
673
  * <p>[Network Load Balancers] If you need static IP addresses for your load balancer, you can
614
674
  * specify one Elastic IP address per Availability Zone when you create an internal-facing load
615
675
  * balancer. For internal load balancers, you can specify a private IP address from the IPv4
@@ -636,10 +696,12 @@ export declare class AvailabilityZoneNotSupportedException extends __BaseExcepti
636
696
  */
637
697
  export interface Cipher {
638
698
  /**
699
+ * @public
639
700
  * <p>The name of the cipher.</p>
640
701
  */
641
702
  Name?: string;
642
703
  /**
704
+ * @public
643
705
  * <p>The priority of the cipher.</p>
644
706
  */
645
707
  Priority?: number;
@@ -666,10 +728,12 @@ export type ProtocolEnum = (typeof ProtocolEnum)[keyof typeof ProtocolEnum];
666
728
  */
667
729
  export interface CreateListenerInput {
668
730
  /**
731
+ * @public
669
732
  * <p>The Amazon Resource Name (ARN) of the load balancer.</p>
670
733
  */
671
734
  LoadBalancerArn: string | undefined;
672
735
  /**
736
+ * @public
673
737
  * <p>The protocol for connections from clients to the load balancer. For Application Load
674
738
  * Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the
675
739
  * supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP
@@ -678,11 +742,13 @@ export interface CreateListenerInput {
678
742
  */
679
743
  Protocol?: ProtocolEnum | string;
680
744
  /**
745
+ * @public
681
746
  * <p>The port on which the load balancer is listening. You cannot specify a port for a Gateway
682
747
  * Load Balancer.</p>
683
748
  */
684
749
  Port?: number;
685
750
  /**
751
+ * @public
686
752
  * <p>[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are
687
753
  * supported.</p>
688
754
  * <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> and
@@ -690,16 +756,19 @@ export interface CreateListenerInput {
690
756
  */
691
757
  SslPolicy?: string;
692
758
  /**
759
+ * @public
693
760
  * <p>[HTTPS and TLS listeners] The default certificate for the listener. You must provide
694
761
  * exactly one certificate. Set <code>CertificateArn</code> to the certificate ARN but do not set
695
762
  * <code>IsDefault</code>.</p>
696
763
  */
697
764
  Certificates?: Certificate[];
698
765
  /**
766
+ * @public
699
767
  * <p>The actions for the default rule.</p>
700
768
  */
701
769
  DefaultActions: Action[] | undefined;
702
770
  /**
771
+ * @public
703
772
  * <p>[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You
704
773
  * can specify one policy name. The following are the possible values:</p>
705
774
  * <ul>
@@ -734,6 +803,7 @@ export interface CreateListenerInput {
734
803
  */
735
804
  AlpnPolicy?: string[];
736
805
  /**
806
+ * @public
737
807
  * <p>The tags to assign to the listener.</p>
738
808
  */
739
809
  Tags?: Tag[];
@@ -744,35 +814,43 @@ export interface CreateListenerInput {
744
814
  */
745
815
  export interface Listener {
746
816
  /**
817
+ * @public
747
818
  * <p>The Amazon Resource Name (ARN) of the listener.</p>
748
819
  */
749
820
  ListenerArn?: string;
750
821
  /**
822
+ * @public
751
823
  * <p>The Amazon Resource Name (ARN) of the load balancer.</p>
752
824
  */
753
825
  LoadBalancerArn?: string;
754
826
  /**
827
+ * @public
755
828
  * <p>The port on which the load balancer is listening.</p>
756
829
  */
757
830
  Port?: number;
758
831
  /**
832
+ * @public
759
833
  * <p>The protocol for connections from clients to the load balancer.</p>
760
834
  */
761
835
  Protocol?: ProtocolEnum | string;
762
836
  /**
837
+ * @public
763
838
  * <p>[HTTPS or TLS listener] The default certificate for the listener.</p>
764
839
  */
765
840
  Certificates?: Certificate[];
766
841
  /**
842
+ * @public
767
843
  * <p>[HTTPS or TLS listener] The security policy that defines which protocols and ciphers are
768
844
  * supported.</p>
769
845
  */
770
846
  SslPolicy?: string;
771
847
  /**
848
+ * @public
772
849
  * <p>The default actions for the listener.</p>
773
850
  */
774
851
  DefaultActions?: Action[];
775
852
  /**
853
+ * @public
776
854
  * <p>[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN)
777
855
  * policy.</p>
778
856
  */
@@ -783,6 +861,7 @@ export interface Listener {
783
861
  */
784
862
  export interface CreateListenerOutput {
785
863
  /**
864
+ * @public
786
865
  * <p>Information about the listener.</p>
787
866
  */
788
867
  Listeners?: Listener[];
@@ -976,19 +1055,23 @@ export type LoadBalancerSchemeEnum = (typeof LoadBalancerSchemeEnum)[keyof typeo
976
1055
  */
977
1056
  export interface SubnetMapping {
978
1057
  /**
1058
+ * @public
979
1059
  * <p>The ID of the subnet.</p>
980
1060
  */
981
1061
  SubnetId?: string;
982
1062
  /**
1063
+ * @public
983
1064
  * <p>[Network Load Balancers] The allocation ID of the Elastic IP address for an
984
1065
  * internet-facing load balancer.</p>
985
1066
  */
986
1067
  AllocationId?: string;
987
1068
  /**
1069
+ * @public
988
1070
  * <p>[Network Load Balancers] The private IPv4 address for an internal load balancer.</p>
989
1071
  */
990
1072
  PrivateIPv4Address?: string;
991
1073
  /**
1074
+ * @public
992
1075
  * <p>[Network Load Balancers] The IPv6 address.</p>
993
1076
  */
994
1077
  IPv6Address?: string;
@@ -1011,6 +1094,7 @@ export type LoadBalancerTypeEnum = (typeof LoadBalancerTypeEnum)[keyof typeof Lo
1011
1094
  */
1012
1095
  export interface CreateLoadBalancerInput {
1013
1096
  /**
1097
+ * @public
1014
1098
  * <p>The name of the load balancer.</p>
1015
1099
  * <p>This name must be unique per region per account, can have a maximum of 32 characters, must
1016
1100
  * contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must
@@ -1018,6 +1102,7 @@ export interface CreateLoadBalancerInput {
1018
1102
  */
1019
1103
  Name: string | undefined;
1020
1104
  /**
1105
+ * @public
1021
1106
  * <p>The IDs of the public subnets. You can specify only one subnet per Availability Zone. You
1022
1107
  * must specify either subnets or subnet mappings, but not both. To specify an Elastic IP
1023
1108
  * address, specify subnet mappings instead of subnets.</p>
@@ -1033,6 +1118,7 @@ export interface CreateLoadBalancerInput {
1033
1118
  */
1034
1119
  Subnets?: string[];
1035
1120
  /**
1121
+ * @public
1036
1122
  * <p>The IDs of the public subnets. You can specify only one subnet per Availability Zone. You
1037
1123
  * must specify either subnets or subnet mappings, but not both.</p>
1038
1124
  * <p>[Application Load Balancers] You must specify subnets from at least two Availability
@@ -1050,10 +1136,12 @@ export interface CreateLoadBalancerInput {
1050
1136
  */
1051
1137
  SubnetMappings?: SubnetMapping[];
1052
1138
  /**
1139
+ * @public
1053
1140
  * <p>[Application Load Balancers] The IDs of the security groups for the load balancer.</p>
1054
1141
  */
1055
1142
  SecurityGroups?: string[];
1056
1143
  /**
1144
+ * @public
1057
1145
  * <p>The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an
1058
1146
  * Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes.
1059
1147
  * Therefore, Internet-facing load balancers can route requests from clients over the
@@ -1067,20 +1155,24 @@ export interface CreateLoadBalancerInput {
1067
1155
  */
1068
1156
  Scheme?: LoadBalancerSchemeEnum | string;
1069
1157
  /**
1158
+ * @public
1070
1159
  * <p>The tags to assign to the load balancer.</p>
1071
1160
  */
1072
1161
  Tags?: Tag[];
1073
1162
  /**
1163
+ * @public
1074
1164
  * <p>The type of load balancer. The default is <code>application</code>.</p>
1075
1165
  */
1076
1166
  Type?: LoadBalancerTypeEnum | string;
1077
1167
  /**
1168
+ * @public
1078
1169
  * <p>The type of IP addresses used by the subnets for your load balancer. The possible values
1079
1170
  * are <code>ipv4</code> (for IPv4 addresses) and <code>dualstack</code> (for IPv4 and IPv6
1080
1171
  * addresses). </p>
1081
1172
  */
1082
1173
  IpAddressType?: IpAddressType | string;
1083
1174
  /**
1175
+ * @public
1084
1176
  * <p>[Application Load Balancers on Outposts] The ID of the customer-owned address pool (CoIP
1085
1177
  * pool).</p>
1086
1178
  */
@@ -1106,6 +1198,7 @@ export type LoadBalancerStateEnum = (typeof LoadBalancerStateEnum)[keyof typeof
1106
1198
  */
1107
1199
  export interface LoadBalancerState {
1108
1200
  /**
1201
+ * @public
1109
1202
  * <p>The state code. The initial state of the load balancer is <code>provisioning</code>. After
1110
1203
  * the load balancer is fully set up and ready to route traffic, its state is
1111
1204
  * <code>active</code>. If load balancer is routing traffic but does not have the resources it
@@ -1114,6 +1207,7 @@ export interface LoadBalancerState {
1114
1207
  */
1115
1208
  Code?: LoadBalancerStateEnum | string;
1116
1209
  /**
1210
+ * @public
1117
1211
  * <p>A description of the state.</p>
1118
1212
  */
1119
1213
  Reason?: string;
@@ -1124,26 +1218,32 @@ export interface LoadBalancerState {
1124
1218
  */
1125
1219
  export interface LoadBalancer {
1126
1220
  /**
1221
+ * @public
1127
1222
  * <p>The Amazon Resource Name (ARN) of the load balancer.</p>
1128
1223
  */
1129
1224
  LoadBalancerArn?: string;
1130
1225
  /**
1226
+ * @public
1131
1227
  * <p>The public DNS name of the load balancer.</p>
1132
1228
  */
1133
1229
  DNSName?: string;
1134
1230
  /**
1231
+ * @public
1135
1232
  * <p>The ID of the Amazon Route 53 hosted zone associated with the load balancer.</p>
1136
1233
  */
1137
1234
  CanonicalHostedZoneId?: string;
1138
1235
  /**
1236
+ * @public
1139
1237
  * <p>The date and time the load balancer was created.</p>
1140
1238
  */
1141
1239
  CreatedTime?: Date;
1142
1240
  /**
1241
+ * @public
1143
1242
  * <p>The name of the load balancer.</p>
1144
1243
  */
1145
1244
  LoadBalancerName?: string;
1146
1245
  /**
1246
+ * @public
1147
1247
  * <p>The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an
1148
1248
  * Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes.
1149
1249
  * Therefore, Internet-facing load balancers can route requests from clients over the
@@ -1155,32 +1255,39 @@ export interface LoadBalancer {
1155
1255
  */
1156
1256
  Scheme?: LoadBalancerSchemeEnum | string;
1157
1257
  /**
1258
+ * @public
1158
1259
  * <p>The ID of the VPC for the load balancer.</p>
1159
1260
  */
1160
1261
  VpcId?: string;
1161
1262
  /**
1263
+ * @public
1162
1264
  * <p>The state of the load balancer.</p>
1163
1265
  */
1164
1266
  State?: LoadBalancerState;
1165
1267
  /**
1268
+ * @public
1166
1269
  * <p>The type of load balancer.</p>
1167
1270
  */
1168
1271
  Type?: LoadBalancerTypeEnum | string;
1169
1272
  /**
1273
+ * @public
1170
1274
  * <p>The subnets for the load balancer.</p>
1171
1275
  */
1172
1276
  AvailabilityZones?: AvailabilityZone[];
1173
1277
  /**
1278
+ * @public
1174
1279
  * <p>The IDs of the security groups for the load balancer.</p>
1175
1280
  */
1176
1281
  SecurityGroups?: string[];
1177
1282
  /**
1283
+ * @public
1178
1284
  * <p>The type of IP addresses used by the subnets for your load balancer. The possible values
1179
1285
  * are <code>ipv4</code> (for IPv4 addresses) and <code>dualstack</code> (for IPv4 and IPv6
1180
1286
  * addresses).</p>
1181
1287
  */
1182
1288
  IpAddressType?: IpAddressType | string;
1183
1289
  /**
1290
+ * @public
1184
1291
  * <p>[Application Load Balancers on Outposts] The ID of the customer-owned address pool.</p>
1185
1292
  */
1186
1293
  CustomerOwnedIpv4Pool?: string;
@@ -1190,6 +1297,7 @@ export interface LoadBalancer {
1190
1297
  */
1191
1298
  export interface CreateLoadBalancerOutput {
1192
1299
  /**
1300
+ * @public
1193
1301
  * <p>Information about the load balancer.</p>
1194
1302
  */
1195
1303
  LoadBalancers?: LoadBalancer[];
@@ -1305,6 +1413,7 @@ export declare class TooManyLoadBalancersException extends __BaseException {
1305
1413
  */
1306
1414
  export interface HostHeaderConditionConfig {
1307
1415
  /**
1416
+ * @public
1308
1417
  * <p>The host names. The maximum size of each name is 128 characters. The comparison is
1309
1418
  * case insensitive. The following wildcard characters are supported: * (matches 0 or more
1310
1419
  * characters) and ? (matches exactly 1 character).</p>
@@ -1321,6 +1430,7 @@ export interface HostHeaderConditionConfig {
1321
1430
  */
1322
1431
  export interface HttpHeaderConditionConfig {
1323
1432
  /**
1433
+ * @public
1324
1434
  * <p>The name of the HTTP header field. The maximum size is 40 characters. The header name is
1325
1435
  * case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not
1326
1436
  * supported.</p>
@@ -1328,6 +1438,7 @@ export interface HttpHeaderConditionConfig {
1328
1438
  */
1329
1439
  HttpHeaderName?: string;
1330
1440
  /**
1441
+ * @public
1331
1442
  * <p>The strings to compare against the value of the HTTP header. The maximum size of
1332
1443
  * each string is 128 characters. The comparison strings are case insensitive. The following
1333
1444
  * wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1
@@ -1349,6 +1460,7 @@ export interface HttpHeaderConditionConfig {
1349
1460
  */
1350
1461
  export interface HttpRequestMethodConditionConfig {
1351
1462
  /**
1463
+ * @public
1352
1464
  * <p>The name of the request method. The maximum size is 40 characters. The allowed characters
1353
1465
  * are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not
1354
1466
  * supported; therefore, the method name must be an exact match.</p>
@@ -1364,6 +1476,7 @@ export interface HttpRequestMethodConditionConfig {
1364
1476
  */
1365
1477
  export interface PathPatternConditionConfig {
1366
1478
  /**
1479
+ * @public
1367
1480
  * <p>The path patterns to compare against the request URL. The maximum size of each
1368
1481
  * string is 128 characters. The comparison is case sensitive. The following wildcard characters
1369
1482
  * are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).</p>
@@ -1379,10 +1492,12 @@ export interface PathPatternConditionConfig {
1379
1492
  */
1380
1493
  export interface QueryStringKeyValuePair {
1381
1494
  /**
1495
+ * @public
1382
1496
  * <p>The key. You can omit the key.</p>
1383
1497
  */
1384
1498
  Key?: string;
1385
1499
  /**
1500
+ * @public
1386
1501
  * <p>The value.</p>
1387
1502
  */
1388
1503
  Value?: string;
@@ -1397,6 +1512,7 @@ export interface QueryStringKeyValuePair {
1397
1512
  */
1398
1513
  export interface QueryStringConditionConfig {
1399
1514
  /**
1515
+ * @public
1400
1516
  * <p>The key/value pairs or values to find in the query string. The maximum size of
1401
1517
  * each string is 128 characters. The comparison is case insensitive. The following wildcard
1402
1518
  * characters are supported: * (matches 0 or more characters) and ? (matches exactly 1
@@ -1416,6 +1532,7 @@ export interface QueryStringConditionConfig {
1416
1532
  */
1417
1533
  export interface SourceIpConditionConfig {
1418
1534
  /**
1535
+ * @public
1419
1536
  * <p>The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses.
1420
1537
  * Wildcards are not supported.</p>
1421
1538
  * <p>If you specify multiple addresses, the condition is satisfied if the source IP address of
@@ -1436,6 +1553,7 @@ export interface SourceIpConditionConfig {
1436
1553
  */
1437
1554
  export interface RuleCondition {
1438
1555
  /**
1556
+ * @public
1439
1557
  * <p>The field in the HTTP request. The following are the possible values:</p>
1440
1558
  * <ul>
1441
1559
  * <li>
@@ -1472,6 +1590,7 @@ export interface RuleCondition {
1472
1590
  */
1473
1591
  Field?: string;
1474
1592
  /**
1593
+ * @public
1475
1594
  * <p>The condition value. Specify only when <code>Field</code> is <code>host-header</code> or
1476
1595
  * <code>path-pattern</code>. Alternatively, to specify multiple host names or multiple path
1477
1596
  * patterns, use <code>HostHeaderConfig</code> or <code>PathPatternConfig</code>.</p>
@@ -1517,31 +1636,37 @@ export interface RuleCondition {
1517
1636
  */
1518
1637
  Values?: string[];
1519
1638
  /**
1639
+ * @public
1520
1640
  * <p>Information for a host header condition. Specify only when <code>Field</code> is
1521
1641
  * <code>host-header</code>.</p>
1522
1642
  */
1523
1643
  HostHeaderConfig?: HostHeaderConditionConfig;
1524
1644
  /**
1645
+ * @public
1525
1646
  * <p>Information for a path pattern condition. Specify only when <code>Field</code> is
1526
1647
  * <code>path-pattern</code>.</p>
1527
1648
  */
1528
1649
  PathPatternConfig?: PathPatternConditionConfig;
1529
1650
  /**
1651
+ * @public
1530
1652
  * <p>Information for an HTTP header condition. Specify only when <code>Field</code> is
1531
1653
  * <code>http-header</code>.</p>
1532
1654
  */
1533
1655
  HttpHeaderConfig?: HttpHeaderConditionConfig;
1534
1656
  /**
1657
+ * @public
1535
1658
  * <p>Information for a query string condition. Specify only when <code>Field</code> is
1536
1659
  * <code>query-string</code>.</p>
1537
1660
  */
1538
1661
  QueryStringConfig?: QueryStringConditionConfig;
1539
1662
  /**
1663
+ * @public
1540
1664
  * <p>Information for an HTTP method condition. Specify only when <code>Field</code> is
1541
1665
  * <code>http-request-method</code>.</p>
1542
1666
  */
1543
1667
  HttpRequestMethodConfig?: HttpRequestMethodConditionConfig;
1544
1668
  /**
1669
+ * @public
1545
1670
  * <p>Information for a source IP condition. Specify only when <code>Field</code> is
1546
1671
  * <code>source-ip</code>.</p>
1547
1672
  */
@@ -1552,22 +1677,27 @@ export interface RuleCondition {
1552
1677
  */
1553
1678
  export interface CreateRuleInput {
1554
1679
  /**
1680
+ * @public
1555
1681
  * <p>The Amazon Resource Name (ARN) of the listener.</p>
1556
1682
  */
1557
1683
  ListenerArn: string | undefined;
1558
1684
  /**
1685
+ * @public
1559
1686
  * <p>The conditions.</p>
1560
1687
  */
1561
1688
  Conditions: RuleCondition[] | undefined;
1562
1689
  /**
1690
+ * @public
1563
1691
  * <p>The rule priority. A listener can't have multiple rules with the same priority.</p>
1564
1692
  */
1565
1693
  Priority: number | undefined;
1566
1694
  /**
1695
+ * @public
1567
1696
  * <p>The actions.</p>
1568
1697
  */
1569
1698
  Actions: Action[] | undefined;
1570
1699
  /**
1700
+ * @public
1571
1701
  * <p>The tags to assign to the rule.</p>
1572
1702
  */
1573
1703
  Tags?: Tag[];
@@ -1578,14 +1708,17 @@ export interface CreateRuleInput {
1578
1708
  */
1579
1709
  export interface Rule {
1580
1710
  /**
1711
+ * @public
1581
1712
  * <p>The Amazon Resource Name (ARN) of the rule.</p>
1582
1713
  */
1583
1714
  RuleArn?: string;
1584
1715
  /**
1716
+ * @public
1585
1717
  * <p>The priority.</p>
1586
1718
  */
1587
1719
  Priority?: string;
1588
1720
  /**
1721
+ * @public
1589
1722
  * <p>The conditions. Each rule can include zero or one of the following conditions:
1590
1723
  * <code>http-request-method</code>, <code>host-header</code>, <code>path-pattern</code>, and
1591
1724
  * <code>source-ip</code>, and zero or more of the following conditions:
@@ -1593,12 +1726,14 @@ export interface Rule {
1593
1726
  */
1594
1727
  Conditions?: RuleCondition[];
1595
1728
  /**
1729
+ * @public
1596
1730
  * <p>The actions. Each rule must include exactly one of the following types of actions:
1597
1731
  * <code>forward</code>, <code>redirect</code>, or <code>fixed-response</code>, and it must be
1598
1732
  * the last action to be performed.</p>
1599
1733
  */
1600
1734
  Actions?: Action[];
1601
1735
  /**
1736
+ * @public
1602
1737
  * <p>Indicates whether this is the default rule.</p>
1603
1738
  */
1604
1739
  IsDefault?: boolean;
@@ -1608,6 +1743,7 @@ export interface Rule {
1608
1743
  */
1609
1744
  export interface CreateRuleOutput {
1610
1745
  /**
1746
+ * @public
1611
1747
  * <p>Information about the rule.</p>
1612
1748
  */
1613
1749
  Rules?: Rule[];
@@ -1671,6 +1807,7 @@ export type TargetGroupIpAddressTypeEnum = (typeof TargetGroupIpAddressTypeEnum)
1671
1807
  */
1672
1808
  export interface Matcher {
1673
1809
  /**
1810
+ * @public
1674
1811
  * <p>For Application Load Balancers, you can specify values between 200 and 499, with the
1675
1812
  * default value being 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").</p>
1676
1813
  * <p>For Network Load Balancers, you can specify values between 200 and 599, with the
@@ -1681,6 +1818,7 @@ export interface Matcher {
1681
1818
  */
1682
1819
  HttpCode?: string;
1683
1820
  /**
1821
+ * @public
1684
1822
  * <p>You can specify values between 0 and 99. You can specify multiple values (for example,
1685
1823
  * "0,1") or a range of values (for example, "0-5"). The default value is 12.</p>
1686
1824
  */
@@ -1705,6 +1843,7 @@ export type TargetTypeEnum = (typeof TargetTypeEnum)[keyof typeof TargetTypeEnum
1705
1843
  */
1706
1844
  export interface CreateTargetGroupInput {
1707
1845
  /**
1846
+ * @public
1708
1847
  * <p>The name of the target group.</p>
1709
1848
  * <p>This name must be unique per region per account, can have a maximum of 32 characters, must
1710
1849
  * contain only alphanumeric characters or hyphens, and must not begin or end with a
@@ -1712,6 +1851,7 @@ export interface CreateTargetGroupInput {
1712
1851
  */
1713
1852
  Name: string | undefined;
1714
1853
  /**
1854
+ * @public
1715
1855
  * <p>The protocol to use for routing traffic to the targets. For Application Load Balancers,
1716
1856
  * the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported
1717
1857
  * protocols are TCP, TLS, UDP, or TCP_UDP. For Gateway Load Balancers, the supported protocol is
@@ -1720,23 +1860,27 @@ export interface CreateTargetGroupInput {
1720
1860
  */
1721
1861
  Protocol?: ProtocolEnum | string;
1722
1862
  /**
1863
+ * @public
1723
1864
  * <p>[HTTP/HTTPS protocol] The protocol version. Specify <code>GRPC</code> to send requests to
1724
1865
  * targets using gRPC. Specify <code>HTTP2</code> to send requests to targets using HTTP/2. The
1725
1866
  * default is <code>HTTP1</code>, which sends requests to targets using HTTP/1.1.</p>
1726
1867
  */
1727
1868
  ProtocolVersion?: string;
1728
1869
  /**
1870
+ * @public
1729
1871
  * <p>The port on which the targets receive traffic. This port is used unless you specify a port
1730
1872
  * override when registering the target. If the target is a Lambda function, this parameter does
1731
1873
  * not apply. If the protocol is GENEVE, the supported port is 6081.</p>
1732
1874
  */
1733
1875
  Port?: number;
1734
1876
  /**
1877
+ * @public
1735
1878
  * <p>The identifier of the virtual private cloud (VPC). If the target is a Lambda function,
1736
1879
  * this parameter does not apply. Otherwise, this parameter is required.</p>
1737
1880
  */
1738
1881
  VpcId?: string;
1739
1882
  /**
1883
+ * @public
1740
1884
  * <p>The protocol the load balancer uses when performing health checks on targets. For
1741
1885
  * Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load
1742
1886
  * Balancers, the default is TCP. The TCP protocol is not supported for health checks if the
@@ -1745,6 +1889,7 @@ export interface CreateTargetGroupInput {
1745
1889
  */
1746
1890
  HealthCheckProtocol?: ProtocolEnum | string;
1747
1891
  /**
1892
+ * @public
1748
1893
  * <p>The port the load balancer uses when performing health checks on targets. If the protocol
1749
1894
  * is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the default is <code>traffic-port</code>, which is
1750
1895
  * the port on which each target receives traffic from the load balancer. If the protocol is
@@ -1752,6 +1897,7 @@ export interface CreateTargetGroupInput {
1752
1897
  */
1753
1898
  HealthCheckPort?: string;
1754
1899
  /**
1900
+ * @public
1755
1901
  * <p>Indicates whether health checks are enabled. If the target type is <code>lambda</code>,
1756
1902
  * health checks are disabled by default but can be enabled. If the target type is
1757
1903
  * <code>instance</code>, <code>ip</code>, or <code>alb</code>, health checks are always
@@ -1759,6 +1905,7 @@ export interface CreateTargetGroupInput {
1759
1905
  */
1760
1906
  HealthCheckEnabled?: boolean;
1761
1907
  /**
1908
+ * @public
1762
1909
  * <p>[HTTP/HTTPS health checks] The destination for health checks on the targets.</p>
1763
1910
  * <p>[HTTP1 or HTTP2 protocol version] The ping path. The default is /.</p>
1764
1911
  * <p>[GRPC protocol version] The path of a custom health check method with the format
@@ -1766,6 +1913,7 @@ export interface CreateTargetGroupInput {
1766
1913
  */
1767
1914
  HealthCheckPath?: string;
1768
1915
  /**
1916
+ * @public
1769
1917
  * <p>The approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300.
1770
1918
  * If the target group protocol is TCP, TLS, UDP, TCP_UDP, HTTP or HTTPS, the default is 30 seconds.
1771
1919
  * If the target group protocol is GENEVE, the default is 10 seconds.
@@ -1773,6 +1921,7 @@ export interface CreateTargetGroupInput {
1773
1921
  */
1774
1922
  HealthCheckIntervalSeconds?: number;
1775
1923
  /**
1924
+ * @public
1776
1925
  * <p>The amount of time, in seconds, during which no response from a target means a failed
1777
1926
  * health check. The range is 2–120 seconds. For target groups with a protocol of HTTP, the
1778
1927
  * default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default
@@ -1781,6 +1930,7 @@ export interface CreateTargetGroupInput {
1781
1930
  */
1782
1931
  HealthCheckTimeoutSeconds?: number;
1783
1932
  /**
1933
+ * @public
1784
1934
  * <p>The number of consecutive health check successes required before considering a target healthy. The range is
1785
1935
  * 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For target groups
1786
1936
  * with a protocol of GENEVE, the default is 5. If the target type
@@ -1788,6 +1938,7 @@ export interface CreateTargetGroupInput {
1788
1938
  */
1789
1939
  HealthyThresholdCount?: number;
1790
1940
  /**
1941
+ * @public
1791
1942
  * <p>The number of consecutive health check failures required before considering a target unhealthy. The range is
1792
1943
  * 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 2. For target groups
1793
1944
  * with a protocol of GENEVE, the default is 2. If the target type
@@ -1795,6 +1946,7 @@ export interface CreateTargetGroupInput {
1795
1946
  */
1796
1947
  UnhealthyThresholdCount?: number;
1797
1948
  /**
1949
+ * @public
1798
1950
  * <p>[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful
1799
1951
  * response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP or TLS the range
1800
1952
  * is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target
@@ -1802,6 +1954,7 @@ export interface CreateTargetGroupInput {
1802
1954
  */
1803
1955
  Matcher?: Matcher;
1804
1956
  /**
1957
+ * @public
1805
1958
  * <p>The type of target that you must specify when registering targets with this target group.
1806
1959
  * You can't specify targets for a target group using more than one target type.</p>
1807
1960
  * <ul>
@@ -1829,10 +1982,12 @@ export interface CreateTargetGroupInput {
1829
1982
  */
1830
1983
  TargetType?: TargetTypeEnum | string;
1831
1984
  /**
1985
+ * @public
1832
1986
  * <p>The tags to assign to the target group.</p>
1833
1987
  */
1834
1988
  Tags?: Tag[];
1835
1989
  /**
1990
+ * @public
1836
1991
  * <p>The type of IP address used for this target group. The possible values are
1837
1992
  * <code>ipv4</code> and <code>ipv6</code>. This is an optional parameter. If not specified,
1838
1993
  * the IP address type defaults to <code>ipv4</code>.</p>
@@ -1845,74 +2000,90 @@ export interface CreateTargetGroupInput {
1845
2000
  */
1846
2001
  export interface TargetGroup {
1847
2002
  /**
2003
+ * @public
1848
2004
  * <p>The Amazon Resource Name (ARN) of the target group.</p>
1849
2005
  */
1850
2006
  TargetGroupArn?: string;
1851
2007
  /**
2008
+ * @public
1852
2009
  * <p>The name of the target group.</p>
1853
2010
  */
1854
2011
  TargetGroupName?: string;
1855
2012
  /**
2013
+ * @public
1856
2014
  * <p>The protocol to use for routing traffic to the targets.</p>
1857
2015
  */
1858
2016
  Protocol?: ProtocolEnum | string;
1859
2017
  /**
2018
+ * @public
1860
2019
  * <p>The port on which the targets are listening. Not used if the target is a Lambda
1861
2020
  * function.</p>
1862
2021
  */
1863
2022
  Port?: number;
1864
2023
  /**
2024
+ * @public
1865
2025
  * <p>The ID of the VPC for the targets.</p>
1866
2026
  */
1867
2027
  VpcId?: string;
1868
2028
  /**
2029
+ * @public
1869
2030
  * <p>The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP
1870
2031
  * protocols are not supported for health checks.</p>
1871
2032
  */
1872
2033
  HealthCheckProtocol?: ProtocolEnum | string;
1873
2034
  /**
2035
+ * @public
1874
2036
  * <p>The port to use to connect with the target.</p>
1875
2037
  */
1876
2038
  HealthCheckPort?: string;
1877
2039
  /**
2040
+ * @public
1878
2041
  * <p>Indicates whether health checks are enabled.</p>
1879
2042
  */
1880
2043
  HealthCheckEnabled?: boolean;
1881
2044
  /**
2045
+ * @public
1882
2046
  * <p>The approximate amount of time, in seconds, between health checks of an individual
1883
2047
  * target.</p>
1884
2048
  */
1885
2049
  HealthCheckIntervalSeconds?: number;
1886
2050
  /**
2051
+ * @public
1887
2052
  * <p>The amount of time, in seconds, during which no response means a failed health
1888
2053
  * check.</p>
1889
2054
  */
1890
2055
  HealthCheckTimeoutSeconds?: number;
1891
2056
  /**
2057
+ * @public
1892
2058
  * <p>The number of consecutive health checks successes required before considering an unhealthy
1893
2059
  * target healthy.</p>
1894
2060
  */
1895
2061
  HealthyThresholdCount?: number;
1896
2062
  /**
2063
+ * @public
1897
2064
  * <p>The number of consecutive health check failures required before considering the target
1898
2065
  * unhealthy.</p>
1899
2066
  */
1900
2067
  UnhealthyThresholdCount?: number;
1901
2068
  /**
2069
+ * @public
1902
2070
  * <p>The destination for health checks on the targets.</p>
1903
2071
  */
1904
2072
  HealthCheckPath?: string;
1905
2073
  /**
2074
+ * @public
1906
2075
  * <p>The HTTP or gRPC codes to use when checking for a successful response from a
1907
2076
  * target.</p>
1908
2077
  */
1909
2078
  Matcher?: Matcher;
1910
2079
  /**
2080
+ * @public
1911
2081
  * <p>The Amazon Resource Names (ARN) of the load balancers that route traffic to this target
1912
2082
  * group.</p>
1913
2083
  */
1914
2084
  LoadBalancerArns?: string[];
1915
2085
  /**
2086
+ * @public
1916
2087
  * <p>The type of target that you must specify when registering targets with this target group.
1917
2088
  * The possible values are <code>instance</code> (register targets by instance ID),
1918
2089
  * <code>ip</code> (register targets by IP address), <code>lambda</code> (register a single
@@ -1921,11 +2092,13 @@ export interface TargetGroup {
1921
2092
  */
1922
2093
  TargetType?: TargetTypeEnum | string;
1923
2094
  /**
2095
+ * @public
1924
2096
  * <p>[HTTP/HTTPS protocol] The protocol version. The possible values are <code>GRPC</code>,
1925
2097
  * <code>HTTP1</code>, and <code>HTTP2</code>.</p>
1926
2098
  */
1927
2099
  ProtocolVersion?: string;
1928
2100
  /**
2101
+ * @public
1929
2102
  * <p>The type of IP address used for this target group. The possible values are
1930
2103
  * <code>ipv4</code> and <code>ipv6</code>. This is an optional parameter. If not specified,
1931
2104
  * the IP address type defaults to <code>ipv4</code>.</p>
@@ -1937,6 +2110,7 @@ export interface TargetGroup {
1937
2110
  */
1938
2111
  export interface CreateTargetGroupOutput {
1939
2112
  /**
2113
+ * @public
1940
2114
  * <p>Information about the target group.</p>
1941
2115
  */
1942
2116
  TargetGroups?: TargetGroup[];
@@ -1959,6 +2133,7 @@ export declare class DuplicateTargetGroupNameException extends __BaseException {
1959
2133
  */
1960
2134
  export interface DeleteListenerInput {
1961
2135
  /**
2136
+ * @public
1962
2137
  * <p>The Amazon Resource Name (ARN) of the listener.</p>
1963
2138
  */
1964
2139
  ListenerArn: string | undefined;
@@ -1973,6 +2148,7 @@ export interface DeleteListenerOutput {
1973
2148
  */
1974
2149
  export interface DeleteLoadBalancerInput {
1975
2150
  /**
2151
+ * @public
1976
2152
  * <p>The Amazon Resource Name (ARN) of the load balancer.</p>
1977
2153
  */
1978
2154
  LoadBalancerArn: string | undefined;
@@ -1987,6 +2163,7 @@ export interface DeleteLoadBalancerOutput {
1987
2163
  */
1988
2164
  export interface DeleteRuleInput {
1989
2165
  /**
2166
+ * @public
1990
2167
  * <p>The Amazon Resource Name (ARN) of the rule.</p>
1991
2168
  */
1992
2169
  RuleArn: string | undefined;
@@ -2001,6 +2178,7 @@ export interface DeleteRuleOutput {
2001
2178
  */
2002
2179
  export interface DeleteTargetGroupInput {
2003
2180
  /**
2181
+ * @public
2004
2182
  * <p>The Amazon Resource Name (ARN) of the target group.</p>
2005
2183
  */
2006
2184
  TargetGroupArn: string | undefined;
@@ -2016,6 +2194,7 @@ export interface DeleteTargetGroupOutput {
2016
2194
  */
2017
2195
  export interface TargetDescription {
2018
2196
  /**
2197
+ * @public
2019
2198
  * <p>The ID of the target. If the target type of the target group is <code>instance</code>,
2020
2199
  * specify an instance ID. If the target type is <code>ip</code>, specify an IP address. If the
2021
2200
  * target type is <code>lambda</code>, specify the ARN of the Lambda function. If the target type
@@ -2023,6 +2202,7 @@ export interface TargetDescription {
2023
2202
  */
2024
2203
  Id: string | undefined;
2025
2204
  /**
2205
+ * @public
2026
2206
  * <p>The port on which the target is listening. If the target group protocol is GENEVE, the
2027
2207
  * supported port is 6081. If the target type is <code>alb</code>, the targeted Application Load
2028
2208
  * Balancer must have at least one listener whose port matches the target group port. Not used if
@@ -2030,6 +2210,7 @@ export interface TargetDescription {
2030
2210
  */
2031
2211
  Port?: number;
2032
2212
  /**
2213
+ * @public
2033
2214
  * <p>An Availability Zone or <code>all</code>. This determines whether the target receives
2034
2215
  * traffic from the load balancer nodes in the specified Availability Zone or from all enabled
2035
2216
  * Availability Zones for the load balancer.</p>
@@ -2054,10 +2235,12 @@ export interface TargetDescription {
2054
2235
  */
2055
2236
  export interface DeregisterTargetsInput {
2056
2237
  /**
2238
+ * @public
2057
2239
  * <p>The Amazon Resource Name (ARN) of the target group.</p>
2058
2240
  */
2059
2241
  TargetGroupArn: string | undefined;
2060
2242
  /**
2243
+ * @public
2061
2244
  * <p>The targets. If you specified a port override when you registered a target, you must
2062
2245
  * specify both the target ID and the port when you deregister it.</p>
2063
2246
  */
@@ -2087,11 +2270,13 @@ export declare class InvalidTargetException extends __BaseException {
2087
2270
  */
2088
2271
  export interface DescribeAccountLimitsInput {
2089
2272
  /**
2273
+ * @public
2090
2274
  * <p>The marker for the next set of results. (You received this marker from a previous
2091
2275
  * call.)</p>
2092
2276
  */
2093
2277
  Marker?: string;
2094
2278
  /**
2279
+ * @public
2095
2280
  * <p>The maximum number of results to return with this call.</p>
2096
2281
  */
2097
2282
  PageSize?: number;
@@ -2103,6 +2288,7 @@ export interface DescribeAccountLimitsInput {
2103
2288
  */
2104
2289
  export interface Limit {
2105
2290
  /**
2291
+ * @public
2106
2292
  * <p>The name of the limit. The possible values are:</p>
2107
2293
  * <ul>
2108
2294
  * <li>
@@ -2163,6 +2349,7 @@ export interface Limit {
2163
2349
  */
2164
2350
  Name?: string;
2165
2351
  /**
2352
+ * @public
2166
2353
  * <p>The maximum value of the limit.</p>
2167
2354
  */
2168
2355
  Max?: string;
@@ -2172,10 +2359,12 @@ export interface Limit {
2172
2359
  */
2173
2360
  export interface DescribeAccountLimitsOutput {
2174
2361
  /**
2362
+ * @public
2175
2363
  * <p>Information about the limits.</p>
2176
2364
  */
2177
2365
  Limits?: Limit[];
2178
2366
  /**
2367
+ * @public
2179
2368
  * <p>If there are additional results, this is the marker for the next set of results.
2180
2369
  * Otherwise, this is null.</p>
2181
2370
  */
@@ -2186,15 +2375,18 @@ export interface DescribeAccountLimitsOutput {
2186
2375
  */
2187
2376
  export interface DescribeListenerCertificatesInput {
2188
2377
  /**
2378
+ * @public
2189
2379
  * <p>The Amazon Resource Names (ARN) of the listener.</p>
2190
2380
  */
2191
2381
  ListenerArn: string | undefined;
2192
2382
  /**
2383
+ * @public
2193
2384
  * <p>The marker for the next set of results. (You received this marker from a previous
2194
2385
  * call.)</p>
2195
2386
  */
2196
2387
  Marker?: string;
2197
2388
  /**
2389
+ * @public
2198
2390
  * <p>The maximum number of results to return with this call.</p>
2199
2391
  */
2200
2392
  PageSize?: number;
@@ -2204,10 +2396,12 @@ export interface DescribeListenerCertificatesInput {
2204
2396
  */
2205
2397
  export interface DescribeListenerCertificatesOutput {
2206
2398
  /**
2399
+ * @public
2207
2400
  * <p>Information about the certificates.</p>
2208
2401
  */
2209
2402
  Certificates?: Certificate[];
2210
2403
  /**
2404
+ * @public
2211
2405
  * <p>If there are additional results, this is the marker for the next set of results.
2212
2406
  * Otherwise, this is null.</p>
2213
2407
  */
@@ -2218,19 +2412,23 @@ export interface DescribeListenerCertificatesOutput {
2218
2412
  */
2219
2413
  export interface DescribeListenersInput {
2220
2414
  /**
2415
+ * @public
2221
2416
  * <p>The Amazon Resource Name (ARN) of the load balancer.</p>
2222
2417
  */
2223
2418
  LoadBalancerArn?: string;
2224
2419
  /**
2420
+ * @public
2225
2421
  * <p>The Amazon Resource Names (ARN) of the listeners.</p>
2226
2422
  */
2227
2423
  ListenerArns?: string[];
2228
2424
  /**
2425
+ * @public
2229
2426
  * <p>The marker for the next set of results. (You received this marker from a previous
2230
2427
  * call.)</p>
2231
2428
  */
2232
2429
  Marker?: string;
2233
2430
  /**
2431
+ * @public
2234
2432
  * <p>The maximum number of results to return with this call.</p>
2235
2433
  */
2236
2434
  PageSize?: number;
@@ -2240,10 +2438,12 @@ export interface DescribeListenersInput {
2240
2438
  */
2241
2439
  export interface DescribeListenersOutput {
2242
2440
  /**
2441
+ * @public
2243
2442
  * <p>Information about the listeners.</p>
2244
2443
  */
2245
2444
  Listeners?: Listener[];
2246
2445
  /**
2446
+ * @public
2247
2447
  * <p>If there are additional results, this is the marker for the next set of results.
2248
2448
  * Otherwise, this is null.</p>
2249
2449
  */
@@ -2254,6 +2454,7 @@ export interface DescribeListenersOutput {
2254
2454
  */
2255
2455
  export interface DescribeLoadBalancerAttributesInput {
2256
2456
  /**
2457
+ * @public
2257
2458
  * <p>The Amazon Resource Name (ARN) of the load balancer.</p>
2258
2459
  */
2259
2460
  LoadBalancerArn: string | undefined;
@@ -2264,6 +2465,7 @@ export interface DescribeLoadBalancerAttributesInput {
2264
2465
  */
2265
2466
  export interface LoadBalancerAttribute {
2266
2467
  /**
2468
+ * @public
2267
2469
  * <p>The name of the attribute.</p>
2268
2470
  * <p>The following attributes are supported by all load balancers:</p>
2269
2471
  * <ul>
@@ -2398,6 +2600,7 @@ export interface LoadBalancerAttribute {
2398
2600
  */
2399
2601
  Key?: string;
2400
2602
  /**
2603
+ * @public
2401
2604
  * <p>The value of the attribute.</p>
2402
2605
  */
2403
2606
  Value?: string;
@@ -2407,6 +2610,7 @@ export interface LoadBalancerAttribute {
2407
2610
  */
2408
2611
  export interface DescribeLoadBalancerAttributesOutput {
2409
2612
  /**
2613
+ * @public
2410
2614
  * <p>Information about the load balancer attributes.</p>
2411
2615
  */
2412
2616
  Attributes?: LoadBalancerAttribute[];
@@ -2416,20 +2620,24 @@ export interface DescribeLoadBalancerAttributesOutput {
2416
2620
  */
2417
2621
  export interface DescribeLoadBalancersInput {
2418
2622
  /**
2623
+ * @public
2419
2624
  * <p>The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load
2420
2625
  * balancers in a single call.</p>
2421
2626
  */
2422
2627
  LoadBalancerArns?: string[];
2423
2628
  /**
2629
+ * @public
2424
2630
  * <p>The names of the load balancers.</p>
2425
2631
  */
2426
2632
  Names?: string[];
2427
2633
  /**
2634
+ * @public
2428
2635
  * <p>The marker for the next set of results. (You received this marker from a previous
2429
2636
  * call.)</p>
2430
2637
  */
2431
2638
  Marker?: string;
2432
2639
  /**
2640
+ * @public
2433
2641
  * <p>The maximum number of results to return with this call.</p>
2434
2642
  */
2435
2643
  PageSize?: number;
@@ -2439,10 +2647,12 @@ export interface DescribeLoadBalancersInput {
2439
2647
  */
2440
2648
  export interface DescribeLoadBalancersOutput {
2441
2649
  /**
2650
+ * @public
2442
2651
  * <p>Information about the load balancers.</p>
2443
2652
  */
2444
2653
  LoadBalancers?: LoadBalancer[];
2445
2654
  /**
2655
+ * @public
2446
2656
  * <p>If there are additional results, this is the marker for the next set of results.
2447
2657
  * Otherwise, this is null.</p>
2448
2658
  */
@@ -2453,19 +2663,23 @@ export interface DescribeLoadBalancersOutput {
2453
2663
  */
2454
2664
  export interface DescribeRulesInput {
2455
2665
  /**
2666
+ * @public
2456
2667
  * <p>The Amazon Resource Name (ARN) of the listener.</p>
2457
2668
  */
2458
2669
  ListenerArn?: string;
2459
2670
  /**
2671
+ * @public
2460
2672
  * <p>The Amazon Resource Names (ARN) of the rules.</p>
2461
2673
  */
2462
2674
  RuleArns?: string[];
2463
2675
  /**
2676
+ * @public
2464
2677
  * <p>The marker for the next set of results. (You received this marker from a previous
2465
2678
  * call.)</p>
2466
2679
  */
2467
2680
  Marker?: string;
2468
2681
  /**
2682
+ * @public
2469
2683
  * <p>The maximum number of results to return with this call.</p>
2470
2684
  */
2471
2685
  PageSize?: number;
@@ -2475,10 +2689,12 @@ export interface DescribeRulesInput {
2475
2689
  */
2476
2690
  export interface DescribeRulesOutput {
2477
2691
  /**
2692
+ * @public
2478
2693
  * <p>Information about the rules.</p>
2479
2694
  */
2480
2695
  Rules?: Rule[];
2481
2696
  /**
2697
+ * @public
2482
2698
  * <p>If there are additional results, this is the marker for the next set of results.
2483
2699
  * Otherwise, this is null.</p>
2484
2700
  */
@@ -2489,19 +2705,23 @@ export interface DescribeRulesOutput {
2489
2705
  */
2490
2706
  export interface DescribeSSLPoliciesInput {
2491
2707
  /**
2708
+ * @public
2492
2709
  * <p>The names of the policies.</p>
2493
2710
  */
2494
2711
  Names?: string[];
2495
2712
  /**
2713
+ * @public
2496
2714
  * <p>The marker for the next set of results. (You received this marker from a previous
2497
2715
  * call.)</p>
2498
2716
  */
2499
2717
  Marker?: string;
2500
2718
  /**
2719
+ * @public
2501
2720
  * <p>The maximum number of results to return with this call.</p>
2502
2721
  */
2503
2722
  PageSize?: number;
2504
2723
  /**
2724
+ * @public
2505
2725
  * <p> The type of load balancer. The default lists the SSL policies for all load
2506
2726
  * balancers.</p>
2507
2727
  */
@@ -2513,18 +2733,22 @@ export interface DescribeSSLPoliciesInput {
2513
2733
  */
2514
2734
  export interface SslPolicy {
2515
2735
  /**
2736
+ * @public
2516
2737
  * <p>The protocols.</p>
2517
2738
  */
2518
2739
  SslProtocols?: string[];
2519
2740
  /**
2741
+ * @public
2520
2742
  * <p>The ciphers.</p>
2521
2743
  */
2522
2744
  Ciphers?: Cipher[];
2523
2745
  /**
2746
+ * @public
2524
2747
  * <p>The name of the policy.</p>
2525
2748
  */
2526
2749
  Name?: string;
2527
2750
  /**
2751
+ * @public
2528
2752
  * <p> The supported load balancers. </p>
2529
2753
  */
2530
2754
  SupportedLoadBalancerTypes?: string[];
@@ -2534,10 +2758,12 @@ export interface SslPolicy {
2534
2758
  */
2535
2759
  export interface DescribeSSLPoliciesOutput {
2536
2760
  /**
2761
+ * @public
2537
2762
  * <p>Information about the security policies.</p>
2538
2763
  */
2539
2764
  SslPolicies?: SslPolicy[];
2540
2765
  /**
2766
+ * @public
2541
2767
  * <p>If there are additional results, this is the marker for the next set of results.
2542
2768
  * Otherwise, this is null.</p>
2543
2769
  */
@@ -2548,6 +2774,7 @@ export interface DescribeSSLPoliciesOutput {
2548
2774
  */
2549
2775
  export interface DescribeTagsInput {
2550
2776
  /**
2777
+ * @public
2551
2778
  * <p>The Amazon Resource Names (ARN) of the resources. You can specify up to 20 resources in a
2552
2779
  * single call.</p>
2553
2780
  */
@@ -2559,10 +2786,12 @@ export interface DescribeTagsInput {
2559
2786
  */
2560
2787
  export interface TagDescription {
2561
2788
  /**
2789
+ * @public
2562
2790
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
2563
2791
  */
2564
2792
  ResourceArn?: string;
2565
2793
  /**
2794
+ * @public
2566
2795
  * <p>Information about the tags.</p>
2567
2796
  */
2568
2797
  Tags?: Tag[];
@@ -2572,6 +2801,7 @@ export interface TagDescription {
2572
2801
  */
2573
2802
  export interface DescribeTagsOutput {
2574
2803
  /**
2804
+ * @public
2575
2805
  * <p>Information about the tags.</p>
2576
2806
  */
2577
2807
  TagDescriptions?: TagDescription[];
@@ -2581,6 +2811,7 @@ export interface DescribeTagsOutput {
2581
2811
  */
2582
2812
  export interface DescribeTargetGroupAttributesInput {
2583
2813
  /**
2814
+ * @public
2584
2815
  * <p>The Amazon Resource Name (ARN) of the target group.</p>
2585
2816
  */
2586
2817
  TargetGroupArn: string | undefined;
@@ -2591,6 +2822,7 @@ export interface DescribeTargetGroupAttributesInput {
2591
2822
  */
2592
2823
  export interface TargetGroupAttribute {
2593
2824
  /**
2825
+ * @public
2594
2826
  * <p>The name of the attribute.</p>
2595
2827
  * <p>The following attributes are supported by all load balancers:</p>
2596
2828
  * <ul>
@@ -2772,6 +3004,7 @@ export interface TargetGroupAttribute {
2772
3004
  */
2773
3005
  Key?: string;
2774
3006
  /**
3007
+ * @public
2775
3008
  * <p>The value of the attribute.</p>
2776
3009
  */
2777
3010
  Value?: string;
@@ -2781,6 +3014,7 @@ export interface TargetGroupAttribute {
2781
3014
  */
2782
3015
  export interface DescribeTargetGroupAttributesOutput {
2783
3016
  /**
3017
+ * @public
2784
3018
  * <p>Information about the target group attributes</p>
2785
3019
  */
2786
3020
  Attributes?: TargetGroupAttribute[];
@@ -2790,23 +3024,28 @@ export interface DescribeTargetGroupAttributesOutput {
2790
3024
  */
2791
3025
  export interface DescribeTargetGroupsInput {
2792
3026
  /**
3027
+ * @public
2793
3028
  * <p>The Amazon Resource Name (ARN) of the load balancer.</p>
2794
3029
  */
2795
3030
  LoadBalancerArn?: string;
2796
3031
  /**
3032
+ * @public
2797
3033
  * <p>The Amazon Resource Names (ARN) of the target groups.</p>
2798
3034
  */
2799
3035
  TargetGroupArns?: string[];
2800
3036
  /**
3037
+ * @public
2801
3038
  * <p>The names of the target groups.</p>
2802
3039
  */
2803
3040
  Names?: string[];
2804
3041
  /**
3042
+ * @public
2805
3043
  * <p>The marker for the next set of results. (You received this marker from a previous
2806
3044
  * call.)</p>
2807
3045
  */
2808
3046
  Marker?: string;
2809
3047
  /**
3048
+ * @public
2810
3049
  * <p>The maximum number of results to return with this call.</p>
2811
3050
  */
2812
3051
  PageSize?: number;
@@ -2816,10 +3055,12 @@ export interface DescribeTargetGroupsInput {
2816
3055
  */
2817
3056
  export interface DescribeTargetGroupsOutput {
2818
3057
  /**
3058
+ * @public
2819
3059
  * <p>Information about the target groups.</p>
2820
3060
  */
2821
3061
  TargetGroups?: TargetGroup[];
2822
3062
  /**
3063
+ * @public
2823
3064
  * <p>If there are additional results, this is the marker for the next set of results.
2824
3065
  * Otherwise, this is null.</p>
2825
3066
  */
@@ -2830,10 +3071,12 @@ export interface DescribeTargetGroupsOutput {
2830
3071
  */
2831
3072
  export interface DescribeTargetHealthInput {
2832
3073
  /**
3074
+ * @public
2833
3075
  * <p>The Amazon Resource Name (ARN) of the target group.</p>
2834
3076
  */
2835
3077
  TargetGroupArn: string | undefined;
2836
3078
  /**
3079
+ * @public
2837
3080
  * <p>The targets.</p>
2838
3081
  */
2839
3082
  Targets?: TargetDescription[];
@@ -2882,10 +3125,12 @@ export type TargetHealthStateEnum = (typeof TargetHealthStateEnum)[keyof typeof
2882
3125
  */
2883
3126
  export interface TargetHealth {
2884
3127
  /**
3128
+ * @public
2885
3129
  * <p>The state of the target.</p>
2886
3130
  */
2887
3131
  State?: TargetHealthStateEnum | string;
2888
3132
  /**
3133
+ * @public
2889
3134
  * <p>The reason code.</p>
2890
3135
  * <p>If the target state is <code>healthy</code>, a reason code is not provided.</p>
2891
3136
  * <p>If the target state is <code>initial</code>, the reason code can be one of the following
@@ -2977,6 +3222,7 @@ export interface TargetHealth {
2977
3222
  */
2978
3223
  Reason?: TargetHealthReasonEnum | string;
2979
3224
  /**
3225
+ * @public
2980
3226
  * <p>A description of the target health that provides additional details. If the state is
2981
3227
  * <code>healthy</code>, a description is not provided.</p>
2982
3228
  */
@@ -2988,14 +3234,17 @@ export interface TargetHealth {
2988
3234
  */
2989
3235
  export interface TargetHealthDescription {
2990
3236
  /**
3237
+ * @public
2991
3238
  * <p>The description of the target.</p>
2992
3239
  */
2993
3240
  Target?: TargetDescription;
2994
3241
  /**
3242
+ * @public
2995
3243
  * <p>The port to use to connect with the target.</p>
2996
3244
  */
2997
3245
  HealthCheckPort?: string;
2998
3246
  /**
3247
+ * @public
2999
3248
  * <p>The health information for the target.</p>
3000
3249
  */
3001
3250
  TargetHealth?: TargetHealth;
@@ -3005,6 +3254,7 @@ export interface TargetHealthDescription {
3005
3254
  */
3006
3255
  export interface DescribeTargetHealthOutput {
3007
3256
  /**
3257
+ * @public
3008
3258
  * <p>Information about the health of the targets.</p>
3009
3259
  */
3010
3260
  TargetHealthDescriptions?: TargetHealthDescription[];
@@ -3028,15 +3278,18 @@ export declare class HealthUnavailableException extends __BaseException {
3028
3278
  */
3029
3279
  export interface ModifyListenerInput {
3030
3280
  /**
3281
+ * @public
3031
3282
  * <p>The Amazon Resource Name (ARN) of the listener.</p>
3032
3283
  */
3033
3284
  ListenerArn: string | undefined;
3034
3285
  /**
3286
+ * @public
3035
3287
  * <p>The port for connections from clients to the load balancer. You cannot specify a port for
3036
3288
  * a Gateway Load Balancer.</p>
3037
3289
  */
3038
3290
  Port?: number;
3039
3291
  /**
3292
+ * @public
3040
3293
  * <p>The protocol for connections from clients to the load balancer. Application Load Balancers
3041
3294
  * support the HTTP and HTTPS protocols. Network Load Balancers support the TCP, TLS, UDP, and
3042
3295
  * TCP_UDP protocols. You can’t change the protocol to UDP or TCP_UDP if dual-stack mode is
@@ -3044,6 +3297,7 @@ export interface ModifyListenerInput {
3044
3297
  */
3045
3298
  Protocol?: ProtocolEnum | string;
3046
3299
  /**
3300
+ * @public
3047
3301
  * <p>[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are
3048
3302
  * supported.</p>
3049
3303
  * <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
@@ -3051,16 +3305,19 @@ export interface ModifyListenerInput {
3051
3305
  */
3052
3306
  SslPolicy?: string;
3053
3307
  /**
3308
+ * @public
3054
3309
  * <p>[HTTPS and TLS listeners] The default certificate for the listener. You must provide
3055
3310
  * exactly one certificate. Set <code>CertificateArn</code> to the certificate ARN but do not set
3056
3311
  * <code>IsDefault</code>.</p>
3057
3312
  */
3058
3313
  Certificates?: Certificate[];
3059
3314
  /**
3315
+ * @public
3060
3316
  * <p>The actions for the default rule.</p>
3061
3317
  */
3062
3318
  DefaultActions?: Action[];
3063
3319
  /**
3320
+ * @public
3064
3321
  * <p>[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You
3065
3322
  * can specify one policy name. The following are the possible values:</p>
3066
3323
  * <ul>
@@ -3100,6 +3357,7 @@ export interface ModifyListenerInput {
3100
3357
  */
3101
3358
  export interface ModifyListenerOutput {
3102
3359
  /**
3360
+ * @public
3103
3361
  * <p>Information about the modified listener.</p>
3104
3362
  */
3105
3363
  Listeners?: Listener[];
@@ -3109,10 +3367,12 @@ export interface ModifyListenerOutput {
3109
3367
  */
3110
3368
  export interface ModifyLoadBalancerAttributesInput {
3111
3369
  /**
3370
+ * @public
3112
3371
  * <p>The Amazon Resource Name (ARN) of the load balancer.</p>
3113
3372
  */
3114
3373
  LoadBalancerArn: string | undefined;
3115
3374
  /**
3375
+ * @public
3116
3376
  * <p>The load balancer attributes.</p>
3117
3377
  */
3118
3378
  Attributes: LoadBalancerAttribute[] | undefined;
@@ -3122,6 +3382,7 @@ export interface ModifyLoadBalancerAttributesInput {
3122
3382
  */
3123
3383
  export interface ModifyLoadBalancerAttributesOutput {
3124
3384
  /**
3385
+ * @public
3125
3386
  * <p>Information about the load balancer attributes.</p>
3126
3387
  */
3127
3388
  Attributes?: LoadBalancerAttribute[];
@@ -3131,14 +3392,17 @@ export interface ModifyLoadBalancerAttributesOutput {
3131
3392
  */
3132
3393
  export interface ModifyRuleInput {
3133
3394
  /**
3395
+ * @public
3134
3396
  * <p>The Amazon Resource Name (ARN) of the rule.</p>
3135
3397
  */
3136
3398
  RuleArn: string | undefined;
3137
3399
  /**
3400
+ * @public
3138
3401
  * <p>The conditions.</p>
3139
3402
  */
3140
3403
  Conditions?: RuleCondition[];
3141
3404
  /**
3405
+ * @public
3142
3406
  * <p>The actions.</p>
3143
3407
  */
3144
3408
  Actions?: Action[];
@@ -3148,6 +3412,7 @@ export interface ModifyRuleInput {
3148
3412
  */
3149
3413
  export interface ModifyRuleOutput {
3150
3414
  /**
3415
+ * @public
3151
3416
  * <p>Information about the modified rule.</p>
3152
3417
  */
3153
3418
  Rules?: Rule[];
@@ -3157,10 +3422,12 @@ export interface ModifyRuleOutput {
3157
3422
  */
3158
3423
  export interface ModifyTargetGroupInput {
3159
3424
  /**
3425
+ * @public
3160
3426
  * <p>The Amazon Resource Name (ARN) of the target group.</p>
3161
3427
  */
3162
3428
  TargetGroupArn: string | undefined;
3163
3429
  /**
3430
+ * @public
3164
3431
  * <p>The protocol the load balancer uses when performing health checks on targets. For
3165
3432
  * Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load
3166
3433
  * Balancers, the default is TCP. The TCP protocol is not supported for health checks if the
@@ -3170,10 +3437,12 @@ export interface ModifyTargetGroupInput {
3170
3437
  */
3171
3438
  HealthCheckProtocol?: ProtocolEnum | string;
3172
3439
  /**
3440
+ * @public
3173
3441
  * <p>The port the load balancer uses when performing health checks on targets.</p>
3174
3442
  */
3175
3443
  HealthCheckPort?: string;
3176
3444
  /**
3445
+ * @public
3177
3446
  * <p>[HTTP/HTTPS health checks] The destination for health checks on the targets.</p>
3178
3447
  * <p>[HTTP1 or HTTP2 protocol version] The ping path. The default is /.</p>
3179
3448
  * <p>[GRPC protocol version] The path of a custom health check method with the format
@@ -3181,29 +3450,35 @@ export interface ModifyTargetGroupInput {
3181
3450
  */
3182
3451
  HealthCheckPath?: string;
3183
3452
  /**
3453
+ * @public
3184
3454
  * <p>Indicates whether health checks are enabled.</p>
3185
3455
  */
3186
3456
  HealthCheckEnabled?: boolean;
3187
3457
  /**
3458
+ * @public
3188
3459
  * <p>The approximate amount of time, in seconds, between health checks of an individual target.</p>
3189
3460
  */
3190
3461
  HealthCheckIntervalSeconds?: number;
3191
3462
  /**
3463
+ * @public
3192
3464
  * <p>[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means
3193
3465
  * a failed health check.</p>
3194
3466
  */
3195
3467
  HealthCheckTimeoutSeconds?: number;
3196
3468
  /**
3469
+ * @public
3197
3470
  * <p>The number of consecutive health checks successes required before considering an unhealthy
3198
3471
  * target healthy.</p>
3199
3472
  */
3200
3473
  HealthyThresholdCount?: number;
3201
3474
  /**
3475
+ * @public
3202
3476
  * <p>The number of consecutive health check failures required before considering the target
3203
3477
  * unhealthy.</p>
3204
3478
  */
3205
3479
  UnhealthyThresholdCount?: number;
3206
3480
  /**
3481
+ * @public
3207
3482
  * <p>[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful
3208
3483
  * response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP or TLS the range
3209
3484
  * is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target
@@ -3216,6 +3491,7 @@ export interface ModifyTargetGroupInput {
3216
3491
  */
3217
3492
  export interface ModifyTargetGroupOutput {
3218
3493
  /**
3494
+ * @public
3219
3495
  * <p>Information about the modified target group.</p>
3220
3496
  */
3221
3497
  TargetGroups?: TargetGroup[];
@@ -3225,10 +3501,12 @@ export interface ModifyTargetGroupOutput {
3225
3501
  */
3226
3502
  export interface ModifyTargetGroupAttributesInput {
3227
3503
  /**
3504
+ * @public
3228
3505
  * <p>The Amazon Resource Name (ARN) of the target group.</p>
3229
3506
  */
3230
3507
  TargetGroupArn: string | undefined;
3231
3508
  /**
3509
+ * @public
3232
3510
  * <p>The attributes.</p>
3233
3511
  */
3234
3512
  Attributes: TargetGroupAttribute[] | undefined;
@@ -3238,6 +3516,7 @@ export interface ModifyTargetGroupAttributesInput {
3238
3516
  */
3239
3517
  export interface ModifyTargetGroupAttributesOutput {
3240
3518
  /**
3519
+ * @public
3241
3520
  * <p>Information about the attributes.</p>
3242
3521
  */
3243
3522
  Attributes?: TargetGroupAttribute[];
@@ -3247,10 +3526,12 @@ export interface ModifyTargetGroupAttributesOutput {
3247
3526
  */
3248
3527
  export interface RegisterTargetsInput {
3249
3528
  /**
3529
+ * @public
3250
3530
  * <p>The Amazon Resource Name (ARN) of the target group.</p>
3251
3531
  */
3252
3532
  TargetGroupArn: string | undefined;
3253
3533
  /**
3534
+ * @public
3254
3535
  * <p>The targets.</p>
3255
3536
  */
3256
3537
  Targets: TargetDescription[] | undefined;
@@ -3265,10 +3546,12 @@ export interface RegisterTargetsOutput {
3265
3546
  */
3266
3547
  export interface RemoveListenerCertificatesInput {
3267
3548
  /**
3549
+ * @public
3268
3550
  * <p>The Amazon Resource Name (ARN) of the listener.</p>
3269
3551
  */
3270
3552
  ListenerArn: string | undefined;
3271
3553
  /**
3554
+ * @public
3272
3555
  * <p>The certificate to remove. You can specify one certificate per call. Set
3273
3556
  * <code>CertificateArn</code> to the certificate ARN but do not set
3274
3557
  * <code>IsDefault</code>.</p>
@@ -3285,10 +3568,12 @@ export interface RemoveListenerCertificatesOutput {
3285
3568
  */
3286
3569
  export interface RemoveTagsInput {
3287
3570
  /**
3571
+ * @public
3288
3572
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
3289
3573
  */
3290
3574
  ResourceArns: string[] | undefined;
3291
3575
  /**
3576
+ * @public
3292
3577
  * <p>The tag keys for the tags to remove.</p>
3293
3578
  */
3294
3579
  TagKeys: string[] | undefined;
@@ -3303,10 +3588,12 @@ export interface RemoveTagsOutput {
3303
3588
  */
3304
3589
  export interface SetIpAddressTypeInput {
3305
3590
  /**
3591
+ * @public
3306
3592
  * <p>The Amazon Resource Name (ARN) of the load balancer.</p>
3307
3593
  */
3308
3594
  LoadBalancerArn: string | undefined;
3309
3595
  /**
3596
+ * @public
3310
3597
  * <p>The IP address type. The possible values are <code>ipv4</code> (for IPv4 addresses) and
3311
3598
  * <code>dualstack</code> (for IPv4 and IPv6 addresses).
3312
3599
  * You can’t specify
@@ -3319,6 +3606,7 @@ export interface SetIpAddressTypeInput {
3319
3606
  */
3320
3607
  export interface SetIpAddressTypeOutput {
3321
3608
  /**
3609
+ * @public
3322
3610
  * <p>The IP address type.</p>
3323
3611
  */
3324
3612
  IpAddressType?: IpAddressType | string;
@@ -3329,10 +3617,12 @@ export interface SetIpAddressTypeOutput {
3329
3617
  */
3330
3618
  export interface RulePriorityPair {
3331
3619
  /**
3620
+ * @public
3332
3621
  * <p>The Amazon Resource Name (ARN) of the rule.</p>
3333
3622
  */
3334
3623
  RuleArn?: string;
3335
3624
  /**
3625
+ * @public
3336
3626
  * <p>The rule priority.</p>
3337
3627
  */
3338
3628
  Priority?: number;
@@ -3342,6 +3632,7 @@ export interface RulePriorityPair {
3342
3632
  */
3343
3633
  export interface SetRulePrioritiesInput {
3344
3634
  /**
3635
+ * @public
3345
3636
  * <p>The rule priorities.</p>
3346
3637
  */
3347
3638
  RulePriorities: RulePriorityPair[] | undefined;
@@ -3351,6 +3642,7 @@ export interface SetRulePrioritiesInput {
3351
3642
  */
3352
3643
  export interface SetRulePrioritiesOutput {
3353
3644
  /**
3645
+ * @public
3354
3646
  * <p>Information about the rules.</p>
3355
3647
  */
3356
3648
  Rules?: Rule[];
@@ -3360,10 +3652,12 @@ export interface SetRulePrioritiesOutput {
3360
3652
  */
3361
3653
  export interface SetSecurityGroupsInput {
3362
3654
  /**
3655
+ * @public
3363
3656
  * <p>The Amazon Resource Name (ARN) of the load balancer.</p>
3364
3657
  */
3365
3658
  LoadBalancerArn: string | undefined;
3366
3659
  /**
3660
+ * @public
3367
3661
  * <p>The IDs of the security groups.</p>
3368
3662
  */
3369
3663
  SecurityGroups: string[] | undefined;
@@ -3373,6 +3667,7 @@ export interface SetSecurityGroupsInput {
3373
3667
  */
3374
3668
  export interface SetSecurityGroupsOutput {
3375
3669
  /**
3670
+ * @public
3376
3671
  * <p>The IDs of the security groups associated with the load balancer.</p>
3377
3672
  */
3378
3673
  SecurityGroupIds?: string[];
@@ -3382,10 +3677,12 @@ export interface SetSecurityGroupsOutput {
3382
3677
  */
3383
3678
  export interface SetSubnetsInput {
3384
3679
  /**
3680
+ * @public
3385
3681
  * <p>The Amazon Resource Name (ARN) of the load balancer.</p>
3386
3682
  */
3387
3683
  LoadBalancerArn: string | undefined;
3388
3684
  /**
3685
+ * @public
3389
3686
  * <p>The IDs of the public subnets. You can specify only one subnet per Availability Zone. You
3390
3687
  * must specify either subnets or subnet mappings.</p>
3391
3688
  * <p>[Application Load Balancers] You must specify subnets from at least two Availability
@@ -3398,6 +3695,7 @@ export interface SetSubnetsInput {
3398
3695
  */
3399
3696
  Subnets?: string[];
3400
3697
  /**
3698
+ * @public
3401
3699
  * <p>The IDs of the public subnets. You can specify only one subnet per Availability Zone. You
3402
3700
  * must specify either subnets or subnet mappings.</p>
3403
3701
  * <p>[Application Load Balancers] You must specify subnets from at least two Availability
@@ -3413,6 +3711,7 @@ export interface SetSubnetsInput {
3413
3711
  */
3414
3712
  SubnetMappings?: SubnetMapping[];
3415
3713
  /**
3714
+ * @public
3416
3715
  * <p>[Network Load Balancers] The type of IP addresses used by the subnets for your load
3417
3716
  * balancer. The possible values are <code>ipv4</code> (for IPv4 addresses) and
3418
3717
  * <code>dualstack</code> (for IPv4 and IPv6 addresses). You can’t specify
@@ -3426,10 +3725,12 @@ export interface SetSubnetsInput {
3426
3725
  */
3427
3726
  export interface SetSubnetsOutput {
3428
3727
  /**
3728
+ * @public
3429
3729
  * <p>Information about the subnets.</p>
3430
3730
  */
3431
3731
  AvailabilityZones?: AvailabilityZone[];
3432
3732
  /**
3733
+ * @public
3433
3734
  * <p>[Network Load Balancers] The IP address type.</p>
3434
3735
  */
3435
3736
  IpAddressType?: IpAddressType | string;