@aws-sdk/client-arc-zonal-shift 3.613.0 → 3.615.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 +39 -16
- package/dist-cjs/index.js +95 -0
- package/dist-es/ARCZonalShift.js +4 -0
- package/dist-es/commands/GetAutoshiftObserverNotificationStatusCommand.js +24 -0
- package/dist-es/commands/UpdateAutoshiftObserverNotificationStatusCommand.js +24 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +49 -0
- package/dist-types/ARCZonalShift.d.ts +38 -16
- package/dist-types/ARCZonalShiftClient.d.ts +27 -18
- package/dist-types/commands/CreatePracticeRunConfigurationCommand.d.ts +3 -0
- package/dist-types/commands/GetAutoshiftObserverNotificationStatusCommand.d.ts +77 -0
- package/dist-types/commands/ListAutoshiftsCommand.d.ts +4 -1
- package/dist-types/commands/ListZonalShiftsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAutoshiftObserverNotificationStatusCommand.d.ts +82 -0
- package/dist-types/commands/UpdateZonalAutoshiftConfigurationCommand.d.ts +8 -4
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/index.d.ts +23 -16
- package/dist-types/models/models_0.d.ts +100 -39
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/dist-types/ts3.4/ARCZonalShift.d.ts +47 -0
- package/dist-types/ts3.4/ARCZonalShiftClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/GetAutoshiftObserverNotificationStatusCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/UpdateAutoshiftObserverNotificationStatusCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +16 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
- package/package.json +20 -20
|
@@ -10,11 +10,13 @@ import { HttpAuthSchemeInputConfig, HttpAuthSchemeResolvedConfig } from "./auth/
|
|
|
10
10
|
import { CancelZonalShiftCommandInput, CancelZonalShiftCommandOutput } from "./commands/CancelZonalShiftCommand";
|
|
11
11
|
import { CreatePracticeRunConfigurationCommandInput, CreatePracticeRunConfigurationCommandOutput } from "./commands/CreatePracticeRunConfigurationCommand";
|
|
12
12
|
import { DeletePracticeRunConfigurationCommandInput, DeletePracticeRunConfigurationCommandOutput } from "./commands/DeletePracticeRunConfigurationCommand";
|
|
13
|
+
import { GetAutoshiftObserverNotificationStatusCommandInput, GetAutoshiftObserverNotificationStatusCommandOutput } from "./commands/GetAutoshiftObserverNotificationStatusCommand";
|
|
13
14
|
import { GetManagedResourceCommandInput, GetManagedResourceCommandOutput } from "./commands/GetManagedResourceCommand";
|
|
14
15
|
import { ListAutoshiftsCommandInput, ListAutoshiftsCommandOutput } from "./commands/ListAutoshiftsCommand";
|
|
15
16
|
import { ListManagedResourcesCommandInput, ListManagedResourcesCommandOutput } from "./commands/ListManagedResourcesCommand";
|
|
16
17
|
import { ListZonalShiftsCommandInput, ListZonalShiftsCommandOutput } from "./commands/ListZonalShiftsCommand";
|
|
17
18
|
import { StartZonalShiftCommandInput, StartZonalShiftCommandOutput } from "./commands/StartZonalShiftCommand";
|
|
19
|
+
import { UpdateAutoshiftObserverNotificationStatusCommandInput, UpdateAutoshiftObserverNotificationStatusCommandOutput } from "./commands/UpdateAutoshiftObserverNotificationStatusCommand";
|
|
18
20
|
import { UpdatePracticeRunConfigurationCommandInput, UpdatePracticeRunConfigurationCommandOutput } from "./commands/UpdatePracticeRunConfigurationCommand";
|
|
19
21
|
import { UpdateZonalAutoshiftConfigurationCommandInput, UpdateZonalAutoshiftConfigurationCommandOutput } from "./commands/UpdateZonalAutoshiftConfigurationCommand";
|
|
20
22
|
import { UpdateZonalShiftCommandInput, UpdateZonalShiftCommandOutput } from "./commands/UpdateZonalShiftCommand";
|
|
@@ -24,11 +26,11 @@ export { __Client };
|
|
|
24
26
|
/**
|
|
25
27
|
* @public
|
|
26
28
|
*/
|
|
27
|
-
export type ServiceInputTypes = CancelZonalShiftCommandInput | CreatePracticeRunConfigurationCommandInput | DeletePracticeRunConfigurationCommandInput | GetManagedResourceCommandInput | ListAutoshiftsCommandInput | ListManagedResourcesCommandInput | ListZonalShiftsCommandInput | StartZonalShiftCommandInput | UpdatePracticeRunConfigurationCommandInput | UpdateZonalAutoshiftConfigurationCommandInput | UpdateZonalShiftCommandInput;
|
|
29
|
+
export type ServiceInputTypes = CancelZonalShiftCommandInput | CreatePracticeRunConfigurationCommandInput | DeletePracticeRunConfigurationCommandInput | GetAutoshiftObserverNotificationStatusCommandInput | GetManagedResourceCommandInput | ListAutoshiftsCommandInput | ListManagedResourcesCommandInput | ListZonalShiftsCommandInput | StartZonalShiftCommandInput | UpdateAutoshiftObserverNotificationStatusCommandInput | UpdatePracticeRunConfigurationCommandInput | UpdateZonalAutoshiftConfigurationCommandInput | UpdateZonalShiftCommandInput;
|
|
28
30
|
/**
|
|
29
31
|
* @public
|
|
30
32
|
*/
|
|
31
|
-
export type ServiceOutputTypes = CancelZonalShiftCommandOutput | CreatePracticeRunConfigurationCommandOutput | DeletePracticeRunConfigurationCommandOutput | GetManagedResourceCommandOutput | ListAutoshiftsCommandOutput | ListManagedResourcesCommandOutput | ListZonalShiftsCommandOutput | StartZonalShiftCommandOutput | UpdatePracticeRunConfigurationCommandOutput | UpdateZonalAutoshiftConfigurationCommandOutput | UpdateZonalShiftCommandOutput;
|
|
33
|
+
export type ServiceOutputTypes = CancelZonalShiftCommandOutput | CreatePracticeRunConfigurationCommandOutput | DeletePracticeRunConfigurationCommandOutput | GetAutoshiftObserverNotificationStatusCommandOutput | GetManagedResourceCommandOutput | ListAutoshiftsCommandOutput | ListManagedResourcesCommandOutput | ListZonalShiftsCommandOutput | StartZonalShiftCommandOutput | UpdateAutoshiftObserverNotificationStatusCommandOutput | UpdatePracticeRunConfigurationCommandOutput | UpdateZonalAutoshiftConfigurationCommandOutput | UpdateZonalShiftCommandOutput;
|
|
32
34
|
/**
|
|
33
35
|
* @public
|
|
34
36
|
*/
|
|
@@ -162,30 +164,37 @@ export type ARCZonalShiftClientResolvedConfigType = __SmithyResolvedConfiguratio
|
|
|
162
164
|
export interface ARCZonalShiftClientResolvedConfig extends ARCZonalShiftClientResolvedConfigType {
|
|
163
165
|
}
|
|
164
166
|
/**
|
|
165
|
-
* <p>Welcome to the
|
|
167
|
+
* <p>Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Route 53 Application Recovery Controller (Route 53 ARC).</p>
|
|
166
168
|
* <p>You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to
|
|
167
169
|
* help your application recover quickly from an impairment in an Availability Zone. For example,
|
|
168
170
|
* you can recover your application from a developer's bad code deployment or from an
|
|
169
171
|
* Amazon Web Services infrastructure failure in a single Availability Zone.</p>
|
|
170
|
-
* <p>You can also configure zonal autoshift for
|
|
171
|
-
* is a capability in Route 53 ARC where Amazon Web Services
|
|
172
|
-
* traffic from an Availability Zone, on your behalf, to help reduce your time to recovery
|
|
173
|
-
* Amazon Web Services
|
|
174
|
-
*
|
|
175
|
-
*
|
|
176
|
-
* <p>To ensure that zonal autoshift is safe for your application, you must
|
|
172
|
+
* <p>You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift
|
|
173
|
+
* is a capability in Route 53 ARC where you authorize Amazon Web Services to shift away application resource
|
|
174
|
+
* traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery.
|
|
175
|
+
* Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability
|
|
176
|
+
* Zone impairment that could potentially impact customers.</p>
|
|
177
|
+
* <p>To help make sure that zonal autoshift is safe for your application, you must
|
|
177
178
|
* also configure practice runs when you enable zonal autoshift for a resource. Practice runs start
|
|
178
|
-
* weekly zonal shifts for a resource, to shift
|
|
179
|
-
*
|
|
180
|
-
*
|
|
181
|
-
* for your application to continue to operate normally
|
|
179
|
+
* weekly zonal shifts for a resource, to shift traffic for the resource away from an Availability Zone.
|
|
180
|
+
* Practice runs help you to make sure, on a regular basis, that you have enough capacity in all the
|
|
181
|
+
* Availability Zones in an Amazon Web Services Region for your application to continue to operate normally
|
|
182
182
|
* when traffic for a resource is shifted away from one Availability Zone.</p>
|
|
183
183
|
* <important>
|
|
184
|
-
* <p>
|
|
185
|
-
*
|
|
186
|
-
*
|
|
187
|
-
* starts.
|
|
184
|
+
* <p>Before you configure practice runs or enable zonal autoshift, we strongly recommend
|
|
185
|
+
* that you prescale your application resource capacity in all Availability Zones in the Region where
|
|
186
|
+
* your application resources are deployed. You should not rely on scaling on demand when an
|
|
187
|
+
* autoshift or practice run starts. Zonal autoshift, including practice runs, works independently,
|
|
188
|
+
* and does not wait for auto scaling actions to complete. Relying on auto scaling, instead of
|
|
189
|
+
* pre-scaling, can result in loss of availability.</p>
|
|
190
|
+
* <p>If you use auto scaling to handle regular cycles of traffic, we strongly recommend that you configure
|
|
191
|
+
* the minimum capacity of your auto scaling to continue operating normally with the loss of an
|
|
192
|
+
* Availability Zone. </p>
|
|
188
193
|
* </important>
|
|
194
|
+
* <p>Be aware that Route 53 ARC does not inspect the health of individual resources. Amazon Web Services only starts an
|
|
195
|
+
* autoshift when Amazon Web Services telemetry detects that there is an Availability Zone impairment that could
|
|
196
|
+
* potentially impact customers. In some cases, resources might be shifted away that are not experiencing
|
|
197
|
+
* impact.</p>
|
|
189
198
|
* <p>For more information about using zonal shift and zonal autoshift, see the
|
|
190
199
|
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route53-recovery.html">Amazon Route 53 Application Recovery Controller
|
|
191
200
|
* Developer Guide</a>.</p>
|
|
@@ -32,6 +32,9 @@ declare const CreatePracticeRunConfigurationCommand_base: {
|
|
|
32
32
|
* and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an
|
|
33
33
|
* <i>outcome alarm</i>, to monitor application health during practice runs and,
|
|
34
34
|
* optionally, a <i>blocking alarm</i>, to block practice runs from starting.</p>
|
|
35
|
+
* <p>When a resource has a practice run configuration, Route 53 ARC starts zonal shifts for the resource
|
|
36
|
+
* weekly, to shift traffic for practice runs. Practice runs help you to ensure that
|
|
37
|
+
* shifting away traffic from an Availability Zone during an autoshift is safe for your application.</p>
|
|
35
38
|
* <p>For more information, see
|
|
36
39
|
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html">
|
|
37
40
|
* Considerations when you configure zonal autoshift</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ARCZonalShiftClient";
|
|
4
|
+
import { GetAutoshiftObserverNotificationStatusRequest, GetAutoshiftObserverNotificationStatusResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetAutoshiftObserverNotificationStatusCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetAutoshiftObserverNotificationStatusCommandInput extends GetAutoshiftObserverNotificationStatusRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetAutoshiftObserverNotificationStatusCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetAutoshiftObserverNotificationStatusCommandOutput extends GetAutoshiftObserverNotificationStatusResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetAutoshiftObserverNotificationStatusCommand_base: {
|
|
25
|
+
new (input: GetAutoshiftObserverNotificationStatusCommandInput): import("@smithy/smithy-client").CommandImpl<GetAutoshiftObserverNotificationStatusCommandInput, GetAutoshiftObserverNotificationStatusCommandOutput, ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [GetAutoshiftObserverNotificationStatusCommandInput]): import("@smithy/smithy-client").CommandImpl<GetAutoshiftObserverNotificationStatusCommandInput, GetAutoshiftObserverNotificationStatusCommandOutput, ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns the status of autoshift observer notification. Autoshift observer
|
|
31
|
+
* notification enables you to be notified, through Amazon EventBridge, when
|
|
32
|
+
* there is an autoshift event for zonal autoshift.</p>
|
|
33
|
+
* <p>If the status is <code>ENABLED</code>,
|
|
34
|
+
* Route 53 ARC includes all autoshift events when you use the EventBridge pattern
|
|
35
|
+
* <code>Autoshift In Progress</code>. When the status is <code>DISABLED</code>,
|
|
36
|
+
* Route 53 ARC includes only autoshift events for autoshifts when one or more of your
|
|
37
|
+
* resources is included in the autoshift.</p>
|
|
38
|
+
* <p>For more information, see
|
|
39
|
+
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html#ZAShiftNotification">
|
|
40
|
+
* Notifications for practice runs and autoshifts</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
41
|
+
* @example
|
|
42
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
43
|
+
* ```javascript
|
|
44
|
+
* import { ARCZonalShiftClient, GetAutoshiftObserverNotificationStatusCommand } from "@aws-sdk/client-arc-zonal-shift"; // ES Modules import
|
|
45
|
+
* // const { ARCZonalShiftClient, GetAutoshiftObserverNotificationStatusCommand } = require("@aws-sdk/client-arc-zonal-shift"); // CommonJS import
|
|
46
|
+
* const client = new ARCZonalShiftClient(config);
|
|
47
|
+
* const input = {};
|
|
48
|
+
* const command = new GetAutoshiftObserverNotificationStatusCommand(input);
|
|
49
|
+
* const response = await client.send(command);
|
|
50
|
+
* // { // GetAutoshiftObserverNotificationStatusResponse
|
|
51
|
+
* // status: "ENABLED" || "DISABLED", // required
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
56
|
+
* @param GetAutoshiftObserverNotificationStatusCommandInput - {@link GetAutoshiftObserverNotificationStatusCommandInput}
|
|
57
|
+
* @returns {@link GetAutoshiftObserverNotificationStatusCommandOutput}
|
|
58
|
+
* @see {@link GetAutoshiftObserverNotificationStatusCommandInput} for command's `input` shape.
|
|
59
|
+
* @see {@link GetAutoshiftObserverNotificationStatusCommandOutput} for command's `response` shape.
|
|
60
|
+
* @see {@link ARCZonalShiftClientResolvedConfig | config} for ARCZonalShiftClient's `config` shape.
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
63
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InternalServerException} (server fault)
|
|
66
|
+
* <p>There was an internal server error.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
69
|
+
* <p>The request was denied due to request throttling.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ARCZonalShiftServiceException}
|
|
72
|
+
* <p>Base exception class for all service exceptions from ARCZonalShift service.</p>
|
|
73
|
+
*
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
export declare class GetAutoshiftObserverNotificationStatusCommand extends GetAutoshiftObserverNotificationStatusCommand_base {
|
|
77
|
+
}
|
|
@@ -27,7 +27,10 @@ declare const ListAutoshiftsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns
|
|
30
|
+
* <p>Returns a list of autoshifts for an Amazon Web Services Region. By default, the call returns
|
|
31
|
+
* only <code>ACTIVE</code> autoshifts. Optionally, you can specify the <code>status</code> parameter to return
|
|
32
|
+
* <code>COMPLETED</code> autoshifts.
|
|
33
|
+
* </p>
|
|
31
34
|
* @example
|
|
32
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
36
|
* ```javascript
|
|
@@ -28,7 +28,7 @@ declare const ListZonalShiftsCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <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.
|
|
31
|
-
* <code>ListZonalShifts</code> returns customer-
|
|
31
|
+
* <code>ListZonalShifts</code> returns customer-initiated zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on
|
|
32
32
|
* your behalf for zonal autoshift.</p>
|
|
33
33
|
* <p>The <code>ListZonalShifts</code> operation does not list autoshifts. For more information about listing
|
|
34
34
|
* autoshifts, see <a href="https://docs.aws.amazon.com/arc-zonal-shift/latest/api/API_ListAutoshifts.html">">ListAutoshifts</a>.</p>
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ARCZonalShiftClient";
|
|
4
|
+
import { UpdateAutoshiftObserverNotificationStatusRequest, UpdateAutoshiftObserverNotificationStatusResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpdateAutoshiftObserverNotificationStatusCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateAutoshiftObserverNotificationStatusCommandInput extends UpdateAutoshiftObserverNotificationStatusRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateAutoshiftObserverNotificationStatusCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateAutoshiftObserverNotificationStatusCommandOutput extends UpdateAutoshiftObserverNotificationStatusResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateAutoshiftObserverNotificationStatusCommand_base: {
|
|
25
|
+
new (input: UpdateAutoshiftObserverNotificationStatusCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateAutoshiftObserverNotificationStatusCommandInput, UpdateAutoshiftObserverNotificationStatusCommandOutput, ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: UpdateAutoshiftObserverNotificationStatusCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateAutoshiftObserverNotificationStatusCommandInput, UpdateAutoshiftObserverNotificationStatusCommandOutput, ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Update the status of autoshift observer notification. Autoshift observer
|
|
31
|
+
* notification enables you to be notified, through Amazon EventBridge, when
|
|
32
|
+
* there is an autoshift event for zonal autoshift.</p>
|
|
33
|
+
* <p>If the status is <code>ENABLED</code>,
|
|
34
|
+
* Route 53 ARC includes all autoshift events when you use the EventBridge pattern
|
|
35
|
+
* <code>Autoshift In Progress</code>. When the status is <code>DISABLED</code>,
|
|
36
|
+
* Route 53 ARC includes only autoshift events for autoshifts when one or more of your
|
|
37
|
+
* resources is included in the autoshift.</p>
|
|
38
|
+
* <p>For more information, see
|
|
39
|
+
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html#ZAShiftNotification">
|
|
40
|
+
* Notifications for practice runs and autoshifts</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
41
|
+
* @example
|
|
42
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
43
|
+
* ```javascript
|
|
44
|
+
* import { ARCZonalShiftClient, UpdateAutoshiftObserverNotificationStatusCommand } from "@aws-sdk/client-arc-zonal-shift"; // ES Modules import
|
|
45
|
+
* // const { ARCZonalShiftClient, UpdateAutoshiftObserverNotificationStatusCommand } = require("@aws-sdk/client-arc-zonal-shift"); // CommonJS import
|
|
46
|
+
* const client = new ARCZonalShiftClient(config);
|
|
47
|
+
* const input = { // UpdateAutoshiftObserverNotificationStatusRequest
|
|
48
|
+
* status: "ENABLED" || "DISABLED", // required
|
|
49
|
+
* };
|
|
50
|
+
* const command = new UpdateAutoshiftObserverNotificationStatusCommand(input);
|
|
51
|
+
* const response = await client.send(command);
|
|
52
|
+
* // { // UpdateAutoshiftObserverNotificationStatusResponse
|
|
53
|
+
* // status: "ENABLED" || "DISABLED", // required
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @param UpdateAutoshiftObserverNotificationStatusCommandInput - {@link UpdateAutoshiftObserverNotificationStatusCommandInput}
|
|
59
|
+
* @returns {@link UpdateAutoshiftObserverNotificationStatusCommandOutput}
|
|
60
|
+
* @see {@link UpdateAutoshiftObserverNotificationStatusCommandInput} for command's `input` shape.
|
|
61
|
+
* @see {@link UpdateAutoshiftObserverNotificationStatusCommandOutput} for command's `response` shape.
|
|
62
|
+
* @see {@link ARCZonalShiftClientResolvedConfig | config} for ARCZonalShiftClient's `config` shape.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
65
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link InternalServerException} (server fault)
|
|
68
|
+
* <p>There was an internal server error.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
71
|
+
* <p>The request was denied due to request throttling.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ValidationException} (client fault)
|
|
74
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ARCZonalShiftServiceException}
|
|
77
|
+
* <p>Base exception class for all service exceptions from ARCZonalShift service.</p>
|
|
78
|
+
*
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
export declare class UpdateAutoshiftObserverNotificationStatusCommand extends UpdateAutoshiftObserverNotificationStatusCommand_base {
|
|
82
|
+
}
|
|
@@ -27,10 +27,14 @@ declare const UpdateZonalAutoshiftConfigurationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* autoshift. When
|
|
32
|
-
* resource traffic from an Availability Zone
|
|
33
|
-
*
|
|
30
|
+
* <p>The zonal autoshift configuration for a resource includes the practice run configuration and the status for
|
|
31
|
+
* running autoshifts, zonal autoshift status. When a resource has a practice run configuation, Route 53 ARC
|
|
32
|
+
* starts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice
|
|
33
|
+
* runs help you to make sure that your application can continue to operate normally with the loss of one Availability Zone.</p>
|
|
34
|
+
* <p>You can update the zonal autoshift autoshift status to enable or disable zonal autoshift. When zonal
|
|
35
|
+
* autoshift is <code>ENABLED</code>, you authorize Amazon Web Services to shift away resource traffic for
|
|
36
|
+
* an application from an Availability Zone during events, on your behalf, to help reduce time to recovery.
|
|
37
|
+
* Traffic is also shifted away for the required weekly practice runs.</p>
|
|
34
38
|
* @example
|
|
35
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
40
|
* ```javascript
|
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
export * from "./CancelZonalShiftCommand";
|
|
2
2
|
export * from "./CreatePracticeRunConfigurationCommand";
|
|
3
3
|
export * from "./DeletePracticeRunConfigurationCommand";
|
|
4
|
+
export * from "./GetAutoshiftObserverNotificationStatusCommand";
|
|
4
5
|
export * from "./GetManagedResourceCommand";
|
|
5
6
|
export * from "./ListAutoshiftsCommand";
|
|
6
7
|
export * from "./ListManagedResourcesCommand";
|
|
7
8
|
export * from "./ListZonalShiftsCommand";
|
|
8
9
|
export * from "./StartZonalShiftCommand";
|
|
10
|
+
export * from "./UpdateAutoshiftObserverNotificationStatusCommand";
|
|
9
11
|
export * from "./UpdatePracticeRunConfigurationCommand";
|
|
10
12
|
export * from "./UpdateZonalAutoshiftConfigurationCommand";
|
|
11
13
|
export * from "./UpdateZonalShiftCommand";
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,28 +1,35 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <p>Welcome to the
|
|
2
|
+
* <p>Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Route 53 Application Recovery Controller (Route 53 ARC).</p>
|
|
3
3
|
* <p>You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to
|
|
4
4
|
* help your application recover quickly from an impairment in an Availability Zone. For example,
|
|
5
5
|
* you can recover your application from a developer's bad code deployment or from an
|
|
6
6
|
* Amazon Web Services infrastructure failure in a single Availability Zone.</p>
|
|
7
|
-
* <p>You can also configure zonal autoshift for
|
|
8
|
-
* is a capability in Route 53 ARC where Amazon Web Services
|
|
9
|
-
* traffic from an Availability Zone, on your behalf, to help reduce your time to recovery
|
|
10
|
-
* Amazon Web Services
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
* <p>To ensure that zonal autoshift is safe for your application, you must
|
|
7
|
+
* <p>You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift
|
|
8
|
+
* is a capability in Route 53 ARC where you authorize Amazon Web Services to shift away application resource
|
|
9
|
+
* traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery.
|
|
10
|
+
* Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability
|
|
11
|
+
* Zone impairment that could potentially impact customers.</p>
|
|
12
|
+
* <p>To help make sure that zonal autoshift is safe for your application, you must
|
|
14
13
|
* also configure practice runs when you enable zonal autoshift for a resource. Practice runs start
|
|
15
|
-
* weekly zonal shifts for a resource, to shift
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* for your application to continue to operate normally
|
|
14
|
+
* weekly zonal shifts for a resource, to shift traffic for the resource away from an Availability Zone.
|
|
15
|
+
* Practice runs help you to make sure, on a regular basis, that you have enough capacity in all the
|
|
16
|
+
* Availability Zones in an Amazon Web Services Region for your application to continue to operate normally
|
|
19
17
|
* when traffic for a resource is shifted away from one Availability Zone.</p>
|
|
20
18
|
* <important>
|
|
21
|
-
* <p>
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
* starts.
|
|
19
|
+
* <p>Before you configure practice runs or enable zonal autoshift, we strongly recommend
|
|
20
|
+
* that you prescale your application resource capacity in all Availability Zones in the Region where
|
|
21
|
+
* your application resources are deployed. You should not rely on scaling on demand when an
|
|
22
|
+
* autoshift or practice run starts. Zonal autoshift, including practice runs, works independently,
|
|
23
|
+
* and does not wait for auto scaling actions to complete. Relying on auto scaling, instead of
|
|
24
|
+
* pre-scaling, can result in loss of availability.</p>
|
|
25
|
+
* <p>If you use auto scaling to handle regular cycles of traffic, we strongly recommend that you configure
|
|
26
|
+
* the minimum capacity of your auto scaling to continue operating normally with the loss of an
|
|
27
|
+
* Availability Zone. </p>
|
|
25
28
|
* </important>
|
|
29
|
+
* <p>Be aware that Route 53 ARC does not inspect the health of individual resources. Amazon Web Services only starts an
|
|
30
|
+
* autoshift when Amazon Web Services telemetry detects that there is an Availability Zone impairment that could
|
|
31
|
+
* potentially impact customers. In some cases, resources might be shifted away that are not experiencing
|
|
32
|
+
* impact.</p>
|
|
26
33
|
* <p>For more information about using zonal shift and zonal autoshift, see the
|
|
27
34
|
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route53-recovery.html">Amazon Route 53 Application Recovery Controller
|
|
28
35
|
* Developer Guide</a>.</p>
|