@aws-sdk/client-arc-zonal-shift 3.839.0 → 3.840.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/README.md +17 -34
- package/dist-cjs/index.js +116 -8
- package/dist-es/ARCZonalShift.js +4 -0
- package/dist-es/commands/CancelPracticeRunCommand.js +22 -0
- package/dist-es/commands/StartPracticeRunCommand.js +22 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +11 -5
- package/dist-es/protocols/Aws_restJson1.js +64 -0
- package/dist-types/ARCZonalShift.d.ts +15 -34
- package/dist-types/ARCZonalShiftClient.d.ts +5 -36
- package/dist-types/commands/CancelPracticeRunCommand.d.ts +96 -0
- package/dist-types/commands/CancelZonalShiftCommand.d.ts +1 -4
- package/dist-types/commands/CreatePracticeRunConfigurationCommand.d.ts +1 -11
- package/dist-types/commands/DeletePracticeRunConfigurationCommand.d.ts +1 -3
- package/dist-types/commands/GetAutoshiftObserverNotificationStatusCommand.d.ts +1 -2
- package/dist-types/commands/GetManagedResourceCommand.d.ts +2 -3
- package/dist-types/commands/ListAutoshiftsCommand.d.ts +1 -4
- package/dist-types/commands/ListManagedResourcesCommand.d.ts +2 -5
- package/dist-types/commands/ListZonalShiftsCommand.d.ts +2 -2
- package/dist-types/commands/StartPracticeRunCommand.d.ts +98 -0
- package/dist-types/commands/StartZonalShiftCommand.d.ts +1 -11
- package/dist-types/commands/UpdateAutoshiftObserverNotificationStatusCommand.d.ts +1 -11
- package/dist-types/commands/UpdatePracticeRunConfigurationCommand.d.ts +1 -3
- package/dist-types/commands/UpdateZonalAutoshiftConfigurationCommand.d.ts +1 -8
- package/dist-types/commands/UpdateZonalShiftCommand.d.ts +1 -2
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/index.d.ts +1 -34
- package/dist-types/models/models_0.d.ts +204 -417
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/dist-types/ts3.4/ARCZonalShift.d.ts +34 -0
- package/dist-types/ts3.4/ARCZonalShiftClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/CancelPracticeRunCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StartPracticeRunCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +40 -8
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
- package/package.json +12 -12
|
@@ -53,9 +53,7 @@ export type AutoshiftExecutionStatus = (typeof AutoshiftExecutionStatus)[keyof t
|
|
|
53
53
|
*/
|
|
54
54
|
export interface ListAutoshiftsRequest {
|
|
55
55
|
/**
|
|
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
|
|
57
|
-
* previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous
|
|
58
|
-
* call's <code>nextToken</code> response to request the next page of results.</p>
|
|
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 previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>nextToken</code> response to request the next page of results.</p>
|
|
59
57
|
* @public
|
|
60
58
|
*/
|
|
61
59
|
nextToken?: string | undefined;
|
|
@@ -71,21 +69,12 @@ export interface ListAutoshiftsRequest {
|
|
|
71
69
|
maxResults?: number | undefined;
|
|
72
70
|
}
|
|
73
71
|
/**
|
|
74
|
-
* <p>Information about an autoshift. Amazon Web Services starts an autoshift to temporarily move traffic for a resource
|
|
75
|
-
* away from an Availability Zone in an Amazon Web Services Region
|
|
76
|
-
* when Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers.
|
|
77
|
-
* You can configure zonal autoshift in ARC for managed resources in your Amazon Web Services account in a Region.
|
|
78
|
-
* Supported Amazon Web Services resources are automatically registered with ARC.</p>
|
|
79
|
-
* <p>Autoshifts are temporary. When the Availability Zone recovers, Amazon Web Services ends the autoshift, and
|
|
80
|
-
* traffic for the resource is no longer directed to the other Availability Zones in the Region.</p>
|
|
72
|
+
* <p>Information about an autoshift. Amazon Web Services starts an autoshift to temporarily move traffic for a resource away from an Availability Zone in an Amazon Web Services Region when Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers. You can configure zonal autoshift in ARC for managed resources in your Amazon Web Services account in a Region. Supported Amazon Web Services resources are automatically registered with ARC.</p> <p>Autoshifts are temporary. When the Availability Zone recovers, Amazon Web Services ends the autoshift, and traffic for the resource is no longer directed to the other Availability Zones in the Region.</p> <p>You can stop an autoshift for a resource by disabling zonal autoshift.</p>
|
|
81
73
|
* @public
|
|
82
74
|
*/
|
|
83
75
|
export interface AutoshiftSummary {
|
|
84
76
|
/**
|
|
85
|
-
* <p>The Availability Zone (for example, <code>use1-az1</code>) that traffic is shifted away from for a resource when Amazon Web Services starts an autoshift.
|
|
86
|
-
* Until the autoshift ends, traffic for the resource is instead directed to other Availability Zones in the Amazon Web Services Region.
|
|
87
|
-
* An autoshift can end for a resource, for example, when Amazon Web Services ends the autoshift for the Availability Zone or when
|
|
88
|
-
* you disable zonal autoshift for the resource.</p>
|
|
77
|
+
* <p>The Availability Zone (for example, <code>use1-az1</code>) that traffic is shifted away from for a resource when Amazon Web Services starts an autoshift. Until the autoshift ends, traffic for the resource is instead directed to other Availability Zones in the Amazon Web Services Region. An autoshift can end for a resource, for example, when Amazon Web Services ends the autoshift for the Availability Zone or when you disable zonal autoshift for the resource.</p>
|
|
89
78
|
* @public
|
|
90
79
|
*/
|
|
91
80
|
awayFrom: string | undefined;
|
|
@@ -115,9 +104,7 @@ export interface ListAutoshiftsResponse {
|
|
|
115
104
|
*/
|
|
116
105
|
items?: AutoshiftSummary[] | undefined;
|
|
117
106
|
/**
|
|
118
|
-
* <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>nextToken</code> response in the
|
|
119
|
-
* previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous
|
|
120
|
-
* call's <code>nextToken</code> response to request the next page of results.</p>
|
|
107
|
+
* <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>nextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>nextToken</code> response to request the next page of results.</p>
|
|
121
108
|
* @public
|
|
122
109
|
*/
|
|
123
110
|
nextToken?: string | undefined;
|
|
@@ -151,6 +138,7 @@ export declare const ValidationExceptionReason: {
|
|
|
151
138
|
readonly INVALID_TOKEN: "InvalidToken";
|
|
152
139
|
readonly MISSING_VALUE: "MissingValue";
|
|
153
140
|
readonly UNSUPPORTED_AZ: "UnsupportedAz";
|
|
141
|
+
readonly UNSUPPORTED_PRACTICE_CANCEL_SHIFT_TYPE: "UnsupportedPracticeCancelShiftType";
|
|
154
142
|
};
|
|
155
143
|
/**
|
|
156
144
|
* @public
|
|
@@ -186,34 +174,17 @@ export declare const AutoshiftAppliedStatus: {
|
|
|
186
174
|
*/
|
|
187
175
|
export type AutoshiftAppliedStatus = (typeof AutoshiftAppliedStatus)[keyof typeof AutoshiftAppliedStatus];
|
|
188
176
|
/**
|
|
189
|
-
* <p>A complex structure that lists an autoshift that is currently active for a managed resource and information about
|
|
190
|
-
* the autoshift.</p>
|
|
191
|
-
* <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
|
-
* and practice runs work</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
177
|
+
* <p>A complex structure that lists an autoshift that is currently active for a managed resource and information about the autoshift.</p> <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 and practice runs work</a> in the Amazon Application Recovery Controller Developer Guide.</p>
|
|
193
178
|
* @public
|
|
194
179
|
*/
|
|
195
180
|
export interface AutoshiftInResource {
|
|
196
181
|
/**
|
|
197
|
-
* <p>The <code>appliedStatus</code> field specifies which application traffic shift is in effect for a
|
|
198
|
-
* resource when there is more than one active traffic shift. There can be more than one application traffic
|
|
199
|
-
* shift in progress at the same time - that is, practice run zonal shifts, customer-initiated zonal shifts,
|
|
200
|
-
* or an autoshift. The <code>appliedStatus</code> field for a shift that is in progress for a resource can
|
|
201
|
-
* have one of two values: <code>APPLIED</code> or <code>NOT_APPLIED</code>. The zonal shift or autoshift
|
|
202
|
-
* that is currently in effect for the resource has an <code>appliedStatus</code> set to <code>APPLIED</code>.</p>
|
|
203
|
-
* <p>The overall principle for precedence is that zonal shifts that you start as a customer take precedence
|
|
204
|
-
* autoshifts, which take precedence over practice runs. That is, customer-initiated zonal shifts > autoshifts > practice run
|
|
205
|
-
* zonal shifts.</p>
|
|
206
|
-
* <p>For more information, see
|
|
207
|
-
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html">How zonal autoshift
|
|
208
|
-
* and practice runs work</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
182
|
+
* <p>The <code>appliedStatus</code> field specifies which application traffic shift is in effect for a resource when there is more than one active traffic shift. There can be more than one application traffic shift in progress at the same time - that is, practice run zonal shifts, customer-initiated zonal shifts, or an autoshift. The <code>appliedStatus</code> field for a shift that is in progress for a resource can have one of two values: <code>APPLIED</code> or <code>NOT_APPLIED</code>. The zonal shift or autoshift that is currently in effect for the resource has an <code>appliedStatus</code> set to <code>APPLIED</code>.</p> <p>The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-initiated zonal shifts > autoshifts > practice run zonal shifts.</p> <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 and practice runs work</a> in the Amazon Application Recovery Controller Developer Guide.</p>
|
|
209
183
|
* @public
|
|
210
184
|
*/
|
|
211
185
|
appliedStatus: AutoshiftAppliedStatus | undefined;
|
|
212
186
|
/**
|
|
213
|
-
* <p>The Availability Zone (for example, <code>use1-az1</code>) that traffic is shifted away from for a resource, when Amazon Web Services starts an autoshift.
|
|
214
|
-
* Until the autoshift ends, traffic for the resource is instead directed to other Availability Zones in the Amazon Web Services Region.
|
|
215
|
-
* An autoshift can end for a resource, for example, when Amazon Web Services ends the autoshift for the Availability Zone or when
|
|
216
|
-
* you disable zonal autoshift for the resource.</p>
|
|
187
|
+
* <p>The Availability Zone (for example, <code>use1-az1</code>) that traffic is shifted away from for a resource, when Amazon Web Services starts an autoshift. Until the autoshift ends, traffic for the resource is instead directed to other Availability Zones in the Amazon Web Services Region. An autoshift can end for a resource, for example, when Amazon Web Services ends the autoshift for the Availability Zone or when you disable zonal autoshift for the resource.</p>
|
|
217
188
|
* @public
|
|
218
189
|
*/
|
|
219
190
|
awayFrom: string | undefined;
|
|
@@ -245,11 +216,7 @@ export type AutoshiftObserverNotificationStatus = (typeof AutoshiftObserverNotif
|
|
|
245
216
|
*/
|
|
246
217
|
export interface GetAutoshiftObserverNotificationStatusResponse {
|
|
247
218
|
/**
|
|
248
|
-
* <p>The status of autoshift observer notification. If the status is <code>ENABLED</code>,
|
|
249
|
-
* ARC includes all autoshift events when you use the Amazon EventBridge pattern
|
|
250
|
-
* <code>Autoshift In Progress</code>. When the status is <code>DISABLED</code>,
|
|
251
|
-
* ARC includes only autoshift events for autoshifts when one or more of your
|
|
252
|
-
* resources is included in the autoshift. </p>
|
|
219
|
+
* <p>The status of autoshift observer notification. If the status is <code>ENABLED</code>, ARC includes all autoshift events when you use the Amazon EventBridge pattern <code>Autoshift In Progress</code>. When the status is <code>DISABLED</code>, ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift. </p>
|
|
253
220
|
* @public
|
|
254
221
|
*/
|
|
255
222
|
status: AutoshiftObserverNotificationStatus | undefined;
|
|
@@ -259,11 +226,7 @@ export interface GetAutoshiftObserverNotificationStatusResponse {
|
|
|
259
226
|
*/
|
|
260
227
|
export interface UpdateAutoshiftObserverNotificationStatusRequest {
|
|
261
228
|
/**
|
|
262
|
-
* <p>The status to set for autoshift observer notification. If the status is <code>ENABLED</code>,
|
|
263
|
-
* ARC includes all autoshift events when you use the Amazon EventBridge pattern
|
|
264
|
-
* <code>Autoshift In Progress</code>. When the status is <code>DISABLED</code>,
|
|
265
|
-
* ARC includes only autoshift events for autoshifts when one or more of your
|
|
266
|
-
* resources is included in the autoshift. </p>
|
|
229
|
+
* <p>The status to set for autoshift observer notification. If the status is <code>ENABLED</code>, ARC includes all autoshift events when you use the Amazon EventBridge pattern <code>Autoshift In Progress</code>. When the status is <code>DISABLED</code>, ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift. </p>
|
|
267
230
|
* @public
|
|
268
231
|
*/
|
|
269
232
|
status: AutoshiftObserverNotificationStatus | undefined;
|
|
@@ -281,21 +244,78 @@ export interface UpdateAutoshiftObserverNotificationStatusResponse {
|
|
|
281
244
|
/**
|
|
282
245
|
* @public
|
|
283
246
|
*/
|
|
284
|
-
export interface
|
|
247
|
+
export interface CancelPracticeRunRequest {
|
|
285
248
|
/**
|
|
286
|
-
* <p>The
|
|
249
|
+
* <p>The identifier of a practice run zonal shift in Amazon Application Recovery Controller that you want to cancel.</p>
|
|
287
250
|
* @public
|
|
288
251
|
*/
|
|
289
252
|
zonalShiftId: string | undefined;
|
|
290
253
|
}
|
|
254
|
+
/**
|
|
255
|
+
* @public
|
|
256
|
+
* @enum
|
|
257
|
+
*/
|
|
258
|
+
export declare const ZonalShiftStatus: {
|
|
259
|
+
readonly ACTIVE: "ACTIVE";
|
|
260
|
+
readonly CANCELED: "CANCELED";
|
|
261
|
+
readonly EXPIRED: "EXPIRED";
|
|
262
|
+
};
|
|
263
|
+
/**
|
|
264
|
+
* @public
|
|
265
|
+
*/
|
|
266
|
+
export type ZonalShiftStatus = (typeof ZonalShiftStatus)[keyof typeof ZonalShiftStatus];
|
|
267
|
+
/**
|
|
268
|
+
* @public
|
|
269
|
+
*/
|
|
270
|
+
export interface CancelPracticeRunResponse {
|
|
271
|
+
/**
|
|
272
|
+
* <p>The identifier of the practice run zonal shift in Amazon Application Recovery Controller that was canceled.</p>
|
|
273
|
+
* @public
|
|
274
|
+
*/
|
|
275
|
+
zonalShiftId: string | undefined;
|
|
276
|
+
/**
|
|
277
|
+
* <p>The identifier for the resource that you canceled a practice run zonal shift for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
278
|
+
* @public
|
|
279
|
+
*/
|
|
280
|
+
resourceIdentifier: string | undefined;
|
|
281
|
+
/**
|
|
282
|
+
* <p>The Availability Zone (for example, <code>use1-az1</code>) that traffic was moved away from for a resource that you specified for the practice run.</p>
|
|
283
|
+
* @public
|
|
284
|
+
*/
|
|
285
|
+
awayFrom: string | undefined;
|
|
286
|
+
/**
|
|
287
|
+
* <p>The expiry time (expiration time) for an on-demand practice run zonal shift is 30 minutes from the time when you start the practice run, unless you cancel it before that time. However, be aware that the <code>expiryTime</code> field for practice run zonal shifts always has a value of 1 minute. </p>
|
|
288
|
+
* @public
|
|
289
|
+
*/
|
|
290
|
+
expiryTime: Date | undefined;
|
|
291
|
+
/**
|
|
292
|
+
* <p>The time (UTC) when the zonal shift starts.</p>
|
|
293
|
+
* @public
|
|
294
|
+
*/
|
|
295
|
+
startTime: Date | undefined;
|
|
296
|
+
/**
|
|
297
|
+
* <p>A status for the practice run that you canceled (expected status is <b>CANCELED</b>).</p> <p>The <code>Status</code> for a practice run zonal shift can have one of the following values:</p>
|
|
298
|
+
* @public
|
|
299
|
+
*/
|
|
300
|
+
status: ZonalShiftStatus | undefined;
|
|
301
|
+
/**
|
|
302
|
+
* <p>The initial comment that you entered about the practice run. Be aware that this comment can be overwritten by Amazon Web Services if the automatic check for balanced capacity fails. For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.capacity-check.html"> Capacity checks for practice runs</a> in the Amazon Application Recovery Controller Developer Guide. </p>
|
|
303
|
+
* @public
|
|
304
|
+
*/
|
|
305
|
+
comment: string | undefined;
|
|
306
|
+
}
|
|
291
307
|
/**
|
|
292
308
|
* @public
|
|
293
309
|
* @enum
|
|
294
310
|
*/
|
|
295
311
|
export declare const ConflictExceptionReason: {
|
|
296
312
|
readonly AUTOSHIFT_ENABLED: "AutoShiftEnabled";
|
|
313
|
+
readonly PRACTICE_BLOCKING_ALARMS_RED: "PracticeBlockingAlarmsRed";
|
|
297
314
|
readonly PRACTICE_CONFIGURATION_ALREADY_EXISTS: "PracticeConfigurationAlreadyExists";
|
|
298
315
|
readonly PRACTICE_CONFIGURATION_DOES_NOT_EXIST: "PracticeConfigurationDoesNotExist";
|
|
316
|
+
readonly PRACTICE_IN_BLOCKED_DATES: "PracticeInBlockedDates";
|
|
317
|
+
readonly PRACTICE_IN_BLOCKED_WINDOWS: "PracticeInBlockedWindows";
|
|
318
|
+
readonly PRACTICE_OUTCOME_ALARMS_RED: "PracticeOutcomeAlarmsRed";
|
|
299
319
|
readonly SIMULTANEOUS_ZONAL_SHIFTS_CONFLICT: "SimultaneousZonalShiftsConflict";
|
|
300
320
|
readonly ZONAL_AUTOSHIFT_ACTIVE: "ZonalAutoshiftActive";
|
|
301
321
|
readonly ZONAL_SHIFT_ALREADY_EXISTS: "ZonalShiftAlreadyExists";
|
|
@@ -339,19 +359,16 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
339
359
|
*/
|
|
340
360
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
341
361
|
}
|
|
342
|
-
/**
|
|
343
|
-
* @public
|
|
344
|
-
* @enum
|
|
345
|
-
*/
|
|
346
|
-
export declare const ZonalShiftStatus: {
|
|
347
|
-
readonly ACTIVE: "ACTIVE";
|
|
348
|
-
readonly CANCELED: "CANCELED";
|
|
349
|
-
readonly EXPIRED: "EXPIRED";
|
|
350
|
-
};
|
|
351
362
|
/**
|
|
352
363
|
* @public
|
|
353
364
|
*/
|
|
354
|
-
export
|
|
365
|
+
export interface CancelZonalShiftRequest {
|
|
366
|
+
/**
|
|
367
|
+
* <p>The internally-generated identifier of a zonal shift.</p>
|
|
368
|
+
* @public
|
|
369
|
+
*/
|
|
370
|
+
zonalShiftId: string | undefined;
|
|
371
|
+
}
|
|
355
372
|
/**
|
|
356
373
|
* @public
|
|
357
374
|
*/
|
|
@@ -362,24 +379,17 @@ export interface ZonalShift {
|
|
|
362
379
|
*/
|
|
363
380
|
zonalShiftId: string | undefined;
|
|
364
381
|
/**
|
|
365
|
-
* <p>The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
366
|
-
* <p>At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.</p>
|
|
382
|
+
* <p>The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.</p> <p>Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html">Amazon EC2 Auto Scaling groups</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html">Amazon Elastic Kubernetes Service</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html">Application Load Balancer</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html">Network Load Balancer</a> </p> </li> </ul>
|
|
367
383
|
* @public
|
|
368
384
|
*/
|
|
369
385
|
resourceIdentifier: string | undefined;
|
|
370
386
|
/**
|
|
371
|
-
* <p>The Availability Zone (for example, <code>use1-az1</code>) that traffic is moved away from for a resource when you start a zonal shift.
|
|
372
|
-
* 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>
|
|
387
|
+
* <p>The Availability Zone (for example, <code>use1-az1</code>) that traffic is moved away from for a resource when you start a zonal shift. 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>
|
|
373
388
|
* @public
|
|
374
389
|
*/
|
|
375
390
|
awayFrom: string | undefined;
|
|
376
391
|
/**
|
|
377
|
-
* <p>The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift.
|
|
378
|
-
* You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift
|
|
379
|
-
* to set a new expiration at any time. </p>
|
|
380
|
-
* <p>When you start a zonal shift, you specify how long you want it to be active, which ARC converts
|
|
381
|
-
* to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or
|
|
382
|
-
* just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.</p>
|
|
392
|
+
* <p>The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time. </p> <p>When you start a zonal shift, you specify how long you want it to be active, which ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.</p>
|
|
383
393
|
* @public
|
|
384
394
|
*/
|
|
385
395
|
expiryTime: Date | undefined;
|
|
@@ -389,28 +399,12 @@ export interface ZonalShift {
|
|
|
389
399
|
*/
|
|
390
400
|
startTime: Date | undefined;
|
|
391
401
|
/**
|
|
392
|
-
* <p>A status for a zonal shift.</p>
|
|
393
|
-
* <p>The <code>Status</code> for a zonal shift can have one of the following values:</p>
|
|
394
|
-
* <ul>
|
|
395
|
-
* <li>
|
|
396
|
-
* <p>
|
|
397
|
-
* <b>ACTIVE:</b> The zonal shift has been started and active.</p>
|
|
398
|
-
* </li>
|
|
399
|
-
* <li>
|
|
400
|
-
* <p>
|
|
401
|
-
* <b>EXPIRED:</b> The zonal shift has expired (the expiry time was exceeded).</p>
|
|
402
|
-
* </li>
|
|
403
|
-
* <li>
|
|
404
|
-
* <p>
|
|
405
|
-
* <b>CANCELED:</b> The zonal shift was canceled.</p>
|
|
406
|
-
* </li>
|
|
407
|
-
* </ul>
|
|
402
|
+
* <p>A status for a zonal shift.</p> <p>The <code>Status</code> for a zonal shift can have one of the following values:</p> <ul> <li> <p> <b>ACTIVE:</b> The zonal shift has been started and is active.</p> </li> <li> <p> <b>EXPIRED:</b> The zonal shift has expired (the expiry time was exceeded).</p> </li> <li> <p> <b>CANCELED:</b> The zonal shift was canceled.</p> </li> </ul>
|
|
408
403
|
* @public
|
|
409
404
|
*/
|
|
410
405
|
status: ZonalShiftStatus | undefined;
|
|
411
406
|
/**
|
|
412
|
-
* <p>A comment that you enter about the zonal shift. Only the latest comment is retained; no comment
|
|
413
|
-
* history is maintained. A new comment overwrites any existing comment string.</p>
|
|
407
|
+
* <p>A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.</p>
|
|
414
408
|
* @public
|
|
415
409
|
*/
|
|
416
410
|
comment: string | undefined;
|
|
@@ -427,22 +421,12 @@ export declare const ControlConditionType: {
|
|
|
427
421
|
*/
|
|
428
422
|
export type ControlConditionType = (typeof ControlConditionType)[keyof typeof ControlConditionType];
|
|
429
423
|
/**
|
|
430
|
-
* <p>A control condition is an alarm that you specify for a practice run. When you configure practice runs
|
|
431
|
-
* with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch
|
|
432
|
-
* to use with the practice run. The alarms that you specify are an
|
|
433
|
-
* <i>outcome alarm</i>, to monitor application health during practice runs and,
|
|
434
|
-
* optionally, a <i>blocking alarm</i>, to block practice runs from starting or to interrupt
|
|
435
|
-
* a practice run in progress.</p>
|
|
436
|
-
* <p>Control condition alarms do not apply for autoshifts.</p>
|
|
437
|
-
* <p>For more information, see
|
|
438
|
-
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html">
|
|
439
|
-
* Considerations when you configure zonal autoshift</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
424
|
+
* <p>A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. The alarms that you specify are an <i>outcome alarm</i>, to monitor application health during practice runs and, optionally, a <i>blocking alarm</i>, to block practice runs from starting or to interrupt a practice run in progress.</p> <p>Control condition alarms do not apply for autoshifts.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html"> Considerations when you configure zonal autoshift</a> in the Amazon Application Recovery Controller Developer Guide.</p>
|
|
440
425
|
* @public
|
|
441
426
|
*/
|
|
442
427
|
export interface ControlCondition {
|
|
443
428
|
/**
|
|
444
|
-
* <p>The type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the
|
|
445
|
-
* only valid value is <code>CLOUDWATCH</code>.</p>
|
|
429
|
+
* <p>The type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the only valid value is <code>CLOUDWATCH</code>.</p>
|
|
446
430
|
* @public
|
|
447
431
|
*/
|
|
448
432
|
type: ControlConditionType | undefined;
|
|
@@ -457,93 +441,53 @@ export interface ControlCondition {
|
|
|
457
441
|
*/
|
|
458
442
|
export interface CreatePracticeRunConfigurationRequest {
|
|
459
443
|
/**
|
|
460
|
-
* <p>The identifier of the resource that Amazon Web Services shifts traffic for with a practice
|
|
461
|
-
* run zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
462
|
-
* <p>At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.</p>
|
|
444
|
+
* <p>The identifier of the resource that Amazon Web Services shifts traffic for with a practice run zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.</p> <p>Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html">Amazon EC2 Auto Scaling groups</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html">Amazon Elastic Kubernetes Service</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html">Application Load Balancer</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html">Network Load Balancer</a> </p> </li> </ul>
|
|
463
445
|
* @public
|
|
464
446
|
*/
|
|
465
447
|
resourceIdentifier: string | undefined;
|
|
466
448
|
/**
|
|
467
|
-
* <p>Optionally, you can block ARC from starting practice runs for specific windows of
|
|
468
|
-
* days and times. </p>
|
|
469
|
-
* <p>The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates,
|
|
470
|
-
* that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments
|
|
471
|
-
* that might be required for daylight saving time differences. Separate multiple blocked windows
|
|
472
|
-
* with spaces.</p>
|
|
473
|
-
* <p>For example, say you run business report summaries three days a week. For
|
|
474
|
-
* this scenario, you might set the following recurring days and times as blocked windows,
|
|
475
|
-
* for example: <code>MON-20:30-21:30 WED-20:30-21:30
|
|
476
|
-
* FRI-20:30-21:30</code>.</p>
|
|
449
|
+
* <p>Optionally, you can block ARC from starting practice runs for specific windows of days and times. </p> <p>The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces.</p> <p>For example, say you run business report summaries three days a week. For this scenario, you might set the following recurring days and times as blocked windows, for example: <code>MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30</code>.</p>
|
|
477
450
|
* @public
|
|
478
451
|
*/
|
|
479
452
|
blockedWindows?: string[] | undefined;
|
|
480
453
|
/**
|
|
481
|
-
* <p>Optionally, you can block ARC from starting practice runs for a resource
|
|
482
|
-
* on specific calendar dates.</p>
|
|
483
|
-
* <p>The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates,
|
|
484
|
-
* that dates and times for practice runs are in UTC. Separate multiple blocked
|
|
485
|
-
* dates with spaces.</p>
|
|
486
|
-
* <p>For example, if you have an application update scheduled to launch on May 1, 2024, and
|
|
487
|
-
* you don't want practice runs to shift traffic away at that time, you could set a blocked date
|
|
488
|
-
* for <code>2024-05-01</code>.</p>
|
|
454
|
+
* <p>Optionally, you can block ARC from starting practice runs for a resource on specific calendar dates.</p> <p>The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces.</p> <p>For example, if you have an application update scheduled to launch on May 1, 2024, and you don't want practice runs to shift traffic away at that time, you could set a blocked date for <code>2024-05-01</code>.</p>
|
|
489
455
|
* @public
|
|
490
456
|
*/
|
|
491
457
|
blockedDates?: string[] | undefined;
|
|
492
458
|
/**
|
|
493
|
-
* <p>An Amazon CloudWatch alarm that you can specify for zonal autoshift
|
|
494
|
-
* practice runs. This alarm blocks ARC from starting practice run zonal
|
|
495
|
-
* shifts, and ends a practice run that's in progress, when the alarm is in
|
|
496
|
-
* an <code>ALARM</code> state. </p>
|
|
459
|
+
* <p>An Amazon CloudWatch alarm that you can specify for zonal autoshift practice runs. This alarm blocks ARC from starting practice run zonal shifts, and ends a practice run that's in progress, when the alarm is in an <code>ALARM</code> state. </p>
|
|
497
460
|
* @public
|
|
498
461
|
*/
|
|
499
462
|
blockingAlarms?: ControlCondition[] | undefined;
|
|
500
463
|
/**
|
|
501
|
-
* <p>The <i>outcome alarm</i> for practice runs is a required
|
|
502
|
-
* Amazon CloudWatch alarm that you specify that ends a practice run when the
|
|
503
|
-
* alarm is in an <code>ALARM</code> state.</p>
|
|
504
|
-
* <p>Configure the alarm to monitor the health of your application
|
|
505
|
-
* when traffic is shifted away from an Availability Zone during each
|
|
506
|
-
* practice run. You should configure the alarm to go into an <code>ALARM</code> state
|
|
507
|
-
* if your application is impacted by the zonal shift, and you want to stop the
|
|
508
|
-
* zonal shift, to let traffic for the resource return to the Availability Zone.</p>
|
|
464
|
+
* <p>The <i>outcome alarm</i> for practice runs is a required Amazon CloudWatch alarm that you specify that ends a practice run when the alarm is in an <code>ALARM</code> state.</p> <p>Configure the alarm to monitor the health of your application when traffic is shifted away from an Availability Zone during each practice run. You should configure the alarm to go into an <code>ALARM</code> state if your application is impacted by the zonal shift, and you want to stop the zonal shift, to let traffic for the resource return to the Availability Zone.</p>
|
|
509
465
|
* @public
|
|
510
466
|
*/
|
|
511
467
|
outcomeAlarms: ControlCondition[] | undefined;
|
|
512
468
|
}
|
|
513
469
|
/**
|
|
514
|
-
* <p>A practice run configuration for a resource includes the Amazon CloudWatch alarms that you've specified for a practice
|
|
515
|
-
* run, as well as any blocked dates or blocked windows for the practice run. When a resource has a practice run
|
|
516
|
-
* configuration, ARC shifts traffic for the resource weekly for practice runs.</p>
|
|
517
|
-
* <p>Practice runs are required for zonal autoshift. The zonal shifts that ARC starts for practice runs help you to ensure that
|
|
518
|
-
* shifting away traffic from an Availability Zone during an autoshift is safe for your application.</p>
|
|
519
|
-
* <p>You can update or delete a practice run configuration. Before you delete a practice run configuration, you
|
|
520
|
-
* must disable zonal autoshift for the resource. A practice run configuration is required when zonal autoshift is enabled.</p>
|
|
470
|
+
* <p>A practice run configuration for a resource includes the Amazon CloudWatch alarms that you've specified for a practice run, as well as any blocked dates or blocked windows for the practice run. When a resource has a practice run configuration, ARC shifts traffic for the resource weekly for practice runs.</p> <p>Practice runs are required for zonal autoshift. The zonal shifts that ARC starts for practice runs help you to ensure that shifting away traffic from an Availability Zone during an autoshift is safe for your application.</p> <p>You can update or delete a practice run configuration. Before you delete a practice run configuration, you must disable zonal autoshift for the resource. A practice run configuration is required when zonal autoshift is enabled.</p>
|
|
521
471
|
* @public
|
|
522
472
|
*/
|
|
523
473
|
export interface PracticeRunConfiguration {
|
|
524
474
|
/**
|
|
525
|
-
* <p>The <i>blocking alarm</i> for practice runs is an optional alarm that you can
|
|
526
|
-
* specify that blocks practice runs when the alarm is in an <code>ALARM</code> state.</p>
|
|
475
|
+
* <p>The <i>blocking alarm</i> for practice runs is an optional alarm that you can specify that blocks practice runs when the alarm is in an <code>ALARM</code> state.</p>
|
|
527
476
|
* @public
|
|
528
477
|
*/
|
|
529
478
|
blockingAlarms?: ControlCondition[] | undefined;
|
|
530
479
|
/**
|
|
531
|
-
* <p>The <i>outcome alarm</i> for practice runs is an alarm that you specify that
|
|
532
|
-
* ends a practice run when the alarm is in an <code>ALARM</code> state.</p>
|
|
480
|
+
* <p>The <i>outcome alarm</i> for practice runs is an alarm that you specify that ends a practice run when the alarm is in an <code>ALARM</code> state.</p>
|
|
533
481
|
* @public
|
|
534
482
|
*/
|
|
535
483
|
outcomeAlarms: ControlCondition[] | undefined;
|
|
536
484
|
/**
|
|
537
|
-
* <p>An array of one or more windows of days and times that you can block ARC
|
|
538
|
-
* from starting practice runs for a resource.</p>
|
|
539
|
-
* <p>Specify the blocked windows in UTC, using the format <code>DAY:HH:MM-DAY:HH:MM</code>, separated by
|
|
540
|
-
* spaces. For example, <code>MON:18:30-MON:19:30 TUE:18:30-TUE:19:30</code>.</p>
|
|
485
|
+
* <p>An array of one or more windows of days and times that you can block ARC from starting practice runs for a resource.</p> <p>Specify the blocked windows in UTC, using the format <code>DAY:HH:MM-DAY:HH:MM</code>, separated by spaces. For example, <code>MON:18:30-MON:19:30 TUE:18:30-TUE:19:30</code>.</p>
|
|
541
486
|
* @public
|
|
542
487
|
*/
|
|
543
488
|
blockedWindows?: string[] | undefined;
|
|
544
489
|
/**
|
|
545
|
-
* <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>
|
|
546
|
-
* <p>Specify blocked dates, in UTC, in the format <code>YYYY-MM-DD</code>, separated by spaces. </p>
|
|
490
|
+
* <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> <p>Specify blocked dates, in UTC, in the format <code>YYYY-MM-DD</code>, separated by spaces. </p>
|
|
547
491
|
* @public
|
|
548
492
|
*/
|
|
549
493
|
blockedDates?: string[] | undefined;
|
|
@@ -565,31 +509,22 @@ export type ZonalAutoshiftStatus = (typeof ZonalAutoshiftStatus)[keyof typeof Zo
|
|
|
565
509
|
*/
|
|
566
510
|
export interface CreatePracticeRunConfigurationResponse {
|
|
567
511
|
/**
|
|
568
|
-
* <p>The Amazon Resource Name (ARN) of the resource that you configured
|
|
569
|
-
* run for.</p>
|
|
512
|
+
* <p>The Amazon Resource Name (ARN) of the resource that you configured the practice run for.</p>
|
|
570
513
|
* @public
|
|
571
514
|
*/
|
|
572
515
|
arn: string | undefined;
|
|
573
516
|
/**
|
|
574
|
-
* <p>The name of the resource that you configured
|
|
517
|
+
* <p>The name of the resource that you configured the practice run for. </p>
|
|
575
518
|
* @public
|
|
576
519
|
*/
|
|
577
520
|
name: string | undefined;
|
|
578
521
|
/**
|
|
579
|
-
* <p>The status for zonal autoshift for a resource. When you specify <code>ENABLED</code>
|
|
580
|
-
* for the autoshift status, Amazon Web Services shifts traffic
|
|
581
|
-
* away from shifts away application resource traffic from an Availability Zone,
|
|
582
|
-
* on your behalf, when internal telemetry indicates that there is an Availability
|
|
583
|
-
* Zone impairment that could potentially impact customers.</p>
|
|
584
|
-
* <p>When you enable zonal autoshift, you must also configure practice runs for
|
|
585
|
-
* the resource.</p>
|
|
522
|
+
* <p>The status for zonal autoshift for a resource. When you specify <code>ENABLED</code> for the autoshift status, Amazon Web Services shifts traffic away from shifts away application resource traffic from an Availability Zone, on your behalf, when internal telemetry indicates that there is an Availability Zone impairment that could potentially impact customers.</p> <p>When you enable zonal autoshift, you must also configure practice runs for the resource.</p>
|
|
586
523
|
* @public
|
|
587
524
|
*/
|
|
588
525
|
zonalAutoshiftStatus: ZonalAutoshiftStatus | undefined;
|
|
589
526
|
/**
|
|
590
|
-
* <p>A practice run configuration for a resource. Configurations include the
|
|
591
|
-
* outcome alarm that you specify for practice runs, and, optionally, a
|
|
592
|
-
* blocking alarm and blocking dates and windows.</p>
|
|
527
|
+
* <p>A practice run configuration for a resource. Configurations include the outcome alarm that you specify for practice runs, and, optionally, a blocking alarm and blocking dates and windows.</p>
|
|
593
528
|
* @public
|
|
594
529
|
*/
|
|
595
530
|
practiceRunConfiguration: PracticeRunConfiguration | undefined;
|
|
@@ -599,8 +534,7 @@ export interface CreatePracticeRunConfigurationResponse {
|
|
|
599
534
|
*/
|
|
600
535
|
export interface DeletePracticeRunConfigurationRequest {
|
|
601
536
|
/**
|
|
602
|
-
* <p>The identifier for the resource that you want to delete the practice
|
|
603
|
-
* run configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
537
|
+
* <p>The identifier for the resource that you want to delete the practice run configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
604
538
|
* @public
|
|
605
539
|
*/
|
|
606
540
|
resourceIdentifier: string | undefined;
|
|
@@ -610,14 +544,12 @@ export interface DeletePracticeRunConfigurationRequest {
|
|
|
610
544
|
*/
|
|
611
545
|
export interface DeletePracticeRunConfigurationResponse {
|
|
612
546
|
/**
|
|
613
|
-
* <p>The Amazon Resource Name (ARN) of the resource that you deleted the practice
|
|
614
|
-
* run for.</p>
|
|
547
|
+
* <p>The Amazon Resource Name (ARN) of the resource that you deleted the practice run for.</p>
|
|
615
548
|
* @public
|
|
616
549
|
*/
|
|
617
550
|
arn: string | undefined;
|
|
618
551
|
/**
|
|
619
|
-
* <p>The name of the resource that you deleted the practice
|
|
620
|
-
* run for. </p>
|
|
552
|
+
* <p>The name of the resource that you deleted the practice run for. </p>
|
|
621
553
|
* @public
|
|
622
554
|
*/
|
|
623
555
|
name: string | undefined;
|
|
@@ -632,8 +564,7 @@ export interface DeletePracticeRunConfigurationResponse {
|
|
|
632
564
|
*/
|
|
633
565
|
export interface GetManagedResourceRequest {
|
|
634
566
|
/**
|
|
635
|
-
* <p>The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
636
|
-
* <p>At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.</p>
|
|
567
|
+
* <p>The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.</p> <p>Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html">Amazon EC2 Auto Scaling groups</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html">Amazon Elastic Kubernetes Service</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html">Application Load Balancer</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html">Network Load Balancer</a> </p> </li> </ul>
|
|
637
568
|
* @public
|
|
638
569
|
*/
|
|
639
570
|
resourceIdentifier: string | undefined;
|
|
@@ -643,6 +574,7 @@ export interface GetManagedResourceRequest {
|
|
|
643
574
|
* @enum
|
|
644
575
|
*/
|
|
645
576
|
export declare const PracticeRunOutcome: {
|
|
577
|
+
readonly CAPACITY_CHECK_FAILED: "CAPACITY_CHECK_FAILED";
|
|
646
578
|
readonly FAILED: "FAILED";
|
|
647
579
|
readonly INTERRUPTED: "INTERRUPTED";
|
|
648
580
|
readonly PENDING: "PENDING";
|
|
@@ -672,18 +604,7 @@ export type ShiftType = (typeof ShiftType)[keyof typeof ShiftType];
|
|
|
672
604
|
*/
|
|
673
605
|
export interface ZonalShiftInResource {
|
|
674
606
|
/**
|
|
675
|
-
* <p>The <code>appliedStatus</code> field specifies which application traffic shift is in effect for a
|
|
676
|
-
* resource when there is more than one active traffic shift. There can be more than one application traffic
|
|
677
|
-
* shift in progress at the same time - that is, practice run zonal shifts, customer-initiated zonal shifts,
|
|
678
|
-
* or an autoshift. The <code>appliedStatus</code> field for a shift that is in progress for a resource can
|
|
679
|
-
* have one of two values: <code>APPLIED</code> or <code>NOT_APPLIED</code>. The zonal shift or autoshift
|
|
680
|
-
* that is currently in effect for the resource has an <code>appliedStatus</code> set to <code>APPLIED</code>.</p>
|
|
681
|
-
* <p>The overall principle for precedence is that zonal shifts that you start as a customer take precedence
|
|
682
|
-
* autoshifts, which take precedence over practice runs. That is, customer-initiated zonal shifts > autoshifts > practice run
|
|
683
|
-
* zonal shifts.</p>
|
|
684
|
-
* <p>For more information, see
|
|
685
|
-
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html">How zonal autoshift
|
|
686
|
-
* and practice runs work</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
607
|
+
* <p>The <code>appliedStatus</code> field specifies which application traffic shift is in effect for a resource when there is more than one active traffic shift. There can be more than one application traffic shift in progress at the same time - that is, practice run zonal shifts, customer-initiated zonal shifts, or an autoshift. The <code>appliedStatus</code> field for a shift that is in progress for a resource can have one of two values: <code>APPLIED</code> or <code>NOT_APPLIED</code>. The zonal shift or autoshift that is currently in effect for the resource has an <code>appliedStatus</code> set to <code>APPLIED</code>.</p> <p>The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-initiated zonal shifts > autoshifts > practice run zonal shifts.</p> <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 and practice runs work</a> in the Amazon Application Recovery Controller Developer Guide.</p>
|
|
687
608
|
* @public
|
|
688
609
|
*/
|
|
689
610
|
appliedStatus: AppliedStatus | undefined;
|
|
@@ -693,24 +614,17 @@ export interface ZonalShiftInResource {
|
|
|
693
614
|
*/
|
|
694
615
|
zonalShiftId: string | undefined;
|
|
695
616
|
/**
|
|
696
|
-
* <p>The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
697
|
-
* <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>
|
|
617
|
+
* <p>The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.</p> <p>Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html">Amazon EC2 Auto Scaling groups</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html">Amazon Elastic Kubernetes Service</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html">Application Load Balancer</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html">Network Load Balancer</a> </p> </li> </ul>
|
|
698
618
|
* @public
|
|
699
619
|
*/
|
|
700
620
|
resourceIdentifier: string | undefined;
|
|
701
621
|
/**
|
|
702
|
-
* <p>The Availability Zone (for example, <code>use1-az1</code>) that traffic is moved away from for a resource when you start a zonal shift.
|
|
703
|
-
* 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>
|
|
622
|
+
* <p>The Availability Zone (for example, <code>use1-az1</code>) that traffic is moved away from for a resource when you start a zonal shift. 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>
|
|
704
623
|
* @public
|
|
705
624
|
*/
|
|
706
625
|
awayFrom: string | undefined;
|
|
707
626
|
/**
|
|
708
|
-
* <p>The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift.
|
|
709
|
-
* You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift
|
|
710
|
-
* to set a new expiration at any time. </p>
|
|
711
|
-
* <p>When you start a zonal shift, you specify how long you want it to be active, which ARC converts
|
|
712
|
-
* to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or
|
|
713
|
-
* just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.</p>
|
|
627
|
+
* <p>The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time. </p> <p>When you start a zonal shift, you specify how long you want it to be active, which ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.</p>
|
|
714
628
|
* @public
|
|
715
629
|
*/
|
|
716
630
|
expiryTime: Date | undefined;
|
|
@@ -720,8 +634,7 @@ export interface ZonalShiftInResource {
|
|
|
720
634
|
*/
|
|
721
635
|
startTime: Date | undefined;
|
|
722
636
|
/**
|
|
723
|
-
* <p>A comment that you enter for a customer-initiated zonal shift. Only the latest comment is retained; no comment
|
|
724
|
-
* history is maintained. That is, a new comment overwrites any existing comment string.</p>
|
|
637
|
+
* <p>A comment that you enter for a customer-initiated zonal shift. Only the latest comment is retained; no comment history is maintained. That is, a new comment overwrites any existing comment string.</p>
|
|
725
638
|
* @public
|
|
726
639
|
*/
|
|
727
640
|
comment: string | undefined;
|
|
@@ -731,33 +644,7 @@ export interface ZonalShiftInResource {
|
|
|
731
644
|
*/
|
|
732
645
|
shiftType?: ShiftType | undefined;
|
|
733
646
|
/**
|
|
734
|
-
* <p>The outcome, or end state, returned for a practice run. The following values can be returned:</p>
|
|
735
|
-
* <ul>
|
|
736
|
-
* <li>
|
|
737
|
-
* <p>
|
|
738
|
-
* <b>PENDING:</b> Outcome value when a practice run is in progress.</p>
|
|
739
|
-
* </li>
|
|
740
|
-
* <li>
|
|
741
|
-
* <p>
|
|
742
|
-
* <b>SUCCEEDED:</b> Outcome value when the outcome alarm specified for
|
|
743
|
-
* the practice run configuration does not go into an <code>ALARM</code> state during the practice run, and the practice run
|
|
744
|
-
* was not interrupted before it completed the expected 30 minute zonal shift.</p>
|
|
745
|
-
* </li>
|
|
746
|
-
* <li>
|
|
747
|
-
* <p>
|
|
748
|
-
* <b>INTERRUPTED:</b> Outcome value when the practice run was stopped before the
|
|
749
|
-
* expected 30 minute zonal shift duration, or there was another problem with the practice run that created an inconclusive outcome.</p>
|
|
750
|
-
* </li>
|
|
751
|
-
* <li>
|
|
752
|
-
* <p>
|
|
753
|
-
* <b>FAILED:</b> Outcome value when the outcome alarm specified for
|
|
754
|
-
* the practice run configuration goes into an <code>ALARM</code> state during the practice run, and the practice run
|
|
755
|
-
* was not interrupted before it completed.</p>
|
|
756
|
-
* </li>
|
|
757
|
-
* </ul>
|
|
758
|
-
* <p>For more information about practice run outcomes, see
|
|
759
|
-
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.configure.html">
|
|
760
|
-
* Considerations when you configure zonal autoshift</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
647
|
+
* <p>The outcome, or end state, returned for a practice run. The following values can be returned:</p> <ul> <li> <p> <b>PENDING:</b> Outcome value when a practice run is in progress.</p> </li> <li> <p> <b>SUCCEEDED:</b> Outcome value when the outcome alarm specified for the practice run configuration does not go into an <code>ALARM</code> state during the practice run, and the practice run was not interrupted before it completed the expected 30 minute zonal shift.</p> </li> <li> <p> <b>INTERRUPTED:</b> Outcome value when the practice run was stopped before the expected 30 minute zonal shift duration, or there was another problem with the practice run that created an inconclusive outcome.</p> </li> <li> <p> <b>FAILED:</b> Outcome value when the outcome alarm specified for the practice run configuration goes into an <code>ALARM</code> state during the practice run, and the practice run was not interrupted before it completed.</p> </li> <li> <p> <b>CAPACITY_CHECK_FAILED:</b> The check for balanced capacity across Availability Zones for your load balancing and Auto Scaling group resources failed.</p> </li> </ul> <p>For more information about practice run outcomes, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.configure.html"> Considerations when you configure zonal autoshift</a> in the Amazon Application Recovery Controller Developer Guide.</p>
|
|
761
648
|
* @public
|
|
762
649
|
*/
|
|
763
650
|
practiceRunOutcome?: PracticeRunOutcome | undefined;
|
|
@@ -777,8 +664,7 @@ export interface GetManagedResourceResponse {
|
|
|
777
664
|
*/
|
|
778
665
|
name?: string | undefined;
|
|
779
666
|
/**
|
|
780
|
-
* <p>A collection of key-value pairs that indicate whether resources are active in Availability Zones or not.
|
|
781
|
-
* The key name is the Availability Zone where the resource is deployed. The value is 1 or 0.</p>
|
|
667
|
+
* <p>A collection of key-value pairs that indicate whether resources are active in Availability Zones or not. The key name is the Availability Zone where the resource is deployed. The value is 1 or 0.</p>
|
|
782
668
|
* @public
|
|
783
669
|
*/
|
|
784
670
|
appliedWeights: Record<string, number> | undefined;
|
|
@@ -793,17 +679,12 @@ export interface GetManagedResourceResponse {
|
|
|
793
679
|
*/
|
|
794
680
|
autoshifts?: AutoshiftInResource[] | undefined;
|
|
795
681
|
/**
|
|
796
|
-
* <p>The practice run configuration for zonal autoshift that's associated with
|
|
797
|
-
* the resource.</p>
|
|
682
|
+
* <p>The practice run configuration for zonal autoshift that's associated with the resource.</p>
|
|
798
683
|
* @public
|
|
799
684
|
*/
|
|
800
685
|
practiceRunConfiguration?: PracticeRunConfiguration | undefined;
|
|
801
686
|
/**
|
|
802
|
-
* <p>The status for zonal autoshift for a resource. When the
|
|
803
|
-
* autoshift status is <code>ENABLED</code>, Amazon Web Services shifts traffic
|
|
804
|
-
* for a resource away from an Availability Zone, on your behalf, when
|
|
805
|
-
* Amazon Web Services determines that there's an issue in
|
|
806
|
-
* the Availability Zone that could potentially affect customers.</p>
|
|
687
|
+
* <p>The status for zonal autoshift for a resource. When the autoshift status is <code>ENABLED</code>, Amazon Web Services shifts traffic for a resource away from an Availability Zone, on your behalf, when Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers.</p>
|
|
807
688
|
* @public
|
|
808
689
|
*/
|
|
809
690
|
zonalAutoshiftStatus?: ZonalAutoshiftStatus | undefined;
|
|
@@ -813,9 +694,7 @@ export interface GetManagedResourceResponse {
|
|
|
813
694
|
*/
|
|
814
695
|
export interface ListManagedResourcesRequest {
|
|
815
696
|
/**
|
|
816
|
-
* <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>nextToken</code> response in the
|
|
817
|
-
* previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous
|
|
818
|
-
* call's <code>nextToken</code> response to request the next page of results.</p>
|
|
697
|
+
* <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>nextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>nextToken</code> response to request the next page of results.</p>
|
|
819
698
|
* @public
|
|
820
699
|
*/
|
|
821
700
|
nextToken?: string | undefined;
|
|
@@ -826,15 +705,7 @@ export interface ListManagedResourcesRequest {
|
|
|
826
705
|
maxResults?: number | undefined;
|
|
827
706
|
}
|
|
828
707
|
/**
|
|
829
|
-
* <p>A complex structure for a managed resource in an Amazon Web Services account with information about zonal shifts
|
|
830
|
-
* and autoshifts.</p>
|
|
831
|
-
* <p>A managed resource is a load balancer that has been registered
|
|
832
|
-
* with ARC by Elastic Load Balancing. You can start a zonal shift in ARC for a managed resource to
|
|
833
|
-
* temporarily move traffic for the resource away from an Availability Zone in an Amazon Web Services Region.
|
|
834
|
-
* You can also configure zonal autoshift for a managed resource.</p>
|
|
835
|
-
* <note>
|
|
836
|
-
* <p>At this time, managed resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.</p>
|
|
837
|
-
* </note>
|
|
708
|
+
* <p>A complex structure for a managed resource in an Amazon Web Services account with information about zonal shifts and autoshifts.</p> <p>You can start a zonal shift in ARC for a managed resource to temporarily move traffic for the resource away from an Availability Zone in an Amazon Web Services Region. You can also configure zonal autoshift for a managed resource.</p> <note> <p>At this time, managed resources are Amazon EC2 Auto Scaling groups, Amazon Elastic Kubernetes Service, Network Load Balancers, and Application Load Balancer.</p> </note>
|
|
838
709
|
* @public
|
|
839
710
|
*/
|
|
840
711
|
export interface ManagedResourceSummary {
|
|
@@ -854,8 +725,7 @@ export interface ManagedResourceSummary {
|
|
|
854
725
|
*/
|
|
855
726
|
availabilityZones: string[] | undefined;
|
|
856
727
|
/**
|
|
857
|
-
* <p>A collection of key-value pairs that indicate whether resources are active in Availability Zones or not.
|
|
858
|
-
* The key name is the Availability Zone where the resource is deployed. The value is 1 or 0.</p>
|
|
728
|
+
* <p>A collection of key-value pairs that indicate whether resources are active in Availability Zones or not. The key name is the Availability Zone where the resource is deployed. The value is 1 or 0.</p>
|
|
859
729
|
* @public
|
|
860
730
|
*/
|
|
861
731
|
appliedWeights?: Record<string, number> | undefined;
|
|
@@ -870,18 +740,12 @@ export interface ManagedResourceSummary {
|
|
|
870
740
|
*/
|
|
871
741
|
autoshifts?: AutoshiftInResource[] | undefined;
|
|
872
742
|
/**
|
|
873
|
-
* <p>The status of autoshift for a resource. When you configure zonal autoshift for a
|
|
874
|
-
* resource, you can set the value of the status to <code>ENABLED</code> or <code>DISABLED</code>.</p>
|
|
743
|
+
* <p>The status of autoshift for a resource. When you configure zonal autoshift for a resource, you can set the value of the status to <code>ENABLED</code> or <code>DISABLED</code>.</p>
|
|
875
744
|
* @public
|
|
876
745
|
*/
|
|
877
746
|
zonalAutoshiftStatus?: ZonalAutoshiftStatus | undefined;
|
|
878
747
|
/**
|
|
879
|
-
* <p>This status tracks whether a practice run configuration exists for a resource. When you configure
|
|
880
|
-
* a practice run for a resource so that a practice run configuration exists, ARC sets this value to
|
|
881
|
-
* <code>ENABLED</code>. If a you have not configured a practice run for the resource, or delete a practice
|
|
882
|
-
* run configuration, ARC sets the value to <code>DISABLED</code>.</p>
|
|
883
|
-
* <p>ARC updates this status; you can't set a practice run status to <code>ENABLED</code> or
|
|
884
|
-
* <code>DISABLED</code>.</p>
|
|
748
|
+
* <p>This status tracks whether a practice run configuration exists for a resource. When you configure a practice run for a resource so that a practice run configuration exists, ARC sets this value to <code>ENABLED</code>. If a you have not configured a practice run for the resource, or delete a practice run configuration, ARC sets the value to <code>DISABLED</code>.</p> <p>ARC updates this status; you can't set a practice run status to <code>ENABLED</code> or <code>DISABLED</code>.</p>
|
|
885
749
|
* @public
|
|
886
750
|
*/
|
|
887
751
|
practiceRunStatus?: ZonalAutoshiftStatus | undefined;
|
|
@@ -896,9 +760,7 @@ export interface ListManagedResourcesResponse {
|
|
|
896
760
|
*/
|
|
897
761
|
items: ManagedResourceSummary[] | undefined;
|
|
898
762
|
/**
|
|
899
|
-
* <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>nextToken</code> response in the
|
|
900
|
-
* previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous
|
|
901
|
-
* call's <code>nextToken</code> response to request the next page of results.</p>
|
|
763
|
+
* <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>nextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>nextToken</code> response to request the next page of results.</p>
|
|
902
764
|
* @public
|
|
903
765
|
*/
|
|
904
766
|
nextToken?: string | undefined;
|
|
@@ -908,29 +770,12 @@ export interface ListManagedResourcesResponse {
|
|
|
908
770
|
*/
|
|
909
771
|
export interface ListZonalShiftsRequest {
|
|
910
772
|
/**
|
|
911
|
-
* <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>nextToken</code> response in the
|
|
912
|
-
* previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous
|
|
913
|
-
* call's <code>nextToken</code> response to request the next page of results.</p>
|
|
773
|
+
* <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>nextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>nextToken</code> response to request the next page of results.</p>
|
|
914
774
|
* @public
|
|
915
775
|
*/
|
|
916
776
|
nextToken?: string | undefined;
|
|
917
777
|
/**
|
|
918
|
-
* <p>A status for a zonal shift.</p>
|
|
919
|
-
* <p>The <code>Status</code> for a zonal shift can have one of the following values:</p>
|
|
920
|
-
* <ul>
|
|
921
|
-
* <li>
|
|
922
|
-
* <p>
|
|
923
|
-
* <b>ACTIVE</b>: The zonal shift has been started and active.</p>
|
|
924
|
-
* </li>
|
|
925
|
-
* <li>
|
|
926
|
-
* <p>
|
|
927
|
-
* <b>EXPIRED</b>: The zonal shift has expired (the expiry time was exceeded).</p>
|
|
928
|
-
* </li>
|
|
929
|
-
* <li>
|
|
930
|
-
* <p>
|
|
931
|
-
* <b>CANCELED</b>: The zonal shift was canceled.</p>
|
|
932
|
-
* </li>
|
|
933
|
-
* </ul>
|
|
778
|
+
* <p>A status for a zonal shift.</p> <p>The <code>Status</code> for a zonal shift can have one of the following values:</p> <ul> <li> <p> <b>ACTIVE</b>: The zonal shift has been started and is active.</p> </li> <li> <p> <b>EXPIRED</b>: The zonal shift has expired (the expiry time was exceeded).</p> </li> <li> <p> <b>CANCELED</b>: The zonal shift was canceled.</p> </li> </ul>
|
|
934
779
|
* @public
|
|
935
780
|
*/
|
|
936
781
|
status?: ZonalShiftStatus | undefined;
|
|
@@ -940,18 +785,13 @@ export interface ListZonalShiftsRequest {
|
|
|
940
785
|
*/
|
|
941
786
|
maxResults?: number | undefined;
|
|
942
787
|
/**
|
|
943
|
-
* <p>The identifier for the resource that you want to list zonal shifts for.
|
|
944
|
-
* The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
788
|
+
* <p>The identifier for the resource that you want to list zonal shifts for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
945
789
|
* @public
|
|
946
790
|
*/
|
|
947
791
|
resourceIdentifier?: string | undefined;
|
|
948
792
|
}
|
|
949
793
|
/**
|
|
950
|
-
* <p>Lists information about zonal shifts in Amazon
|
|
951
|
-
* on your behalf for practice runs with zonal autoshift.</p>
|
|
952
|
-
* <p>Zonal shifts are temporary, including customer-initiated zonal shifts and the zonal autoshift practice run zonal shifts that
|
|
953
|
-
* ARC starts weekly, on your behalf. A zonal shift that a customer starts can be active for up to three days (72 hours). A
|
|
954
|
-
* practice run zonal shift has a 30 minute duration.</p>
|
|
794
|
+
* <p>Lists information about zonal shifts in Amazon Application Recovery Controller, including zonal shifts that you start yourself and zonal shifts that ARC starts on your behalf for practice runs with zonal autoshift.</p> <p>Zonal shifts are temporary, including customer-initiated zonal shifts and the zonal autoshift practice run zonal shifts that ARC starts weekly, on your behalf. A zonal shift that a customer starts can be active for up to three days (72 hours). A practice run zonal shift has a 30 minute duration.</p>
|
|
955
795
|
* @public
|
|
956
796
|
*/
|
|
957
797
|
export interface ZonalShiftSummary {
|
|
@@ -961,24 +801,17 @@ export interface ZonalShiftSummary {
|
|
|
961
801
|
*/
|
|
962
802
|
zonalShiftId: string | undefined;
|
|
963
803
|
/**
|
|
964
|
-
* <p>The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
965
|
-
* <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>
|
|
804
|
+
* <p>The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.</p> <p>Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html">Amazon EC2 Auto Scaling groups</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html">Amazon Elastic Kubernetes Service</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html">Application Load Balancers</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html">Network Load Balancers</a> </p> </li> </ul>
|
|
966
805
|
* @public
|
|
967
806
|
*/
|
|
968
807
|
resourceIdentifier: string | undefined;
|
|
969
808
|
/**
|
|
970
|
-
* <p>The Availability Zone (for example, <code>use1-az1</code>) that traffic is moved away from for a resource when you start a zonal shift.
|
|
971
|
-
* 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>
|
|
809
|
+
* <p>The Availability Zone (for example, <code>use1-az1</code>) that traffic is moved away from for a resource when you start a zonal shift. 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>
|
|
972
810
|
* @public
|
|
973
811
|
*/
|
|
974
812
|
awayFrom: string | undefined;
|
|
975
813
|
/**
|
|
976
|
-
* <p>The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift.
|
|
977
|
-
* You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift
|
|
978
|
-
* to set a new expiration at any time. </p>
|
|
979
|
-
* <p>When you start a zonal shift, you specify how long you want it to be active, which ARC converts
|
|
980
|
-
* to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or
|
|
981
|
-
* just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.</p>
|
|
814
|
+
* <p>The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time. </p> <p>When you start a zonal shift, you specify how long you want it to be active, which ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.</p>
|
|
982
815
|
* @public
|
|
983
816
|
*/
|
|
984
817
|
expiryTime: Date | undefined;
|
|
@@ -988,28 +821,12 @@ export interface ZonalShiftSummary {
|
|
|
988
821
|
*/
|
|
989
822
|
startTime: Date | undefined;
|
|
990
823
|
/**
|
|
991
|
-
* <p>A status for a zonal shift.</p>
|
|
992
|
-
* <p>The <code>Status</code> for a zonal shift can have one of the following values:</p>
|
|
993
|
-
* <ul>
|
|
994
|
-
* <li>
|
|
995
|
-
* <p>
|
|
996
|
-
* <b>ACTIVE:</b> The zonal shift has been started and active.</p>
|
|
997
|
-
* </li>
|
|
998
|
-
* <li>
|
|
999
|
-
* <p>
|
|
1000
|
-
* <b>EXPIRED:</b> The zonal shift has expired (the expiry time was exceeded).</p>
|
|
1001
|
-
* </li>
|
|
1002
|
-
* <li>
|
|
1003
|
-
* <p>
|
|
1004
|
-
* <b>CANCELED:</b> The zonal shift was canceled.</p>
|
|
1005
|
-
* </li>
|
|
1006
|
-
* </ul>
|
|
824
|
+
* <p>A status for a zonal shift.</p> <p>The <code>Status</code> for a zonal shift can have one of the following values:</p> <ul> <li> <p> <b>ACTIVE:</b> The zonal shift has been started and is active.</p> </li> <li> <p> <b>EXPIRED:</b> The zonal shift has expired (the expiry time was exceeded).</p> </li> <li> <p> <b>CANCELED:</b> The zonal shift was canceled.</p> </li> </ul>
|
|
1007
825
|
* @public
|
|
1008
826
|
*/
|
|
1009
827
|
status: ZonalShiftStatus | undefined;
|
|
1010
828
|
/**
|
|
1011
|
-
* <p>A comment that you enter about the zonal shift. Only the latest comment is retained; no comment
|
|
1012
|
-
* history is maintained. That is, a new comment overwrites any existing comment string.</p>
|
|
829
|
+
* <p>A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. That is, a new comment overwrites any existing comment string.</p>
|
|
1013
830
|
* @public
|
|
1014
831
|
*/
|
|
1015
832
|
comment: string | undefined;
|
|
@@ -1019,33 +836,7 @@ export interface ZonalShiftSummary {
|
|
|
1019
836
|
*/
|
|
1020
837
|
shiftType?: ShiftType | undefined;
|
|
1021
838
|
/**
|
|
1022
|
-
* <p>The outcome, or end state, of a practice run. The following values can be returned:</p>
|
|
1023
|
-
* <ul>
|
|
1024
|
-
* <li>
|
|
1025
|
-
* <p>
|
|
1026
|
-
* <b>PENDING:</b> Outcome value when the practice run is in progress.</p>
|
|
1027
|
-
* </li>
|
|
1028
|
-
* <li>
|
|
1029
|
-
* <p>
|
|
1030
|
-
* <b>SUCCEEDED:</b> Outcome value when the outcome alarm specified for
|
|
1031
|
-
* the practice run configuration does not go into an <code>ALARM</code> state during the practice run, and the practice run
|
|
1032
|
-
* was not interrupted before it completed.</p>
|
|
1033
|
-
* </li>
|
|
1034
|
-
* <li>
|
|
1035
|
-
* <p>
|
|
1036
|
-
* <b>INTERRUPTED:</b> Outcome value when the practice run did not run for the
|
|
1037
|
-
* expected 30 minutes or there was another problem with the practice run that created an inconclusive outcome.</p>
|
|
1038
|
-
* </li>
|
|
1039
|
-
* <li>
|
|
1040
|
-
* <p>
|
|
1041
|
-
* <b>FAILED:</b> Outcome value when the outcome alarm specified for
|
|
1042
|
-
* the practice run configuration goes into an <code>ALARM</code> state during the practice run, and the practice run
|
|
1043
|
-
* was not interrupted before it completed.</p>
|
|
1044
|
-
* </li>
|
|
1045
|
-
* </ul>
|
|
1046
|
-
* <p>For more information about practice run outcomes, see
|
|
1047
|
-
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.configure.html">
|
|
1048
|
-
* Considerations when you configure zonal autoshift</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
839
|
+
* <p>The outcome, or end state, of a practice run. The following values can be returned:</p> <ul> <li> <p> <b>PENDING:</b> Outcome value when the practice run is in progress.</p> </li> <li> <p> <b>SUCCEEDED:</b> Outcome value when the outcome alarm specified for the practice run configuration does not go into an <code>ALARM</code> state during the practice run, and the practice run was not interrupted before it completed.</p> </li> <li> <p> <b>INTERRUPTED:</b> Outcome value when the practice run did not run for the expected 30 minutes or there was another problem with the practice run that created an inconclusive outcome.</p> </li> <li> <p> <b>FAILED:</b> Outcome value when the outcome alarm specified for the practice run configuration goes into an <code>ALARM</code> state during the practice run, and the practice run was not interrupted before it completed.</p> </li> <li> <p> <b>CAPACITY_CHECK_FAILED:</b> The check for balanced capacity across Availability Zones for your load balancing and Auto Scaling group resources failed.</p> </li> </ul> <p>For more information about practice run outcomes, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.configure.html"> Considerations when you configure zonal autoshift</a> in the Amazon Application Recovery Controller Developer Guide.</p>
|
|
1049
840
|
* @public
|
|
1050
841
|
*/
|
|
1051
842
|
practiceRunOutcome?: PracticeRunOutcome | undefined;
|
|
@@ -1060,9 +851,7 @@ export interface ListZonalShiftsResponse {
|
|
|
1060
851
|
*/
|
|
1061
852
|
items?: ZonalShiftSummary[] | undefined;
|
|
1062
853
|
/**
|
|
1063
|
-
* <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>nextToken</code> response in the
|
|
1064
|
-
* previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous
|
|
1065
|
-
* call's <code>nextToken</code> response to request the next page of results.</p>
|
|
854
|
+
* <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>nextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>nextToken</code> response to request the next page of results.</p>
|
|
1066
855
|
* @public
|
|
1067
856
|
*/
|
|
1068
857
|
nextToken?: string | undefined;
|
|
@@ -1072,16 +861,12 @@ export interface ListZonalShiftsResponse {
|
|
|
1072
861
|
*/
|
|
1073
862
|
export interface UpdateZonalAutoshiftConfigurationRequest {
|
|
1074
863
|
/**
|
|
1075
|
-
* <p>The identifier for the resource that you want to update the zonal autoshift
|
|
1076
|
-
* configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
864
|
+
* <p>The identifier for the resource that you want to update the zonal autoshift configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
1077
865
|
* @public
|
|
1078
866
|
*/
|
|
1079
867
|
resourceIdentifier: string | undefined;
|
|
1080
868
|
/**
|
|
1081
|
-
* <p>The zonal autoshift status for the resource that you want to update the zonal
|
|
1082
|
-
* autoshift configuration for. Choose <code>ENABLED</code> to authorize Amazon Web Services
|
|
1083
|
-
* to shift away resource traffic for an application from an Availability Zone during events,
|
|
1084
|
-
* on your behalf, to help reduce time to recovery.</p>
|
|
869
|
+
* <p>The zonal autoshift status for the resource that you want to update the zonal autoshift configuration for. Choose <code>ENABLED</code> to authorize Amazon Web Services to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery.</p>
|
|
1085
870
|
* @public
|
|
1086
871
|
*/
|
|
1087
872
|
zonalAutoshiftStatus: ZonalAutoshiftStatus | undefined;
|
|
@@ -1091,8 +876,7 @@ export interface UpdateZonalAutoshiftConfigurationRequest {
|
|
|
1091
876
|
*/
|
|
1092
877
|
export interface UpdateZonalAutoshiftConfigurationResponse {
|
|
1093
878
|
/**
|
|
1094
|
-
* <p>The identifier for the resource that you updated the zonal autoshift
|
|
1095
|
-
* configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
879
|
+
* <p>The identifier for the resource that you updated the zonal autoshift configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
1096
880
|
* @public
|
|
1097
881
|
*/
|
|
1098
882
|
resourceIdentifier: string | undefined;
|
|
@@ -1107,40 +891,22 @@ export interface UpdateZonalAutoshiftConfigurationResponse {
|
|
|
1107
891
|
*/
|
|
1108
892
|
export interface UpdatePracticeRunConfigurationRequest {
|
|
1109
893
|
/**
|
|
1110
|
-
* <p>The identifier for the resource that you want to update the practice
|
|
1111
|
-
* run configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
894
|
+
* <p>The identifier for the resource that you want to update the practice run configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
1112
895
|
* @public
|
|
1113
896
|
*/
|
|
1114
897
|
resourceIdentifier: string | undefined;
|
|
1115
898
|
/**
|
|
1116
|
-
* <p>Add, change, or remove windows of days and times for when you can, optionally,
|
|
1117
|
-
* block ARC from starting a practice run for a resource.</p>
|
|
1118
|
-
* <p>The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates,
|
|
1119
|
-
* that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments
|
|
1120
|
-
* that might be required for daylight saving time differences. Separate multiple blocked windows
|
|
1121
|
-
* with spaces.</p>
|
|
1122
|
-
* <p>For example, say you run business report summaries three days a week. For
|
|
1123
|
-
* this scenario, you might set the following recurring days and times as blocked windows,
|
|
1124
|
-
* for example: <code>MON-20:30-21:30 WED-20:30-21:30
|
|
1125
|
-
* FRI-20:30-21:30</code>.</p>
|
|
899
|
+
* <p>Add, change, or remove windows of days and times for when you can, optionally, block ARC from starting a practice run for a resource.</p> <p>The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces.</p> <p>For example, say you run business report summaries three days a week. For this scenario, you might set the following recurring days and times as blocked windows, for example: <code>MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30</code>.</p>
|
|
1126
900
|
* @public
|
|
1127
901
|
*/
|
|
1128
902
|
blockedWindows?: string[] | undefined;
|
|
1129
903
|
/**
|
|
1130
|
-
* <p>Add, change, or remove blocked dates for a practice run in zonal autoshift.</p>
|
|
1131
|
-
* <p>Optionally, you can block practice runs for specific calendar dates.
|
|
1132
|
-
* The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates,
|
|
1133
|
-
* that dates and times for practice runs are in UTC. Separate multiple blocked
|
|
1134
|
-
* dates with spaces.</p>
|
|
1135
|
-
* <p>For example, if you have an application update scheduled to launch on May 1, 2024, and
|
|
1136
|
-
* you don't want practice runs to shift traffic away at that time, you could set a blocked date
|
|
1137
|
-
* for <code>2024-05-01</code>.</p>
|
|
904
|
+
* <p>Add, change, or remove blocked dates for a practice run in zonal autoshift.</p> <p>Optionally, you can block practice runs for specific calendar dates. The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces.</p> <p>For example, if you have an application update scheduled to launch on May 1, 2024, and you don't want practice runs to shift traffic away at that time, you could set a blocked date for <code>2024-05-01</code>.</p>
|
|
1138
905
|
* @public
|
|
1139
906
|
*/
|
|
1140
907
|
blockedDates?: string[] | undefined;
|
|
1141
908
|
/**
|
|
1142
|
-
* <p>Add, change, or remove the Amazon CloudWatch alarm that you optionally
|
|
1143
|
-
* specify as the blocking alarm for practice runs.</p>
|
|
909
|
+
* <p>Add, change, or remove the Amazon CloudWatch alarm that you optionally specify as the blocking alarm for practice runs.</p>
|
|
1144
910
|
* @public
|
|
1145
911
|
*/
|
|
1146
912
|
blockingAlarms?: ControlCondition[] | undefined;
|
|
@@ -1155,20 +921,17 @@ export interface UpdatePracticeRunConfigurationRequest {
|
|
|
1155
921
|
*/
|
|
1156
922
|
export interface UpdatePracticeRunConfigurationResponse {
|
|
1157
923
|
/**
|
|
1158
|
-
* <p>The Amazon Resource Name (ARN) of the resource that you updated the practice
|
|
1159
|
-
* run for.</p>
|
|
924
|
+
* <p>The Amazon Resource Name (ARN) of the resource that you updated the practice run for.</p>
|
|
1160
925
|
* @public
|
|
1161
926
|
*/
|
|
1162
927
|
arn: string | undefined;
|
|
1163
928
|
/**
|
|
1164
|
-
* <p>The name of the resource that you updated the practice
|
|
1165
|
-
* run for. </p>
|
|
929
|
+
* <p>The name of the resource that you updated the practice run for. </p>
|
|
1166
930
|
* @public
|
|
1167
931
|
*/
|
|
1168
932
|
name: string | undefined;
|
|
1169
933
|
/**
|
|
1170
|
-
* <p>The zonal autoshift status for the resource that you updated the practice
|
|
1171
|
-
* run for.</p>
|
|
934
|
+
* <p>The zonal autoshift status for the resource that you updated the practice run for.</p>
|
|
1172
935
|
* @public
|
|
1173
936
|
*/
|
|
1174
937
|
zonalAutoshiftStatus: ZonalAutoshiftStatus | undefined;
|
|
@@ -1188,73 +951,97 @@ export interface UpdateZonalShiftRequest {
|
|
|
1188
951
|
*/
|
|
1189
952
|
zonalShiftId: string | undefined;
|
|
1190
953
|
/**
|
|
1191
|
-
* <p>A comment that you enter about the zonal shift. Only the latest comment is retained; no comment
|
|
1192
|
-
* history is maintained. A new comment overwrites any existing comment string.</p>
|
|
954
|
+
* <p>A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.</p>
|
|
1193
955
|
* @public
|
|
1194
956
|
*/
|
|
1195
957
|
comment?: string | undefined;
|
|
1196
958
|
/**
|
|
1197
|
-
* <p>The length of time that you want a zonal shift to be active, which ARC converts to an expiry time (expiration time).
|
|
1198
|
-
* Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours).</p>
|
|
1199
|
-
* <p>If you want to still keep traffic away from an Availability Zone, you can update the
|
|
1200
|
-
* zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to
|
|
1201
|
-
* restore traffic to the Availability Zone.</p>
|
|
1202
|
-
* <p>To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:</p>
|
|
1203
|
-
* <ul>
|
|
1204
|
-
* <li>
|
|
1205
|
-
* <p>
|
|
1206
|
-
* <b>A lowercase letter m:</b> To specify that the value is in minutes.</p>
|
|
1207
|
-
* </li>
|
|
1208
|
-
* <li>
|
|
1209
|
-
* <p>
|
|
1210
|
-
* <b>A lowercase letter h:</b> To specify that the value is in hours.</p>
|
|
1211
|
-
* </li>
|
|
1212
|
-
* </ul>
|
|
1213
|
-
* <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>
|
|
959
|
+
* <p>The length of time that you want a zonal shift to be active, which ARC converts to an expiry time (expiration time). Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours).</p> <p>If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.</p> <p>To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:</p> <ul> <li> <p> <b>A lowercase letter m:</b> To specify that the value is in minutes.</p> </li> <li> <p> <b>A lowercase letter h:</b> To specify that the value is in hours.</p> </li> </ul> <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>
|
|
1214
960
|
* @public
|
|
1215
961
|
*/
|
|
1216
962
|
expiresIn?: string | undefined;
|
|
1217
963
|
}
|
|
964
|
+
/**
|
|
965
|
+
* @public
|
|
966
|
+
*/
|
|
967
|
+
export interface StartPracticeRunRequest {
|
|
968
|
+
/**
|
|
969
|
+
* <p>The identifier for the resource that you want to start a practice run zonal shift for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
970
|
+
* @public
|
|
971
|
+
*/
|
|
972
|
+
resourceIdentifier: string | undefined;
|
|
973
|
+
/**
|
|
974
|
+
* <p>The Availability Zone (for example, <code>use1-az1</code>) that traffic is shifted away from for the resource that you specify for the practice run.</p>
|
|
975
|
+
* @public
|
|
976
|
+
*/
|
|
977
|
+
awayFrom: string | undefined;
|
|
978
|
+
/**
|
|
979
|
+
* <p>The initial comment that you enter about the practice run. Be aware that this comment can be overwritten by Amazon Web Services if the automatic check for balanced capacity fails. For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.capacity-check.html"> Capacity checks for practice runs</a> in the Amazon Application Recovery Controller Developer Guide. </p>
|
|
980
|
+
* @public
|
|
981
|
+
*/
|
|
982
|
+
comment: string | undefined;
|
|
983
|
+
}
|
|
984
|
+
/**
|
|
985
|
+
* @public
|
|
986
|
+
*/
|
|
987
|
+
export interface StartPracticeRunResponse {
|
|
988
|
+
/**
|
|
989
|
+
* <p>The identifier of a practice run zonal shift.</p>
|
|
990
|
+
* @public
|
|
991
|
+
*/
|
|
992
|
+
zonalShiftId: string | undefined;
|
|
993
|
+
/**
|
|
994
|
+
* <p>The identifier for the resource that you want to shift traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
995
|
+
* @public
|
|
996
|
+
*/
|
|
997
|
+
resourceIdentifier: string | undefined;
|
|
998
|
+
/**
|
|
999
|
+
* <p>The Availability Zone (for example, <code>use1-az1</code>) that traffic is shifted away from for the resource that you specify for the practice run.</p>
|
|
1000
|
+
* @public
|
|
1001
|
+
*/
|
|
1002
|
+
awayFrom: string | undefined;
|
|
1003
|
+
/**
|
|
1004
|
+
* <p>The expiry time (expiration time) for an on-demand practice run zonal shift is 30 minutes from the time when you start the practice run, unless you cancel it before that time. However, be aware that the <code>expiryTime</code> field for practice run zonal shifts always has a value of 1 minute. </p>
|
|
1005
|
+
* @public
|
|
1006
|
+
*/
|
|
1007
|
+
expiryTime: Date | undefined;
|
|
1008
|
+
/**
|
|
1009
|
+
* <p>The time (UTC) when the zonal shift starts.</p>
|
|
1010
|
+
* @public
|
|
1011
|
+
*/
|
|
1012
|
+
startTime: Date | undefined;
|
|
1013
|
+
/**
|
|
1014
|
+
* <p>A status for the practice run (expected status is <b>ACTIVE</b>).</p>
|
|
1015
|
+
* @public
|
|
1016
|
+
*/
|
|
1017
|
+
status: ZonalShiftStatus | undefined;
|
|
1018
|
+
/**
|
|
1019
|
+
* <p>The initial comment that you enter about the practice run. Be aware that this comment can be overwritten by Amazon Web Services if the automatic check for balanced capacity fails. For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.capacity-check.html"> Capacity checks for practice runs</a> in the Amazon Application Recovery Controller Developer Guide. </p>
|
|
1020
|
+
* @public
|
|
1021
|
+
*/
|
|
1022
|
+
comment: string | undefined;
|
|
1023
|
+
}
|
|
1218
1024
|
/**
|
|
1219
1025
|
* @public
|
|
1220
1026
|
*/
|
|
1221
1027
|
export interface StartZonalShiftRequest {
|
|
1222
1028
|
/**
|
|
1223
|
-
* <p>The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
|
|
1224
|
-
* <p>At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.</p>
|
|
1029
|
+
* <p>The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.</p> <p>Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html">Amazon EC2 Auto Scaling groups</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html">Amazon Elastic Kubernetes Service</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html">Application Load Balancer</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html">Network Load Balancer</a> </p> </li> </ul>
|
|
1225
1030
|
* @public
|
|
1226
1031
|
*/
|
|
1227
1032
|
resourceIdentifier: string | undefined;
|
|
1228
1033
|
/**
|
|
1229
|
-
* <p>The Availability Zone (for example, <code>use1-az1</code>) that traffic is moved away from for a resource when you start a zonal shift.
|
|
1230
|
-
* 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>
|
|
1034
|
+
* <p>The Availability Zone (for example, <code>use1-az1</code>) that traffic is moved away from for a resource when you start a zonal shift. 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>
|
|
1231
1035
|
* @public
|
|
1232
1036
|
*/
|
|
1233
1037
|
awayFrom: string | undefined;
|
|
1234
1038
|
/**
|
|
1235
|
-
* <p>The length of time that you want a zonal shift to be active, which ARC converts to an expiry time (expiration time).
|
|
1236
|
-
* Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours).</p>
|
|
1237
|
-
* <p>If you want to still keep traffic away from an Availability Zone, you can update the
|
|
1238
|
-
* zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to
|
|
1239
|
-
* restore traffic to the Availability Zone.</p>
|
|
1240
|
-
* <p>To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:</p>
|
|
1241
|
-
* <ul>
|
|
1242
|
-
* <li>
|
|
1243
|
-
* <p>
|
|
1244
|
-
* <b>A lowercase letter m:</b> To specify that the value is in minutes.</p>
|
|
1245
|
-
* </li>
|
|
1246
|
-
* <li>
|
|
1247
|
-
* <p>
|
|
1248
|
-
* <b>A lowercase letter h:</b> To specify that the value is in hours.</p>
|
|
1249
|
-
* </li>
|
|
1250
|
-
* </ul>
|
|
1251
|
-
* <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>
|
|
1039
|
+
* <p>The length of time that you want a zonal shift to be active, which ARC converts to an expiry time (expiration time). Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours).</p> <p>If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.</p> <p>To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:</p> <ul> <li> <p> <b>A lowercase letter m:</b> To specify that the value is in minutes.</p> </li> <li> <p> <b>A lowercase letter h:</b> To specify that the value is in hours.</p> </li> </ul> <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>
|
|
1252
1040
|
* @public
|
|
1253
1041
|
*/
|
|
1254
1042
|
expiresIn: string | undefined;
|
|
1255
1043
|
/**
|
|
1256
|
-
* <p>A comment that you enter about the zonal shift. Only the latest comment is retained; no comment
|
|
1257
|
-
* history is maintained. A new comment overwrites any existing comment string.</p>
|
|
1044
|
+
* <p>A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.</p>
|
|
1258
1045
|
* @public
|
|
1259
1046
|
*/
|
|
1260
1047
|
comment: string | undefined;
|