@aws-sdk/client-arc-region-switch 3.859.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/LICENSE +201 -0
- package/README.md +365 -0
- package/dist-cjs/ARCRegionSwitch.js +51 -0
- package/dist-cjs/ARCRegionSwitchClient.js +52 -0
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
- package/dist-cjs/commands/ApprovePlanExecutionStepCommand.js +26 -0
- package/dist-cjs/commands/CancelPlanExecutionCommand.js +26 -0
- package/dist-cjs/commands/CreatePlanCommand.js +29 -0
- package/dist-cjs/commands/DeletePlanCommand.js +29 -0
- package/dist-cjs/commands/GetPlanCommand.js +29 -0
- package/dist-cjs/commands/GetPlanEvaluationStatusCommand.js +26 -0
- package/dist-cjs/commands/GetPlanExecutionCommand.js +26 -0
- package/dist-cjs/commands/GetPlanInRegionCommand.js +26 -0
- package/dist-cjs/commands/ListPlanExecutionEventsCommand.js +26 -0
- package/dist-cjs/commands/ListPlanExecutionsCommand.js +26 -0
- package/dist-cjs/commands/ListPlansCommand.js +29 -0
- package/dist-cjs/commands/ListPlansInRegionCommand.js +26 -0
- package/dist-cjs/commands/ListRoute53HealthChecksCommand.js +29 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +29 -0
- package/dist-cjs/commands/StartPlanExecutionCommand.js +26 -0
- package/dist-cjs/commands/TagResourceCommand.js +29 -0
- package/dist-cjs/commands/UntagResourceCommand.js +29 -0
- package/dist-cjs/commands/UpdatePlanCommand.js +29 -0
- package/dist-cjs/commands/UpdatePlanExecutionCommand.js +26 -0
- package/dist-cjs/commands/UpdatePlanExecutionStepCommand.js +26 -0
- package/dist-cjs/commands/index.js +23 -0
- package/dist-cjs/endpoint/EndpointParameters.js +15 -0
- package/dist-cjs/endpoint/endpointResolver.js +18 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +12 -0
- package/dist-cjs/models/ARCRegionSwitchServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +233 -0
- package/dist-cjs/pagination/GetPlanEvaluationStatusPaginator.js +7 -0
- package/dist-cjs/pagination/GetPlanExecutionPaginator.js +7 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListPlanExecutionEventsPaginator.js +7 -0
- package/dist-cjs/pagination/ListPlanExecutionsPaginator.js +7 -0
- package/dist-cjs/pagination/ListPlansInRegionPaginator.js +7 -0
- package/dist-cjs/pagination/ListPlansPaginator.js +7 -0
- package/dist-cjs/pagination/ListRoute53HealthChecksPaginator.js +7 -0
- package/dist-cjs/pagination/index.js +11 -0
- package/dist-cjs/protocols/Aws_json1_0.js +919 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +56 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +34 -0
- package/dist-cjs/runtimeExtensions.js +13 -0
- package/dist-cjs/waiters/index.js +5 -0
- package/dist-cjs/waiters/waitForPlanEvaluationStatusPassed.js +54 -0
- package/dist-cjs/waiters/waitForPlanExecutionCompleted.js +72 -0
- package/dist-es/ARCRegionSwitch.js +47 -0
- package/dist-es/ARCRegionSwitchClient.js +48 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
- package/dist-es/commands/ApprovePlanExecutionStepCommand.js +22 -0
- package/dist-es/commands/CancelPlanExecutionCommand.js +22 -0
- package/dist-es/commands/CreatePlanCommand.js +25 -0
- package/dist-es/commands/DeletePlanCommand.js +25 -0
- package/dist-es/commands/GetPlanCommand.js +25 -0
- package/dist-es/commands/GetPlanEvaluationStatusCommand.js +22 -0
- package/dist-es/commands/GetPlanExecutionCommand.js +22 -0
- package/dist-es/commands/GetPlanInRegionCommand.js +22 -0
- package/dist-es/commands/ListPlanExecutionEventsCommand.js +22 -0
- package/dist-es/commands/ListPlanExecutionsCommand.js +22 -0
- package/dist-es/commands/ListPlansCommand.js +25 -0
- package/dist-es/commands/ListPlansInRegionCommand.js +22 -0
- package/dist-es/commands/ListRoute53HealthChecksCommand.js +25 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +25 -0
- package/dist-es/commands/StartPlanExecutionCommand.js +22 -0
- package/dist-es/commands/TagResourceCommand.js +25 -0
- package/dist-es/commands/UntagResourceCommand.js +25 -0
- package/dist-es/commands/UpdatePlanCommand.js +25 -0
- package/dist-es/commands/UpdatePlanExecutionCommand.js +22 -0
- package/dist-es/commands/UpdatePlanExecutionStepCommand.js +22 -0
- package/dist-es/commands/index.js +20 -0
- package/dist-es/endpoint/EndpointParameters.js +11 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +7 -0
- package/dist-es/models/ARCRegionSwitchServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +225 -0
- package/dist-es/pagination/GetPlanEvaluationStatusPaginator.js +4 -0
- package/dist-es/pagination/GetPlanExecutionPaginator.js +4 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListPlanExecutionEventsPaginator.js +4 -0
- package/dist-es/pagination/ListPlanExecutionsPaginator.js +4 -0
- package/dist-es/pagination/ListPlansInRegionPaginator.js +4 -0
- package/dist-es/pagination/ListPlansPaginator.js +4 -0
- package/dist-es/pagination/ListRoute53HealthChecksPaginator.js +4 -0
- package/dist-es/pagination/index.js +8 -0
- package/dist-es/protocols/Aws_json1_0.js +876 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +51 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +30 -0
- package/dist-es/runtimeExtensions.js +9 -0
- package/dist-es/waiters/index.js +2 -0
- package/dist-es/waiters/waitForPlanEvaluationStatusPassed.js +49 -0
- package/dist-es/waiters/waitForPlanExecutionCompleted.js +67 -0
- package/dist-types/ARCRegionSwitch.d.ts +152 -0
- package/dist-types/ARCRegionSwitchClient.d.ts +207 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
- package/dist-types/commands/ApprovePlanExecutionStepCommand.d.ts +80 -0
- package/dist-types/commands/CancelPlanExecutionCommand.d.ts +78 -0
- package/dist-types/commands/CreatePlanCommand.d.ts +697 -0
- package/dist-types/commands/DeletePlanCommand.d.ts +76 -0
- package/dist-types/commands/GetPlanCommand.d.ts +389 -0
- package/dist-types/commands/GetPlanEvaluationStatusCommand.d.ts +99 -0
- package/dist-types/commands/GetPlanExecutionCommand.d.ts +417 -0
- package/dist-types/commands/GetPlanInRegionCommand.d.ts +392 -0
- package/dist-types/commands/ListPlanExecutionEventsCommand.d.ts +97 -0
- package/dist-types/commands/ListPlanExecutionsCommand.d.ts +97 -0
- package/dist-types/commands/ListPlansCommand.d.ts +91 -0
- package/dist-types/commands/ListPlansInRegionCommand.d.ts +94 -0
- package/dist-types/commands/ListRoute53HealthChecksCommand.d.ts +93 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +80 -0
- package/dist-types/commands/StartPlanExecutionCommand.d.ts +93 -0
- package/dist-types/commands/TagResourceCommand.d.ts +79 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +79 -0
- package/dist-types/commands/UpdatePlanCommand.d.ts +692 -0
- package/dist-types/commands/UpdatePlanExecutionCommand.d.ts +82 -0
- package/dist-types/commands/UpdatePlanExecutionStepCommand.d.ts +80 -0
- package/dist-types/commands/index.d.ts +20 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +33 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +15 -0
- package/dist-types/models/ARCRegionSwitchServiceException.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +2370 -0
- package/dist-types/pagination/GetPlanEvaluationStatusPaginator.d.ts +7 -0
- package/dist-types/pagination/GetPlanExecutionPaginator.d.ts +7 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListPlanExecutionEventsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListPlanExecutionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListPlansInRegionPaginator.d.ts +7 -0
- package/dist-types/pagination/ListPlansPaginator.d.ts +7 -0
- package/dist-types/pagination/ListRoute53HealthChecksPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +8 -0
- package/dist-types/protocols/Aws_json1_0.d.ts +182 -0
- package/dist-types/runtimeConfig.browser.d.ts +50 -0
- package/dist-types/runtimeConfig.d.ts +50 -0
- package/dist-types/runtimeConfig.native.d.ts +49 -0
- package/dist-types/runtimeConfig.shared.d.ts +21 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/ARCRegionSwitch.d.ts +349 -0
- package/dist-types/ts3.4/ARCRegionSwitchClient.d.ts +240 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +47 -0
- package/dist-types/ts3.4/commands/ApprovePlanExecutionStepCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CancelPlanExecutionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreatePlanCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeletePlanCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetPlanCommand.d.ts +43 -0
- package/dist-types/ts3.4/commands/GetPlanEvaluationStatusCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetPlanExecutionCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetPlanInRegionCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListPlanExecutionEventsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListPlanExecutionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListPlansCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListPlansInRegionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListRoute53HealthChecksCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StartPlanExecutionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdatePlanCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdatePlanExecutionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdatePlanExecutionStepCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +20 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +46 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +10 -0
- package/dist-types/ts3.4/models/ARCRegionSwitchServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +813 -0
- package/dist-types/ts3.4/pagination/GetPlanEvaluationStatusPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/GetPlanExecutionPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListPlanExecutionEventsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListPlanExecutionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListPlansInRegionPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListPlansPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListRoute53HealthChecksPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +8 -0
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +245 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +93 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +91 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +97 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +23 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +13 -0
- package/dist-types/ts3.4/waiters/index.d.ts +2 -0
- package/dist-types/ts3.4/waiters/waitForPlanEvaluationStatusPassed.d.ts +11 -0
- package/dist-types/ts3.4/waiters/waitForPlanExecutionCompleted.d.ts +11 -0
- package/dist-types/waiters/index.d.ts +2 -0
- package/dist-types/waiters/waitForPlanEvaluationStatusPassed.d.ts +14 -0
- package/dist-types/waiters/waitForPlanExecutionCompleted.d.ts +14 -0
- package/package.json +100 -0
|
@@ -0,0 +1,2370 @@
|
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
+
import { ARCRegionSwitchServiceException as __BaseException } from "./ARCRegionSwitchServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
* @enum
|
|
6
|
+
*/
|
|
7
|
+
export declare const ExecutionAction: {
|
|
8
|
+
readonly ACTIVATE: "activate";
|
|
9
|
+
readonly DEACTIVATE: "deactivate";
|
|
10
|
+
};
|
|
11
|
+
/**
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
export type ExecutionAction = (typeof ExecutionAction)[keyof typeof ExecutionAction];
|
|
15
|
+
/**
|
|
16
|
+
* @public
|
|
17
|
+
* @enum
|
|
18
|
+
*/
|
|
19
|
+
export declare const ExecutionState: {
|
|
20
|
+
readonly CANCELLED: "canceled";
|
|
21
|
+
readonly COMPLETED: "completed";
|
|
22
|
+
readonly COMPLETED_MONITORING_APPLICATION_HEALTH: "completedMonitoringApplicationHealth";
|
|
23
|
+
readonly COMPLETED_WITH_EXCEPTIONS: "completedWithExceptions";
|
|
24
|
+
readonly FAILED: "failed";
|
|
25
|
+
readonly IN_PROGRESS: "inProgress";
|
|
26
|
+
readonly PAUSED_BY_FAILED_STEP: "pausedByFailedStep";
|
|
27
|
+
readonly PAUSED_BY_OPERATOR: "pausedByOperator";
|
|
28
|
+
readonly PENDING: "pending";
|
|
29
|
+
readonly PENDING_MANUAL_APPROVAL: "pendingManualApproval";
|
|
30
|
+
readonly PLAN_EXECUTION_TIMED_OUT: "planExecutionTimedOut";
|
|
31
|
+
};
|
|
32
|
+
/**
|
|
33
|
+
* @public
|
|
34
|
+
*/
|
|
35
|
+
export type ExecutionState = (typeof ExecutionState)[keyof typeof ExecutionState];
|
|
36
|
+
/**
|
|
37
|
+
* @public
|
|
38
|
+
* @enum
|
|
39
|
+
*/
|
|
40
|
+
export declare const ExecutionMode: {
|
|
41
|
+
readonly GRACEFUL: "graceful";
|
|
42
|
+
readonly UNGRACEFUL: "ungraceful";
|
|
43
|
+
};
|
|
44
|
+
/**
|
|
45
|
+
* @public
|
|
46
|
+
*/
|
|
47
|
+
export type ExecutionMode = (typeof ExecutionMode)[keyof typeof ExecutionMode];
|
|
48
|
+
/**
|
|
49
|
+
* <p>A summarized representation of a plan execution. This structure contains key information about an execution without all the detailed step data.</p>
|
|
50
|
+
* @public
|
|
51
|
+
*/
|
|
52
|
+
export interface AbbreviatedExecution {
|
|
53
|
+
/**
|
|
54
|
+
* <p>The Amazon Resource Name (ARN) of the plan.</p>
|
|
55
|
+
* @public
|
|
56
|
+
*/
|
|
57
|
+
planArn: string | undefined;
|
|
58
|
+
/**
|
|
59
|
+
* <p>The execution identifier of a plan execution.</p>
|
|
60
|
+
* @public
|
|
61
|
+
*/
|
|
62
|
+
executionId: string | undefined;
|
|
63
|
+
/**
|
|
64
|
+
* <p>The version for the plan.</p>
|
|
65
|
+
* @public
|
|
66
|
+
*/
|
|
67
|
+
version?: string | undefined;
|
|
68
|
+
/**
|
|
69
|
+
* <p>The timestamp when the plan execution was last updated.</p>
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
updatedAt?: Date | undefined;
|
|
73
|
+
/**
|
|
74
|
+
* <p>An optional comment about the plan execution.</p>
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
77
|
+
comment?: string | undefined;
|
|
78
|
+
/**
|
|
79
|
+
* <p>The timestamp when the plan execution was started.</p>
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
82
|
+
startTime: Date | undefined;
|
|
83
|
+
/**
|
|
84
|
+
* <p>The timestamp when the plan execution was ended.</p>
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
endTime?: Date | undefined;
|
|
88
|
+
/**
|
|
89
|
+
* <p>The plan execution mode. Valid values are <code>Practice</code>, for testing without making actual changes, or <code>Recovery</code>, for actual traffic shifting and application recovery.</p>
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
mode: ExecutionMode | undefined;
|
|
93
|
+
/**
|
|
94
|
+
* <p>The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.</p>
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
executionState: ExecutionState | undefined;
|
|
98
|
+
/**
|
|
99
|
+
* <p>The plan execution action. Valid values are <code>Activate</code>, to activate an Amazon Web Services Region, or <code>Deactivate</code>, to deactivate a Region.</p>
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
executionAction: ExecutionAction | undefined;
|
|
103
|
+
/**
|
|
104
|
+
* <p>The Amazon Web Services Region for a plan execution.</p>
|
|
105
|
+
* @public
|
|
106
|
+
*/
|
|
107
|
+
executionRegion: string | undefined;
|
|
108
|
+
/**
|
|
109
|
+
* <p>The actual recovery time that Region switch calculates for a plan execution. Actual recovery time includes the time for the plan to run added to the time elapsed until the application health alarms that you've specified are healthy again.</p>
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
112
|
+
actualRecoveryTime?: string | undefined;
|
|
113
|
+
}
|
|
114
|
+
/**
|
|
115
|
+
* @public
|
|
116
|
+
* @enum
|
|
117
|
+
*/
|
|
118
|
+
export declare const RecoveryApproach: {
|
|
119
|
+
readonly ACTIVE_ACTIVE: "activeActive";
|
|
120
|
+
readonly ACTIVE_PASSIVE: "activePassive";
|
|
121
|
+
};
|
|
122
|
+
/**
|
|
123
|
+
* @public
|
|
124
|
+
*/
|
|
125
|
+
export type RecoveryApproach = (typeof RecoveryApproach)[keyof typeof RecoveryApproach];
|
|
126
|
+
/**
|
|
127
|
+
* <p>A summarized representation of a Region switch plan. This structure contains key information about a plan without all the detailed workflow and step data.</p>
|
|
128
|
+
* @public
|
|
129
|
+
*/
|
|
130
|
+
export interface AbbreviatedPlan {
|
|
131
|
+
/**
|
|
132
|
+
* <p>The Amazon Resource Name (ARN) of the Region switch plan.</p>
|
|
133
|
+
* @public
|
|
134
|
+
*/
|
|
135
|
+
arn: string | undefined;
|
|
136
|
+
/**
|
|
137
|
+
* <p>The owner of a Region switch plan.</p>
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
140
|
+
owner: string | undefined;
|
|
141
|
+
/**
|
|
142
|
+
* <p>The name of a Region switch plan.</p>
|
|
143
|
+
* @public
|
|
144
|
+
*/
|
|
145
|
+
name: string | undefined;
|
|
146
|
+
/**
|
|
147
|
+
* <p>The Amazon Web Services Region specified for a Region switch plan.</p>
|
|
148
|
+
* @public
|
|
149
|
+
*/
|
|
150
|
+
regions: string[] | undefined;
|
|
151
|
+
/**
|
|
152
|
+
* <p>The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).</p>
|
|
153
|
+
* @public
|
|
154
|
+
*/
|
|
155
|
+
recoveryApproach: RecoveryApproach | undefined;
|
|
156
|
+
/**
|
|
157
|
+
* <p>The primary Region for a plan.</p>
|
|
158
|
+
* @public
|
|
159
|
+
*/
|
|
160
|
+
primaryRegion?: string | undefined;
|
|
161
|
+
/**
|
|
162
|
+
* <p>The version for the plan.</p>
|
|
163
|
+
* @public
|
|
164
|
+
*/
|
|
165
|
+
version?: string | undefined;
|
|
166
|
+
/**
|
|
167
|
+
* <p>The timestamp when the plan execution was last updated.</p>
|
|
168
|
+
* @public
|
|
169
|
+
*/
|
|
170
|
+
updatedAt?: Date | undefined;
|
|
171
|
+
/**
|
|
172
|
+
* <p>The description of a Region switch plan.</p>
|
|
173
|
+
* @public
|
|
174
|
+
*/
|
|
175
|
+
description?: string | undefined;
|
|
176
|
+
/**
|
|
177
|
+
* <p>The execution role is a way to categorize a Region switch plan. </p>
|
|
178
|
+
* @public
|
|
179
|
+
*/
|
|
180
|
+
executionRole?: string | undefined;
|
|
181
|
+
/**
|
|
182
|
+
* <p>Specifies if this is the active plan execution at this time.</p>
|
|
183
|
+
* @public
|
|
184
|
+
*/
|
|
185
|
+
activePlanExecution?: string | undefined;
|
|
186
|
+
/**
|
|
187
|
+
* <p>The recovery time objective that you've specified.</p>
|
|
188
|
+
* @public
|
|
189
|
+
*/
|
|
190
|
+
recoveryTimeObjectiveMinutes?: number | undefined;
|
|
191
|
+
}
|
|
192
|
+
/**
|
|
193
|
+
* <p>You do not have sufficient access to perform this action.</p> <p>HTTP Status Code: 403</p>
|
|
194
|
+
* @public
|
|
195
|
+
*/
|
|
196
|
+
export declare class AccessDeniedException extends __BaseException {
|
|
197
|
+
readonly name: "AccessDeniedException";
|
|
198
|
+
readonly $fault: "client";
|
|
199
|
+
/**
|
|
200
|
+
* @internal
|
|
201
|
+
*/
|
|
202
|
+
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
203
|
+
}
|
|
204
|
+
/**
|
|
205
|
+
* @public
|
|
206
|
+
* @enum
|
|
207
|
+
*/
|
|
208
|
+
export declare const AlarmCondition: {
|
|
209
|
+
readonly GREEN: "green";
|
|
210
|
+
readonly RED: "red";
|
|
211
|
+
};
|
|
212
|
+
/**
|
|
213
|
+
* @public
|
|
214
|
+
*/
|
|
215
|
+
export type AlarmCondition = (typeof AlarmCondition)[keyof typeof AlarmCondition];
|
|
216
|
+
/**
|
|
217
|
+
* @public
|
|
218
|
+
* @enum
|
|
219
|
+
*/
|
|
220
|
+
export declare const AlarmType: {
|
|
221
|
+
readonly APPLICATION_HEALTH: "applicationHealth";
|
|
222
|
+
readonly TRIGGER: "trigger";
|
|
223
|
+
};
|
|
224
|
+
/**
|
|
225
|
+
* @public
|
|
226
|
+
*/
|
|
227
|
+
export type AlarmType = (typeof AlarmType)[keyof typeof AlarmType];
|
|
228
|
+
/**
|
|
229
|
+
* @public
|
|
230
|
+
* @enum
|
|
231
|
+
*/
|
|
232
|
+
export declare const Approval: {
|
|
233
|
+
readonly APPROVE: "approve";
|
|
234
|
+
readonly DECLINE: "decline";
|
|
235
|
+
};
|
|
236
|
+
/**
|
|
237
|
+
* @public
|
|
238
|
+
*/
|
|
239
|
+
export type Approval = (typeof Approval)[keyof typeof Approval];
|
|
240
|
+
/**
|
|
241
|
+
* @public
|
|
242
|
+
*/
|
|
243
|
+
export interface ApprovePlanExecutionStepRequest {
|
|
244
|
+
/**
|
|
245
|
+
* <p>The Amazon Resource Name (ARN) of the plan.</p>
|
|
246
|
+
* @public
|
|
247
|
+
*/
|
|
248
|
+
planArn: string | undefined;
|
|
249
|
+
/**
|
|
250
|
+
* <p>The execution identifier of a plan execution.</p>
|
|
251
|
+
* @public
|
|
252
|
+
*/
|
|
253
|
+
executionId: string | undefined;
|
|
254
|
+
/**
|
|
255
|
+
* <p>The name of a step in a plan execution.</p>
|
|
256
|
+
* @public
|
|
257
|
+
*/
|
|
258
|
+
stepName: string | undefined;
|
|
259
|
+
/**
|
|
260
|
+
* <p>The status of approval for a plan execution step. </p>
|
|
261
|
+
* @public
|
|
262
|
+
*/
|
|
263
|
+
approval: Approval | undefined;
|
|
264
|
+
/**
|
|
265
|
+
* <p>A comment that you can enter about a plan execution.</p>
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
comment?: string | undefined;
|
|
269
|
+
}
|
|
270
|
+
/**
|
|
271
|
+
* @public
|
|
272
|
+
*/
|
|
273
|
+
export interface ApprovePlanExecutionStepResponse {
|
|
274
|
+
}
|
|
275
|
+
/**
|
|
276
|
+
* <p>The specified resource was not found.</p> <p>HTTP Status Code: 404</p>
|
|
277
|
+
* @public
|
|
278
|
+
*/
|
|
279
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
280
|
+
readonly name: "ResourceNotFoundException";
|
|
281
|
+
readonly $fault: "client";
|
|
282
|
+
/**
|
|
283
|
+
* @internal
|
|
284
|
+
*/
|
|
285
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
286
|
+
}
|
|
287
|
+
/**
|
|
288
|
+
* @public
|
|
289
|
+
*/
|
|
290
|
+
export interface CancelPlanExecutionRequest {
|
|
291
|
+
/**
|
|
292
|
+
* <p>The Amazon Resource Name (ARN) of the plan.</p>
|
|
293
|
+
* @public
|
|
294
|
+
*/
|
|
295
|
+
planArn: string | undefined;
|
|
296
|
+
/**
|
|
297
|
+
* <p>The execution identifier of a plan execution.</p>
|
|
298
|
+
* @public
|
|
299
|
+
*/
|
|
300
|
+
executionId: string | undefined;
|
|
301
|
+
/**
|
|
302
|
+
* <p>A comment that you can enter about canceling a plan execution step.</p>
|
|
303
|
+
* @public
|
|
304
|
+
*/
|
|
305
|
+
comment?: string | undefined;
|
|
306
|
+
}
|
|
307
|
+
/**
|
|
308
|
+
* @public
|
|
309
|
+
*/
|
|
310
|
+
export interface CancelPlanExecutionResponse {
|
|
311
|
+
}
|
|
312
|
+
/**
|
|
313
|
+
* @public
|
|
314
|
+
*/
|
|
315
|
+
export interface GetPlanEvaluationStatusRequest {
|
|
316
|
+
/**
|
|
317
|
+
* <p>The Amazon Resource Name (ARN) of the Region switch plan to retrieve evaluation status for.</p>
|
|
318
|
+
* @public
|
|
319
|
+
*/
|
|
320
|
+
planArn: string | undefined;
|
|
321
|
+
/**
|
|
322
|
+
* <p>The number of objects that you want to return with this call.</p>
|
|
323
|
+
* @public
|
|
324
|
+
*/
|
|
325
|
+
maxResults?: number | undefined;
|
|
326
|
+
/**
|
|
327
|
+
* <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>
|
|
328
|
+
* @public
|
|
329
|
+
*/
|
|
330
|
+
nextToken?: string | undefined;
|
|
331
|
+
}
|
|
332
|
+
/**
|
|
333
|
+
* @public
|
|
334
|
+
* @enum
|
|
335
|
+
*/
|
|
336
|
+
export declare const EvaluationStatus: {
|
|
337
|
+
readonly ACTION_REQUIRED: "actionRequired";
|
|
338
|
+
readonly PASSED: "passed";
|
|
339
|
+
readonly PENDING_EVALUATION: "pendingEvaluation";
|
|
340
|
+
readonly UNKNOWN: "unknown";
|
|
341
|
+
};
|
|
342
|
+
/**
|
|
343
|
+
* @public
|
|
344
|
+
*/
|
|
345
|
+
export type EvaluationStatus = (typeof EvaluationStatus)[keyof typeof EvaluationStatus];
|
|
346
|
+
/**
|
|
347
|
+
* @public
|
|
348
|
+
* @enum
|
|
349
|
+
*/
|
|
350
|
+
export declare const ResourceWarningStatus: {
|
|
351
|
+
readonly ACTIVE: "active";
|
|
352
|
+
readonly RESOLVED: "resolved";
|
|
353
|
+
};
|
|
354
|
+
/**
|
|
355
|
+
* @public
|
|
356
|
+
*/
|
|
357
|
+
export type ResourceWarningStatus = (typeof ResourceWarningStatus)[keyof typeof ResourceWarningStatus];
|
|
358
|
+
/**
|
|
359
|
+
* <p>A simplified representation of a workflow in a Region switch plan.</p>
|
|
360
|
+
* @public
|
|
361
|
+
*/
|
|
362
|
+
export interface MinimalWorkflow {
|
|
363
|
+
/**
|
|
364
|
+
* <p>The action for a minimal workflow, which can be Activate or Deactivate.</p>
|
|
365
|
+
* @public
|
|
366
|
+
*/
|
|
367
|
+
action?: ExecutionAction | undefined;
|
|
368
|
+
/**
|
|
369
|
+
* <p>The name for a minimal workflow</p>
|
|
370
|
+
* @public
|
|
371
|
+
*/
|
|
372
|
+
name?: string | undefined;
|
|
373
|
+
}
|
|
374
|
+
/**
|
|
375
|
+
* <p>Represents a warning about a resource in a Region switch plan.</p>
|
|
376
|
+
* @public
|
|
377
|
+
*/
|
|
378
|
+
export interface ResourceWarning {
|
|
379
|
+
/**
|
|
380
|
+
* <p>The workflow for the resource warning.</p>
|
|
381
|
+
* @public
|
|
382
|
+
*/
|
|
383
|
+
workflow?: MinimalWorkflow | undefined;
|
|
384
|
+
/**
|
|
385
|
+
* <p>The version for the resource warning.</p>
|
|
386
|
+
* @public
|
|
387
|
+
*/
|
|
388
|
+
version: string | undefined;
|
|
389
|
+
/**
|
|
390
|
+
* <p>The name of the step for the resource warning.</p>
|
|
391
|
+
* @public
|
|
392
|
+
*/
|
|
393
|
+
stepName?: string | undefined;
|
|
394
|
+
/**
|
|
395
|
+
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
396
|
+
* @public
|
|
397
|
+
*/
|
|
398
|
+
resourceArn?: string | undefined;
|
|
399
|
+
/**
|
|
400
|
+
* <p>The status of the resource warning.</p>
|
|
401
|
+
* @public
|
|
402
|
+
*/
|
|
403
|
+
warningStatus: ResourceWarningStatus | undefined;
|
|
404
|
+
/**
|
|
405
|
+
* <p>The timestamp when the warning was last updated.</p>
|
|
406
|
+
* @public
|
|
407
|
+
*/
|
|
408
|
+
warningUpdatedTime: Date | undefined;
|
|
409
|
+
/**
|
|
410
|
+
* <p>The warning message about what needs to be corrected.</p>
|
|
411
|
+
* @public
|
|
412
|
+
*/
|
|
413
|
+
warningMessage: string | undefined;
|
|
414
|
+
}
|
|
415
|
+
/**
|
|
416
|
+
* @public
|
|
417
|
+
*/
|
|
418
|
+
export interface GetPlanEvaluationStatusResponse {
|
|
419
|
+
/**
|
|
420
|
+
* <p>The Amazon Resource Name (ARN) of the plan.</p>
|
|
421
|
+
* @public
|
|
422
|
+
*/
|
|
423
|
+
planArn: string | undefined;
|
|
424
|
+
/**
|
|
425
|
+
* <p>The time of the last time that Region switch ran an evaluation of the plan.</p>
|
|
426
|
+
* @public
|
|
427
|
+
*/
|
|
428
|
+
lastEvaluationTime?: Date | undefined;
|
|
429
|
+
/**
|
|
430
|
+
* <p>The version of the last evaluation of the plan.</p>
|
|
431
|
+
* @public
|
|
432
|
+
*/
|
|
433
|
+
lastEvaluatedVersion?: string | undefined;
|
|
434
|
+
/**
|
|
435
|
+
* <p>The Amazon Web Services Region for the plan.</p>
|
|
436
|
+
* @public
|
|
437
|
+
*/
|
|
438
|
+
region?: string | undefined;
|
|
439
|
+
/**
|
|
440
|
+
* <p>The evaluation state for the plan.</p>
|
|
441
|
+
* @public
|
|
442
|
+
*/
|
|
443
|
+
evaluationState?: EvaluationStatus | undefined;
|
|
444
|
+
/**
|
|
445
|
+
* <p>The current evaluation warnings for the plan. </p>
|
|
446
|
+
* @public
|
|
447
|
+
*/
|
|
448
|
+
warnings?: ResourceWarning[] | undefined;
|
|
449
|
+
/**
|
|
450
|
+
* <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>
|
|
451
|
+
* @public
|
|
452
|
+
*/
|
|
453
|
+
nextToken?: string | undefined;
|
|
454
|
+
}
|
|
455
|
+
/**
|
|
456
|
+
* @public
|
|
457
|
+
*/
|
|
458
|
+
export interface GetPlanExecutionRequest {
|
|
459
|
+
/**
|
|
460
|
+
* <p>The Amazon Resource Name (ARN) of the plan with the execution to retrieve.</p>
|
|
461
|
+
* @public
|
|
462
|
+
*/
|
|
463
|
+
planArn: string | undefined;
|
|
464
|
+
/**
|
|
465
|
+
* <p>The execution identifier of a plan execution.</p>
|
|
466
|
+
* @public
|
|
467
|
+
*/
|
|
468
|
+
executionId: string | undefined;
|
|
469
|
+
/**
|
|
470
|
+
* <p>The number of objects that you want to return with this call.</p>
|
|
471
|
+
* @public
|
|
472
|
+
*/
|
|
473
|
+
maxResults?: number | undefined;
|
|
474
|
+
/**
|
|
475
|
+
* <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>
|
|
476
|
+
* @public
|
|
477
|
+
*/
|
|
478
|
+
nextToken?: string | undefined;
|
|
479
|
+
}
|
|
480
|
+
/**
|
|
481
|
+
* <p>An Amazon CloudWatch alarm associated with a Region switch plan. These alarms can be used to trigger automatic execution of the plan.</p>
|
|
482
|
+
* @public
|
|
483
|
+
*/
|
|
484
|
+
export interface AssociatedAlarm {
|
|
485
|
+
/**
|
|
486
|
+
* <p>The cross account role for the configuration.</p>
|
|
487
|
+
* @public
|
|
488
|
+
*/
|
|
489
|
+
crossAccountRole?: string | undefined;
|
|
490
|
+
/**
|
|
491
|
+
* <p>The external ID (secret key) for the configuration.</p>
|
|
492
|
+
* @public
|
|
493
|
+
*/
|
|
494
|
+
externalId?: string | undefined;
|
|
495
|
+
/**
|
|
496
|
+
* <p>The resource identifier for alarms that you associate with a plan.</p>
|
|
497
|
+
* @public
|
|
498
|
+
*/
|
|
499
|
+
resourceIdentifier: string | undefined;
|
|
500
|
+
/**
|
|
501
|
+
* <p>The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.</p>
|
|
502
|
+
* @public
|
|
503
|
+
*/
|
|
504
|
+
alarmType: AlarmType | undefined;
|
|
505
|
+
}
|
|
506
|
+
/**
|
|
507
|
+
* @public
|
|
508
|
+
* @enum
|
|
509
|
+
*/
|
|
510
|
+
export declare const WorkflowTargetAction: {
|
|
511
|
+
readonly ACTIVATE: "activate";
|
|
512
|
+
readonly DEACTIVATE: "deactivate";
|
|
513
|
+
};
|
|
514
|
+
/**
|
|
515
|
+
* @public
|
|
516
|
+
*/
|
|
517
|
+
export type WorkflowTargetAction = (typeof WorkflowTargetAction)[keyof typeof WorkflowTargetAction];
|
|
518
|
+
/**
|
|
519
|
+
* <p>Defines a condition that must be met for a trigger to fire.</p>
|
|
520
|
+
* @public
|
|
521
|
+
*/
|
|
522
|
+
export interface TriggerCondition {
|
|
523
|
+
/**
|
|
524
|
+
* <p>The name of the CloudWatch alarm associated with the condition.</p>
|
|
525
|
+
* @public
|
|
526
|
+
*/
|
|
527
|
+
associatedAlarmName: string | undefined;
|
|
528
|
+
/**
|
|
529
|
+
* <p>The condition that must be met. Valid values include ALARM and OK.</p>
|
|
530
|
+
* @public
|
|
531
|
+
*/
|
|
532
|
+
condition: AlarmCondition | undefined;
|
|
533
|
+
}
|
|
534
|
+
/**
|
|
535
|
+
* <p>Defines a condition that can automatically trigger the execution of a Region switch plan.</p>
|
|
536
|
+
* @public
|
|
537
|
+
*/
|
|
538
|
+
export interface Trigger {
|
|
539
|
+
/**
|
|
540
|
+
* <p>The description for a trigger.</p>
|
|
541
|
+
* @public
|
|
542
|
+
*/
|
|
543
|
+
description?: string | undefined;
|
|
544
|
+
/**
|
|
545
|
+
* <p>The Amazon Web Services Region for a trigger.</p>
|
|
546
|
+
* @public
|
|
547
|
+
*/
|
|
548
|
+
targetRegion: string | undefined;
|
|
549
|
+
/**
|
|
550
|
+
* <p>The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.</p>
|
|
551
|
+
* @public
|
|
552
|
+
*/
|
|
553
|
+
action: WorkflowTargetAction | undefined;
|
|
554
|
+
/**
|
|
555
|
+
* <p>The conditions that must be met for the trigger to fire.</p>
|
|
556
|
+
* @public
|
|
557
|
+
*/
|
|
558
|
+
conditions: TriggerCondition[] | undefined;
|
|
559
|
+
/**
|
|
560
|
+
* <p>The minimum time, in minutes, that must elapse between automatic executions of the plan.</p>
|
|
561
|
+
* @public
|
|
562
|
+
*/
|
|
563
|
+
minDelayMinutesBetweenExecutions: number | undefined;
|
|
564
|
+
}
|
|
565
|
+
/**
|
|
566
|
+
* @public
|
|
567
|
+
* @enum
|
|
568
|
+
*/
|
|
569
|
+
export declare const RoutingControlStateChange: {
|
|
570
|
+
readonly OFF: "Off";
|
|
571
|
+
readonly ON: "On";
|
|
572
|
+
};
|
|
573
|
+
/**
|
|
574
|
+
* @public
|
|
575
|
+
*/
|
|
576
|
+
export type RoutingControlStateChange = (typeof RoutingControlStateChange)[keyof typeof RoutingControlStateChange];
|
|
577
|
+
/**
|
|
578
|
+
* <p>Represents the state of an ARC routing control.</p>
|
|
579
|
+
* @public
|
|
580
|
+
*/
|
|
581
|
+
export interface ArcRoutingControlState {
|
|
582
|
+
/**
|
|
583
|
+
* <p>The Amazon Resource Name (ARN) of a routing control.</p>
|
|
584
|
+
* @public
|
|
585
|
+
*/
|
|
586
|
+
routingControlArn: string | undefined;
|
|
587
|
+
/**
|
|
588
|
+
* <p>The state of an ARC routing control, On or Off.</p>
|
|
589
|
+
* @public
|
|
590
|
+
*/
|
|
591
|
+
state: RoutingControlStateChange | undefined;
|
|
592
|
+
}
|
|
593
|
+
/**
|
|
594
|
+
* <p>Configuration for ARC routing controls used in a Region switch plan. Routing controls are simple on/off switches that you can use to shift traffic away from an impaired Region.</p>
|
|
595
|
+
* @public
|
|
596
|
+
*/
|
|
597
|
+
export interface ArcRoutingControlConfiguration {
|
|
598
|
+
/**
|
|
599
|
+
* <p>The timeout value specified for the configuration.</p>
|
|
600
|
+
* @public
|
|
601
|
+
*/
|
|
602
|
+
timeoutMinutes?: number | undefined;
|
|
603
|
+
/**
|
|
604
|
+
* <p>The cross account role for the configuration.</p>
|
|
605
|
+
* @public
|
|
606
|
+
*/
|
|
607
|
+
crossAccountRole?: string | undefined;
|
|
608
|
+
/**
|
|
609
|
+
* <p>The external ID (secret key) for the configuration.</p>
|
|
610
|
+
* @public
|
|
611
|
+
*/
|
|
612
|
+
externalId?: string | undefined;
|
|
613
|
+
/**
|
|
614
|
+
* <p>The Region and ARC routing controls for the configuration.</p>
|
|
615
|
+
* @public
|
|
616
|
+
*/
|
|
617
|
+
regionAndRoutingControls: Record<string, ArcRoutingControlState[]> | undefined;
|
|
618
|
+
}
|
|
619
|
+
/**
|
|
620
|
+
* <p>Configuration for Amazon Web Services Lambda functions used in a Region switch plan.</p>
|
|
621
|
+
* @public
|
|
622
|
+
*/
|
|
623
|
+
export interface Lambdas {
|
|
624
|
+
/**
|
|
625
|
+
* <p>The cross account role for the configuration.</p>
|
|
626
|
+
* @public
|
|
627
|
+
*/
|
|
628
|
+
crossAccountRole?: string | undefined;
|
|
629
|
+
/**
|
|
630
|
+
* <p>The external ID (secret key) for the configuration.</p>
|
|
631
|
+
* @public
|
|
632
|
+
*/
|
|
633
|
+
externalId?: string | undefined;
|
|
634
|
+
/**
|
|
635
|
+
* <p>The Amazon Resource Name (ARN) of the Lambda function.</p>
|
|
636
|
+
* @public
|
|
637
|
+
*/
|
|
638
|
+
arn?: string | undefined;
|
|
639
|
+
}
|
|
640
|
+
/**
|
|
641
|
+
* @public
|
|
642
|
+
* @enum
|
|
643
|
+
*/
|
|
644
|
+
export declare const RegionToRunIn: {
|
|
645
|
+
readonly ACTIVATING_REGION: "activatingRegion";
|
|
646
|
+
readonly DEACTIVATING_REGION: "deactivatingRegion";
|
|
647
|
+
};
|
|
648
|
+
/**
|
|
649
|
+
* @public
|
|
650
|
+
*/
|
|
651
|
+
export type RegionToRunIn = (typeof RegionToRunIn)[keyof typeof RegionToRunIn];
|
|
652
|
+
/**
|
|
653
|
+
* @public
|
|
654
|
+
* @enum
|
|
655
|
+
*/
|
|
656
|
+
export declare const LambdaUngracefulBehavior: {
|
|
657
|
+
readonly SKIP: "skip";
|
|
658
|
+
};
|
|
659
|
+
/**
|
|
660
|
+
* @public
|
|
661
|
+
*/
|
|
662
|
+
export type LambdaUngracefulBehavior = (typeof LambdaUngracefulBehavior)[keyof typeof LambdaUngracefulBehavior];
|
|
663
|
+
/**
|
|
664
|
+
* <p>Configuration for handling failures when invoking Lambda functions.</p>
|
|
665
|
+
* @public
|
|
666
|
+
*/
|
|
667
|
+
export interface LambdaUngraceful {
|
|
668
|
+
/**
|
|
669
|
+
* <p>The ungraceful behavior for a Lambda function, which must be set to <code>skip</code>.</p>
|
|
670
|
+
* @public
|
|
671
|
+
*/
|
|
672
|
+
behavior?: LambdaUngracefulBehavior | undefined;
|
|
673
|
+
}
|
|
674
|
+
/**
|
|
675
|
+
* <p>Configuration for Amazon Web Services Lambda functions that perform custom actions during a Region switch.</p>
|
|
676
|
+
* @public
|
|
677
|
+
*/
|
|
678
|
+
export interface CustomActionLambdaConfiguration {
|
|
679
|
+
/**
|
|
680
|
+
* <p>The timeout value specified for the configuration.</p>
|
|
681
|
+
* @public
|
|
682
|
+
*/
|
|
683
|
+
timeoutMinutes?: number | undefined;
|
|
684
|
+
/**
|
|
685
|
+
* <p>The Amazon Web Services Lambda functions for the execution block.</p>
|
|
686
|
+
* @public
|
|
687
|
+
*/
|
|
688
|
+
lambdas: Lambdas[] | undefined;
|
|
689
|
+
/**
|
|
690
|
+
* <p>The retry interval specified.</p>
|
|
691
|
+
* @public
|
|
692
|
+
*/
|
|
693
|
+
retryIntervalMinutes: number | undefined;
|
|
694
|
+
/**
|
|
695
|
+
* <p>The Amazon Web Services Region for the function to run in.</p>
|
|
696
|
+
* @public
|
|
697
|
+
*/
|
|
698
|
+
regionToRun: RegionToRunIn | undefined;
|
|
699
|
+
/**
|
|
700
|
+
* <p>The settings for ungraceful execution.</p>
|
|
701
|
+
* @public
|
|
702
|
+
*/
|
|
703
|
+
ungraceful?: LambdaUngraceful | undefined;
|
|
704
|
+
}
|
|
705
|
+
/**
|
|
706
|
+
* <p>Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.</p>
|
|
707
|
+
* @public
|
|
708
|
+
*/
|
|
709
|
+
export interface Asg {
|
|
710
|
+
/**
|
|
711
|
+
* <p>The cross account role for the configuration.</p>
|
|
712
|
+
* @public
|
|
713
|
+
*/
|
|
714
|
+
crossAccountRole?: string | undefined;
|
|
715
|
+
/**
|
|
716
|
+
* <p>The external ID (secret key) for the configuration.</p>
|
|
717
|
+
* @public
|
|
718
|
+
*/
|
|
719
|
+
externalId?: string | undefined;
|
|
720
|
+
/**
|
|
721
|
+
* <p>The Amazon Resource Name (ARN) of the EC2 Auto Scaling group.</p>
|
|
722
|
+
* @public
|
|
723
|
+
*/
|
|
724
|
+
arn?: string | undefined;
|
|
725
|
+
}
|
|
726
|
+
/**
|
|
727
|
+
* @public
|
|
728
|
+
* @enum
|
|
729
|
+
*/
|
|
730
|
+
export declare const Ec2AsgCapacityMonitoringApproach: {
|
|
731
|
+
readonly AUTOSCALING_MAX_IN_LAST_24_HOURS: "autoscalingMaxInLast24Hours";
|
|
732
|
+
readonly SAMPLED_MAX_IN_LAST_24_HOURS: "sampledMaxInLast24Hours";
|
|
733
|
+
};
|
|
734
|
+
/**
|
|
735
|
+
* @public
|
|
736
|
+
*/
|
|
737
|
+
export type Ec2AsgCapacityMonitoringApproach = (typeof Ec2AsgCapacityMonitoringApproach)[keyof typeof Ec2AsgCapacityMonitoringApproach];
|
|
738
|
+
/**
|
|
739
|
+
* <p>Configuration for handling failures when performing operations on EC2 resources.</p>
|
|
740
|
+
* @public
|
|
741
|
+
*/
|
|
742
|
+
export interface Ec2Ungraceful {
|
|
743
|
+
/**
|
|
744
|
+
* <p>The minimum success percentage that you specify for EC2 Auto Scaling groups.</p>
|
|
745
|
+
* @public
|
|
746
|
+
*/
|
|
747
|
+
minimumSuccessPercentage: number | undefined;
|
|
748
|
+
}
|
|
749
|
+
/**
|
|
750
|
+
* <p>Configuration for increasing the capacity of Amazon EC2 Auto Scaling groups during a Region switch.</p>
|
|
751
|
+
* @public
|
|
752
|
+
*/
|
|
753
|
+
export interface Ec2AsgCapacityIncreaseConfiguration {
|
|
754
|
+
/**
|
|
755
|
+
* <p>The timeout value specified for the configuration.</p>
|
|
756
|
+
* @public
|
|
757
|
+
*/
|
|
758
|
+
timeoutMinutes?: number | undefined;
|
|
759
|
+
/**
|
|
760
|
+
* <p>The EC2 Auto Scaling groups for the configuration.</p>
|
|
761
|
+
* @public
|
|
762
|
+
*/
|
|
763
|
+
asgs: Asg[] | undefined;
|
|
764
|
+
/**
|
|
765
|
+
* <p>The settings for ungraceful execution.</p>
|
|
766
|
+
* @public
|
|
767
|
+
*/
|
|
768
|
+
ungraceful?: Ec2Ungraceful | undefined;
|
|
769
|
+
/**
|
|
770
|
+
* <p>The target percentage that you specify for EC2 Auto Scaling groups.</p>
|
|
771
|
+
* @public
|
|
772
|
+
*/
|
|
773
|
+
targetPercent?: number | undefined;
|
|
774
|
+
/**
|
|
775
|
+
* <p>The monitoring approach that you specify EC2 Auto Scaling groups for the configuration.</p>
|
|
776
|
+
* @public
|
|
777
|
+
*/
|
|
778
|
+
capacityMonitoringApproach?: Ec2AsgCapacityMonitoringApproach | undefined;
|
|
779
|
+
}
|
|
780
|
+
/**
|
|
781
|
+
* @public
|
|
782
|
+
* @enum
|
|
783
|
+
*/
|
|
784
|
+
export declare const EcsCapacityMonitoringApproach: {
|
|
785
|
+
readonly CONTAINER_INSIGHTS_MAX_IN_LAST_24_HOURS: "containerInsightsMaxInLast24Hours";
|
|
786
|
+
readonly SAMPLED_MAX_IN_LAST_24_HOURS: "sampledMaxInLast24Hours";
|
|
787
|
+
};
|
|
788
|
+
/**
|
|
789
|
+
* @public
|
|
790
|
+
*/
|
|
791
|
+
export type EcsCapacityMonitoringApproach = (typeof EcsCapacityMonitoringApproach)[keyof typeof EcsCapacityMonitoringApproach];
|
|
792
|
+
/**
|
|
793
|
+
* <p>The service for a cross account role.</p>
|
|
794
|
+
* @public
|
|
795
|
+
*/
|
|
796
|
+
export interface Service {
|
|
797
|
+
/**
|
|
798
|
+
* <p>The cross account role for a service.</p>
|
|
799
|
+
* @public
|
|
800
|
+
*/
|
|
801
|
+
crossAccountRole?: string | undefined;
|
|
802
|
+
/**
|
|
803
|
+
* <p>The external ID (secret key) for the service.</p>
|
|
804
|
+
* @public
|
|
805
|
+
*/
|
|
806
|
+
externalId?: string | undefined;
|
|
807
|
+
/**
|
|
808
|
+
* <p>The cluster Amazon Resource Name (ARN) for a service.</p>
|
|
809
|
+
* @public
|
|
810
|
+
*/
|
|
811
|
+
clusterArn?: string | undefined;
|
|
812
|
+
/**
|
|
813
|
+
* <p>The Amazon Resource Name (ARN) for a service.</p>
|
|
814
|
+
* @public
|
|
815
|
+
*/
|
|
816
|
+
serviceArn?: string | undefined;
|
|
817
|
+
}
|
|
818
|
+
/**
|
|
819
|
+
* <p>The settings for ungraceful execution.</p>
|
|
820
|
+
* @public
|
|
821
|
+
*/
|
|
822
|
+
export interface EcsUngraceful {
|
|
823
|
+
/**
|
|
824
|
+
* <p>The minimum success percentage specified for the configuration.</p>
|
|
825
|
+
* @public
|
|
826
|
+
*/
|
|
827
|
+
minimumSuccessPercentage: number | undefined;
|
|
828
|
+
}
|
|
829
|
+
/**
|
|
830
|
+
* <p>The configuration for an Amazon Web Services ECS capacity increase.</p>
|
|
831
|
+
* @public
|
|
832
|
+
*/
|
|
833
|
+
export interface EcsCapacityIncreaseConfiguration {
|
|
834
|
+
/**
|
|
835
|
+
* <p>The timeout value specified for the configuration.</p>
|
|
836
|
+
* @public
|
|
837
|
+
*/
|
|
838
|
+
timeoutMinutes?: number | undefined;
|
|
839
|
+
/**
|
|
840
|
+
* <p>The services specified for the configuration.</p>
|
|
841
|
+
* @public
|
|
842
|
+
*/
|
|
843
|
+
services: Service[] | undefined;
|
|
844
|
+
/**
|
|
845
|
+
* <p>The settings for ungraceful execution.</p>
|
|
846
|
+
* @public
|
|
847
|
+
*/
|
|
848
|
+
ungraceful?: EcsUngraceful | undefined;
|
|
849
|
+
/**
|
|
850
|
+
* <p>The target percentage specified for the configuration.</p>
|
|
851
|
+
* @public
|
|
852
|
+
*/
|
|
853
|
+
targetPercent?: number | undefined;
|
|
854
|
+
/**
|
|
855
|
+
* <p>The monitoring approach specified for the configuration, for example, <code>Most_Recent</code>.</p>
|
|
856
|
+
* @public
|
|
857
|
+
*/
|
|
858
|
+
capacityMonitoringApproach?: EcsCapacityMonitoringApproach | undefined;
|
|
859
|
+
}
|
|
860
|
+
/**
|
|
861
|
+
* @public
|
|
862
|
+
* @enum
|
|
863
|
+
*/
|
|
864
|
+
export declare const EksCapacityMonitoringApproach: {
|
|
865
|
+
readonly SAMPLED_MAX_IN_LAST_24_HOURS: "sampledMaxInLast24Hours";
|
|
866
|
+
};
|
|
867
|
+
/**
|
|
868
|
+
* @public
|
|
869
|
+
*/
|
|
870
|
+
export type EksCapacityMonitoringApproach = (typeof EksCapacityMonitoringApproach)[keyof typeof EksCapacityMonitoringApproach];
|
|
871
|
+
/**
|
|
872
|
+
* <p>The Amazon Web Services EKS cluster execution block configuration.</p>
|
|
873
|
+
* @public
|
|
874
|
+
*/
|
|
875
|
+
export interface EksCluster {
|
|
876
|
+
/**
|
|
877
|
+
* <p>The cross account role for the configuration.</p>
|
|
878
|
+
* @public
|
|
879
|
+
*/
|
|
880
|
+
crossAccountRole?: string | undefined;
|
|
881
|
+
/**
|
|
882
|
+
* <p>The external ID (secret key) for the configuration.</p>
|
|
883
|
+
* @public
|
|
884
|
+
*/
|
|
885
|
+
externalId?: string | undefined;
|
|
886
|
+
/**
|
|
887
|
+
* <p>The Amazon Resource Name (ARN) of an Amazon Web Services EKS cluster.</p>
|
|
888
|
+
* @public
|
|
889
|
+
*/
|
|
890
|
+
clusterArn: string | undefined;
|
|
891
|
+
}
|
|
892
|
+
/**
|
|
893
|
+
* <p>Defines the type of Kubernetes resource to scale in an Amazon EKS cluster.</p>
|
|
894
|
+
* @public
|
|
895
|
+
*/
|
|
896
|
+
export interface KubernetesResourceType {
|
|
897
|
+
/**
|
|
898
|
+
* <p>The API version type for the Kubernetes resource.</p>
|
|
899
|
+
* @public
|
|
900
|
+
*/
|
|
901
|
+
apiVersion: string | undefined;
|
|
902
|
+
/**
|
|
903
|
+
* <p>The kind for the Kubernetes resource.</p>
|
|
904
|
+
* @public
|
|
905
|
+
*/
|
|
906
|
+
kind: string | undefined;
|
|
907
|
+
}
|
|
908
|
+
/**
|
|
909
|
+
* <p>Defines a Kubernetes resource to scale in an Amazon EKS cluster.</p>
|
|
910
|
+
* @public
|
|
911
|
+
*/
|
|
912
|
+
export interface KubernetesScalingResource {
|
|
913
|
+
/**
|
|
914
|
+
* <p>The namespace for the Kubernetes resource.</p>
|
|
915
|
+
* @public
|
|
916
|
+
*/
|
|
917
|
+
namespace: string | undefined;
|
|
918
|
+
/**
|
|
919
|
+
* <p>The name for the Kubernetes resource.</p>
|
|
920
|
+
* @public
|
|
921
|
+
*/
|
|
922
|
+
name: string | undefined;
|
|
923
|
+
/**
|
|
924
|
+
* <p>The hpaname for the Kubernetes resource.</p>
|
|
925
|
+
* @public
|
|
926
|
+
*/
|
|
927
|
+
hpaName?: string | undefined;
|
|
928
|
+
}
|
|
929
|
+
/**
|
|
930
|
+
* <p>The ungraceful settings for Amazon Web Services EKS resource scaling.</p>
|
|
931
|
+
* @public
|
|
932
|
+
*/
|
|
933
|
+
export interface EksResourceScalingUngraceful {
|
|
934
|
+
/**
|
|
935
|
+
* <p>The minimum success percentage for the configuration.</p>
|
|
936
|
+
* @public
|
|
937
|
+
*/
|
|
938
|
+
minimumSuccessPercentage: number | undefined;
|
|
939
|
+
}
|
|
940
|
+
/**
|
|
941
|
+
* <p>The Amazon Web Services EKS resource scaling configuration.</p>
|
|
942
|
+
* @public
|
|
943
|
+
*/
|
|
944
|
+
export interface EksResourceScalingConfiguration {
|
|
945
|
+
/**
|
|
946
|
+
* <p>The timeout value specified for the configuration.</p>
|
|
947
|
+
* @public
|
|
948
|
+
*/
|
|
949
|
+
timeoutMinutes?: number | undefined;
|
|
950
|
+
/**
|
|
951
|
+
* <p>The Kubernetes resource type for the configuration.</p>
|
|
952
|
+
* @public
|
|
953
|
+
*/
|
|
954
|
+
kubernetesResourceType: KubernetesResourceType | undefined;
|
|
955
|
+
/**
|
|
956
|
+
* <p>The scaling resources for the configuration.</p>
|
|
957
|
+
* @public
|
|
958
|
+
*/
|
|
959
|
+
scalingResources?: Record<string, Record<string, KubernetesScalingResource>>[] | undefined;
|
|
960
|
+
/**
|
|
961
|
+
* <p>The clusters for the configuration.</p>
|
|
962
|
+
* @public
|
|
963
|
+
*/
|
|
964
|
+
eksClusters?: EksCluster[] | undefined;
|
|
965
|
+
/**
|
|
966
|
+
* <p>The settings for ungraceful execution.</p>
|
|
967
|
+
* @public
|
|
968
|
+
*/
|
|
969
|
+
ungraceful?: EksResourceScalingUngraceful | undefined;
|
|
970
|
+
/**
|
|
971
|
+
* <p>The target percentage for the configuration.</p>
|
|
972
|
+
* @public
|
|
973
|
+
*/
|
|
974
|
+
targetPercent?: number | undefined;
|
|
975
|
+
/**
|
|
976
|
+
* <p>The monitoring approach for the configuration, that is, whether it was sampled in the last 24 hours or autoscaled in the last 24 hours.</p>
|
|
977
|
+
* @public
|
|
978
|
+
*/
|
|
979
|
+
capacityMonitoringApproach?: EksCapacityMonitoringApproach | undefined;
|
|
980
|
+
}
|
|
981
|
+
/**
|
|
982
|
+
* <p>Configuration for approval steps in a Region switch plan execution. Approval steps require manual intervention before the execution can proceed.</p>
|
|
983
|
+
* @public
|
|
984
|
+
*/
|
|
985
|
+
export interface ExecutionApprovalConfiguration {
|
|
986
|
+
/**
|
|
987
|
+
* <p>The timeout value specified for the configuration.</p>
|
|
988
|
+
* @public
|
|
989
|
+
*/
|
|
990
|
+
timeoutMinutes?: number | undefined;
|
|
991
|
+
/**
|
|
992
|
+
* <p>The IAM approval role for the configuration.</p>
|
|
993
|
+
* @public
|
|
994
|
+
*/
|
|
995
|
+
approvalRole: string | undefined;
|
|
996
|
+
}
|
|
997
|
+
/**
|
|
998
|
+
* @public
|
|
999
|
+
* @enum
|
|
1000
|
+
*/
|
|
1001
|
+
export declare const GlobalAuroraDefaultBehavior: {
|
|
1002
|
+
readonly FAILOVER: "failover";
|
|
1003
|
+
readonly SWITCHOVER_ONLY: "switchoverOnly";
|
|
1004
|
+
};
|
|
1005
|
+
/**
|
|
1006
|
+
* @public
|
|
1007
|
+
*/
|
|
1008
|
+
export type GlobalAuroraDefaultBehavior = (typeof GlobalAuroraDefaultBehavior)[keyof typeof GlobalAuroraDefaultBehavior];
|
|
1009
|
+
/**
|
|
1010
|
+
* @public
|
|
1011
|
+
* @enum
|
|
1012
|
+
*/
|
|
1013
|
+
export declare const GlobalAuroraUngracefulBehavior: {
|
|
1014
|
+
readonly FAILOVER: "failover";
|
|
1015
|
+
};
|
|
1016
|
+
/**
|
|
1017
|
+
* @public
|
|
1018
|
+
*/
|
|
1019
|
+
export type GlobalAuroraUngracefulBehavior = (typeof GlobalAuroraUngracefulBehavior)[keyof typeof GlobalAuroraUngracefulBehavior];
|
|
1020
|
+
/**
|
|
1021
|
+
* <p>Configuration for handling failures when performing operations on Aurora global databases.</p>
|
|
1022
|
+
* @public
|
|
1023
|
+
*/
|
|
1024
|
+
export interface GlobalAuroraUngraceful {
|
|
1025
|
+
/**
|
|
1026
|
+
* <p>The settings for ungraceful execution.</p>
|
|
1027
|
+
* @public
|
|
1028
|
+
*/
|
|
1029
|
+
ungraceful?: GlobalAuroraUngracefulBehavior | undefined;
|
|
1030
|
+
}
|
|
1031
|
+
/**
|
|
1032
|
+
* <p>Configuration for Amazon Aurora global databases used in a Region switch plan.</p>
|
|
1033
|
+
* @public
|
|
1034
|
+
*/
|
|
1035
|
+
export interface GlobalAuroraConfiguration {
|
|
1036
|
+
/**
|
|
1037
|
+
* <p>The timeout value specified for the configuration.</p>
|
|
1038
|
+
* @public
|
|
1039
|
+
*/
|
|
1040
|
+
timeoutMinutes?: number | undefined;
|
|
1041
|
+
/**
|
|
1042
|
+
* <p>The cross account role for the configuration.</p>
|
|
1043
|
+
* @public
|
|
1044
|
+
*/
|
|
1045
|
+
crossAccountRole?: string | undefined;
|
|
1046
|
+
/**
|
|
1047
|
+
* <p>The external ID (secret key) for the configuration.</p>
|
|
1048
|
+
* @public
|
|
1049
|
+
*/
|
|
1050
|
+
externalId?: string | undefined;
|
|
1051
|
+
/**
|
|
1052
|
+
* <p>The behavior for a global database, that is, only allow switchover or also allow failover.</p>
|
|
1053
|
+
* @public
|
|
1054
|
+
*/
|
|
1055
|
+
behavior: GlobalAuroraDefaultBehavior | undefined;
|
|
1056
|
+
/**
|
|
1057
|
+
* <p>The settings for ungraceful execution.</p>
|
|
1058
|
+
* @public
|
|
1059
|
+
*/
|
|
1060
|
+
ungraceful?: GlobalAuroraUngraceful | undefined;
|
|
1061
|
+
/**
|
|
1062
|
+
* <p>The global cluster identifier for a global database.</p>
|
|
1063
|
+
* @public
|
|
1064
|
+
*/
|
|
1065
|
+
globalClusterIdentifier: string | undefined;
|
|
1066
|
+
/**
|
|
1067
|
+
* <p>The database cluster Amazon Resource Names (ARNs) for a global database.</p>
|
|
1068
|
+
* @public
|
|
1069
|
+
*/
|
|
1070
|
+
databaseClusterArns: string[] | undefined;
|
|
1071
|
+
}
|
|
1072
|
+
/**
|
|
1073
|
+
* <p>Configuration for nested Region switch plans. This allows one Region switch plan to trigger another plan as part of its execution.</p>
|
|
1074
|
+
* @public
|
|
1075
|
+
*/
|
|
1076
|
+
export interface RegionSwitchPlanConfiguration {
|
|
1077
|
+
/**
|
|
1078
|
+
* <p>The cross account role for the configuration.</p>
|
|
1079
|
+
* @public
|
|
1080
|
+
*/
|
|
1081
|
+
crossAccountRole?: string | undefined;
|
|
1082
|
+
/**
|
|
1083
|
+
* <p>The external ID (secret key) for the configuration.</p>
|
|
1084
|
+
* @public
|
|
1085
|
+
*/
|
|
1086
|
+
externalId?: string | undefined;
|
|
1087
|
+
/**
|
|
1088
|
+
* <p>The Amazon Resource Name (ARN) of the plan configuration.</p>
|
|
1089
|
+
* @public
|
|
1090
|
+
*/
|
|
1091
|
+
arn: string | undefined;
|
|
1092
|
+
}
|
|
1093
|
+
/**
|
|
1094
|
+
* <p>The Amazon Route 53 record set.</p>
|
|
1095
|
+
* @public
|
|
1096
|
+
*/
|
|
1097
|
+
export interface Route53ResourceRecordSet {
|
|
1098
|
+
/**
|
|
1099
|
+
* <p>The Amazon Route 53 record set identifier.</p>
|
|
1100
|
+
* @public
|
|
1101
|
+
*/
|
|
1102
|
+
recordSetIdentifier?: string | undefined;
|
|
1103
|
+
/**
|
|
1104
|
+
* <p>The Amazon Route 53 record set Region.</p>
|
|
1105
|
+
* @public
|
|
1106
|
+
*/
|
|
1107
|
+
region?: string | undefined;
|
|
1108
|
+
}
|
|
1109
|
+
/**
|
|
1110
|
+
* <p>The Amazon Route 53 health check configuration.</p>
|
|
1111
|
+
* @public
|
|
1112
|
+
*/
|
|
1113
|
+
export interface Route53HealthCheckConfiguration {
|
|
1114
|
+
/**
|
|
1115
|
+
* <p>The Amazon Route 53 health check configuration time out (in minutes).</p>
|
|
1116
|
+
* @public
|
|
1117
|
+
*/
|
|
1118
|
+
timeoutMinutes?: number | undefined;
|
|
1119
|
+
/**
|
|
1120
|
+
* <p>The cross account role for the configuration.</p>
|
|
1121
|
+
* @public
|
|
1122
|
+
*/
|
|
1123
|
+
crossAccountRole?: string | undefined;
|
|
1124
|
+
/**
|
|
1125
|
+
* <p>The external ID (secret key) for the configuration.</p>
|
|
1126
|
+
* @public
|
|
1127
|
+
*/
|
|
1128
|
+
externalId?: string | undefined;
|
|
1129
|
+
/**
|
|
1130
|
+
* <p>The Amazon Route 53 health check configuration hosted zone ID.</p>
|
|
1131
|
+
* @public
|
|
1132
|
+
*/
|
|
1133
|
+
hostedZoneId: string | undefined;
|
|
1134
|
+
/**
|
|
1135
|
+
* <p>The Amazon Route 53 health check configuration record name.</p>
|
|
1136
|
+
* @public
|
|
1137
|
+
*/
|
|
1138
|
+
recordName: string | undefined;
|
|
1139
|
+
/**
|
|
1140
|
+
* <p>The Amazon Route 53 health check configuration record sets.</p>
|
|
1141
|
+
* @public
|
|
1142
|
+
*/
|
|
1143
|
+
recordSets?: Route53ResourceRecordSet[] | undefined;
|
|
1144
|
+
}
|
|
1145
|
+
/**
|
|
1146
|
+
* @public
|
|
1147
|
+
* @enum
|
|
1148
|
+
*/
|
|
1149
|
+
export declare const ExecutionBlockType: {
|
|
1150
|
+
readonly AURORA: "AuroraGlobalDatabase";
|
|
1151
|
+
readonly CUSTOM_ACTION_LAMBDA: "CustomActionLambda";
|
|
1152
|
+
readonly EC2_ASG: "EC2AutoScaling";
|
|
1153
|
+
readonly ECS: "ECSServiceScaling";
|
|
1154
|
+
readonly EKS_RESOURCE_SCALING: "EKSResourceScaling";
|
|
1155
|
+
readonly EXECUTION_APPROVAL: "ManualApproval";
|
|
1156
|
+
readonly PARALLEL: "Parallel";
|
|
1157
|
+
readonly REGION_SWITCH: "ARCRegionSwitchPlan";
|
|
1158
|
+
readonly ROUTE53_HEALTH_CHECK: "Route53HealthCheck";
|
|
1159
|
+
readonly ROUTING_CONTROL: "ARCRoutingControl";
|
|
1160
|
+
};
|
|
1161
|
+
/**
|
|
1162
|
+
* @public
|
|
1163
|
+
*/
|
|
1164
|
+
export type ExecutionBlockType = (typeof ExecutionBlockType)[keyof typeof ExecutionBlockType];
|
|
1165
|
+
/**
|
|
1166
|
+
* @public
|
|
1167
|
+
* @enum
|
|
1168
|
+
*/
|
|
1169
|
+
export declare const StepStatus: {
|
|
1170
|
+
readonly CANCELLED: "canceled";
|
|
1171
|
+
readonly COMPLETED: "completed";
|
|
1172
|
+
readonly FAILED: "failed";
|
|
1173
|
+
readonly NOT_STARTED: "notStarted";
|
|
1174
|
+
readonly PENDING_APPROVAL: "pendingApproval";
|
|
1175
|
+
readonly RUNNING: "running";
|
|
1176
|
+
readonly SKIPPED: "skipped";
|
|
1177
|
+
};
|
|
1178
|
+
/**
|
|
1179
|
+
* @public
|
|
1180
|
+
*/
|
|
1181
|
+
export type StepStatus = (typeof StepStatus)[keyof typeof StepStatus];
|
|
1182
|
+
/**
|
|
1183
|
+
* <p>Represents the state of a step in a plan execution.</p>
|
|
1184
|
+
* @public
|
|
1185
|
+
*/
|
|
1186
|
+
export interface StepState {
|
|
1187
|
+
/**
|
|
1188
|
+
* <p>The name of a step in a workflow.</p>
|
|
1189
|
+
* @public
|
|
1190
|
+
*/
|
|
1191
|
+
name?: string | undefined;
|
|
1192
|
+
/**
|
|
1193
|
+
* <p>The status of a step in a workflow. For example, a status might be Completed or Pending Approval.</p>
|
|
1194
|
+
* @public
|
|
1195
|
+
*/
|
|
1196
|
+
status?: StepStatus | undefined;
|
|
1197
|
+
/**
|
|
1198
|
+
* <p>The timestamp when a step started execution.</p>
|
|
1199
|
+
* @public
|
|
1200
|
+
*/
|
|
1201
|
+
startTime?: Date | undefined;
|
|
1202
|
+
/**
|
|
1203
|
+
* <p>The timestamp when a step endeded execution.</p>
|
|
1204
|
+
* @public
|
|
1205
|
+
*/
|
|
1206
|
+
endTime?: Date | undefined;
|
|
1207
|
+
/**
|
|
1208
|
+
* <p>The mode for a step execution. The mode can be Graceful or Ungraceful.</p>
|
|
1209
|
+
* @public
|
|
1210
|
+
*/
|
|
1211
|
+
stepMode?: ExecutionMode | undefined;
|
|
1212
|
+
}
|
|
1213
|
+
/**
|
|
1214
|
+
* @public
|
|
1215
|
+
*/
|
|
1216
|
+
export interface GetPlanInRegionRequest {
|
|
1217
|
+
/**
|
|
1218
|
+
* <p>The Amazon Resource Name (ARN) of the plan in Region.</p>
|
|
1219
|
+
* @public
|
|
1220
|
+
*/
|
|
1221
|
+
arn: string | undefined;
|
|
1222
|
+
}
|
|
1223
|
+
/**
|
|
1224
|
+
* @public
|
|
1225
|
+
*/
|
|
1226
|
+
export interface ListPlanExecutionEventsRequest {
|
|
1227
|
+
/**
|
|
1228
|
+
* <p>The Amazon Resource Name (ARN) of the plan.</p>
|
|
1229
|
+
* @public
|
|
1230
|
+
*/
|
|
1231
|
+
planArn: string | undefined;
|
|
1232
|
+
/**
|
|
1233
|
+
* <p>The execution identifier of a plan execution.</p>
|
|
1234
|
+
* @public
|
|
1235
|
+
*/
|
|
1236
|
+
executionId: string | undefined;
|
|
1237
|
+
/**
|
|
1238
|
+
* <p>The number of objects that you want to return with this call.</p>
|
|
1239
|
+
* @public
|
|
1240
|
+
*/
|
|
1241
|
+
maxResults?: number | undefined;
|
|
1242
|
+
/**
|
|
1243
|
+
* <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>
|
|
1244
|
+
* @public
|
|
1245
|
+
*/
|
|
1246
|
+
nextToken?: string | undefined;
|
|
1247
|
+
/**
|
|
1248
|
+
* <p>The name of the plan execution event.</p>
|
|
1249
|
+
* @public
|
|
1250
|
+
*/
|
|
1251
|
+
name?: string | undefined;
|
|
1252
|
+
}
|
|
1253
|
+
/**
|
|
1254
|
+
* @public
|
|
1255
|
+
* @enum
|
|
1256
|
+
*/
|
|
1257
|
+
export declare const ExecutionEventType: {
|
|
1258
|
+
readonly EXECUTION_BEHAVIOR_CHANGED_TO_GRACEFUL: "executionBehaviorChangedToGraceful";
|
|
1259
|
+
readonly EXECUTION_BEHAVIOR_CHANGED_TO_UNGRACEFUL: "executionBehaviorChangedToUngraceful";
|
|
1260
|
+
readonly EXECUTION_CANCELED: "executionCanceled";
|
|
1261
|
+
readonly EXECUTION_CANCELING: "executionCanceling";
|
|
1262
|
+
readonly EXECUTION_FAILED: "executionFailed";
|
|
1263
|
+
readonly EXECUTION_PAUSED: "executionPaused";
|
|
1264
|
+
readonly EXECUTION_PAUSING: "executionPausing";
|
|
1265
|
+
readonly EXECUTION_PENDING: "executionPending";
|
|
1266
|
+
readonly EXECUTION_PENDING_APPROVAL: "executionPendingApproval";
|
|
1267
|
+
readonly EXECUTION_PENDING_CHILD_PLAN_MANUAL_APPROVAL: "executionPendingChildPlanManualApproval";
|
|
1268
|
+
readonly EXECUTION_STARTED: "executionStarted";
|
|
1269
|
+
readonly EXECUTION_SUCCEEDED: "executionSucceeded";
|
|
1270
|
+
readonly EXECUTION_SUCCESS_MONITORING_APPLICATION_HEALTH: "executionSuccessMonitoringApplicationHealth";
|
|
1271
|
+
readonly STEP_CANCELED: "stepCanceled";
|
|
1272
|
+
readonly STEP_EXECUTION_BEHAVIOR_CHANGED_TO_UNGRACEFUL: "stepExecutionBehaviorChangedToUngraceful";
|
|
1273
|
+
readonly STEP_FAILED: "stepFailed";
|
|
1274
|
+
readonly STEP_PAUSED_BY_ERROR: "stepPausedByError";
|
|
1275
|
+
readonly STEP_PAUSED_BY_OPERATOR: "stepPausedByOperator";
|
|
1276
|
+
readonly STEP_PENDING_APPLICATION_HEALTH_MONITOR: "stepPendingApplicationHealthMonitor";
|
|
1277
|
+
readonly STEP_PENDING_APPROVAL: "stepPendingApproval";
|
|
1278
|
+
readonly STEP_SKIPPED: "stepSkipped";
|
|
1279
|
+
readonly STEP_STARTED: "stepStarted";
|
|
1280
|
+
readonly STEP_SUCCEEDED: "stepSucceeded";
|
|
1281
|
+
readonly STEP_UPDATE: "stepUpdate";
|
|
1282
|
+
readonly UNKNOWN: "unknown";
|
|
1283
|
+
};
|
|
1284
|
+
/**
|
|
1285
|
+
* @public
|
|
1286
|
+
*/
|
|
1287
|
+
export type ExecutionEventType = (typeof ExecutionEventType)[keyof typeof ExecutionEventType];
|
|
1288
|
+
/**
|
|
1289
|
+
* <p>Represents an event that occurred during a plan execution. These events provide a detailed timeline of the execution process.</p>
|
|
1290
|
+
* @public
|
|
1291
|
+
*/
|
|
1292
|
+
export interface ExecutionEvent {
|
|
1293
|
+
/**
|
|
1294
|
+
* <p>The timestamp for an execution event.</p>
|
|
1295
|
+
* @public
|
|
1296
|
+
*/
|
|
1297
|
+
timestamp?: Date | undefined;
|
|
1298
|
+
/**
|
|
1299
|
+
* <p>The type of an execution event.</p>
|
|
1300
|
+
* @public
|
|
1301
|
+
*/
|
|
1302
|
+
type?: ExecutionEventType | undefined;
|
|
1303
|
+
/**
|
|
1304
|
+
* <p>The step name for an execution event.</p>
|
|
1305
|
+
* @public
|
|
1306
|
+
*/
|
|
1307
|
+
stepName?: string | undefined;
|
|
1308
|
+
/**
|
|
1309
|
+
* <p>The execution block type for an execution event.</p>
|
|
1310
|
+
* @public
|
|
1311
|
+
*/
|
|
1312
|
+
executionBlockType?: ExecutionBlockType | undefined;
|
|
1313
|
+
/**
|
|
1314
|
+
* <p>The resources for an execution event.</p>
|
|
1315
|
+
* @public
|
|
1316
|
+
*/
|
|
1317
|
+
resources?: string[] | undefined;
|
|
1318
|
+
/**
|
|
1319
|
+
* <p>Errors for an execution event.</p>
|
|
1320
|
+
* @public
|
|
1321
|
+
*/
|
|
1322
|
+
error?: string | undefined;
|
|
1323
|
+
/**
|
|
1324
|
+
* <p>The description for an execution event.</p>
|
|
1325
|
+
* @public
|
|
1326
|
+
*/
|
|
1327
|
+
description?: string | undefined;
|
|
1328
|
+
/**
|
|
1329
|
+
* <p>The event ID for an execution event.</p>
|
|
1330
|
+
* @public
|
|
1331
|
+
*/
|
|
1332
|
+
eventId: string | undefined;
|
|
1333
|
+
/**
|
|
1334
|
+
* <p>The event ID of the previous execution event.</p>
|
|
1335
|
+
* @public
|
|
1336
|
+
*/
|
|
1337
|
+
previousEventId?: string | undefined;
|
|
1338
|
+
}
|
|
1339
|
+
/**
|
|
1340
|
+
* @public
|
|
1341
|
+
*/
|
|
1342
|
+
export interface ListPlanExecutionEventsResponse {
|
|
1343
|
+
/**
|
|
1344
|
+
* <p>The items in the plan execution event.</p>
|
|
1345
|
+
* @public
|
|
1346
|
+
*/
|
|
1347
|
+
items?: ExecutionEvent[] | undefined;
|
|
1348
|
+
/**
|
|
1349
|
+
* <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>
|
|
1350
|
+
* @public
|
|
1351
|
+
*/
|
|
1352
|
+
nextToken?: string | undefined;
|
|
1353
|
+
}
|
|
1354
|
+
/**
|
|
1355
|
+
* @public
|
|
1356
|
+
*/
|
|
1357
|
+
export interface ListPlanExecutionsRequest {
|
|
1358
|
+
/**
|
|
1359
|
+
* <p>The ARN for the plan.</p>
|
|
1360
|
+
* @public
|
|
1361
|
+
*/
|
|
1362
|
+
planArn: string | undefined;
|
|
1363
|
+
/**
|
|
1364
|
+
* <p>The number of objects that you want to return with this call.</p>
|
|
1365
|
+
* @public
|
|
1366
|
+
*/
|
|
1367
|
+
maxResults?: number | undefined;
|
|
1368
|
+
/**
|
|
1369
|
+
* <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>
|
|
1370
|
+
* @public
|
|
1371
|
+
*/
|
|
1372
|
+
nextToken?: string | undefined;
|
|
1373
|
+
/**
|
|
1374
|
+
* <p>The state of the plan execution. For example, the plan execution might be In Progress.</p>
|
|
1375
|
+
* @public
|
|
1376
|
+
*/
|
|
1377
|
+
state?: ExecutionState | undefined;
|
|
1378
|
+
}
|
|
1379
|
+
/**
|
|
1380
|
+
* @public
|
|
1381
|
+
*/
|
|
1382
|
+
export interface ListPlanExecutionsResponse {
|
|
1383
|
+
/**
|
|
1384
|
+
* <p>The items in the plan execution to return.</p>
|
|
1385
|
+
* @public
|
|
1386
|
+
*/
|
|
1387
|
+
items?: AbbreviatedExecution[] | undefined;
|
|
1388
|
+
/**
|
|
1389
|
+
* <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>
|
|
1390
|
+
* @public
|
|
1391
|
+
*/
|
|
1392
|
+
nextToken?: string | undefined;
|
|
1393
|
+
}
|
|
1394
|
+
/**
|
|
1395
|
+
* @public
|
|
1396
|
+
*/
|
|
1397
|
+
export interface ListPlansInRegionRequest {
|
|
1398
|
+
/**
|
|
1399
|
+
* <p>The number of objects that you want to return with this call.</p>
|
|
1400
|
+
* @public
|
|
1401
|
+
*/
|
|
1402
|
+
maxResults?: number | undefined;
|
|
1403
|
+
/**
|
|
1404
|
+
* <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>
|
|
1405
|
+
* @public
|
|
1406
|
+
*/
|
|
1407
|
+
nextToken?: string | undefined;
|
|
1408
|
+
}
|
|
1409
|
+
/**
|
|
1410
|
+
* @public
|
|
1411
|
+
*/
|
|
1412
|
+
export interface ListPlansInRegionResponse {
|
|
1413
|
+
/**
|
|
1414
|
+
* <p>The plans that were requested.</p>
|
|
1415
|
+
* @public
|
|
1416
|
+
*/
|
|
1417
|
+
plans?: AbbreviatedPlan[] | undefined;
|
|
1418
|
+
/**
|
|
1419
|
+
* <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>
|
|
1420
|
+
* @public
|
|
1421
|
+
*/
|
|
1422
|
+
nextToken?: string | undefined;
|
|
1423
|
+
}
|
|
1424
|
+
/**
|
|
1425
|
+
* <p>The request processing has failed because of an unknown error, exception, or failure.</p> <p>HTTP Status Code: 500</p>
|
|
1426
|
+
* @public
|
|
1427
|
+
*/
|
|
1428
|
+
export declare class InternalServerException extends __BaseException {
|
|
1429
|
+
readonly name: "InternalServerException";
|
|
1430
|
+
readonly $fault: "server";
|
|
1431
|
+
/**
|
|
1432
|
+
* @internal
|
|
1433
|
+
*/
|
|
1434
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
1435
|
+
}
|
|
1436
|
+
/**
|
|
1437
|
+
* @public
|
|
1438
|
+
*/
|
|
1439
|
+
export interface ListRoute53HealthChecksRequest {
|
|
1440
|
+
/**
|
|
1441
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Route 53 health check request.</p>
|
|
1442
|
+
* @public
|
|
1443
|
+
*/
|
|
1444
|
+
arn: string | undefined;
|
|
1445
|
+
/**
|
|
1446
|
+
* <p>The hosted zone ID for the health checks.</p>
|
|
1447
|
+
* @public
|
|
1448
|
+
*/
|
|
1449
|
+
hostedZoneId?: string | undefined;
|
|
1450
|
+
/**
|
|
1451
|
+
* <p>The record name for the health checks.</p>
|
|
1452
|
+
* @public
|
|
1453
|
+
*/
|
|
1454
|
+
recordName?: string | undefined;
|
|
1455
|
+
/**
|
|
1456
|
+
* <p>The number of objects that you want to return with this call.</p>
|
|
1457
|
+
* @public
|
|
1458
|
+
*/
|
|
1459
|
+
maxResults?: number | undefined;
|
|
1460
|
+
/**
|
|
1461
|
+
* <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>
|
|
1462
|
+
* @public
|
|
1463
|
+
*/
|
|
1464
|
+
nextToken?: string | undefined;
|
|
1465
|
+
}
|
|
1466
|
+
/**
|
|
1467
|
+
* <p>The Amazon Route 53 health check.</p>
|
|
1468
|
+
* @public
|
|
1469
|
+
*/
|
|
1470
|
+
export interface Route53HealthCheck {
|
|
1471
|
+
/**
|
|
1472
|
+
* <p>The Amazon Route 53 health check hosted zone ID.</p>
|
|
1473
|
+
* @public
|
|
1474
|
+
*/
|
|
1475
|
+
hostedZoneId: string | undefined;
|
|
1476
|
+
/**
|
|
1477
|
+
* <p>The Amazon Route 53 record name.</p>
|
|
1478
|
+
* @public
|
|
1479
|
+
*/
|
|
1480
|
+
recordName: string | undefined;
|
|
1481
|
+
/**
|
|
1482
|
+
* <p>The Amazon Route 53 health check ID.</p>
|
|
1483
|
+
* @public
|
|
1484
|
+
*/
|
|
1485
|
+
healthCheckId?: string | undefined;
|
|
1486
|
+
/**
|
|
1487
|
+
* <p>The Amazon Route 53 Region.</p>
|
|
1488
|
+
* @public
|
|
1489
|
+
*/
|
|
1490
|
+
region: string | undefined;
|
|
1491
|
+
}
|
|
1492
|
+
/**
|
|
1493
|
+
* @public
|
|
1494
|
+
*/
|
|
1495
|
+
export interface ListRoute53HealthChecksResponse {
|
|
1496
|
+
/**
|
|
1497
|
+
* <p>List of the health checks requested.</p>
|
|
1498
|
+
* @public
|
|
1499
|
+
*/
|
|
1500
|
+
healthChecks?: Route53HealthCheck[] | undefined;
|
|
1501
|
+
/**
|
|
1502
|
+
* <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>
|
|
1503
|
+
* @public
|
|
1504
|
+
*/
|
|
1505
|
+
nextToken?: string | undefined;
|
|
1506
|
+
}
|
|
1507
|
+
/**
|
|
1508
|
+
* @public
|
|
1509
|
+
*/
|
|
1510
|
+
export interface DeletePlanRequest {
|
|
1511
|
+
/**
|
|
1512
|
+
* <p>The Amazon Resource Name (ARN) of the plan.</p>
|
|
1513
|
+
* @public
|
|
1514
|
+
*/
|
|
1515
|
+
arn: string | undefined;
|
|
1516
|
+
}
|
|
1517
|
+
/**
|
|
1518
|
+
* @public
|
|
1519
|
+
*/
|
|
1520
|
+
export interface DeletePlanResponse {
|
|
1521
|
+
}
|
|
1522
|
+
/**
|
|
1523
|
+
* <p>The operation failed because the current state of the resource doesn't allow the operation to proceed.</p> <p>HTTP Status Code: 400</p>
|
|
1524
|
+
* @public
|
|
1525
|
+
*/
|
|
1526
|
+
export declare class IllegalStateException extends __BaseException {
|
|
1527
|
+
readonly name: "IllegalStateException";
|
|
1528
|
+
readonly $fault: "client";
|
|
1529
|
+
/**
|
|
1530
|
+
* @internal
|
|
1531
|
+
*/
|
|
1532
|
+
constructor(opts: __ExceptionOptionType<IllegalStateException, __BaseException>);
|
|
1533
|
+
}
|
|
1534
|
+
/**
|
|
1535
|
+
* @public
|
|
1536
|
+
*/
|
|
1537
|
+
export interface GetPlanRequest {
|
|
1538
|
+
/**
|
|
1539
|
+
* <p>The Amazon Resource Name (ARN) of the plan.</p>
|
|
1540
|
+
* @public
|
|
1541
|
+
*/
|
|
1542
|
+
arn: string | undefined;
|
|
1543
|
+
}
|
|
1544
|
+
/**
|
|
1545
|
+
* @public
|
|
1546
|
+
*/
|
|
1547
|
+
export interface ListPlansRequest {
|
|
1548
|
+
/**
|
|
1549
|
+
* <p>The number of objects that you want to return with this call.</p>
|
|
1550
|
+
* @public
|
|
1551
|
+
*/
|
|
1552
|
+
maxResults?: number | undefined;
|
|
1553
|
+
/**
|
|
1554
|
+
* <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>
|
|
1555
|
+
* @public
|
|
1556
|
+
*/
|
|
1557
|
+
nextToken?: string | undefined;
|
|
1558
|
+
}
|
|
1559
|
+
/**
|
|
1560
|
+
* @public
|
|
1561
|
+
*/
|
|
1562
|
+
export interface ListPlansResponse {
|
|
1563
|
+
/**
|
|
1564
|
+
* <p>The plans that were requested.</p>
|
|
1565
|
+
* @public
|
|
1566
|
+
*/
|
|
1567
|
+
plans?: AbbreviatedPlan[] | undefined;
|
|
1568
|
+
/**
|
|
1569
|
+
* <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>
|
|
1570
|
+
* @public
|
|
1571
|
+
*/
|
|
1572
|
+
nextToken?: string | undefined;
|
|
1573
|
+
}
|
|
1574
|
+
/**
|
|
1575
|
+
* @public
|
|
1576
|
+
*/
|
|
1577
|
+
export interface ListTagsForResourceRequest {
|
|
1578
|
+
/**
|
|
1579
|
+
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
1580
|
+
* @public
|
|
1581
|
+
*/
|
|
1582
|
+
arn: string | undefined;
|
|
1583
|
+
}
|
|
1584
|
+
/**
|
|
1585
|
+
* @public
|
|
1586
|
+
*/
|
|
1587
|
+
export interface ListTagsForResourceResponse {
|
|
1588
|
+
/**
|
|
1589
|
+
* <p>The tags for a resource.</p>
|
|
1590
|
+
* @public
|
|
1591
|
+
*/
|
|
1592
|
+
resourceTags?: Record<string, string> | undefined;
|
|
1593
|
+
}
|
|
1594
|
+
/**
|
|
1595
|
+
* @public
|
|
1596
|
+
*/
|
|
1597
|
+
export interface TagResourceRequest {
|
|
1598
|
+
/**
|
|
1599
|
+
* <p>The Amazon Resource Name (ARN) for a tag that you add to a resource.</p>
|
|
1600
|
+
* @public
|
|
1601
|
+
*/
|
|
1602
|
+
arn: string | undefined;
|
|
1603
|
+
/**
|
|
1604
|
+
* <p>Tags that you add to a resource. You can add a maximum of 50 tags in Region switch.</p>
|
|
1605
|
+
* @public
|
|
1606
|
+
*/
|
|
1607
|
+
tags: Record<string, string> | undefined;
|
|
1608
|
+
}
|
|
1609
|
+
/**
|
|
1610
|
+
* @public
|
|
1611
|
+
*/
|
|
1612
|
+
export interface TagResourceResponse {
|
|
1613
|
+
}
|
|
1614
|
+
/**
|
|
1615
|
+
* @public
|
|
1616
|
+
*/
|
|
1617
|
+
export interface UntagResourceRequest {
|
|
1618
|
+
/**
|
|
1619
|
+
* <p>The Amazon Resource Name (ARN) for a tag you remove a resource from.</p>
|
|
1620
|
+
* @public
|
|
1621
|
+
*/
|
|
1622
|
+
arn: string | undefined;
|
|
1623
|
+
/**
|
|
1624
|
+
* <p>Tag keys that you remove from a resource.</p>
|
|
1625
|
+
* @public
|
|
1626
|
+
*/
|
|
1627
|
+
resourceTagKeys: string[] | undefined;
|
|
1628
|
+
}
|
|
1629
|
+
/**
|
|
1630
|
+
* @public
|
|
1631
|
+
*/
|
|
1632
|
+
export interface UntagResourceResponse {
|
|
1633
|
+
}
|
|
1634
|
+
/**
|
|
1635
|
+
* <p>The request processing has an invalid argument.</p>
|
|
1636
|
+
* @public
|
|
1637
|
+
*/
|
|
1638
|
+
export declare class IllegalArgumentException extends __BaseException {
|
|
1639
|
+
readonly name: "IllegalArgumentException";
|
|
1640
|
+
readonly $fault: "client";
|
|
1641
|
+
/**
|
|
1642
|
+
* @internal
|
|
1643
|
+
*/
|
|
1644
|
+
constructor(opts: __ExceptionOptionType<IllegalArgumentException, __BaseException>);
|
|
1645
|
+
}
|
|
1646
|
+
/**
|
|
1647
|
+
* @public
|
|
1648
|
+
*/
|
|
1649
|
+
export interface StartPlanExecutionRequest {
|
|
1650
|
+
/**
|
|
1651
|
+
* <p>The Amazon Resource Name (ARN) of the plan to execute.</p>
|
|
1652
|
+
* @public
|
|
1653
|
+
*/
|
|
1654
|
+
planArn: string | undefined;
|
|
1655
|
+
/**
|
|
1656
|
+
* <p>The Amazon Web Services Region to target with this execution. This is the Region that traffic will be shifted to or from, depending on the action.</p>
|
|
1657
|
+
* @public
|
|
1658
|
+
*/
|
|
1659
|
+
targetRegion: string | undefined;
|
|
1660
|
+
/**
|
|
1661
|
+
* <p>The action to perform. Valid values are ACTIVATE (to shift traffic to the target Region) or DEACTIVATE (to shift traffic away from the target Region).</p>
|
|
1662
|
+
* @public
|
|
1663
|
+
*/
|
|
1664
|
+
action: ExecutionAction | undefined;
|
|
1665
|
+
/**
|
|
1666
|
+
* <p>The plan execution mode. Valid values are <code>Practice</code>, for testing without making actual changes, or <code>Recovery</code>, for actual traffic shifting and application recovery.</p>
|
|
1667
|
+
* @public
|
|
1668
|
+
*/
|
|
1669
|
+
mode?: ExecutionMode | undefined;
|
|
1670
|
+
/**
|
|
1671
|
+
* <p>An optional comment explaining why the plan execution is being started.</p>
|
|
1672
|
+
* @public
|
|
1673
|
+
*/
|
|
1674
|
+
comment?: string | undefined;
|
|
1675
|
+
/**
|
|
1676
|
+
* <p>A boolean value indicating whether to use the latest version of the plan. If set to false, you must specify a specific version.</p>
|
|
1677
|
+
* @public
|
|
1678
|
+
*/
|
|
1679
|
+
latestVersion?: string | undefined;
|
|
1680
|
+
}
|
|
1681
|
+
/**
|
|
1682
|
+
* @public
|
|
1683
|
+
*/
|
|
1684
|
+
export interface StartPlanExecutionResponse {
|
|
1685
|
+
/**
|
|
1686
|
+
* <p>The execution identifier of a plan execution.</p>
|
|
1687
|
+
* @public
|
|
1688
|
+
*/
|
|
1689
|
+
executionId?: string | undefined;
|
|
1690
|
+
/**
|
|
1691
|
+
* <p>The details of the Region switch plan.</p>
|
|
1692
|
+
* @public
|
|
1693
|
+
*/
|
|
1694
|
+
plan?: string | undefined;
|
|
1695
|
+
/**
|
|
1696
|
+
* <p>The version of the plan, a unique number generated by Region switch.</p>
|
|
1697
|
+
* @public
|
|
1698
|
+
*/
|
|
1699
|
+
planVersion?: string | undefined;
|
|
1700
|
+
/**
|
|
1701
|
+
* <p>The Amazon Web Services Region to activate.</p>
|
|
1702
|
+
* @public
|
|
1703
|
+
*/
|
|
1704
|
+
activateRegion?: string | undefined;
|
|
1705
|
+
/**
|
|
1706
|
+
* <p>The Amazon Web Services Region to deactivate.</p>
|
|
1707
|
+
* @public
|
|
1708
|
+
*/
|
|
1709
|
+
deactivateRegion?: string | undefined;
|
|
1710
|
+
}
|
|
1711
|
+
/**
|
|
1712
|
+
* @public
|
|
1713
|
+
* @enum
|
|
1714
|
+
*/
|
|
1715
|
+
export declare const UpdatePlanExecutionAction: {
|
|
1716
|
+
readonly PAUSE: "pause";
|
|
1717
|
+
readonly RESUME: "resume";
|
|
1718
|
+
readonly SWITCH_TO_GRACEFUL: "switchToGraceful";
|
|
1719
|
+
readonly SWITCH_TO_UNGRACEFUL: "switchToUngraceful";
|
|
1720
|
+
};
|
|
1721
|
+
/**
|
|
1722
|
+
* @public
|
|
1723
|
+
*/
|
|
1724
|
+
export type UpdatePlanExecutionAction = (typeof UpdatePlanExecutionAction)[keyof typeof UpdatePlanExecutionAction];
|
|
1725
|
+
/**
|
|
1726
|
+
* @public
|
|
1727
|
+
*/
|
|
1728
|
+
export interface UpdatePlanExecutionRequest {
|
|
1729
|
+
/**
|
|
1730
|
+
* <p>The Amazon Resource Name (ARN) of the plan with the execution to update.</p>
|
|
1731
|
+
* @public
|
|
1732
|
+
*/
|
|
1733
|
+
planArn: string | undefined;
|
|
1734
|
+
/**
|
|
1735
|
+
* <p>The execution identifier of a plan execution.</p>
|
|
1736
|
+
* @public
|
|
1737
|
+
*/
|
|
1738
|
+
executionId: string | undefined;
|
|
1739
|
+
/**
|
|
1740
|
+
* <p>The action specified for a plan execution, for example, Switch to Graceful or Pause.</p>
|
|
1741
|
+
* @public
|
|
1742
|
+
*/
|
|
1743
|
+
action: UpdatePlanExecutionAction | undefined;
|
|
1744
|
+
/**
|
|
1745
|
+
* <p>An optional comment about the plan execution.</p>
|
|
1746
|
+
* @public
|
|
1747
|
+
*/
|
|
1748
|
+
comment?: string | undefined;
|
|
1749
|
+
}
|
|
1750
|
+
/**
|
|
1751
|
+
* @public
|
|
1752
|
+
*/
|
|
1753
|
+
export interface UpdatePlanExecutionResponse {
|
|
1754
|
+
}
|
|
1755
|
+
/**
|
|
1756
|
+
* @public
|
|
1757
|
+
* @enum
|
|
1758
|
+
*/
|
|
1759
|
+
export declare const UpdatePlanExecutionStepAction: {
|
|
1760
|
+
readonly SKIP: "skip";
|
|
1761
|
+
readonly SWITCH_TO_UNGRACEFUL: "switchToUngraceful";
|
|
1762
|
+
};
|
|
1763
|
+
/**
|
|
1764
|
+
* @public
|
|
1765
|
+
*/
|
|
1766
|
+
export type UpdatePlanExecutionStepAction = (typeof UpdatePlanExecutionStepAction)[keyof typeof UpdatePlanExecutionStepAction];
|
|
1767
|
+
/**
|
|
1768
|
+
* @public
|
|
1769
|
+
*/
|
|
1770
|
+
export interface UpdatePlanExecutionStepRequest {
|
|
1771
|
+
/**
|
|
1772
|
+
* <p>The Amazon Resource Name (ARN) of the plan containing the execution step to update.</p>
|
|
1773
|
+
* @public
|
|
1774
|
+
*/
|
|
1775
|
+
planArn: string | undefined;
|
|
1776
|
+
/**
|
|
1777
|
+
* <p>The unique identifier of the plan execution containing the step to update.</p>
|
|
1778
|
+
* @public
|
|
1779
|
+
*/
|
|
1780
|
+
executionId: string | undefined;
|
|
1781
|
+
/**
|
|
1782
|
+
* <p>An optional comment about the plan execution.</p>
|
|
1783
|
+
* @public
|
|
1784
|
+
*/
|
|
1785
|
+
comment: string | undefined;
|
|
1786
|
+
/**
|
|
1787
|
+
* <p>The name of the execution step to update.</p>
|
|
1788
|
+
* @public
|
|
1789
|
+
*/
|
|
1790
|
+
stepName: string | undefined;
|
|
1791
|
+
/**
|
|
1792
|
+
* <p>The updated action to take for the step. This can be used to skip or retry a step.</p>
|
|
1793
|
+
* @public
|
|
1794
|
+
*/
|
|
1795
|
+
actionToTake: UpdatePlanExecutionStepAction | undefined;
|
|
1796
|
+
}
|
|
1797
|
+
/**
|
|
1798
|
+
* @public
|
|
1799
|
+
*/
|
|
1800
|
+
export interface UpdatePlanExecutionStepResponse {
|
|
1801
|
+
}
|
|
1802
|
+
/**
|
|
1803
|
+
* <p>Execution block configurations for a workflow in a Region switch plan. An execution block represents a specific type of action to perform during a Region switch.</p>
|
|
1804
|
+
* @public
|
|
1805
|
+
*/
|
|
1806
|
+
export type ExecutionBlockConfiguration = ExecutionBlockConfiguration.ArcRoutingControlConfigMember | ExecutionBlockConfiguration.CustomActionLambdaConfigMember | ExecutionBlockConfiguration.Ec2AsgCapacityIncreaseConfigMember | ExecutionBlockConfiguration.EcsCapacityIncreaseConfigMember | ExecutionBlockConfiguration.EksResourceScalingConfigMember | ExecutionBlockConfiguration.ExecutionApprovalConfigMember | ExecutionBlockConfiguration.GlobalAuroraConfigMember | ExecutionBlockConfiguration.ParallelConfigMember | ExecutionBlockConfiguration.RegionSwitchPlanConfigMember | ExecutionBlockConfiguration.Route53HealthCheckConfigMember | ExecutionBlockConfiguration.$UnknownMember;
|
|
1807
|
+
/**
|
|
1808
|
+
* @public
|
|
1809
|
+
*/
|
|
1810
|
+
export declare namespace ExecutionBlockConfiguration {
|
|
1811
|
+
/**
|
|
1812
|
+
* <p>An Amazon Web Services Lambda execution block.</p>
|
|
1813
|
+
* @public
|
|
1814
|
+
*/
|
|
1815
|
+
interface CustomActionLambdaConfigMember {
|
|
1816
|
+
customActionLambdaConfig: CustomActionLambdaConfiguration;
|
|
1817
|
+
ec2AsgCapacityIncreaseConfig?: never;
|
|
1818
|
+
executionApprovalConfig?: never;
|
|
1819
|
+
arcRoutingControlConfig?: never;
|
|
1820
|
+
globalAuroraConfig?: never;
|
|
1821
|
+
parallelConfig?: never;
|
|
1822
|
+
regionSwitchPlanConfig?: never;
|
|
1823
|
+
ecsCapacityIncreaseConfig?: never;
|
|
1824
|
+
eksResourceScalingConfig?: never;
|
|
1825
|
+
route53HealthCheckConfig?: never;
|
|
1826
|
+
$unknown?: never;
|
|
1827
|
+
}
|
|
1828
|
+
/**
|
|
1829
|
+
* <p>An EC2 Auto Scaling group execution block.</p>
|
|
1830
|
+
* @public
|
|
1831
|
+
*/
|
|
1832
|
+
interface Ec2AsgCapacityIncreaseConfigMember {
|
|
1833
|
+
customActionLambdaConfig?: never;
|
|
1834
|
+
ec2AsgCapacityIncreaseConfig: Ec2AsgCapacityIncreaseConfiguration;
|
|
1835
|
+
executionApprovalConfig?: never;
|
|
1836
|
+
arcRoutingControlConfig?: never;
|
|
1837
|
+
globalAuroraConfig?: never;
|
|
1838
|
+
parallelConfig?: never;
|
|
1839
|
+
regionSwitchPlanConfig?: never;
|
|
1840
|
+
ecsCapacityIncreaseConfig?: never;
|
|
1841
|
+
eksResourceScalingConfig?: never;
|
|
1842
|
+
route53HealthCheckConfig?: never;
|
|
1843
|
+
$unknown?: never;
|
|
1844
|
+
}
|
|
1845
|
+
/**
|
|
1846
|
+
* <p>A manual approval execution block.</p>
|
|
1847
|
+
* @public
|
|
1848
|
+
*/
|
|
1849
|
+
interface ExecutionApprovalConfigMember {
|
|
1850
|
+
customActionLambdaConfig?: never;
|
|
1851
|
+
ec2AsgCapacityIncreaseConfig?: never;
|
|
1852
|
+
executionApprovalConfig: ExecutionApprovalConfiguration;
|
|
1853
|
+
arcRoutingControlConfig?: never;
|
|
1854
|
+
globalAuroraConfig?: never;
|
|
1855
|
+
parallelConfig?: never;
|
|
1856
|
+
regionSwitchPlanConfig?: never;
|
|
1857
|
+
ecsCapacityIncreaseConfig?: never;
|
|
1858
|
+
eksResourceScalingConfig?: never;
|
|
1859
|
+
route53HealthCheckConfig?: never;
|
|
1860
|
+
$unknown?: never;
|
|
1861
|
+
}
|
|
1862
|
+
/**
|
|
1863
|
+
* <p>An ARC routing control execution block.</p>
|
|
1864
|
+
* @public
|
|
1865
|
+
*/
|
|
1866
|
+
interface ArcRoutingControlConfigMember {
|
|
1867
|
+
customActionLambdaConfig?: never;
|
|
1868
|
+
ec2AsgCapacityIncreaseConfig?: never;
|
|
1869
|
+
executionApprovalConfig?: never;
|
|
1870
|
+
arcRoutingControlConfig: ArcRoutingControlConfiguration;
|
|
1871
|
+
globalAuroraConfig?: never;
|
|
1872
|
+
parallelConfig?: never;
|
|
1873
|
+
regionSwitchPlanConfig?: never;
|
|
1874
|
+
ecsCapacityIncreaseConfig?: never;
|
|
1875
|
+
eksResourceScalingConfig?: never;
|
|
1876
|
+
route53HealthCheckConfig?: never;
|
|
1877
|
+
$unknown?: never;
|
|
1878
|
+
}
|
|
1879
|
+
/**
|
|
1880
|
+
* <p>An Aurora Global Database execution block.</p>
|
|
1881
|
+
* @public
|
|
1882
|
+
*/
|
|
1883
|
+
interface GlobalAuroraConfigMember {
|
|
1884
|
+
customActionLambdaConfig?: never;
|
|
1885
|
+
ec2AsgCapacityIncreaseConfig?: never;
|
|
1886
|
+
executionApprovalConfig?: never;
|
|
1887
|
+
arcRoutingControlConfig?: never;
|
|
1888
|
+
globalAuroraConfig: GlobalAuroraConfiguration;
|
|
1889
|
+
parallelConfig?: never;
|
|
1890
|
+
regionSwitchPlanConfig?: never;
|
|
1891
|
+
ecsCapacityIncreaseConfig?: never;
|
|
1892
|
+
eksResourceScalingConfig?: never;
|
|
1893
|
+
route53HealthCheckConfig?: never;
|
|
1894
|
+
$unknown?: never;
|
|
1895
|
+
}
|
|
1896
|
+
/**
|
|
1897
|
+
* <p>A parallel configuration execution block.</p>
|
|
1898
|
+
* @public
|
|
1899
|
+
*/
|
|
1900
|
+
interface ParallelConfigMember {
|
|
1901
|
+
customActionLambdaConfig?: never;
|
|
1902
|
+
ec2AsgCapacityIncreaseConfig?: never;
|
|
1903
|
+
executionApprovalConfig?: never;
|
|
1904
|
+
arcRoutingControlConfig?: never;
|
|
1905
|
+
globalAuroraConfig?: never;
|
|
1906
|
+
parallelConfig: ParallelExecutionBlockConfiguration;
|
|
1907
|
+
regionSwitchPlanConfig?: never;
|
|
1908
|
+
ecsCapacityIncreaseConfig?: never;
|
|
1909
|
+
eksResourceScalingConfig?: never;
|
|
1910
|
+
route53HealthCheckConfig?: never;
|
|
1911
|
+
$unknown?: never;
|
|
1912
|
+
}
|
|
1913
|
+
/**
|
|
1914
|
+
* <p>A Region switch plan execution block.</p>
|
|
1915
|
+
* @public
|
|
1916
|
+
*/
|
|
1917
|
+
interface RegionSwitchPlanConfigMember {
|
|
1918
|
+
customActionLambdaConfig?: never;
|
|
1919
|
+
ec2AsgCapacityIncreaseConfig?: never;
|
|
1920
|
+
executionApprovalConfig?: never;
|
|
1921
|
+
arcRoutingControlConfig?: never;
|
|
1922
|
+
globalAuroraConfig?: never;
|
|
1923
|
+
parallelConfig?: never;
|
|
1924
|
+
regionSwitchPlanConfig: RegionSwitchPlanConfiguration;
|
|
1925
|
+
ecsCapacityIncreaseConfig?: never;
|
|
1926
|
+
eksResourceScalingConfig?: never;
|
|
1927
|
+
route53HealthCheckConfig?: never;
|
|
1928
|
+
$unknown?: never;
|
|
1929
|
+
}
|
|
1930
|
+
/**
|
|
1931
|
+
* <p>The capacity increase specified for the configuration.</p>
|
|
1932
|
+
* @public
|
|
1933
|
+
*/
|
|
1934
|
+
interface EcsCapacityIncreaseConfigMember {
|
|
1935
|
+
customActionLambdaConfig?: never;
|
|
1936
|
+
ec2AsgCapacityIncreaseConfig?: never;
|
|
1937
|
+
executionApprovalConfig?: never;
|
|
1938
|
+
arcRoutingControlConfig?: never;
|
|
1939
|
+
globalAuroraConfig?: never;
|
|
1940
|
+
parallelConfig?: never;
|
|
1941
|
+
regionSwitchPlanConfig?: never;
|
|
1942
|
+
ecsCapacityIncreaseConfig: EcsCapacityIncreaseConfiguration;
|
|
1943
|
+
eksResourceScalingConfig?: never;
|
|
1944
|
+
route53HealthCheckConfig?: never;
|
|
1945
|
+
$unknown?: never;
|
|
1946
|
+
}
|
|
1947
|
+
/**
|
|
1948
|
+
* <p>An Amazon Web Services EKS resource scaling execution block.</p>
|
|
1949
|
+
* @public
|
|
1950
|
+
*/
|
|
1951
|
+
interface EksResourceScalingConfigMember {
|
|
1952
|
+
customActionLambdaConfig?: never;
|
|
1953
|
+
ec2AsgCapacityIncreaseConfig?: never;
|
|
1954
|
+
executionApprovalConfig?: never;
|
|
1955
|
+
arcRoutingControlConfig?: never;
|
|
1956
|
+
globalAuroraConfig?: never;
|
|
1957
|
+
parallelConfig?: never;
|
|
1958
|
+
regionSwitchPlanConfig?: never;
|
|
1959
|
+
ecsCapacityIncreaseConfig?: never;
|
|
1960
|
+
eksResourceScalingConfig: EksResourceScalingConfiguration;
|
|
1961
|
+
route53HealthCheckConfig?: never;
|
|
1962
|
+
$unknown?: never;
|
|
1963
|
+
}
|
|
1964
|
+
/**
|
|
1965
|
+
* <p>The Amazon Route 53 health check configuration.</p>
|
|
1966
|
+
* @public
|
|
1967
|
+
*/
|
|
1968
|
+
interface Route53HealthCheckConfigMember {
|
|
1969
|
+
customActionLambdaConfig?: never;
|
|
1970
|
+
ec2AsgCapacityIncreaseConfig?: never;
|
|
1971
|
+
executionApprovalConfig?: never;
|
|
1972
|
+
arcRoutingControlConfig?: never;
|
|
1973
|
+
globalAuroraConfig?: never;
|
|
1974
|
+
parallelConfig?: never;
|
|
1975
|
+
regionSwitchPlanConfig?: never;
|
|
1976
|
+
ecsCapacityIncreaseConfig?: never;
|
|
1977
|
+
eksResourceScalingConfig?: never;
|
|
1978
|
+
route53HealthCheckConfig: Route53HealthCheckConfiguration;
|
|
1979
|
+
$unknown?: never;
|
|
1980
|
+
}
|
|
1981
|
+
/**
|
|
1982
|
+
* @public
|
|
1983
|
+
*/
|
|
1984
|
+
interface $UnknownMember {
|
|
1985
|
+
customActionLambdaConfig?: never;
|
|
1986
|
+
ec2AsgCapacityIncreaseConfig?: never;
|
|
1987
|
+
executionApprovalConfig?: never;
|
|
1988
|
+
arcRoutingControlConfig?: never;
|
|
1989
|
+
globalAuroraConfig?: never;
|
|
1990
|
+
parallelConfig?: never;
|
|
1991
|
+
regionSwitchPlanConfig?: never;
|
|
1992
|
+
ecsCapacityIncreaseConfig?: never;
|
|
1993
|
+
eksResourceScalingConfig?: never;
|
|
1994
|
+
route53HealthCheckConfig?: never;
|
|
1995
|
+
$unknown: [string, any];
|
|
1996
|
+
}
|
|
1997
|
+
interface Visitor<T> {
|
|
1998
|
+
customActionLambdaConfig: (value: CustomActionLambdaConfiguration) => T;
|
|
1999
|
+
ec2AsgCapacityIncreaseConfig: (value: Ec2AsgCapacityIncreaseConfiguration) => T;
|
|
2000
|
+
executionApprovalConfig: (value: ExecutionApprovalConfiguration) => T;
|
|
2001
|
+
arcRoutingControlConfig: (value: ArcRoutingControlConfiguration) => T;
|
|
2002
|
+
globalAuroraConfig: (value: GlobalAuroraConfiguration) => T;
|
|
2003
|
+
parallelConfig: (value: ParallelExecutionBlockConfiguration) => T;
|
|
2004
|
+
regionSwitchPlanConfig: (value: RegionSwitchPlanConfiguration) => T;
|
|
2005
|
+
ecsCapacityIncreaseConfig: (value: EcsCapacityIncreaseConfiguration) => T;
|
|
2006
|
+
eksResourceScalingConfig: (value: EksResourceScalingConfiguration) => T;
|
|
2007
|
+
route53HealthCheckConfig: (value: Route53HealthCheckConfiguration) => T;
|
|
2008
|
+
_: (name: string, value: any) => T;
|
|
2009
|
+
}
|
|
2010
|
+
const visit: <T>(value: ExecutionBlockConfiguration, visitor: Visitor<T>) => T;
|
|
2011
|
+
}
|
|
2012
|
+
/**
|
|
2013
|
+
* <p>Configuration for steps that should be executed in parallel during a Region switch.</p>
|
|
2014
|
+
* @public
|
|
2015
|
+
*/
|
|
2016
|
+
export interface ParallelExecutionBlockConfiguration {
|
|
2017
|
+
/**
|
|
2018
|
+
* <p>The steps for a parallel execution block.</p>
|
|
2019
|
+
* @public
|
|
2020
|
+
*/
|
|
2021
|
+
steps: Step[] | undefined;
|
|
2022
|
+
}
|
|
2023
|
+
/**
|
|
2024
|
+
* <p>Represents a step in a Region switch plan workflow. Each step performs a specific action during the Region switch process.</p>
|
|
2025
|
+
* @public
|
|
2026
|
+
*/
|
|
2027
|
+
export interface Step {
|
|
2028
|
+
/**
|
|
2029
|
+
* <p>The name of a step in a workflow.</p>
|
|
2030
|
+
* @public
|
|
2031
|
+
*/
|
|
2032
|
+
name: string | undefined;
|
|
2033
|
+
/**
|
|
2034
|
+
* <p>The description of a step in a workflow.</p>
|
|
2035
|
+
* @public
|
|
2036
|
+
*/
|
|
2037
|
+
description?: string | undefined;
|
|
2038
|
+
/**
|
|
2039
|
+
* <p>The configuration for an execution block in a workflow.</p>
|
|
2040
|
+
* @public
|
|
2041
|
+
*/
|
|
2042
|
+
executionBlockConfiguration: ExecutionBlockConfiguration | undefined;
|
|
2043
|
+
/**
|
|
2044
|
+
* <p>The type of an execution block in a workflow.</p>
|
|
2045
|
+
* @public
|
|
2046
|
+
*/
|
|
2047
|
+
executionBlockType: ExecutionBlockType | undefined;
|
|
2048
|
+
}
|
|
2049
|
+
/**
|
|
2050
|
+
* <p>Represents a workflow in a Region switch plan. A workflow defines a sequence of steps to execute during a Region switch.</p>
|
|
2051
|
+
* @public
|
|
2052
|
+
*/
|
|
2053
|
+
export interface Workflow {
|
|
2054
|
+
/**
|
|
2055
|
+
* <p>The steps that make up the workflow.</p>
|
|
2056
|
+
* @public
|
|
2057
|
+
*/
|
|
2058
|
+
steps?: Step[] | undefined;
|
|
2059
|
+
/**
|
|
2060
|
+
* <p>The action that the workflow performs. Valid values include ACTIVATE and DEACTIVATE.</p>
|
|
2061
|
+
* @public
|
|
2062
|
+
*/
|
|
2063
|
+
workflowTargetAction: WorkflowTargetAction | undefined;
|
|
2064
|
+
/**
|
|
2065
|
+
* <p>The Amazon Web Services Region that the workflow targets.</p>
|
|
2066
|
+
* @public
|
|
2067
|
+
*/
|
|
2068
|
+
workflowTargetRegion?: string | undefined;
|
|
2069
|
+
/**
|
|
2070
|
+
* <p>The description of the workflow.</p>
|
|
2071
|
+
* @public
|
|
2072
|
+
*/
|
|
2073
|
+
workflowDescription?: string | undefined;
|
|
2074
|
+
}
|
|
2075
|
+
/**
|
|
2076
|
+
* @public
|
|
2077
|
+
*/
|
|
2078
|
+
export interface CreatePlanRequest {
|
|
2079
|
+
/**
|
|
2080
|
+
* <p>The description of a Region switch plan.</p>
|
|
2081
|
+
* @public
|
|
2082
|
+
*/
|
|
2083
|
+
description?: string | undefined;
|
|
2084
|
+
/**
|
|
2085
|
+
* <p>An array of workflows included in a Region switch plan.</p>
|
|
2086
|
+
* @public
|
|
2087
|
+
*/
|
|
2088
|
+
workflows: Workflow[] | undefined;
|
|
2089
|
+
/**
|
|
2090
|
+
* <p>An execution role is a way to categorize a Region switch plan.</p>
|
|
2091
|
+
* @public
|
|
2092
|
+
*/
|
|
2093
|
+
executionRole: string | undefined;
|
|
2094
|
+
/**
|
|
2095
|
+
* <p>Optionally, you can specify an recovery time objective for a Region switch plan, in minutes.</p>
|
|
2096
|
+
* @public
|
|
2097
|
+
*/
|
|
2098
|
+
recoveryTimeObjectiveMinutes?: number | undefined;
|
|
2099
|
+
/**
|
|
2100
|
+
* <p>The alarms associated with a Region switch plan.</p>
|
|
2101
|
+
* @public
|
|
2102
|
+
*/
|
|
2103
|
+
associatedAlarms?: Record<string, AssociatedAlarm> | undefined;
|
|
2104
|
+
/**
|
|
2105
|
+
* <p>The triggers associated with a Region switch plan.</p>
|
|
2106
|
+
* @public
|
|
2107
|
+
*/
|
|
2108
|
+
triggers?: Trigger[] | undefined;
|
|
2109
|
+
/**
|
|
2110
|
+
* <p>The name of a Region switch plan.</p>
|
|
2111
|
+
* @public
|
|
2112
|
+
*/
|
|
2113
|
+
name: string | undefined;
|
|
2114
|
+
/**
|
|
2115
|
+
* <p>An array that specifies the Amazon Web Services Regions for a Region switch plan. Specify two Regions.</p>
|
|
2116
|
+
* @public
|
|
2117
|
+
*/
|
|
2118
|
+
regions: string[] | undefined;
|
|
2119
|
+
/**
|
|
2120
|
+
* <p>The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).</p>
|
|
2121
|
+
* @public
|
|
2122
|
+
*/
|
|
2123
|
+
recoveryApproach: RecoveryApproach | undefined;
|
|
2124
|
+
/**
|
|
2125
|
+
* <p>The primary Amazon Web Services Region for the application. This is the Region where the application normally runs before any Region switch occurs.</p>
|
|
2126
|
+
* @public
|
|
2127
|
+
*/
|
|
2128
|
+
primaryRegion?: string | undefined;
|
|
2129
|
+
/**
|
|
2130
|
+
* <p>The tags to apply to the Region switch plan.</p>
|
|
2131
|
+
* @public
|
|
2132
|
+
*/
|
|
2133
|
+
tags?: Record<string, string> | undefined;
|
|
2134
|
+
}
|
|
2135
|
+
/**
|
|
2136
|
+
* <p>Represents a Region switch plan. A plan defines the steps required to shift traffic from one Amazon Web Services Region to another.</p>
|
|
2137
|
+
* @public
|
|
2138
|
+
*/
|
|
2139
|
+
export interface Plan {
|
|
2140
|
+
/**
|
|
2141
|
+
* <p>The Amazon Resource Name (ARN) of the plan.</p>
|
|
2142
|
+
* @public
|
|
2143
|
+
*/
|
|
2144
|
+
arn: string | undefined;
|
|
2145
|
+
/**
|
|
2146
|
+
* <p>The description for a plan.</p>
|
|
2147
|
+
* @public
|
|
2148
|
+
*/
|
|
2149
|
+
description?: string | undefined;
|
|
2150
|
+
/**
|
|
2151
|
+
* <p>The workflows for a plan.</p>
|
|
2152
|
+
* @public
|
|
2153
|
+
*/
|
|
2154
|
+
workflows: Workflow[] | undefined;
|
|
2155
|
+
/**
|
|
2156
|
+
* <p>The execution role for a plan.</p>
|
|
2157
|
+
* @public
|
|
2158
|
+
*/
|
|
2159
|
+
executionRole: string | undefined;
|
|
2160
|
+
/**
|
|
2161
|
+
* <p>The recovery time objective for a plan.</p>
|
|
2162
|
+
* @public
|
|
2163
|
+
*/
|
|
2164
|
+
recoveryTimeObjectiveMinutes?: number | undefined;
|
|
2165
|
+
/**
|
|
2166
|
+
* <p>The associated application health alarms for a plan.</p>
|
|
2167
|
+
* @public
|
|
2168
|
+
*/
|
|
2169
|
+
associatedAlarms?: Record<string, AssociatedAlarm> | undefined;
|
|
2170
|
+
/**
|
|
2171
|
+
* <p>The triggers for a plan.</p>
|
|
2172
|
+
* @public
|
|
2173
|
+
*/
|
|
2174
|
+
triggers?: Trigger[] | undefined;
|
|
2175
|
+
/**
|
|
2176
|
+
* <p>The name for a plan.</p>
|
|
2177
|
+
* @public
|
|
2178
|
+
*/
|
|
2179
|
+
name: string | undefined;
|
|
2180
|
+
/**
|
|
2181
|
+
* <p>The Amazon Web Services Regions for a plan.</p>
|
|
2182
|
+
* @public
|
|
2183
|
+
*/
|
|
2184
|
+
regions: string[] | undefined;
|
|
2185
|
+
/**
|
|
2186
|
+
* <p>The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).</p>
|
|
2187
|
+
* @public
|
|
2188
|
+
*/
|
|
2189
|
+
recoveryApproach: RecoveryApproach | undefined;
|
|
2190
|
+
/**
|
|
2191
|
+
* <p>The primary Region for a plan.</p>
|
|
2192
|
+
* @public
|
|
2193
|
+
*/
|
|
2194
|
+
primaryRegion?: string | undefined;
|
|
2195
|
+
/**
|
|
2196
|
+
* <p>The owner of a plan.</p>
|
|
2197
|
+
* @public
|
|
2198
|
+
*/
|
|
2199
|
+
owner: string | undefined;
|
|
2200
|
+
/**
|
|
2201
|
+
* <p>The version for the plan.</p>
|
|
2202
|
+
* @public
|
|
2203
|
+
*/
|
|
2204
|
+
version?: string | undefined;
|
|
2205
|
+
/**
|
|
2206
|
+
* <p>The timestamp when the plan was last updated.</p>
|
|
2207
|
+
* @public
|
|
2208
|
+
*/
|
|
2209
|
+
updatedAt?: Date | undefined;
|
|
2210
|
+
}
|
|
2211
|
+
/**
|
|
2212
|
+
* @public
|
|
2213
|
+
*/
|
|
2214
|
+
export interface UpdatePlanRequest {
|
|
2215
|
+
/**
|
|
2216
|
+
* <p>The Amazon Resource Name (ARN) of the plan.</p>
|
|
2217
|
+
* @public
|
|
2218
|
+
*/
|
|
2219
|
+
arn: string | undefined;
|
|
2220
|
+
/**
|
|
2221
|
+
* <p>The updated description for the Region switch plan.</p>
|
|
2222
|
+
* @public
|
|
2223
|
+
*/
|
|
2224
|
+
description?: string | undefined;
|
|
2225
|
+
/**
|
|
2226
|
+
* <p>The updated workflows for the Region switch plan.</p>
|
|
2227
|
+
* @public
|
|
2228
|
+
*/
|
|
2229
|
+
workflows: Workflow[] | undefined;
|
|
2230
|
+
/**
|
|
2231
|
+
* <p>The updated IAM role ARN that grants Region switch the permissions needed to execute the plan steps.</p>
|
|
2232
|
+
* @public
|
|
2233
|
+
*/
|
|
2234
|
+
executionRole: string | undefined;
|
|
2235
|
+
/**
|
|
2236
|
+
* <p>The updated target recovery time objective (RTO) in minutes for the plan.</p>
|
|
2237
|
+
* @public
|
|
2238
|
+
*/
|
|
2239
|
+
recoveryTimeObjectiveMinutes?: number | undefined;
|
|
2240
|
+
/**
|
|
2241
|
+
* <p>The updated CloudWatch alarms associated with the plan.</p>
|
|
2242
|
+
* @public
|
|
2243
|
+
*/
|
|
2244
|
+
associatedAlarms?: Record<string, AssociatedAlarm> | undefined;
|
|
2245
|
+
/**
|
|
2246
|
+
* <p>The updated conditions that can automatically trigger the execution of the plan.</p>
|
|
2247
|
+
* @public
|
|
2248
|
+
*/
|
|
2249
|
+
triggers?: Trigger[] | undefined;
|
|
2250
|
+
}
|
|
2251
|
+
/**
|
|
2252
|
+
* @public
|
|
2253
|
+
*/
|
|
2254
|
+
export interface CreatePlanResponse {
|
|
2255
|
+
/**
|
|
2256
|
+
* <p>The details of the created Region switch plan.</p>
|
|
2257
|
+
* @public
|
|
2258
|
+
*/
|
|
2259
|
+
plan?: Plan | undefined;
|
|
2260
|
+
}
|
|
2261
|
+
/**
|
|
2262
|
+
* @public
|
|
2263
|
+
*/
|
|
2264
|
+
export interface GetPlanExecutionResponse {
|
|
2265
|
+
/**
|
|
2266
|
+
* <p>The Amazon Resource Name (ARN) of the plan.</p>
|
|
2267
|
+
* @public
|
|
2268
|
+
*/
|
|
2269
|
+
planArn: string | undefined;
|
|
2270
|
+
/**
|
|
2271
|
+
* <p>The execution identifier of a plan execution.</p>
|
|
2272
|
+
* @public
|
|
2273
|
+
*/
|
|
2274
|
+
executionId: string | undefined;
|
|
2275
|
+
/**
|
|
2276
|
+
* <p>The version for the plan.</p>
|
|
2277
|
+
* @public
|
|
2278
|
+
*/
|
|
2279
|
+
version?: string | undefined;
|
|
2280
|
+
/**
|
|
2281
|
+
* <p>The timestamp when the plan execution was last updated.</p>
|
|
2282
|
+
* @public
|
|
2283
|
+
*/
|
|
2284
|
+
updatedAt?: Date | undefined;
|
|
2285
|
+
/**
|
|
2286
|
+
* <p>A comment included on the plan execution.</p>
|
|
2287
|
+
* @public
|
|
2288
|
+
*/
|
|
2289
|
+
comment?: string | undefined;
|
|
2290
|
+
/**
|
|
2291
|
+
* <p>The time (UTC) when the plan execution started.</p>
|
|
2292
|
+
* @public
|
|
2293
|
+
*/
|
|
2294
|
+
startTime: Date | undefined;
|
|
2295
|
+
/**
|
|
2296
|
+
* <p>The time (UTC) when the plan execution ended.</p>
|
|
2297
|
+
* @public
|
|
2298
|
+
*/
|
|
2299
|
+
endTime?: Date | undefined;
|
|
2300
|
+
/**
|
|
2301
|
+
* <p>The plan execution mode. Valid values are <code>Practice</code>, for testing without making actual changes, or <code>Recovery</code>, for actual traffic shifting and application recovery.</p>
|
|
2302
|
+
* @public
|
|
2303
|
+
*/
|
|
2304
|
+
mode: ExecutionMode | undefined;
|
|
2305
|
+
/**
|
|
2306
|
+
* <p>The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.</p>
|
|
2307
|
+
* @public
|
|
2308
|
+
*/
|
|
2309
|
+
executionState: ExecutionState | undefined;
|
|
2310
|
+
/**
|
|
2311
|
+
* <p>The plan execution action. Valid values are <code>Activate</code>, to activate an Amazon Web Services Region, or <code>Deactivate</code>, to deactivate a Region.</p>
|
|
2312
|
+
* @public
|
|
2313
|
+
*/
|
|
2314
|
+
executionAction: ExecutionAction | undefined;
|
|
2315
|
+
/**
|
|
2316
|
+
* <p>The Amazon Web Services Region for a plan execution.</p>
|
|
2317
|
+
* @public
|
|
2318
|
+
*/
|
|
2319
|
+
executionRegion: string | undefined;
|
|
2320
|
+
/**
|
|
2321
|
+
* <p>The states of the steps in the plan execution.</p>
|
|
2322
|
+
* @public
|
|
2323
|
+
*/
|
|
2324
|
+
stepStates?: StepState[] | undefined;
|
|
2325
|
+
/**
|
|
2326
|
+
* <p>The details of the Region switch plan.</p>
|
|
2327
|
+
* @public
|
|
2328
|
+
*/
|
|
2329
|
+
plan?: Plan | undefined;
|
|
2330
|
+
/**
|
|
2331
|
+
* <p>The actual recovery time that Region switch calculates for a plan execution. Actual recovery time includes the time for the plan to run added to the time elapsed until the application health alarms that you've specified are healthy again.</p>
|
|
2332
|
+
* @public
|
|
2333
|
+
*/
|
|
2334
|
+
actualRecoveryTime?: string | undefined;
|
|
2335
|
+
/**
|
|
2336
|
+
* <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>
|
|
2337
|
+
* @public
|
|
2338
|
+
*/
|
|
2339
|
+
nextToken?: string | undefined;
|
|
2340
|
+
}
|
|
2341
|
+
/**
|
|
2342
|
+
* @public
|
|
2343
|
+
*/
|
|
2344
|
+
export interface GetPlanInRegionResponse {
|
|
2345
|
+
/**
|
|
2346
|
+
* <p>The details of the Region switch plan.</p>
|
|
2347
|
+
* @public
|
|
2348
|
+
*/
|
|
2349
|
+
plan?: Plan | undefined;
|
|
2350
|
+
}
|
|
2351
|
+
/**
|
|
2352
|
+
* @public
|
|
2353
|
+
*/
|
|
2354
|
+
export interface GetPlanResponse {
|
|
2355
|
+
/**
|
|
2356
|
+
* <p>The detailed information about the requested Region switch plan.</p>
|
|
2357
|
+
* @public
|
|
2358
|
+
*/
|
|
2359
|
+
plan?: Plan | undefined;
|
|
2360
|
+
}
|
|
2361
|
+
/**
|
|
2362
|
+
* @public
|
|
2363
|
+
*/
|
|
2364
|
+
export interface UpdatePlanResponse {
|
|
2365
|
+
/**
|
|
2366
|
+
* <p>The details of the updated Region switch plan.</p>
|
|
2367
|
+
* @public
|
|
2368
|
+
*/
|
|
2369
|
+
plan?: Plan | undefined;
|
|
2370
|
+
}
|