@aws-sdk/client-arc-zonal-shift 3.529.1 → 3.535.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.
- package/dist-types/ARCZonalShift.d.ts +4 -1
- package/dist-types/ARCZonalShiftClient.d.ts +1 -1
- package/dist-types/commands/CancelZonalShiftCommand.d.ts +2 -1
- package/dist-types/commands/CreatePracticeRunConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/DeletePracticeRunConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/GetManagedResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListAutoshiftsCommand.d.ts +2 -1
- package/dist-types/commands/ListManagedResourcesCommand.d.ts +2 -1
- package/dist-types/commands/ListZonalShiftsCommand.d.ts +2 -1
- package/dist-types/commands/StartZonalShiftCommand.d.ts +2 -1
- package/dist-types/commands/UpdatePracticeRunConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/UpdateZonalAutoshiftConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/UpdateZonalShiftCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +117 -117
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +2 -2
- package/dist-types/ts3.4/ARCZonalShift.d.ts +3 -0
- package/dist-types/ts3.4/commands/CancelZonalShiftCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreatePracticeRunConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeletePracticeRunConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetManagedResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListAutoshiftsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListManagedResourcesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListZonalShiftsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartZonalShiftCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdatePracticeRunConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateZonalAutoshiftConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateZonalShiftCommand.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
- package/package.json +40 -40
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { ARCZonalShiftServiceException as __BaseException } from "./ARCZonalShiftServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
8
8
|
readonly name: "AccessDeniedException";
|
|
@@ -25,8 +25,8 @@ export declare const AppliedStatus: {
|
|
|
25
25
|
*/
|
|
26
26
|
export type AppliedStatus = (typeof AppliedStatus)[keyof typeof AppliedStatus];
|
|
27
27
|
/**
|
|
28
|
-
* @public
|
|
29
28
|
* <p>There was an internal server error.</p>
|
|
29
|
+
* @public
|
|
30
30
|
*/
|
|
31
31
|
export declare class InternalServerException extends __BaseException {
|
|
32
32
|
readonly name: "InternalServerException";
|
|
@@ -53,25 +53,24 @@ export type AutoshiftExecutionStatus = (typeof AutoshiftExecutionStatus)[keyof t
|
|
|
53
53
|
*/
|
|
54
54
|
export interface ListAutoshiftsRequest {
|
|
55
55
|
/**
|
|
56
|
-
* @public
|
|
57
56
|
* <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the
|
|
58
57
|
* previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous
|
|
59
58
|
* call's <code>NextToken</code> response to request the next page of results.</p>
|
|
59
|
+
* @public
|
|
60
60
|
*/
|
|
61
61
|
nextToken?: string;
|
|
62
62
|
/**
|
|
63
|
-
* @public
|
|
64
63
|
* <p>The status of the autoshift.</p>
|
|
64
|
+
* @public
|
|
65
65
|
*/
|
|
66
66
|
status?: AutoshiftExecutionStatus;
|
|
67
67
|
/**
|
|
68
|
-
* @public
|
|
69
68
|
* <p>The number of objects that you want to return with this call.</p>
|
|
69
|
+
* @public
|
|
70
70
|
*/
|
|
71
71
|
maxResults?: number;
|
|
72
72
|
}
|
|
73
73
|
/**
|
|
74
|
-
* @public
|
|
75
74
|
* <p>Information about an autoshift. Amazon Web Services starts an autoshift to temporarily move traffic for a resource
|
|
76
75
|
* away from an Availability Zone in an Amazon Web Services Region
|
|
77
76
|
* when Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers.
|
|
@@ -80,29 +79,30 @@ export interface ListAutoshiftsRequest {
|
|
|
80
79
|
* <p>Autoshifts are temporary. When the Availability Zone recovers, Amazon Web Services ends the autoshift, and
|
|
81
80
|
* traffic for the resource is no longer directed to the other Availability Zones in the Region.</p>
|
|
82
81
|
* <p>You can stop an autoshift for a resource by disabling zonal autoshift.</p>
|
|
82
|
+
* @public
|
|
83
83
|
*/
|
|
84
84
|
export interface AutoshiftSummary {
|
|
85
85
|
/**
|
|
86
|
-
* @public
|
|
87
86
|
* <p>The Availability Zone that traffic is shifted away from for a resource when Amazon Web Services starts an autoshift.
|
|
88
87
|
* Until the autoshift ends, traffic for the resource is instead directed to other Availability Zones in the Amazon Web Services Region.
|
|
89
88
|
* An autoshift can end for a resource, for example, when Amazon Web Services ends the autoshift for the Availability Zone or when
|
|
90
89
|
* you disable zonal autoshift for the resource.</p>
|
|
90
|
+
* @public
|
|
91
91
|
*/
|
|
92
92
|
awayFrom: string | undefined;
|
|
93
93
|
/**
|
|
94
|
-
* @public
|
|
95
94
|
* <p>The time (in UTC) when the autoshift ended.</p>
|
|
95
|
+
* @public
|
|
96
96
|
*/
|
|
97
97
|
endTime: Date | undefined;
|
|
98
98
|
/**
|
|
99
|
-
* @public
|
|
100
99
|
* <p>The time (in UTC) when the autoshift started.</p>
|
|
100
|
+
* @public
|
|
101
101
|
*/
|
|
102
102
|
startTime: Date | undefined;
|
|
103
103
|
/**
|
|
104
|
-
* @public
|
|
105
104
|
* <p>The status for an autoshift. </p>
|
|
105
|
+
* @public
|
|
106
106
|
*/
|
|
107
107
|
status: AutoshiftExecutionStatus | undefined;
|
|
108
108
|
}
|
|
@@ -111,21 +111,21 @@ export interface AutoshiftSummary {
|
|
|
111
111
|
*/
|
|
112
112
|
export interface ListAutoshiftsResponse {
|
|
113
113
|
/**
|
|
114
|
-
* @public
|
|
115
114
|
* <p>The items in the response list.</p>
|
|
115
|
+
* @public
|
|
116
116
|
*/
|
|
117
117
|
items?: AutoshiftSummary[];
|
|
118
118
|
/**
|
|
119
|
-
* @public
|
|
120
119
|
* <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the
|
|
121
120
|
* previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous
|
|
122
121
|
* call's <code>NextToken</code> response to request the next page of results.</p>
|
|
122
|
+
* @public
|
|
123
123
|
*/
|
|
124
124
|
nextToken?: string;
|
|
125
125
|
}
|
|
126
126
|
/**
|
|
127
|
-
* @public
|
|
128
127
|
* <p>The request was denied due to request throttling.</p>
|
|
128
|
+
* @public
|
|
129
129
|
*/
|
|
130
130
|
export declare class ThrottlingException extends __BaseException {
|
|
131
131
|
readonly name: "ThrottlingException";
|
|
@@ -156,15 +156,15 @@ export declare const ValidationExceptionReason: {
|
|
|
156
156
|
*/
|
|
157
157
|
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
158
158
|
/**
|
|
159
|
-
* @public
|
|
160
159
|
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
160
|
+
* @public
|
|
161
161
|
*/
|
|
162
162
|
export declare class ValidationException extends __BaseException {
|
|
163
163
|
readonly name: "ValidationException";
|
|
164
164
|
readonly $fault: "client";
|
|
165
165
|
/**
|
|
166
|
-
* @public
|
|
167
166
|
* <p>The reason for the validation exception.</p>
|
|
167
|
+
* @public
|
|
168
168
|
*/
|
|
169
169
|
reason: ValidationExceptionReason | undefined;
|
|
170
170
|
/**
|
|
@@ -185,15 +185,14 @@ export declare const AutoshiftAppliedStatus: {
|
|
|
185
185
|
*/
|
|
186
186
|
export type AutoshiftAppliedStatus = (typeof AutoshiftAppliedStatus)[keyof typeof AutoshiftAppliedStatus];
|
|
187
187
|
/**
|
|
188
|
-
* @public
|
|
189
188
|
* <p>A complex structure that lists an autoshift that is currently active for a managed resource and information about
|
|
190
189
|
* the autoshift.</p>
|
|
191
190
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html">How zonal autoshift
|
|
192
191
|
* and practice runs work</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
192
|
+
* @public
|
|
193
193
|
*/
|
|
194
194
|
export interface AutoshiftInResource {
|
|
195
195
|
/**
|
|
196
|
-
* @public
|
|
197
196
|
* <p>The <code>appliedStatus</code> field specifies which application traffic shift is in effect for a
|
|
198
197
|
* resource when there is more than one traffic shift active. There can be more than one application traffic
|
|
199
198
|
* shift in progress at the same time - that is, practice run zonal shifts, customer-started zonal shifts,
|
|
@@ -206,19 +205,20 @@ export interface AutoshiftInResource {
|
|
|
206
205
|
* <p>For more information, see
|
|
207
206
|
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html">How zonal autoshift
|
|
208
207
|
* and practice runs work</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
208
|
+
* @public
|
|
209
209
|
*/
|
|
210
210
|
appliedStatus: AutoshiftAppliedStatus | undefined;
|
|
211
211
|
/**
|
|
212
|
-
* @public
|
|
213
212
|
* <p>The Availability Zone that traffic is shifted away from for a resource, when Amazon Web Services starts an autoshift.
|
|
214
213
|
* Until the autoshift ends, traffic for the resource is instead directed to other Availability Zones in the Amazon Web Services Region.
|
|
215
214
|
* An autoshift can end for a resource, for example, when Amazon Web Services ends the autoshift for the Availability Zone or when
|
|
216
215
|
* you disable zonal autoshift for the resource.</p>
|
|
216
|
+
* @public
|
|
217
217
|
*/
|
|
218
218
|
awayFrom: string | undefined;
|
|
219
219
|
/**
|
|
220
|
-
* @public
|
|
221
220
|
* <p>The time (UTC) when the autoshift started.</p>
|
|
221
|
+
* @public
|
|
222
222
|
*/
|
|
223
223
|
startTime: Date | undefined;
|
|
224
224
|
}
|
|
@@ -227,8 +227,8 @@ export interface AutoshiftInResource {
|
|
|
227
227
|
*/
|
|
228
228
|
export interface CancelZonalShiftRequest {
|
|
229
229
|
/**
|
|
230
|
-
* @public
|
|
231
230
|
* <p>The internally-generated identifier of a zonal shift.</p>
|
|
231
|
+
* @public
|
|
232
232
|
*/
|
|
233
233
|
zonalShiftId: string | undefined;
|
|
234
234
|
}
|
|
@@ -249,20 +249,20 @@ export declare const ConflictExceptionReason: {
|
|
|
249
249
|
*/
|
|
250
250
|
export type ConflictExceptionReason = (typeof ConflictExceptionReason)[keyof typeof ConflictExceptionReason];
|
|
251
251
|
/**
|
|
252
|
-
* @public
|
|
253
252
|
* <p>The request could not be processed because of conflict in the current state of the resource.</p>
|
|
253
|
+
* @public
|
|
254
254
|
*/
|
|
255
255
|
export declare class ConflictException extends __BaseException {
|
|
256
256
|
readonly name: "ConflictException";
|
|
257
257
|
readonly $fault: "client";
|
|
258
258
|
/**
|
|
259
|
-
* @public
|
|
260
259
|
* <p>The reason for the conflict exception.</p>
|
|
260
|
+
* @public
|
|
261
261
|
*/
|
|
262
262
|
reason: ConflictExceptionReason | undefined;
|
|
263
263
|
/**
|
|
264
|
-
* @public
|
|
265
264
|
* <p>The zonal shift ID associated with the conflict exception.</p>
|
|
265
|
+
* @public
|
|
266
266
|
*/
|
|
267
267
|
zonalShiftId?: string;
|
|
268
268
|
/**
|
|
@@ -271,8 +271,8 @@ export declare class ConflictException extends __BaseException {
|
|
|
271
271
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
272
272
|
}
|
|
273
273
|
/**
|
|
274
|
-
* @public
|
|
275
274
|
* <p>The input requested a resource that was not found.</p>
|
|
275
|
+
* @public
|
|
276
276
|
*/
|
|
277
277
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
278
278
|
readonly name: "ResourceNotFoundException";
|
|
@@ -300,39 +300,38 @@ export type ZonalShiftStatus = (typeof ZonalShiftStatus)[keyof typeof ZonalShift
|
|
|
300
300
|
*/
|
|
301
301
|
export interface ZonalShift {
|
|
302
302
|
/**
|
|
303
|
-
* @public
|
|
304
303
|
* <p>The identifier of a zonal shift.</p>
|
|
304
|
+
* @public
|
|
305
305
|
*/
|
|
306
306
|
zonalShiftId: string | undefined;
|
|
307
307
|
/**
|
|
308
|
-
* @public
|
|
309
308
|
* <p>The identifier for the resource to shift away traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
310
309
|
* <p>At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.</p>
|
|
310
|
+
* @public
|
|
311
311
|
*/
|
|
312
312
|
resourceIdentifier: string | undefined;
|
|
313
313
|
/**
|
|
314
|
-
* @public
|
|
315
314
|
* <p>The Availability Zone that traffic is moved away from for a resource when you start a zonal shift.
|
|
316
315
|
* Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.</p>
|
|
316
|
+
* @public
|
|
317
317
|
*/
|
|
318
318
|
awayFrom: string | undefined;
|
|
319
319
|
/**
|
|
320
|
-
* @public
|
|
321
320
|
* <p>The expiry time (expiration time) for a customer-started zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift.
|
|
322
321
|
* You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift
|
|
323
322
|
* to set a new expiration at any time. </p>
|
|
324
323
|
* <p>When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts
|
|
325
324
|
* to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or
|
|
326
325
|
* just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.</p>
|
|
326
|
+
* @public
|
|
327
327
|
*/
|
|
328
328
|
expiryTime: Date | undefined;
|
|
329
329
|
/**
|
|
330
|
-
* @public
|
|
331
330
|
* <p>The time (UTC) when the zonal shift starts.</p>
|
|
331
|
+
* @public
|
|
332
332
|
*/
|
|
333
333
|
startTime: Date | undefined;
|
|
334
334
|
/**
|
|
335
|
-
* @public
|
|
336
335
|
* <p>A status for a zonal shift.</p>
|
|
337
336
|
* <p>The <code>Status</code> for a zonal shift can have one of the following values:</p>
|
|
338
337
|
* <ul>
|
|
@@ -349,12 +348,13 @@ export interface ZonalShift {
|
|
|
349
348
|
* <b>CANCELED:</b> The zonal shift was canceled.</p>
|
|
350
349
|
* </li>
|
|
351
350
|
* </ul>
|
|
351
|
+
* @public
|
|
352
352
|
*/
|
|
353
353
|
status: ZonalShiftStatus | undefined;
|
|
354
354
|
/**
|
|
355
|
-
* @public
|
|
356
355
|
* <p>A comment that you enter about the zonal shift. Only the latest comment is retained; no comment
|
|
357
356
|
* history is maintained. A new comment overwrites any existing comment string.</p>
|
|
357
|
+
* @public
|
|
358
358
|
*/
|
|
359
359
|
comment: string | undefined;
|
|
360
360
|
}
|
|
@@ -370,7 +370,6 @@ export declare const ControlConditionType: {
|
|
|
370
370
|
*/
|
|
371
371
|
export type ControlConditionType = (typeof ControlConditionType)[keyof typeof ControlConditionType];
|
|
372
372
|
/**
|
|
373
|
-
* @public
|
|
374
373
|
* <p>A control condition is an alarm that you specify for a practice run. When you configure practice runs
|
|
375
374
|
* with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch
|
|
376
375
|
* to use with the practice run. The alarms that you specify are an
|
|
@@ -380,16 +379,17 @@ export type ControlConditionType = (typeof ControlConditionType)[keyof typeof Co
|
|
|
380
379
|
* <p>For more information, see
|
|
381
380
|
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html">
|
|
382
381
|
* Considerations when you configure zonal autoshift</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
382
|
+
* @public
|
|
383
383
|
*/
|
|
384
384
|
export interface ControlCondition {
|
|
385
385
|
/**
|
|
386
|
-
* @public
|
|
387
386
|
* <p>The type of alarm specified for a practice run. The only valid value is <code>CLOUDWATCH</code>.</p>
|
|
387
|
+
* @public
|
|
388
388
|
*/
|
|
389
389
|
type: ControlConditionType | undefined;
|
|
390
390
|
/**
|
|
391
|
-
* @public
|
|
392
391
|
* <p>The Amazon Resource Name (ARN) for the Amazon CloudWatch alarm that you specify as a control condition for a practice run.</p>
|
|
392
|
+
* @public
|
|
393
393
|
*/
|
|
394
394
|
alarmIdentifier: string | undefined;
|
|
395
395
|
}
|
|
@@ -398,14 +398,13 @@ export interface ControlCondition {
|
|
|
398
398
|
*/
|
|
399
399
|
export interface CreatePracticeRunConfigurationRequest {
|
|
400
400
|
/**
|
|
401
|
-
* @public
|
|
402
401
|
* <p>The identifier of the resource to shift away traffic for when a practice
|
|
403
402
|
* run starts a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
404
403
|
* <p>At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.</p>
|
|
404
|
+
* @public
|
|
405
405
|
*/
|
|
406
406
|
resourceIdentifier: string | undefined;
|
|
407
407
|
/**
|
|
408
|
-
* @public
|
|
409
408
|
* <p>Optionally, you can block Route 53 ARC from starting practice runs for specific windows of
|
|
410
409
|
* days and times. </p>
|
|
411
410
|
* <p>The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates,
|
|
@@ -416,10 +415,10 @@ export interface CreatePracticeRunConfigurationRequest {
|
|
|
416
415
|
* this scenario, you might set the following recurring days and times as blocked windows,
|
|
417
416
|
* for example: <code>MON-20:30-21:30 WED-20:30-21:30
|
|
418
417
|
* FRI-20:30-21:30</code>.</p>
|
|
418
|
+
* @public
|
|
419
419
|
*/
|
|
420
420
|
blockedWindows?: string[];
|
|
421
421
|
/**
|
|
422
|
-
* @public
|
|
423
422
|
* <p>Optionally, you can block Route 53 ARC from starting practice runs for a resource
|
|
424
423
|
* on specific calendar dates.</p>
|
|
425
424
|
* <p>The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates,
|
|
@@ -428,18 +427,18 @@ export interface CreatePracticeRunConfigurationRequest {
|
|
|
428
427
|
* <p>For example, if you have an application update scheduled to launch on May 1, 2024, and
|
|
429
428
|
* you don't want practice runs to shift traffic away at that time, you could set a blocked date
|
|
430
429
|
* for <code>2024-05-01</code>.</p>
|
|
430
|
+
* @public
|
|
431
431
|
*/
|
|
432
432
|
blockedDates?: string[];
|
|
433
433
|
/**
|
|
434
|
-
* @public
|
|
435
434
|
* <p>An Amazon CloudWatch alarm that you can specify for zonal autoshift
|
|
436
435
|
* practice runs. This alarm blocks Route 53 ARC from starting practice run zonal
|
|
437
436
|
* shifts, and ends a practice run that's in progress, when the alarm is in
|
|
438
437
|
* an <code>ALARM</code> state. </p>
|
|
438
|
+
* @public
|
|
439
439
|
*/
|
|
440
440
|
blockingAlarms?: ControlCondition[];
|
|
441
441
|
/**
|
|
442
|
-
* @public
|
|
443
442
|
* <p>The <i>outcome alarm</i> for practice runs is a required
|
|
444
443
|
* Amazon CloudWatch alarm that you specify that ends a practice run when the
|
|
445
444
|
* alarm is in an <code>ALARM</code> state.</p>
|
|
@@ -448,41 +447,42 @@ export interface CreatePracticeRunConfigurationRequest {
|
|
|
448
447
|
* practice run. You should configure the alarm to go into an <code>ALARM</code> state
|
|
449
448
|
* if your application is impacted by the zonal shift, and you want to stop the
|
|
450
449
|
* zonal shift, to let traffic for the resource return to the Availability Zone.</p>
|
|
450
|
+
* @public
|
|
451
451
|
*/
|
|
452
452
|
outcomeAlarms: ControlCondition[] | undefined;
|
|
453
453
|
}
|
|
454
454
|
/**
|
|
455
|
-
* @public
|
|
456
455
|
* <p>A practice run configuration for a resource includes the Amazon CloudWatch alarms that you've specified for a practice
|
|
457
456
|
* run, as well as any blocked dates or blocked windows for the practice run.</p>
|
|
458
457
|
* <p>You can update or delete a practice run configuration. Before you delete a practice run configuration, you
|
|
459
458
|
* must disable zonal autoshift for the resource. A practice run configuration is required when zonal autoshift is enabled.</p>
|
|
459
|
+
* @public
|
|
460
460
|
*/
|
|
461
461
|
export interface PracticeRunConfiguration {
|
|
462
462
|
/**
|
|
463
|
-
* @public
|
|
464
463
|
* <p>The <i>blocking alarm</i> for practice runs is an optional alarm that you can
|
|
465
464
|
* specify that blocks practice runs when the alarm is in an <code>ALARM</code> state.</p>
|
|
465
|
+
* @public
|
|
466
466
|
*/
|
|
467
467
|
blockingAlarms?: ControlCondition[];
|
|
468
468
|
/**
|
|
469
|
-
* @public
|
|
470
469
|
* <p>The <i>outcome alarm</i> for practice runs is an alarm that you specify that
|
|
471
470
|
* ends a practice run when the alarm is in an <code>ALARM</code> state.</p>
|
|
471
|
+
* @public
|
|
472
472
|
*/
|
|
473
473
|
outcomeAlarms: ControlCondition[] | undefined;
|
|
474
474
|
/**
|
|
475
|
-
* @public
|
|
476
475
|
* <p>An array of one or more windows of days and times that you can block Route 53 ARC
|
|
477
476
|
* from starting practice runs for a resource.</p>
|
|
478
477
|
* <p>Specify the blocked windows in UTC, using the format <code>DAY:HH:MM-DAY:HH:MM</code>, separated by
|
|
479
478
|
* spaces. For example, <code>MON:18:30-MON:19:30 TUE:18:30-TUE:19:30</code>.</p>
|
|
479
|
+
* @public
|
|
480
480
|
*/
|
|
481
481
|
blockedWindows?: string[];
|
|
482
482
|
/**
|
|
483
|
-
* @public
|
|
484
483
|
* <p>An array of one or more dates that you can specify when Amazon Web Services does not start practice runs for a resource.</p>
|
|
485
484
|
* <p>Specify blocked dates, in UTC, in the format <code>YYYY-MM-DD</code>, separated by spaces. </p>
|
|
485
|
+
* @public
|
|
486
486
|
*/
|
|
487
487
|
blockedDates?: string[];
|
|
488
488
|
}
|
|
@@ -503,18 +503,17 @@ export type ZonalAutoshiftStatus = (typeof ZonalAutoshiftStatus)[keyof typeof Zo
|
|
|
503
503
|
*/
|
|
504
504
|
export interface CreatePracticeRunConfigurationResponse {
|
|
505
505
|
/**
|
|
506
|
-
* @public
|
|
507
506
|
* <p>The Amazon Resource Name (ARN) of the resource that you configured the practice
|
|
508
507
|
* run for.</p>
|
|
508
|
+
* @public
|
|
509
509
|
*/
|
|
510
510
|
arn: string | undefined;
|
|
511
511
|
/**
|
|
512
|
-
* @public
|
|
513
512
|
* <p>The name of the resource that you configured the practice run for. </p>
|
|
513
|
+
* @public
|
|
514
514
|
*/
|
|
515
515
|
name: string | undefined;
|
|
516
516
|
/**
|
|
517
|
-
* @public
|
|
518
517
|
* <p>The status for zonal autoshift for a resource. When you specify the
|
|
519
518
|
* autoshift status as <code>ENABLED</code>, Amazon Web Services shifts traffic
|
|
520
519
|
* away from shifts away application resource traffic from an Availability Zone,
|
|
@@ -522,13 +521,14 @@ export interface CreatePracticeRunConfigurationResponse {
|
|
|
522
521
|
* the Availability Zone that could potentially affect customers.</p>
|
|
523
522
|
* <p>When you enable zonal autoshift, you must also configure practice runs for
|
|
524
523
|
* the resource.</p>
|
|
524
|
+
* @public
|
|
525
525
|
*/
|
|
526
526
|
zonalAutoshiftStatus: ZonalAutoshiftStatus | undefined;
|
|
527
527
|
/**
|
|
528
|
-
* @public
|
|
529
528
|
* <p>A practice run configuration for a resource. Configurations include the
|
|
530
529
|
* outcome alarm that you specify for practice runs, and, optionally, a
|
|
531
530
|
* blocking alarm and blocking dates and windows.</p>
|
|
531
|
+
* @public
|
|
532
532
|
*/
|
|
533
533
|
practiceRunConfiguration: PracticeRunConfiguration | undefined;
|
|
534
534
|
}
|
|
@@ -537,9 +537,9 @@ export interface CreatePracticeRunConfigurationResponse {
|
|
|
537
537
|
*/
|
|
538
538
|
export interface DeletePracticeRunConfigurationRequest {
|
|
539
539
|
/**
|
|
540
|
-
* @public
|
|
541
540
|
* <p>The identifier for the resource that you want to delete the practice
|
|
542
541
|
* run configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
542
|
+
* @public
|
|
543
543
|
*/
|
|
544
544
|
resourceIdentifier: string | undefined;
|
|
545
545
|
}
|
|
@@ -548,20 +548,20 @@ export interface DeletePracticeRunConfigurationRequest {
|
|
|
548
548
|
*/
|
|
549
549
|
export interface DeletePracticeRunConfigurationResponse {
|
|
550
550
|
/**
|
|
551
|
-
* @public
|
|
552
551
|
* <p>The Amazon Resource Name (ARN) of the resource that you deleted the practice
|
|
553
552
|
* run for.</p>
|
|
553
|
+
* @public
|
|
554
554
|
*/
|
|
555
555
|
arn: string | undefined;
|
|
556
556
|
/**
|
|
557
|
-
* @public
|
|
558
557
|
* <p>The name of the resource that you deleted the practice
|
|
559
558
|
* run for. </p>
|
|
559
|
+
* @public
|
|
560
560
|
*/
|
|
561
561
|
name: string | undefined;
|
|
562
562
|
/**
|
|
563
|
-
* @public
|
|
564
563
|
* <p>The status of zonal autoshift for the resource.</p>
|
|
564
|
+
* @public
|
|
565
565
|
*/
|
|
566
566
|
zonalAutoshiftStatus: ZonalAutoshiftStatus | undefined;
|
|
567
567
|
}
|
|
@@ -570,9 +570,9 @@ export interface DeletePracticeRunConfigurationResponse {
|
|
|
570
570
|
*/
|
|
571
571
|
export interface GetManagedResourceRequest {
|
|
572
572
|
/**
|
|
573
|
-
* @public
|
|
574
573
|
* <p>The identifier for the resource to shift away traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
575
574
|
* <p>At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.</p>
|
|
575
|
+
* @public
|
|
576
576
|
*/
|
|
577
577
|
resourceIdentifier: string | undefined;
|
|
578
578
|
}
|
|
@@ -591,12 +591,11 @@ export declare const PracticeRunOutcome: {
|
|
|
591
591
|
*/
|
|
592
592
|
export type PracticeRunOutcome = (typeof PracticeRunOutcome)[keyof typeof PracticeRunOutcome];
|
|
593
593
|
/**
|
|
594
|
-
* @public
|
|
595
594
|
* <p>A complex structure that lists the zonal shifts for a managed resource and their statuses for the resource.</p>
|
|
595
|
+
* @public
|
|
596
596
|
*/
|
|
597
597
|
export interface ZonalShiftInResource {
|
|
598
598
|
/**
|
|
599
|
-
* @public
|
|
600
599
|
* <p>The <code>appliedStatus</code> field specifies which application traffic shift is in effect for a
|
|
601
600
|
* resource when there is more than one traffic shift active. There can be more than one application traffic
|
|
602
601
|
* shift in progress at the same time - that is, practice run zonal shifts, customer-started zonal shifts,
|
|
@@ -609,48 +608,48 @@ export interface ZonalShiftInResource {
|
|
|
609
608
|
* <p>For more information, see
|
|
610
609
|
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html">How zonal autoshift
|
|
611
610
|
* and practice runs work</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
611
|
+
* @public
|
|
612
612
|
*/
|
|
613
613
|
appliedStatus: AppliedStatus | undefined;
|
|
614
614
|
/**
|
|
615
|
-
* @public
|
|
616
615
|
* <p>The identifier of a zonal shift.</p>
|
|
616
|
+
* @public
|
|
617
617
|
*/
|
|
618
618
|
zonalShiftId: string | undefined;
|
|
619
619
|
/**
|
|
620
|
-
* @public
|
|
621
620
|
* <p>The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
622
621
|
* <p>At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.</p>
|
|
622
|
+
* @public
|
|
623
623
|
*/
|
|
624
624
|
resourceIdentifier: string | undefined;
|
|
625
625
|
/**
|
|
626
|
-
* @public
|
|
627
626
|
* <p>The Availability Zone that traffic is moved away from for a resource when you start a zonal shift.
|
|
628
627
|
* Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.</p>
|
|
628
|
+
* @public
|
|
629
629
|
*/
|
|
630
630
|
awayFrom: string | undefined;
|
|
631
631
|
/**
|
|
632
|
-
* @public
|
|
633
632
|
* <p>The expiry time (expiration time) for a customer-started zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift.
|
|
634
633
|
* You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift
|
|
635
634
|
* to set a new expiration at any time. </p>
|
|
636
635
|
* <p>When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts
|
|
637
636
|
* to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or
|
|
638
637
|
* just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.</p>
|
|
638
|
+
* @public
|
|
639
639
|
*/
|
|
640
640
|
expiryTime: Date | undefined;
|
|
641
641
|
/**
|
|
642
|
-
* @public
|
|
643
642
|
* <p>The time (UTC) when the zonal shift starts.</p>
|
|
643
|
+
* @public
|
|
644
644
|
*/
|
|
645
645
|
startTime: Date | undefined;
|
|
646
646
|
/**
|
|
647
|
-
* @public
|
|
648
647
|
* <p>A comment that you enter about the zonal shift. Only the latest comment is retained; no comment
|
|
649
648
|
* history is maintained. That is, a new comment overwrites any existing comment string.</p>
|
|
649
|
+
* @public
|
|
650
650
|
*/
|
|
651
651
|
comment: string | undefined;
|
|
652
652
|
/**
|
|
653
|
-
* @public
|
|
654
653
|
* <p>The outcome, or end state, returned for a practice run. The following values can be returned:</p>
|
|
655
654
|
* <ul>
|
|
656
655
|
* <li>
|
|
@@ -678,6 +677,7 @@ export interface ZonalShiftInResource {
|
|
|
678
677
|
* <p>For more information about practice run outcomes, see
|
|
679
678
|
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.configure.html">
|
|
680
679
|
* Considerations when you configure zonal autoshift</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
680
|
+
* @public
|
|
681
681
|
*/
|
|
682
682
|
practiceRunOutcome?: PracticeRunOutcome;
|
|
683
683
|
}
|
|
@@ -686,44 +686,44 @@ export interface ZonalShiftInResource {
|
|
|
686
686
|
*/
|
|
687
687
|
export interface GetManagedResourceResponse {
|
|
688
688
|
/**
|
|
689
|
-
* @public
|
|
690
689
|
* <p>The Amazon Resource Name (ARN) for the resource.</p>
|
|
690
|
+
* @public
|
|
691
691
|
*/
|
|
692
692
|
arn?: string;
|
|
693
693
|
/**
|
|
694
|
-
* @public
|
|
695
694
|
* <p>The name of the resource.</p>
|
|
695
|
+
* @public
|
|
696
696
|
*/
|
|
697
697
|
name?: string;
|
|
698
698
|
/**
|
|
699
|
-
* @public
|
|
700
699
|
* <p>A collection of key-value pairs that indicate whether resources are active in Availability Zones or not.
|
|
701
700
|
* The key name is the Availability Zone where the resource is deployed. The value is 1 or 0.</p>
|
|
701
|
+
* @public
|
|
702
702
|
*/
|
|
703
703
|
appliedWeights: Record<string, number> | undefined;
|
|
704
704
|
/**
|
|
705
|
-
* @public
|
|
706
705
|
* <p>The zonal shifts that are currently active for a resource. </p>
|
|
706
|
+
* @public
|
|
707
707
|
*/
|
|
708
708
|
zonalShifts: ZonalShiftInResource[] | undefined;
|
|
709
709
|
/**
|
|
710
|
-
* @public
|
|
711
710
|
* <p>An array of the autoshifts that are active for the resource.</p>
|
|
711
|
+
* @public
|
|
712
712
|
*/
|
|
713
713
|
autoshifts?: AutoshiftInResource[];
|
|
714
714
|
/**
|
|
715
|
-
* @public
|
|
716
715
|
* <p>The practice run configuration for zonal autoshift that's associated with
|
|
717
716
|
* the resource.</p>
|
|
717
|
+
* @public
|
|
718
718
|
*/
|
|
719
719
|
practiceRunConfiguration?: PracticeRunConfiguration;
|
|
720
720
|
/**
|
|
721
|
-
* @public
|
|
722
721
|
* <p>The status for zonal autoshift for a resource. When the
|
|
723
722
|
* autoshift status is <code>ENABLED</code>, Amazon Web Services shifts traffic
|
|
724
723
|
* for a resource away from an Availability Zone, on your behalf, when
|
|
725
724
|
* Amazon Web Services determines that there's an issue in
|
|
726
725
|
* the Availability Zone that could potentially affect customers.</p>
|
|
726
|
+
* @public
|
|
727
727
|
*/
|
|
728
728
|
zonalAutoshiftStatus?: ZonalAutoshiftStatus;
|
|
729
729
|
}
|
|
@@ -732,20 +732,19 @@ export interface GetManagedResourceResponse {
|
|
|
732
732
|
*/
|
|
733
733
|
export interface ListManagedResourcesRequest {
|
|
734
734
|
/**
|
|
735
|
-
* @public
|
|
736
735
|
* <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the
|
|
737
736
|
* previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous
|
|
738
737
|
* call's <code>NextToken</code> response to request the next page of results.</p>
|
|
738
|
+
* @public
|
|
739
739
|
*/
|
|
740
740
|
nextToken?: string;
|
|
741
741
|
/**
|
|
742
|
-
* @public
|
|
743
742
|
* <p>The number of objects that you want to return with this call.</p>
|
|
743
|
+
* @public
|
|
744
744
|
*/
|
|
745
745
|
maxResults?: number;
|
|
746
746
|
}
|
|
747
747
|
/**
|
|
748
|
-
* @public
|
|
749
748
|
* <p>A complex structure for a managed resource in an Amazon Web Services account with information about zonal shifts
|
|
750
749
|
* and autoshifts.</p>
|
|
751
750
|
* <p>A managed resource is a load balancer that has been registered
|
|
@@ -755,53 +754,54 @@ export interface ListManagedResourcesRequest {
|
|
|
755
754
|
* <note>
|
|
756
755
|
* <p>At this time, managed resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.</p>
|
|
757
756
|
* </note>
|
|
757
|
+
* @public
|
|
758
758
|
*/
|
|
759
759
|
export interface ManagedResourceSummary {
|
|
760
760
|
/**
|
|
761
|
-
* @public
|
|
762
761
|
* <p>The Amazon Resource Name (ARN) for the managed resource.</p>
|
|
762
|
+
* @public
|
|
763
763
|
*/
|
|
764
764
|
arn?: string;
|
|
765
765
|
/**
|
|
766
|
-
* @public
|
|
767
766
|
* <p>The name of the managed resource.</p>
|
|
767
|
+
* @public
|
|
768
768
|
*/
|
|
769
769
|
name?: string;
|
|
770
770
|
/**
|
|
771
|
-
* @public
|
|
772
771
|
* <p>The Availability Zones that a resource is deployed in.</p>
|
|
772
|
+
* @public
|
|
773
773
|
*/
|
|
774
774
|
availabilityZones: string[] | undefined;
|
|
775
775
|
/**
|
|
776
|
-
* @public
|
|
777
776
|
* <p>A collection of key-value pairs that indicate whether resources are active in Availability Zones or not.
|
|
778
777
|
* The key name is the Availability Zone where the resource is deployed. The value is 1 or 0.</p>
|
|
778
|
+
* @public
|
|
779
779
|
*/
|
|
780
780
|
appliedWeights?: Record<string, number>;
|
|
781
781
|
/**
|
|
782
|
-
* @public
|
|
783
782
|
* <p>An array of the zonal shifts for a resource.</p>
|
|
783
|
+
* @public
|
|
784
784
|
*/
|
|
785
785
|
zonalShifts?: ZonalShiftInResource[];
|
|
786
786
|
/**
|
|
787
|
-
* @public
|
|
788
787
|
* <p>An array of the autoshifts that have been completed for a resource.</p>
|
|
788
|
+
* @public
|
|
789
789
|
*/
|
|
790
790
|
autoshifts?: AutoshiftInResource[];
|
|
791
791
|
/**
|
|
792
|
-
* @public
|
|
793
792
|
* <p>The status of autoshift for a resource. When you configure zonal autoshift for a
|
|
794
793
|
* resource, you can set the value of the status to <code>ENABLED</code> or <code>DISABLED</code>.</p>
|
|
794
|
+
* @public
|
|
795
795
|
*/
|
|
796
796
|
zonalAutoshiftStatus?: ZonalAutoshiftStatus;
|
|
797
797
|
/**
|
|
798
|
-
* @public
|
|
799
798
|
* <p>This status tracks whether a practice run configuration exists for a resource. When you configure
|
|
800
799
|
* a practice run for a resource so that a practice run configuration exists, Route 53 ARC sets this value to
|
|
801
800
|
* <code>ENABLED</code>. If a you have not configured a practice run for the resource, or delete a practice
|
|
802
801
|
* run configuration, Route 53 ARC sets the value to <code>DISABLED</code>.</p>
|
|
803
802
|
* <p>Route 53 ARC updates this status; you can't set a practice run status to <code>ENABLED</code> or
|
|
804
803
|
* <code>DISABLED</code>.</p>
|
|
804
|
+
* @public
|
|
805
805
|
*/
|
|
806
806
|
practiceRunStatus?: ZonalAutoshiftStatus;
|
|
807
807
|
}
|
|
@@ -810,15 +810,15 @@ export interface ManagedResourceSummary {
|
|
|
810
810
|
*/
|
|
811
811
|
export interface ListManagedResourcesResponse {
|
|
812
812
|
/**
|
|
813
|
-
* @public
|
|
814
813
|
* <p>The items in the response list.</p>
|
|
814
|
+
* @public
|
|
815
815
|
*/
|
|
816
816
|
items: ManagedResourceSummary[] | undefined;
|
|
817
817
|
/**
|
|
818
|
-
* @public
|
|
819
818
|
* <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the
|
|
820
819
|
* previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous
|
|
821
820
|
* call's <code>NextToken</code> response to request the next page of results.</p>
|
|
821
|
+
* @public
|
|
822
822
|
*/
|
|
823
823
|
nextToken?: string;
|
|
824
824
|
}
|
|
@@ -827,14 +827,13 @@ export interface ListManagedResourcesResponse {
|
|
|
827
827
|
*/
|
|
828
828
|
export interface ListZonalShiftsRequest {
|
|
829
829
|
/**
|
|
830
|
-
* @public
|
|
831
830
|
* <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the
|
|
832
831
|
* previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous
|
|
833
832
|
* call's <code>NextToken</code> response to request the next page of results.</p>
|
|
833
|
+
* @public
|
|
834
834
|
*/
|
|
835
835
|
nextToken?: string;
|
|
836
836
|
/**
|
|
837
|
-
* @public
|
|
838
837
|
* <p>A status for a zonal shift.</p>
|
|
839
838
|
* <p>The <code>Status</code> for a zonal shift can have one of the following values:</p>
|
|
840
839
|
* <ul>
|
|
@@ -851,63 +850,63 @@ export interface ListZonalShiftsRequest {
|
|
|
851
850
|
* <b>CANCELED</b>: The zonal shift was canceled.</p>
|
|
852
851
|
* </li>
|
|
853
852
|
* </ul>
|
|
853
|
+
* @public
|
|
854
854
|
*/
|
|
855
855
|
status?: ZonalShiftStatus;
|
|
856
856
|
/**
|
|
857
|
-
* @public
|
|
858
857
|
* <p>The number of objects that you want to return with this call.</p>
|
|
858
|
+
* @public
|
|
859
859
|
*/
|
|
860
860
|
maxResults?: number;
|
|
861
861
|
/**
|
|
862
|
-
* @public
|
|
863
862
|
* <p>The identifier for the resource that you want to list zonal shifts for.
|
|
864
863
|
* The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
864
|
+
* @public
|
|
865
865
|
*/
|
|
866
866
|
resourceIdentifier?: string;
|
|
867
867
|
}
|
|
868
868
|
/**
|
|
869
|
-
* @public
|
|
870
869
|
* <p>Lists information about zonal shifts in Amazon Route 53 Application Recovery Controller, including zonal shifts that you start yourself and zonal shifts that Route 53 ARC starts
|
|
871
870
|
* on your behalf for practice runs with zonal autoshift.</p>
|
|
872
871
|
* <p>Zonal shifts are temporary, including customer-started zonal shifts and the zonal autoshift practice run zonal shifts that
|
|
873
872
|
* Route 53 ARC starts weekly, on your behalf. A zonal shift that a customer starts can be active for up to three days (72 hours). A
|
|
874
873
|
* practice run zonal shift has a 30 minute duration.</p>
|
|
874
|
+
* @public
|
|
875
875
|
*/
|
|
876
876
|
export interface ZonalShiftSummary {
|
|
877
877
|
/**
|
|
878
|
-
* @public
|
|
879
878
|
* <p>The identifier of a zonal shift.</p>
|
|
879
|
+
* @public
|
|
880
880
|
*/
|
|
881
881
|
zonalShiftId: string | undefined;
|
|
882
882
|
/**
|
|
883
|
-
* @public
|
|
884
883
|
* <p>The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
885
884
|
* <p>At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.</p>
|
|
885
|
+
* @public
|
|
886
886
|
*/
|
|
887
887
|
resourceIdentifier: string | undefined;
|
|
888
888
|
/**
|
|
889
|
-
* @public
|
|
890
889
|
* <p>The Availability Zone that traffic is moved away from for a resource when you start a zonal shift.
|
|
891
890
|
* Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.</p>
|
|
891
|
+
* @public
|
|
892
892
|
*/
|
|
893
893
|
awayFrom: string | undefined;
|
|
894
894
|
/**
|
|
895
|
-
* @public
|
|
896
895
|
* <p>The expiry time (expiration time) for a customer-started zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift.
|
|
897
896
|
* You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift
|
|
898
897
|
* to set a new expiration at any time. </p>
|
|
899
898
|
* <p>When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts
|
|
900
899
|
* to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or
|
|
901
900
|
* just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.</p>
|
|
901
|
+
* @public
|
|
902
902
|
*/
|
|
903
903
|
expiryTime: Date | undefined;
|
|
904
904
|
/**
|
|
905
|
-
* @public
|
|
906
905
|
* <p>The time (UTC) when the zonal shift starts.</p>
|
|
906
|
+
* @public
|
|
907
907
|
*/
|
|
908
908
|
startTime: Date | undefined;
|
|
909
909
|
/**
|
|
910
|
-
* @public
|
|
911
910
|
* <p>A status for a zonal shift.</p>
|
|
912
911
|
* <p>The <code>Status</code> for a zonal shift can have one of the following values:</p>
|
|
913
912
|
* <ul>
|
|
@@ -924,16 +923,16 @@ export interface ZonalShiftSummary {
|
|
|
924
923
|
* <b>CANCELED:</b> The zonal shift was canceled.</p>
|
|
925
924
|
* </li>
|
|
926
925
|
* </ul>
|
|
926
|
+
* @public
|
|
927
927
|
*/
|
|
928
928
|
status: ZonalShiftStatus | undefined;
|
|
929
929
|
/**
|
|
930
|
-
* @public
|
|
931
930
|
* <p>A comment that you enter about the zonal shift. Only the latest comment is retained; no comment
|
|
932
931
|
* history is maintained. That is, a new comment overwrites any existing comment string.</p>
|
|
932
|
+
* @public
|
|
933
933
|
*/
|
|
934
934
|
comment: string | undefined;
|
|
935
935
|
/**
|
|
936
|
-
* @public
|
|
937
936
|
* <p>The outcome, or end state, of a practice run. The following values can be returned:</p>
|
|
938
937
|
* <ul>
|
|
939
938
|
* <li>
|
|
@@ -961,6 +960,7 @@ export interface ZonalShiftSummary {
|
|
|
961
960
|
* <p>For more information about practice run outcomes, see
|
|
962
961
|
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.configure.html">
|
|
963
962
|
* Considerations when you configure zonal autoshift</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
963
|
+
* @public
|
|
964
964
|
*/
|
|
965
965
|
practiceRunOutcome?: PracticeRunOutcome;
|
|
966
966
|
}
|
|
@@ -969,15 +969,15 @@ export interface ZonalShiftSummary {
|
|
|
969
969
|
*/
|
|
970
970
|
export interface ListZonalShiftsResponse {
|
|
971
971
|
/**
|
|
972
|
-
* @public
|
|
973
972
|
* <p>The items in the response list.</p>
|
|
973
|
+
* @public
|
|
974
974
|
*/
|
|
975
975
|
items?: ZonalShiftSummary[];
|
|
976
976
|
/**
|
|
977
|
-
* @public
|
|
978
977
|
* <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the
|
|
979
978
|
* previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous
|
|
980
979
|
* call's <code>NextToken</code> response to request the next page of results.</p>
|
|
980
|
+
* @public
|
|
981
981
|
*/
|
|
982
982
|
nextToken?: string;
|
|
983
983
|
}
|
|
@@ -986,15 +986,15 @@ export interface ListZonalShiftsResponse {
|
|
|
986
986
|
*/
|
|
987
987
|
export interface UpdateZonalAutoshiftConfigurationRequest {
|
|
988
988
|
/**
|
|
989
|
-
* @public
|
|
990
989
|
* <p>The identifier for the resource that you want to update the zonal autoshift
|
|
991
990
|
* configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
991
|
+
* @public
|
|
992
992
|
*/
|
|
993
993
|
resourceIdentifier: string | undefined;
|
|
994
994
|
/**
|
|
995
|
-
* @public
|
|
996
995
|
* <p>The zonal autoshift status for the resource that you want to update the zonal
|
|
997
996
|
* autoshift configuration for.</p>
|
|
997
|
+
* @public
|
|
998
998
|
*/
|
|
999
999
|
zonalAutoshiftStatus: ZonalAutoshiftStatus | undefined;
|
|
1000
1000
|
}
|
|
@@ -1003,15 +1003,15 @@ export interface UpdateZonalAutoshiftConfigurationRequest {
|
|
|
1003
1003
|
*/
|
|
1004
1004
|
export interface UpdateZonalAutoshiftConfigurationResponse {
|
|
1005
1005
|
/**
|
|
1006
|
-
* @public
|
|
1007
1006
|
* <p>The identifier for the resource that you updated the zonal autoshift
|
|
1008
1007
|
* configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
1008
|
+
* @public
|
|
1009
1009
|
*/
|
|
1010
1010
|
resourceIdentifier: string | undefined;
|
|
1011
1011
|
/**
|
|
1012
|
-
* @public
|
|
1013
1012
|
* <p>The zonal autoshift status for the resource that you updated the zonal
|
|
1014
1013
|
* autoshift configuration for.</p>
|
|
1014
|
+
* @public
|
|
1015
1015
|
*/
|
|
1016
1016
|
zonalAutoshiftStatus: ZonalAutoshiftStatus | undefined;
|
|
1017
1017
|
}
|
|
@@ -1020,13 +1020,12 @@ export interface UpdateZonalAutoshiftConfigurationResponse {
|
|
|
1020
1020
|
*/
|
|
1021
1021
|
export interface UpdatePracticeRunConfigurationRequest {
|
|
1022
1022
|
/**
|
|
1023
|
-
* @public
|
|
1024
1023
|
* <p>The identifier for the resource that you want to update the practice
|
|
1025
1024
|
* run configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
1025
|
+
* @public
|
|
1026
1026
|
*/
|
|
1027
1027
|
resourceIdentifier: string | undefined;
|
|
1028
1028
|
/**
|
|
1029
|
-
* @public
|
|
1030
1029
|
* <p>Add, change, or remove windows of days and times for when you can, optionally,
|
|
1031
1030
|
* block Route 53 ARC from starting a practice run for a resource.</p>
|
|
1032
1031
|
* <p>The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates,
|
|
@@ -1037,10 +1036,10 @@ export interface UpdatePracticeRunConfigurationRequest {
|
|
|
1037
1036
|
* this scenario, you might set the following recurring days and times as blocked windows,
|
|
1038
1037
|
* for example: <code>MON-20:30-21:30 WED-20:30-21:30
|
|
1039
1038
|
* FRI-20:30-21:30</code>.</p>
|
|
1039
|
+
* @public
|
|
1040
1040
|
*/
|
|
1041
1041
|
blockedWindows?: string[];
|
|
1042
1042
|
/**
|
|
1043
|
-
* @public
|
|
1044
1043
|
* <p>Add, change, or remove blocked dates for a practice run in zonal autoshift.</p>
|
|
1045
1044
|
* <p>Optionally, you can block practice runs for specific calendar dates.
|
|
1046
1045
|
* The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates,
|
|
@@ -1049,17 +1048,18 @@ export interface UpdatePracticeRunConfigurationRequest {
|
|
|
1049
1048
|
* <p>For example, if you have an application update scheduled to launch on May 1, 2024, and
|
|
1050
1049
|
* you don't want practice runs to shift traffic away at that time, you could set a blocked date
|
|
1051
1050
|
* for <code>2024-05-01</code>.</p>
|
|
1051
|
+
* @public
|
|
1052
1052
|
*/
|
|
1053
1053
|
blockedDates?: string[];
|
|
1054
1054
|
/**
|
|
1055
|
-
* @public
|
|
1056
1055
|
* <p>Add, change, or remove the Amazon CloudWatch alarm that you optionally
|
|
1057
1056
|
* specify as the blocking alarm for practice runs.</p>
|
|
1057
|
+
* @public
|
|
1058
1058
|
*/
|
|
1059
1059
|
blockingAlarms?: ControlCondition[];
|
|
1060
1060
|
/**
|
|
1061
|
-
* @public
|
|
1062
1061
|
* <p>Specify a new the Amazon CloudWatch alarm as the outcome alarm for practice runs.</p>
|
|
1062
|
+
* @public
|
|
1063
1063
|
*/
|
|
1064
1064
|
outcomeAlarms?: ControlCondition[];
|
|
1065
1065
|
}
|
|
@@ -1068,26 +1068,26 @@ export interface UpdatePracticeRunConfigurationRequest {
|
|
|
1068
1068
|
*/
|
|
1069
1069
|
export interface UpdatePracticeRunConfigurationResponse {
|
|
1070
1070
|
/**
|
|
1071
|
-
* @public
|
|
1072
1071
|
* <p>The Amazon Resource Name (ARN) of the resource that you updated the practice
|
|
1073
1072
|
* run for.</p>
|
|
1073
|
+
* @public
|
|
1074
1074
|
*/
|
|
1075
1075
|
arn: string | undefined;
|
|
1076
1076
|
/**
|
|
1077
|
-
* @public
|
|
1078
1077
|
* <p>The name of the resource that you updated the practice
|
|
1079
1078
|
* run for. </p>
|
|
1079
|
+
* @public
|
|
1080
1080
|
*/
|
|
1081
1081
|
name: string | undefined;
|
|
1082
1082
|
/**
|
|
1083
|
-
* @public
|
|
1084
1083
|
* <p>The zonal autoshift status for the resource that you updated the practice
|
|
1085
1084
|
* run for.</p>
|
|
1085
|
+
* @public
|
|
1086
1086
|
*/
|
|
1087
1087
|
zonalAutoshiftStatus: ZonalAutoshiftStatus | undefined;
|
|
1088
1088
|
/**
|
|
1089
|
-
* @public
|
|
1090
1089
|
* <p>The practice run configuration that was updated.</p>
|
|
1090
|
+
* @public
|
|
1091
1091
|
*/
|
|
1092
1092
|
practiceRunConfiguration: PracticeRunConfiguration | undefined;
|
|
1093
1093
|
}
|
|
@@ -1096,18 +1096,17 @@ export interface UpdatePracticeRunConfigurationResponse {
|
|
|
1096
1096
|
*/
|
|
1097
1097
|
export interface UpdateZonalShiftRequest {
|
|
1098
1098
|
/**
|
|
1099
|
-
* @public
|
|
1100
1099
|
* <p>The identifier of a zonal shift.</p>
|
|
1100
|
+
* @public
|
|
1101
1101
|
*/
|
|
1102
1102
|
zonalShiftId: string | undefined;
|
|
1103
1103
|
/**
|
|
1104
|
-
* @public
|
|
1105
1104
|
* <p>A comment that you enter about the zonal shift. Only the latest comment is retained; no comment
|
|
1106
1105
|
* history is maintained. A new comment overwrites any existing comment string.</p>
|
|
1106
|
+
* @public
|
|
1107
1107
|
*/
|
|
1108
1108
|
comment?: string;
|
|
1109
1109
|
/**
|
|
1110
|
-
* @public
|
|
1111
1110
|
* <p>The length of time that you want a zonal shift to be active, which Route 53 ARC converts to an expiry time (expiration time).
|
|
1112
1111
|
* Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours).</p>
|
|
1113
1112
|
* <p>If you want to still keep traffic away from an Availability Zone, you can update the
|
|
@@ -1125,6 +1124,7 @@ export interface UpdateZonalShiftRequest {
|
|
|
1125
1124
|
* </li>
|
|
1126
1125
|
* </ul>
|
|
1127
1126
|
* <p>For example: <code>20h</code> means the zonal shift expires in 20 hours. <code>120m</code> means the zonal shift expires in 120 minutes (2 hours).</p>
|
|
1127
|
+
* @public
|
|
1128
1128
|
*/
|
|
1129
1129
|
expiresIn?: string;
|
|
1130
1130
|
}
|
|
@@ -1133,19 +1133,18 @@ export interface UpdateZonalShiftRequest {
|
|
|
1133
1133
|
*/
|
|
1134
1134
|
export interface StartZonalShiftRequest {
|
|
1135
1135
|
/**
|
|
1136
|
-
* @public
|
|
1137
1136
|
* <p>The identifier for the resource to shift away traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
1138
1137
|
* <p>At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.</p>
|
|
1138
|
+
* @public
|
|
1139
1139
|
*/
|
|
1140
1140
|
resourceIdentifier: string | undefined;
|
|
1141
1141
|
/**
|
|
1142
|
-
* @public
|
|
1143
1142
|
* <p>The Availability Zone that traffic is moved away from for a resource when you start a zonal shift.
|
|
1144
1143
|
* Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.</p>
|
|
1144
|
+
* @public
|
|
1145
1145
|
*/
|
|
1146
1146
|
awayFrom: string | undefined;
|
|
1147
1147
|
/**
|
|
1148
|
-
* @public
|
|
1149
1148
|
* <p>The length of time that you want a zonal shift to be active, which Route 53 ARC converts to an expiry time (expiration time).
|
|
1150
1149
|
* Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours).</p>
|
|
1151
1150
|
* <p>If you want to still keep traffic away from an Availability Zone, you can update the
|
|
@@ -1163,12 +1162,13 @@ export interface StartZonalShiftRequest {
|
|
|
1163
1162
|
* </li>
|
|
1164
1163
|
* </ul>
|
|
1165
1164
|
* <p>For example: <code>20h</code> means the zonal shift expires in 20 hours. <code>120m</code> means the zonal shift expires in 120 minutes (2 hours).</p>
|
|
1165
|
+
* @public
|
|
1166
1166
|
*/
|
|
1167
1167
|
expiresIn: string | undefined;
|
|
1168
1168
|
/**
|
|
1169
|
-
* @public
|
|
1170
1169
|
* <p>A comment that you enter about the zonal shift. Only the latest comment is retained; no comment
|
|
1171
1170
|
* history is maintained. A new comment overwrites any existing comment string.</p>
|
|
1171
|
+
* @public
|
|
1172
1172
|
*/
|
|
1173
1173
|
comment: string | undefined;
|
|
1174
1174
|
}
|