Skip to content

Commit f341188

Browse files
author
awstools
committed
feat(client-arc-zonal-shift): Add new shiftType field for ARC zonal shifts.
1 parent 74fdfa0 commit f341188

16 files changed

+258
-165
lines changed

‎clients/client-arc-zonal-shift/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66

77
AWS SDK for JavaScript ARCZonalShift Client for Node.js, Browser and React Native.
88

9-
<p>Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Route 53 Application Recovery Controller (Route 53 ARC).</p>
9+
<p>Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Route 53 Application Recovery Controller (ARC).</p>
1010
<p>You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to
1111
help your application recover quickly from an impairment in an Availability Zone. For example,
1212
you can recover your application from a developer's bad code deployment or from an
1313
Amazon Web Services infrastructure failure in a single Availability Zone.</p>
1414
<p>You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift
15-
is a capability in Route 53 ARC where you authorize Amazon Web Services to shift away application resource
15+
is a capability in ARC where you authorize Amazon Web Services to shift away application resource
1616
traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery.
1717
Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability
1818
Zone impairment that could potentially impact customers.</p>
@@ -33,7 +33,7 @@ pre-scaling, can result in loss of availability.</p>
3333
the minimum capacity of your auto scaling to continue operating normally with the loss of an
3434
Availability Zone. </p>
3535
</important>
36-
<p>Be aware that Route 53 ARC does not inspect the health of individual resources. Amazon Web Services only starts an
36+
<p>Be aware that ARC does not inspect the health of individual resources. Amazon Web Services only starts an
3737
autoshift when Amazon Web Services telemetry detects that there is an Availability Zone impairment that could
3838
potentially impact customers. In some cases, resources might be shifted away that are not experiencing
3939
impact.</p>

‎clients/client-arc-zonal-shift/src/ARCZonalShift.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -304,13 +304,13 @@ export interface ARCZonalShift {
304304
}
305305

