@aws-sdk/client-route53-recovery-control-config 3.378.0 → 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.
@@ -1,4 +1,7 @@
1
1
  import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
2
+ /**
3
+ * @public
4
+ */
2
5
  export interface ClientInputEndpointParameters {
3
6
  region?: string | Provider<string>;
4
7
  useDualstackEndpoint?: boolean | Provider<boolean>;
@@ -5,6 +5,7 @@
5
5
  */
6
6
  export * from "./Route53RecoveryControlConfigClient";
7
7
  export * from "./Route53RecoveryControlConfig";
8
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
8
9
  export * from "./commands";
9
10
  export * from "./pagination";
10
11
  export * from "./waiters";
@@ -6,10 +6,12 @@ import { Route53RecoveryControlConfigServiceException as __BaseException } from
6
6
  */
7
7
  export interface ClusterEndpoint {
8
8
  /**
9
+ * @public
9
10
  * <p>A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster.</p> <p>To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.</p>
10
11
  */
11
12
  Endpoint?: string;
12
13
  /**
14
+ * @public
13
15
  * <p>The Amazon Web Services Region for a cluster endpoint.</p>
14
16
  */
15
17
  Region?: string;
@@ -33,18 +35,22 @@ export type Status = (typeof Status)[keyof typeof Status];
33
35
  */
34
36
  export interface Cluster {
35
37
  /**
38
+ * @public
36
39
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
37
40
  */
38
41
  ClusterArn?: string;
39
42
  /**
43
+ * @public
40
44
  * <p>Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.</p> <p>To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.</p>
41
45
  */
42
46
  ClusterEndpoints?: ClusterEndpoint[];
43
47
  /**
48
+ * @public
44
49
  * <p>The name of the cluster.</p>
45
50
  */
46
51
  Name?: string;
47
52
  /**
53
+ * @public
48
54
  * <p>Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.</p>
49
55
  */
50
56
  Status?: Status | string;
@@ -55,26 +61,32 @@ export interface Cluster {
55
61
  */
56
62
  export interface ControlPanel {
57
63
  /**
64
+ * @public
58
65
  * <p>The Amazon Resource Name (ARN) of the cluster that includes the control panel.</p>
59
66
  */
60
67
  ClusterArn?: string;
61
68
  /**
69
+ * @public
62
70
  * <p>The Amazon Resource Name (ARN) of the control panel.</p>
63
71
  */
64
72
  ControlPanelArn?: string;
65
73
  /**
74
+ * @public
66
75
  * <p>A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.</p>
67
76
  */
68
77
  DefaultControlPanel?: boolean;
69
78
  /**
79
+ * @public
70
80
  * <p>The name of the control panel. You can use any non-white space character in the name.</p>
71
81
  */
72
82
  Name?: string;
73
83
  /**
84
+ * @public
74
85
  * <p>The number of routing controls in the control panel.</p>
75
86
  */
76
87
  RoutingControlCount?: number;
77
88
  /**
89
+ * @public
78
90
  * <p>The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.</p>
79
91
  */
80
92
  Status?: Status | string;
@@ -85,18 +97,22 @@ export interface ControlPanel {
85
97
  */
86
98
  export interface RoutingControl {
87
99
  /**
100
+ * @public
88
101
  * <p>The Amazon Resource Name (ARN) of the control panel that includes the routing control.</p>
89
102
  */
90
103
  ControlPanelArn?: string;
91
104
  /**
105
+ * @public
92
106
  * <p>The name of the routing control.</p>
93
107
  */
94
108
  Name?: string;
95
109
  /**
110
+ * @public
96
111
  * <p>The Amazon Resource Name (ARN) of the routing control.</p>
97
112
  */
98
113
  RoutingControlArn?: string;
99
114
  /**
115
+ * @public
100
116
  * <p>The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.</p>
101
117
  */
102
118
  Status?: Status | string;
@@ -120,14 +136,17 @@ export type RuleType = (typeof RuleType)[keyof typeof RuleType];
120
136
  */
121
137
  export interface RuleConfig {
122
138
  /**
139
+ * @public
123
140
  * <p>Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.</p>
124
141
  */
125
142
  Inverted: boolean | undefined;
126
143
  /**
144
+ * @public
127
145
  * <p>The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.</p>
128
146
  */
129
147
  Threshold: number | undefined;
130
148
  /**
149
+ * @public
131
150
  * <p>A rule can be one of the following: ATLEAST, AND, or OR.</p>
132
151
  */
133
152
  Type: RuleType | string | undefined;
@@ -138,30 +157,37 @@ export interface RuleConfig {
138
157
  */
139
158
  export interface AssertionRule {
140
159
  /**
160
+ * @public
141
161
  * <p>The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.</p>
142
162
  */
143
163
  AssertedControls: string[] | undefined;
144
164
  /**
165
+ * @public
145
166
  * <p>The Amazon Resource Name (ARN) of the control panel.</p>
146
167
  */
147
168
  ControlPanelArn: string | undefined;
148
169
  /**
170
+ * @public
149
171
  * <p>Name of the assertion rule. You can use any non-white space character in the name.</p>
150
172
  */
151
173
  Name: string | undefined;
152
174
  /**
175
+ * @public
153
176
  * <p>The criteria that you set for specific assertion routing controls (AssertedControls) that designate how many routing control states must be ON as the result of a transaction. For example, if you have three assertion routing controls, you might specify ATLEAST 2 for your rule configuration. This means that at least two assertion routing control states must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.</p>
154
177
  */
155
178
  RuleConfig: RuleConfig | undefined;
156
179
  /**
180
+ * @public
157
181
  * <p>The Amazon Resource Name (ARN) of the assertion rule.</p>
158
182
  */
159
183
  SafetyRuleArn: string | undefined;
160
184
  /**
185
+ * @public
161
186
  * <p>The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.</p>
162
187
  */
163
188
  Status: Status | string | undefined;
164
189
  /**
190
+ * @public
165
191
  * <p>An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.</p>
166
192
  */
167
193
  WaitPeriodMs: number | undefined;
@@ -172,34 +198,42 @@ export interface AssertionRule {
172
198
  */
173
199
  export interface GatingRule {
174
200
  /**
201
+ * @public
175
202
  * <p>The Amazon Resource Name (ARN) of the control panel.</p>
176
203
  */
177
204
  ControlPanelArn: string | undefined;
178
205
  /**
206
+ * @public
179
207
  * <p>An array of gating routing control Amazon Resource Names (ARNs). For a simple "on/off" switch, specify the ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you specify to determine if the target routing control states can be changed.</p>
180
208
  */
181
209
  GatingControls: string[] | undefined;
182
210
  /**
211
+ * @public
183
212
  * <p>The name for the gating rule. You can use any non-white space character in the name.</p>
184
213
  */
185
214
  Name: string | undefined;
186
215
  /**
216
+ * @public
187
217
  * <p>The criteria that you set for gating routing controls that designate how many of the routing control states must be ON to allow you to update target routing control states.</p>
188
218
  */
189
219
  RuleConfig: RuleConfig | undefined;
190
220
  /**
221
+ * @public
191
222
  * <p>The Amazon Resource Name (ARN) of the gating rule.</p>
192
223
  */
193
224
  SafetyRuleArn: string | undefined;
194
225
  /**
226
+ * @public
195
227
  * <p>The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.</p>
196
228
  */
197
229
  Status: Status | string | undefined;
198
230
  /**
231
+ * @public
199
232
  * <p>An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control. As a simple example, if you have a single gating control, it acts as an overall "on/off" switch for a set of target routing controls. You can use this to manually override automated failover, for example.</p>
200
233
  */
201
234
  TargetControls: string[] | undefined;
202
235
  /**
236
+ * @public
203
237
  * <p>An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.</p>
204
238
  */
205
239
  WaitPeriodMs: number | undefined;
@@ -210,10 +244,12 @@ export interface GatingRule {
210
244
  */
211
245
  export interface Rule {
212
246
  /**
247
+ * @public
213
248
  * <p>An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control state is not accepted. For example, the criteria might be that at least one routing control state is On after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.</p>
214
249
  */
215
250
  ASSERTION?: AssertionRule;
216
251
  /**
252
+ * @public
217
253
  * <p>A gating rule verifies that a gating routing control or set of gating routing controls, evaluates as true, based on a rule configuration that you specify, which allows a set of routing control state changes to complete.</p> <p>For example, if you specify one gating routing control and you set the Type in the rule configuration to OR, that indicates that you must set the gating routing control to On for the rule to evaluate as true; that is, for the gating control "switch" to be "On". When you do that, then you can update the routing control states for the target routing controls that you specify in the gating rule.</p>
218
254
  */
219
255
  GATING?: GatingRule;
@@ -237,14 +273,17 @@ export declare class AccessDeniedException extends __BaseException {
237
273
  */
238
274
  export interface AssertionRuleUpdate {
239
275
  /**
276
+ * @public
240
277
  * <p>The name of the assertion rule. You can use any non-white space character in the name.</p>
241
278
  */
242
279
  Name: string | undefined;
243
280
  /**
281
+ * @public
244
282
  * <p>The Amazon Resource Name (ARN) of the assertion rule.</p>
245
283
  */
246
284
  SafetyRuleArn: string | undefined;
247
285
  /**
286
+ * @public
248
287
  * <p>An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.</p>
249
288
  */
250
289
  WaitPeriodMs: number | undefined;
@@ -268,14 +307,17 @@ export declare class ConflictException extends __BaseException {
268
307
  */
269
308
  export interface CreateClusterRequest {
270
309
  /**
310
+ * @public
271
311
  * <p>A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.</p>
272
312
  */
273
313
  ClientToken?: string;
274
314
  /**
315
+ * @public
275
316
  * <p>The name of the cluster.</p>
276
317
  */
277
318
  ClusterName: string | undefined;
278
319
  /**
320
+ * @public
279
321
  * <p>The tags associated with the cluster.</p>
280
322
  */
281
323
  Tags?: Record<string, string>;
@@ -285,6 +327,7 @@ export interface CreateClusterRequest {
285
327
  */
286
328
  export interface CreateClusterResponse {
287
329
  /**
330
+ * @public
288
331
  * <p>The cluster that was created.</p>
289
332
  */
290
333
  Cluster?: Cluster;
@@ -360,18 +403,22 @@ export declare class ValidationException extends __BaseException {
360
403
  */
361
404
  export interface CreateControlPanelRequest {
362
405
  /**
406
+ * @public
363
407
  * <p>A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.</p>
364
408
  */
365
409
  ClientToken?: string;
366
410
  /**
411
+ * @public
367
412
  * <p>The Amazon Resource Name (ARN) of the cluster for the control panel.</p>
368
413
  */
369
414
  ClusterArn: string | undefined;
370
415
  /**
416
+ * @public
371
417
  * <p>The name of the control panel.</p>
372
418
  */
373
419
  ControlPanelName: string | undefined;
374
420
  /**
421
+ * @public
375
422
  * <p>The tags associated with the control panel.</p>
376
423
  */
377
424
  Tags?: Record<string, string>;
@@ -381,6 +428,7 @@ export interface CreateControlPanelRequest {
381
428
  */
382
429
  export interface CreateControlPanelResponse {
383
430
  /**
431
+ * @public
384
432
  * <p>Information about a control panel.</p>
385
433
  */
386
434
  ControlPanel?: ControlPanel;
@@ -391,18 +439,22 @@ export interface CreateControlPanelResponse {
391
439
  */
392
440
  export interface CreateRoutingControlRequest {
393
441
  /**
442
+ * @public
394
443
  * <p>A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.</p>
395
444
  */
396
445
  ClientToken?: string;
397
446
  /**
447
+ * @public
398
448
  * <p>The Amazon Resource Name (ARN) of the cluster that includes the routing control.</p>
399
449
  */
400
450
  ClusterArn: string | undefined;
401
451
  /**
452
+ * @public
402
453
  * <p>The Amazon Resource Name (ARN) of the control panel that includes the routing control.</p>
403
454
  */
404
455
  ControlPanelArn?: string;
405
456
  /**
457
+ * @public
406
458
  * <p>The name of the routing control.</p>
407
459
  */
408
460
  RoutingControlName: string | undefined;
@@ -412,6 +464,7 @@ export interface CreateRoutingControlRequest {
412
464
  */
413
465
  export interface CreateRoutingControlResponse {
414
466
  /**
467
+ * @public
415
468
  * <p>The routing control that is created.</p>
416
469
  */
417
470
  RoutingControl?: RoutingControl;
@@ -422,22 +475,27 @@ export interface CreateRoutingControlResponse {
422
475
  */
423
476
  export interface NewAssertionRule {
424
477
  /**
478
+ * @public
425
479
  * <p>The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.</p>
426
480
  */
427
481
  AssertedControls: string[] | undefined;
428
482
  /**
483
+ * @public
429
484
  * <p>The Amazon Resource Name (ARN) for the control panel.</p>
430
485
  */
431
486
  ControlPanelArn: string | undefined;
432
487
  /**
488
+ * @public
433
489
  * <p>The name of the assertion rule. You can use any non-white space character in the name.</p>
434
490
  */
435
491
  Name: string | undefined;
436
492
  /**
493
+ * @public
437
494
  * <p>The criteria that you set for specific assertion controls (routing controls) that designate how many control states must be ON as the result of a transaction. For example, if you have three assertion controls, you might specify ATLEAST 2 for your rule configuration. This means that at least two assertion controls must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.</p>
438
495
  */
439
496
  RuleConfig: RuleConfig | undefined;
440
497
  /**
498
+ * @public
441
499
  * <p>An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.</p>
442
500
  */
443
501
  WaitPeriodMs: number | undefined;
@@ -448,26 +506,32 @@ export interface NewAssertionRule {
448
506
  */
449
507
  export interface NewGatingRule {
450
508
  /**
509
+ * @public
451
510
  * <p>The Amazon Resource Name (ARN) of the control panel.</p>
452
511
  */
453
512
  ControlPanelArn: string | undefined;
454
513
  /**
514
+ * @public
455
515
  * <p>The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.</p>
456
516
  */
457
517
  GatingControls: string[] | undefined;
458
518
  /**
519
+ * @public
459
520
  * <p>The name for the new gating rule.</p>
460
521
  */
461
522
  Name: string | undefined;
462
523
  /**
524
+ * @public
463
525
  * <p>The criteria that you set for specific gating controls (routing controls) that designate how many control states must be ON to allow you to change (set or unset) the target control states.</p>
464
526
  */
465
527
  RuleConfig: RuleConfig | undefined;
466
528
  /**
529
+ * @public
467
530
  * <p>Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.</p> <p>In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.</p>
468
531
  */
469
532
  TargetControls: string[] | undefined;
470
533
  /**
534
+ * @public
471
535
  * <p>An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.</p>
472
536
  */
473
537
  WaitPeriodMs: number | undefined;
@@ -478,18 +542,22 @@ export interface NewGatingRule {
478
542
  */
479
543
  export interface CreateSafetyRuleRequest {
480
544
  /**
545
+ * @public
481
546
  * <p>The assertion rule requested.</p>
482
547
  */
483
548
  AssertionRule?: NewAssertionRule;
484
549
  /**
550
+ * @public
485
551
  * <p>A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.</p>
486
552
  */
487
553
  ClientToken?: string;
488
554
  /**
555
+ * @public
489
556
  * <p>The gating rule requested.</p>
490
557
  */
491
558
  GatingRule?: NewGatingRule;
492
559
  /**
560
+ * @public
493
561
  * <p>The tags associated with the safety rule.</p>
494
562
  */
495
563
  Tags?: Record<string, string>;
@@ -499,10 +567,12 @@ export interface CreateSafetyRuleRequest {
499
567
  */
500
568
  export interface CreateSafetyRuleResponse {
501
569
  /**
570
+ * @public
502
571
  * <p>The assertion rule created.</p>
503
572
  */
504
573
  AssertionRule?: AssertionRule;
505
574
  /**
575
+ * @public
506
576
  * <p>The gating rule created.</p>
507
577
  */
508
578
  GatingRule?: GatingRule;
@@ -512,6 +582,7 @@ export interface CreateSafetyRuleResponse {
512
582
  */
513
583
  export interface DeleteClusterRequest {
514
584
  /**
585
+ * @public
515
586
  * <p>The Amazon Resource Name (ARN) of the cluster that you're deleting.</p>
516
587
  */
517
588
  ClusterArn: string | undefined;
@@ -526,6 +597,7 @@ export interface DeleteClusterResponse {
526
597
  */
527
598
  export interface DeleteControlPanelRequest {
528
599
  /**
600
+ * @public
529
601
  * <p>The Amazon Resource Name (ARN) of the control panel.</p>
530
602
  */
531
603
  ControlPanelArn: string | undefined;
@@ -540,6 +612,7 @@ export interface DeleteControlPanelResponse {
540
612
  */
541
613
  export interface DeleteRoutingControlRequest {
542
614
  /**
615
+ * @public
543
616
  * <p>The Amazon Resource Name (ARN) of the routing control that you're deleting.</p>
544
617
  */
545
618
  RoutingControlArn: string | undefined;
@@ -554,6 +627,7 @@ export interface DeleteRoutingControlResponse {
554
627
  */
555
628
  export interface DeleteSafetyRuleRequest {
556
629
  /**
630
+ * @public
557
631
  * <p>The ARN of the safety rule.</p>
558
632
  */
559
633
  SafetyRuleArn: string | undefined;
@@ -568,6 +642,7 @@ export interface DeleteSafetyRuleResponse {
568
642
  */
569
643
  export interface DescribeClusterRequest {
570
644
  /**
645
+ * @public
571
646
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
572
647
  */
573
648
  ClusterArn: string | undefined;
@@ -577,6 +652,7 @@ export interface DescribeClusterRequest {
577
652
  */
578
653
  export interface DescribeClusterResponse {
579
654
  /**
655
+ * @public
580
656
  * <p>The cluster for the DescribeCluster request.</p>
581
657
  */
582
658
  Cluster?: Cluster;
@@ -586,6 +662,7 @@ export interface DescribeClusterResponse {
586
662
  */
587
663
  export interface DescribeControlPanelRequest {
588
664
  /**
665
+ * @public
589
666
  * <p>The Amazon Resource Name (ARN) of the control panel.</p>
590
667
  */
591
668
  ControlPanelArn: string | undefined;
@@ -595,6 +672,7 @@ export interface DescribeControlPanelRequest {
595
672
  */
596
673
  export interface DescribeControlPanelResponse {
597
674
  /**
675
+ * @public
598
676
  * <p>Information about the control panel.</p>
599
677
  */
600
678
  ControlPanel?: ControlPanel;
@@ -604,6 +682,7 @@ export interface DescribeControlPanelResponse {
604
682
  */
605
683
  export interface DescribeRoutingControlRequest {
606
684
  /**
685
+ * @public
607
686
  * <p>The Amazon Resource Name (ARN) of the routing control.</p>
608
687
  */
609
688
  RoutingControlArn: string | undefined;
@@ -613,6 +692,7 @@ export interface DescribeRoutingControlRequest {
613
692
  */
614
693
  export interface DescribeRoutingControlResponse {
615
694
  /**
695
+ * @public
616
696
  * <p>Information about the routing control.</p>
617
697
  */
618
698
  RoutingControl?: RoutingControl;
@@ -622,6 +702,7 @@ export interface DescribeRoutingControlResponse {
622
702
  */
623
703
  export interface DescribeSafetyRuleRequest {
624
704
  /**
705
+ * @public
625
706
  * <p>The ARN of the safety rule.</p>
626
707
  */
627
708
  SafetyRuleArn: string | undefined;
@@ -631,10 +712,12 @@ export interface DescribeSafetyRuleRequest {
631
712
  */
632
713
  export interface DescribeSafetyRuleResponse {
633
714
  /**
715
+ * @public
634
716
  * <p>The assertion rule in the response.</p>
635
717
  */
636
718
  AssertionRule?: AssertionRule;
637
719
  /**
720
+ * @public
638
721
  * <p>The gating rule in the response.</p>
639
722
  */
640
723
  GatingRule?: GatingRule;
@@ -645,14 +728,17 @@ export interface DescribeSafetyRuleResponse {
645
728
  */
646
729
  export interface GatingRuleUpdate {
647
730
  /**
731
+ * @public
648
732
  * <p>The name for the gating rule. You can use any non-white space character in the name.</p>
649
733
  */
650
734
  Name: string | undefined;
651
735
  /**
736
+ * @public
652
737
  * <p>The Amazon Resource Name (ARN) of the gating rule.</p>
653
738
  */
654
739
  SafetyRuleArn: string | undefined;
655
740
  /**
741
+ * @public
656
742
  * <p>An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.</p>
657
743
  */
658
744
  WaitPeriodMs: number | undefined;
@@ -662,14 +748,17 @@ export interface GatingRuleUpdate {
662
748
  */
663
749
  export interface ListAssociatedRoute53HealthChecksRequest {
664
750
  /**
751
+ * @public
665
752
  * <p>The number of objects that you want to return with this call.</p>
666
753
  */
667
754
  MaxResults?: number;
668
755
  /**
756
+ * @public
669
757
  * <p>The token that identifies which batch of results you want to see.</p>
670
758
  */
671
759
  NextToken?: string;
672
760
  /**
761
+ * @public
673
762
  * <p>The Amazon Resource Name (ARN) of the routing control.</p>
674
763
  */
675
764
  RoutingControlArn: string | undefined;
@@ -679,10 +768,12 @@ export interface ListAssociatedRoute53HealthChecksRequest {
679
768
  */
680
769
  export interface ListAssociatedRoute53HealthChecksResponse {
681
770
  /**
771
+ * @public
682
772
  * <p>Identifiers for the health checks.</p>
683
773
  */
684
774
  HealthCheckIds?: string[];
685
775
  /**
776
+ * @public
686
777
  * <p>Next token for listing health checks.</p>
687
778
  */
688
779
  NextToken?: string;
@@ -692,10 +783,12 @@ export interface ListAssociatedRoute53HealthChecksResponse {
692
783
  */
693
784
  export interface ListClustersRequest {
694
785
  /**
786
+ * @public
695
787
  * <p>The number of objects that you want to return with this call.</p>
696
788
  */
697
789
  MaxResults?: number;
698
790
  /**
791
+ * @public
699
792
  * <p>The token that identifies which batch of results you want to see.</p>
700
793
  */
701
794
  NextToken?: string;
@@ -705,10 +798,12 @@ export interface ListClustersRequest {
705
798
  */
706
799
  export interface ListClustersResponse {
707
800
  /**
801
+ * @public
708
802
  * <p>An array of the clusters in an account.</p>
709
803
  */
710
804
  Clusters?: Cluster[];
711
805
  /**
806
+ * @public
712
807
  * <p>The token that identifies which batch of results you want to see.</p>
713
808
  */
714
809
  NextToken?: string;
@@ -718,14 +813,17 @@ export interface ListClustersResponse {
718
813
  */
719
814
  export interface ListControlPanelsRequest {
720
815
  /**
816
+ * @public
721
817
  * <p>The Amazon Resource Name (ARN) of a cluster.</p>
722
818
  */
723
819
  ClusterArn?: string;
724
820
  /**
821
+ * @public
725
822
  * <p>The number of objects that you want to return with this call.</p>
726
823
  */
727
824
  MaxResults?: number;
728
825
  /**
826
+ * @public
729
827
  * <p>The token that identifies which batch of results you want to see.</p>
730
828
  */
731
829
  NextToken?: string;
@@ -735,10 +833,12 @@ export interface ListControlPanelsRequest {
735
833
  */
736
834
  export interface ListControlPanelsResponse {
737
835
  /**
836
+ * @public
738
837
  * <p>The result of a successful ListControlPanel request.</p>
739
838
  */
740
839
  ControlPanels?: ControlPanel[];
741
840
  /**
841
+ * @public
742
842
  * <p>The token that identifies which batch of results you want to see.</p>
743
843
  */
744
844
  NextToken?: string;
@@ -748,14 +848,17 @@ export interface ListControlPanelsResponse {
748
848
  */
749
849
  export interface ListRoutingControlsRequest {
750
850
  /**
851
+ * @public
751
852
  * <p>The Amazon Resource Name (ARN) of the control panel.</p>
752
853
  */
753
854
  ControlPanelArn: string | undefined;
754
855
  /**
856
+ * @public
755
857
  * <p>The number of objects that you want to return with this call.</p>
756
858
  */
757
859
  MaxResults?: number;
758
860
  /**
861
+ * @public
759
862
  * <p>The token that identifies which batch of results you want to see.</p>
760
863
  */
761
864
  NextToken?: string;
@@ -765,10 +868,12 @@ export interface ListRoutingControlsRequest {
765
868
  */
766
869
  export interface ListRoutingControlsResponse {
767
870
  /**
871
+ * @public
768
872
  * <p>The token that identifies which batch of results you want to see.</p>
769
873
  */
770
874
  NextToken?: string;
771
875
  /**
876
+ * @public
772
877
  * <p>An array of routing controls.</p>
773
878
  */
774
879
  RoutingControls?: RoutingControl[];
@@ -778,14 +883,17 @@ export interface ListRoutingControlsResponse {
778
883
  */
779
884
  export interface ListSafetyRulesRequest {
780
885
  /**
886
+ * @public
781
887
  * <p>The Amazon Resource Name (ARN) of the control panel.</p>
782
888
  */
783
889
  ControlPanelArn: string | undefined;
784
890
  /**
891
+ * @public
785
892
  * <p>The number of objects that you want to return with this call.</p>
786
893
  */
787
894
  MaxResults?: number;
788
895
  /**
896
+ * @public
789
897
  * <p>The token that identifies which batch of results you want to see.</p>
790
898
  */
791
899
  NextToken?: string;
@@ -795,10 +903,12 @@ export interface ListSafetyRulesRequest {
795
903
  */
796
904
  export interface ListSafetyRulesResponse {
797
905
  /**
906
+ * @public
798
907
  * <p>The token that identifies which batch of results you want to see.</p>
799
908
  */
800
909
  NextToken?: string;
801
910
  /**
911
+ * @public
802
912
  * <p>The list of safety rules in a control panel.</p>
803
913
  */
804
914
  SafetyRules?: Rule[];
@@ -808,6 +918,7 @@ export interface ListSafetyRulesResponse {
808
918
  */
809
919
  export interface ListTagsForResourceRequest {
810
920
  /**
921
+ * @public
811
922
  * <p>The Amazon Resource Name (ARN) for the resource that's tagged.</p>
812
923
  */
813
924
  ResourceArn: string | undefined;
@@ -817,6 +928,7 @@ export interface ListTagsForResourceRequest {
817
928
  */
818
929
  export interface ListTagsForResourceResponse {
819
930
  /**
931
+ * @public
820
932
  * <p>The tags associated with the resource.</p>
821
933
  */
822
934
  Tags?: Record<string, string>;
@@ -827,10 +939,12 @@ export interface ListTagsForResourceResponse {
827
939
  */
828
940
  export interface TagResourceRequest {
829
941
  /**
942
+ * @public
830
943
  * <p>The Amazon Resource Name (ARN) for the resource that's tagged.</p>
831
944
  */
832
945
  ResourceArn: string | undefined;
833
946
  /**
947
+ * @public
834
948
  * <p>The tags associated with the resource.</p>
835
949
  */
836
950
  Tags: Record<string, string> | undefined;
@@ -845,10 +959,12 @@ export interface TagResourceResponse {
845
959
  */
846
960
  export interface UntagResourceRequest {
847
961
  /**
962
+ * @public
848
963
  * <p>The Amazon Resource Name (ARN) for the resource that's tagged.</p>
849
964
  */
850
965
  ResourceArn: string | undefined;
851
966
  /**
967
+ * @public
852
968
  * <p>Keys for the tags to be removed.</p>
853
969
  */
854
970
  TagKeys: string[] | undefined;
@@ -864,10 +980,12 @@ export interface UntagResourceResponse {
864
980
  */
865
981
  export interface UpdateControlPanelRequest {
866
982
  /**
983
+ * @public
867
984
  * <p>The Amazon Resource Name (ARN) of the control panel.</p>
868
985
  */
869
986
  ControlPanelArn: string | undefined;
870
987
  /**
988
+ * @public
871
989
  * <p>The name of the control panel.</p>
872
990
  */
873
991
  ControlPanelName: string | undefined;
@@ -877,6 +995,7 @@ export interface UpdateControlPanelRequest {
877
995
  */
878
996
  export interface UpdateControlPanelResponse {
879
997
  /**
998
+ * @public
880
999
  * <p>The control panel to update.</p>
881
1000
  */
882
1001
  ControlPanel?: ControlPanel;
@@ -887,10 +1006,12 @@ export interface UpdateControlPanelResponse {
887
1006
  */
888
1007
  export interface UpdateRoutingControlRequest {
889
1008
  /**
1009
+ * @public
890
1010
  * <p>The Amazon Resource Name (ARN) of the routing control.</p>
891
1011
  */
892
1012
  RoutingControlArn: string | undefined;
893
1013
  /**
1014
+ * @public
894
1015
  * <p>The name of the routing control.</p>
895
1016
  */
896
1017
  RoutingControlName: string | undefined;
@@ -900,6 +1021,7 @@ export interface UpdateRoutingControlRequest {
900
1021
  */
901
1022
  export interface UpdateRoutingControlResponse {
902
1023
  /**
1024
+ * @public
903
1025
  * <p>The routing control that was updated.</p>
904
1026
  */
905
1027
  RoutingControl?: RoutingControl;
@@ -910,10 +1032,12 @@ export interface UpdateRoutingControlResponse {
910
1032
  */
911
1033
  export interface UpdateSafetyRuleRequest {
912
1034
  /**
1035
+ * @public
913
1036
  * <p>The assertion rule to update.</p>
914
1037
  */
915
1038
  AssertionRuleUpdate?: AssertionRuleUpdate;
916
1039
  /**
1040
+ * @public
917
1041
  * <p>The gating rule to update.</p>
918
1042
  */
919
1043
  GatingRuleUpdate?: GatingRuleUpdate;
@@ -923,10 +1047,12 @@ export interface UpdateSafetyRuleRequest {
923
1047
  */
924
1048
  export interface UpdateSafetyRuleResponse {
925
1049
  /**
1050
+ * @public
926
1051
  * <p>The assertion rule updated.</p>
927
1052
  */
928
1053
  AssertionRule?: AssertionRule;
929
1054
  /**
1055
+ * @public
930
1056
  * <p>The gating rule updated.</p>
931
1057
  */
932
1058
  GatingRule?: GatingRule;
@@ -1,5 +1,6 @@
1
1
  export * from "./Route53RecoveryControlConfigClient";
2
2
  export * from "./Route53RecoveryControlConfig";
3
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
3
4
  export * from "./commands";
4
5
  export * from "./pagination";
5
6
  export * from "./waiters";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-route53-recovery-control-config",
3
3
  "description": "AWS SDK for JavaScript Route53 Recovery Control Config Client for Node.js, Browser and React Native",
4
- "version": "3.378.0",
4
+ "version": "3.382.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.378.0",
25
- "@aws-sdk/credential-provider-node": "3.378.0",
26
- "@aws-sdk/middleware-host-header": "3.378.0",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
26
+ "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
- "@aws-sdk/middleware-signing": "3.378.0",
30
- "@aws-sdk/middleware-user-agent": "3.378.0",
29
+ "@aws-sdk/middleware-signing": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",