306306
/**
307-
* <p>Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Route 53 Application Recovery Controller (Route 53 ARC).</p>
307+
* <p>Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Route 53 Application Recovery Controller (ARC).</p>
308308
* <p>You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to
309309
* help your application recover quickly from an impairment in an Availability Zone. For example,
310310
* you can recover your application from a developer's bad code deployment or from an
311311
* Amazon Web Services infrastructure failure in a single Availability Zone.</p>
312312
* <p>You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift
313-
* is a capability in Route 53 ARC where you authorize Amazon Web Services to shift away application resource
313+
* is a capability in ARC where you authorize Amazon Web Services to shift away application resource
314314
* traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery.
315315
* Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability
316316
* Zone impairment that could potentially impact customers.</p>
@@ -331,7 +331,7 @@ export interface ARCZonalShift {
331331
* the minimum capacity of your auto scaling to continue operating normally with the loss of an
332332
* Availability Zone. </p>
333333
* </important>
334-
* <p>Be aware that Route 53 ARC does not inspect the health of individual resources. Amazon Web Services only starts an
334+
* <p>Be aware that ARC does not inspect the health of individual resources. Amazon Web Services only starts an
335335
* autoshift when Amazon Web Services telemetry detects that there is an Availability Zone impairment that could
336336
* potentially impact customers. In some cases, resources might be shifted away that are not experiencing
337337
* impact.</p>

‎clients/client-arc-zonal-shift/src/ARCZonalShiftClient.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -325,13 +325,13 @@ export type ARCZonalShiftClientResolvedConfigType = __SmithyResolvedConfiguratio
325325
export interface ARCZonalShiftClientResolvedConfig extends ARCZonalShiftClientResolvedConfigType {}
326326

327327
/**
328-
* <p>Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Route 53 Application Recovery Controller (Route 53 ARC).</p>
328+
* <p>Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Route 53 Application Recovery Controller (ARC).</p>
329329
* <p>You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to
330330
* help your application recover quickly from an impairment in an Availability Zone. For example,
331331
* you can recover your application from a developer's bad code deployment or from an
332332
* Amazon Web Services infrastructure failure in a single Availability Zone.</p>
333333
* <p>You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift
334-
* is a capability in Route 53 ARC where you authorize Amazon Web Services to shift away application resource
334+
* is a capability in ARC where you authorize Amazon Web Services to shift away application resource
335335
* traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery.
336336
* Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability
337337
* Zone impairment that could potentially impact customers.</p>
@@ -352,7 +352,7 @@ export interface ARCZonalShiftClientResolvedConfig extends ARCZonalShiftClientRe
352352
* the minimum capacity of your auto scaling to continue operating normally with the loss of an
353353
* Availability Zone. </p>
354354
* </important>
355-
* <p>Be aware that Route 53 ARC does not inspect the health of individual resources. Amazon Web Services only starts an
355+
* <p>Be aware that ARC does not inspect the health of individual resources. Amazon Web Services only starts an
356356
* autoshift when Amazon Web Services telemetry detects that there is an Availability Zone impairment that could
357357
* potentially impact customers. In some cases, resources might be shifted away that are not experiencing
358358
* impact.</p>

‎clients/client-arc-zonal-shift/src/commands/CreatePracticeRunConfigurationCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export interface CreatePracticeRunConfigurationCommandOutput
3838
* and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an
3939
* <i>outcome alarm</i>, to monitor application health during practice runs and,
4040
* optionally, a <i>blocking alarm</i>, to block practice runs from starting.</p>
41-
* <p>When a resource has a practice run configuration, Route 53 ARC starts zonal shifts for the resource
41+
* <p>When a resource has a practice run configuration, ARC starts zonal shifts for the resource
4242
* weekly, to shift traffic for practice runs. Practice runs help you to ensure that
4343
* shifting away traffic from an Availability Zone during an autoshift is safe for your application.</p>
4444
* <p>For more information, see

‎clients/client-arc-zonal-shift/src/commands/GetAutoshiftObserverNotificationStatusCommand.ts

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,8 @@ export interface GetAutoshiftObserverNotificationStatusCommandOutput
3737
__MetadataBearer {}
3838

3939
/**
40-
* <p>Returns the status of autoshift observer notification. Autoshift observer
41-
* notification enables you to be notified, through Amazon EventBridge, when
42-
* there is an autoshift event for zonal autoshift.</p>
43-
* <p>If the status is <code>ENABLED</code>,
44-
* Route 53 ARC includes all autoshift events when you use the EventBridge pattern
45-
* <code>Autoshift In Progress</code>. When the status is <code>DISABLED</code>,
46-
* Route 53 ARC includes only autoshift events for autoshifts when one or more of your
47-
* resources is included in the autoshift.</p>
48-
* <p>For more information, see
49-
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html#ZAShiftNotification">
50-
* Notifications for practice runs and autoshifts</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
40+
* <p>Returns the status of the autoshift observer notification. Autoshift observer notifications notify you through Amazon EventBridge when there is an autoshift event for zonal autoshift. The status can be <code>ENABLED</code> or <code>DISABLED</code>. When <code>ENABLED</code>, a notification is sent when an autoshift is triggered. When <code>DISABLED</code>, notifications are not sent.
41+
* </p>
5142
* @example
5243
* Use a bare-bones client and the command you need to make an API call.
5344
* ```javascript

‎clients/client-arc-zonal-shift/src/commands/GetManagedResourceCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ export interface GetManagedResourceCommandOutput extends GetManagedResourceRespo
2929

3030
/**
3131
* <p>Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this Amazon Web Services Region. Resources that are registered for
32-
* zonal shifts are managed resources in Route 53 ARC. You can start zonal shifts and configure zonal autoshift for managed resources.</p>
33-
* <p>At this time, you can only start a zonal shift or configure zonal autoshift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.</p>
32+
* zonal shifts are managed resources in ARC. You can start zonal shifts and configure zonal autoshift for managed resources.</p>
3433
* @example
3534
* Use a bare-bones client and the command you need to make an API call.
3635
* ```javascript
@@ -57,6 +56,7 @@ export interface GetManagedResourceCommandOutput extends GetManagedResourceRespo
5756
* // expiryTime: new Date("TIMESTAMP"), // required
5857
* // startTime: new Date("TIMESTAMP"), // required
5958
* // comment: "STRING_VALUE", // required
59+
* // shiftType: "ZONAL_SHIFT" || "PRACTICE_RUN" || "FIS_EXPERIMENT" || "ZONAL_AUTOSHIFT",
6060
* // practiceRunOutcome: "FAILED" || "INTERRUPTED" || "PENDING" || "SUCCEEDED",
6161
* // },
6262
* // ],

‎clients/client-arc-zonal-shift/src/commands/ListAutoshiftsCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface ListAutoshiftsCommandInput extends ListAutoshiftsRequest {}
2828
export interface ListAutoshiftsCommandOutput extends ListAutoshiftsResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Returns a list of autoshifts for an Amazon Web Services Region. By default, the call returns
31+
* <p>Returns the autoshifts for an Amazon Web Services Region. By default, the call returns
3232
* only <code>ACTIVE</code> autoshifts. Optionally, you can specify the <code>status</code> parameter to return
3333
* <code>COMPLETED</code> autoshifts.
3434
* </p>
@@ -49,7 +49,7 @@ export interface ListAutoshiftsCommandOutput extends ListAutoshiftsResponse, __M
4949
* // items: [ // AutoshiftSummaries
5050
* // { // AutoshiftSummary
5151
* // awayFrom: "STRING_VALUE", // required
52-
* // endTime: new Date("TIMESTAMP"), // required
52+
* // endTime: new Date("TIMESTAMP"),
5353
* // startTime: new Date("TIMESTAMP"), // required
5454
* // status: "ACTIVE" || "COMPLETED", // required
5555
* // },

‎clients/client-arc-zonal-shift/src/commands/ListManagedResourcesCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ export interface ListManagedResourcesCommandOutput extends ListManagedResourcesR
6464
* // expiryTime: new Date("TIMESTAMP"), // required
6565
* // startTime: new Date("TIMESTAMP"), // required
6666
* // comment: "STRING_VALUE", // required
67+
* // shiftType: "ZONAL_SHIFT" || "PRACTICE_RUN" || "FIS_EXPERIMENT" || "ZONAL_AUTOSHIFT",
6768
* // practiceRunOutcome: "FAILED" || "INTERRUPTED" || "PENDING" || "SUCCEEDED",
6869
* // },
6970
* // ],

‎clients/client-arc-zonal-shift/src/commands/ListZonalShiftsCommand.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ export interface ListZonalShiftsCommandOutput extends ListZonalShiftsResponse, _
2929

3030
/**
3131
* <p>Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region.
32-
* <code>ListZonalShifts</code> returns customer-initiated zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on
32+
* <code>ListZonalShifts</code> returns customer-initiated zonal shifts, as well as practice run zonal shifts that ARC started on
3333
* your behalf for zonal autoshift.</p>
34-
* <p>The <code>ListZonalShifts</code> operation does not list autoshifts. For more information about listing
34+
* <p>For more information about listing
3535
* autoshifts, see <a href="https://docs.aws.amazon.com/arc-zonal-shift/latest/api/API_ListAutoshifts.html">"&gt;ListAutoshifts</a>.</p>
3636
* @example
3737
* Use a bare-bones client and the command you need to make an API call.
@@ -57,6 +57,7 @@ export interface ListZonalShiftsCommandOutput extends ListZonalShiftsResponse, _
5757
* // startTime: new Date("TIMESTAMP"), // required
5858
* // status: "ACTIVE" || "EXPIRED" || "CANCELED", // required
5959
* // comment: "STRING_VALUE", // required
60+
* // shiftType: "ZONAL_SHIFT" || "PRACTICE_RUN" || "FIS_EXPERIMENT" || "ZONAL_AUTOSHIFT",
6061
* // practiceRunOutcome: "FAILED" || "INTERRUPTED" || "PENDING" || "SUCCEEDED",
6162
* // },
6263
* // ],

‎clients/client-arc-zonal-shift/src/commands/StartZonalShiftCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ export interface StartZonalShiftCommandOutput extends ZonalShift, __MetadataBear
3030
/**
3131
* <p>You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region,
3232
* to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services
33-
* infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed
34-
* resources in your Amazon Web Services account in an Amazon Web Services Region. Resources are automatically registered with Route 53 ARC
33+
* infrastructure failure in a single Availability Zone. You can start a zonal shift in ARC only for managed
34+
* resources in your Amazon Web Services account in an Amazon Web Services Region. Resources are automatically registered with ARC
3535
* by Amazon Web Services services.</p>
3636
* <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>
3737
* <p>When you start a zonal shift, traffic for the resource is no longer routed to the Availability Zone. The
38-
* zonal shift is created immediately in Route 53 ARC. However, it can take a short time, typically up to a few minutes,
38+
* zonal shift is created immediately in ARC. However, it can take a short time, typically up to a few minutes,
3939
* for existing, in-progress connections in the Availability Zone to complete.</p>
4040
* <p>For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.html">Zonal shift</a>
4141
* in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>

‎clients/client-arc-zonal-shift/src/commands/UpdateAutoshiftObserverNotificationStatusCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ export interface UpdateAutoshiftObserverNotificationStatusCommandOutput
4141
* notification enables you to be notified, through Amazon EventBridge, when
4242
* there is an autoshift event for zonal autoshift.</p>
4343
* <p>If the status is <code>ENABLED</code>,
44-
* Route 53 ARC includes all autoshift events when you use the EventBridge pattern
44+
* ARC includes all autoshift events when you use the EventBridge pattern
4545
* <code>Autoshift In Progress</code>. When the status is <code>DISABLED</code>,
46-
* Route 53 ARC includes only autoshift events for autoshifts when one or more of your
46+
* ARC includes only autoshift events for autoshifts when one or more of your
4747
* resources is included in the autoshift.</p>
4848
* <p>For more information, see
4949
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html#ZAShiftNotification">

‎clients/client-arc-zonal-shift/src/commands/UpdateZonalShiftCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface UpdateZonalShiftCommandOutput extends ZonalShift, __MetadataBea
2929

3030
/**
3131
* <p>Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account. You can update a zonal shift to set a new expiration, or
32-
* edit or replace the comment for the zonal shift. </p>
32+
* edit or replace the comment for the zonal shift.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.
3535
* ```javascript

‎clients/client-arc-zonal-shift/src/index.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
// smithy-typescript generated code
22
/* eslint-disable */
33
/**
4-
* <p>Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Route 53 Application Recovery Controller (Route 53 ARC).</p>
4+
* <p>Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Route 53 Application Recovery Controller (ARC).</p>
55
* <p>You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to
66
* help your application recover quickly from an impairment in an Availability Zone. For example,
77
* you can recover your application from a developer's bad code deployment or from an
88
* Amazon Web Services infrastructure failure in a single Availability Zone.</p>
99
* <p>You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift
10-
* is a capability in Route 53 ARC where you authorize Amazon Web Services to shift away application resource
10+
* is a capability in ARC where you authorize Amazon Web Services to shift away application resource
1111
* traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery.
1212
* Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability
1313
* Zone impairment that could potentially impact customers.</p>
@@ -28,7 +28,7 @@
2828
* the minimum capacity of your auto scaling to continue operating normally with the loss of an
2929
* Availability Zone. </p>
3030
* </important>
31-
* <p>Be aware that Route 53 ARC does not inspect the health of individual resources. Amazon Web Services only starts an
31+
* <p>Be aware that ARC does not inspect the health of individual resources. Amazon Web Services only starts an
3232
* autoshift when Amazon Web Services telemetry detects that there is an Availability Zone impairment that could
3333
* potentially impact customers. In some cases, resources might be shifted away that are not experiencing
3434
* impact.</p>

0 commit comments

Comments
 (0)