@aws-sdk/client-arc-region-switch 3.1150.0 → 3.1152.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +78 -22
- package/dist-es/models/enums.js +4 -0
- package/dist-es/schemas/schemas_0.js +73 -21
- package/dist-types/commands/CreatePlanCommand.d.ts +120 -4
- package/dist-types/commands/GetPlanCommand.d.ts +60 -2
- package/dist-types/commands/GetPlanExecutionCommand.d.ts +60 -2
- package/dist-types/commands/GetPlanInRegionCommand.d.ts +60 -2
- package/dist-types/commands/ListPlanExecutionEventsCommand.d.ts +1 -1
- package/dist-types/commands/ListServiceQuotaWarningsCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePlanCommand.d.ts +120 -4
- package/dist-types/models/enums.d.ts +12 -0
- package/dist-types/models/models_0.d.ts +146 -6
- package/dist-types/schemas/schemas_0.d.ts +4 -0
- package/dist-types/ts3.4/models/enums.d.ts +6 -0
- package/dist-types/ts3.4/models/models_0.d.ts +66 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +4 -0
- package/package.json +1 -1
|
@@ -50,6 +50,7 @@ declare const UpdatePlanCommand_base: {
|
|
|
50
50
|
* crossAccountRole: "STRING_VALUE",
|
|
51
51
|
* externalId: "STRING_VALUE",
|
|
52
52
|
* arn: "STRING_VALUE",
|
|
53
|
+
* payload: "STRING_VALUE",
|
|
53
54
|
* },
|
|
54
55
|
* ],
|
|
55
56
|
* retryIntervalMinutes: Number("float"), // required
|
|
@@ -117,6 +118,7 @@ declare const UpdatePlanCommand_base: {
|
|
|
117
118
|
* crossAccountRole: "STRING_VALUE",
|
|
118
119
|
* externalId: "STRING_VALUE",
|
|
119
120
|
* arn: "STRING_VALUE",
|
|
121
|
+
* payload: "STRING_VALUE",
|
|
120
122
|
* },
|
|
121
123
|
* ],
|
|
122
124
|
* retryIntervalMinutes: Number("float"), // required
|
|
@@ -328,8 +330,36 @@ declare const UpdatePlanCommand_base: {
|
|
|
328
330
|
* ungraceful: "promoteReadReplica",
|
|
329
331
|
* },
|
|
330
332
|
* },
|
|
333
|
+
* ssmSendCommandConfig: { // SsmSendCommandConfiguration
|
|
334
|
+
* timeoutMinutes: Number("int"),
|
|
335
|
+
* regionDocuments: { // RegionSsmDocumentMap // required
|
|
336
|
+
* "<keys>": { // SsmDocumentConfig
|
|
337
|
+
* crossAccountRole: "STRING_VALUE",
|
|
338
|
+
* externalId: "STRING_VALUE",
|
|
339
|
+
* documentArn: "STRING_VALUE", // required
|
|
340
|
+
* targets: [ // SsmTargetList // required
|
|
341
|
+
* { // SsmTarget
|
|
342
|
+
* key: "STRING_VALUE", // required
|
|
343
|
+
* values: [ // SsmTargetValueList // required
|
|
344
|
+
* "STRING_VALUE",
|
|
345
|
+
* ],
|
|
346
|
+
* },
|
|
347
|
+
* ],
|
|
348
|
+
* parameters: { // SsmDocumentParameters
|
|
349
|
+
* "<keys>": [ // SsmParameterValues
|
|
350
|
+
* "STRING_VALUE",
|
|
351
|
+
* ],
|
|
352
|
+
* },
|
|
353
|
+
* documentVersion: "STRING_VALUE",
|
|
354
|
+
* },
|
|
355
|
+
* },
|
|
356
|
+
* retryIntervalMinutes: Number("float"), // required
|
|
357
|
+
* ungraceful: { // SsmSendCommandUngraceful
|
|
358
|
+
* behavior: "skip",
|
|
359
|
+
* },
|
|
360
|
+
* },
|
|
331
361
|
* },
|
|
332
|
-
* executionBlockType: "CustomActionLambda" || "ManualApproval" || "AuroraGlobalDatabase" || "EC2AutoScaling" || "ARCRoutingControl" || "ARCRegionSwitchPlan" || "Parallel" || "ECSServiceScaling" || "EKSResourceScaling" || "Route53HealthCheck" || "DocumentDb" || "RdsPromoteReadReplica" || "RdsCreateCrossRegionReplica" || "LambdaEventSourceMapping" || "AuroraServerlessScaling" || "AuroraProvisionedScaling" || "NeptuneGlobalDatabase" || "RdsSwitchoverReadReplica", // required
|
|
362
|
+
* executionBlockType: "CustomActionLambda" || "ManualApproval" || "AuroraGlobalDatabase" || "EC2AutoScaling" || "ARCRoutingControl" || "ARCRegionSwitchPlan" || "Parallel" || "ECSServiceScaling" || "EKSResourceScaling" || "Route53HealthCheck" || "DocumentDb" || "RdsPromoteReadReplica" || "RdsCreateCrossRegionReplica" || "LambdaEventSourceMapping" || "AuroraServerlessScaling" || "AuroraProvisionedScaling" || "NeptuneGlobalDatabase" || "RdsSwitchoverReadReplica" || "SSMSendCommand", // required
|
|
333
363
|
* },
|
|
334
364
|
* ],
|
|
335
365
|
* },
|
|
@@ -485,8 +515,36 @@ declare const UpdatePlanCommand_base: {
|
|
|
485
515
|
* ungraceful: "promoteReadReplica",
|
|
486
516
|
* },
|
|
487
517
|
* },
|
|
518
|
+
* ssmSendCommandConfig: {
|
|
519
|
+
* timeoutMinutes: Number("int"),
|
|
520
|
+
* regionDocuments: { // required
|
|
521
|
+
* "<keys>": {
|
|
522
|
+
* crossAccountRole: "STRING_VALUE",
|
|
523
|
+
* externalId: "STRING_VALUE",
|
|
524
|
+
* documentArn: "STRING_VALUE", // required
|
|
525
|
+
* targets: [ // required
|
|
526
|
+
* {
|
|
527
|
+
* key: "STRING_VALUE", // required
|
|
528
|
+
* values: [ // required
|
|
529
|
+
* "STRING_VALUE",
|
|
530
|
+
* ],
|
|
531
|
+
* },
|
|
532
|
+
* ],
|
|
533
|
+
* parameters: {
|
|
534
|
+
* "<keys>": [
|
|
535
|
+
* "STRING_VALUE",
|
|
536
|
+
* ],
|
|
537
|
+
* },
|
|
538
|
+
* documentVersion: "STRING_VALUE",
|
|
539
|
+
* },
|
|
540
|
+
* },
|
|
541
|
+
* retryIntervalMinutes: Number("float"), // required
|
|
542
|
+
* ungraceful: {
|
|
543
|
+
* behavior: "skip",
|
|
544
|
+
* },
|
|
545
|
+
* },
|
|
488
546
|
* },
|
|
489
|
-
* executionBlockType: "CustomActionLambda" || "ManualApproval" || "AuroraGlobalDatabase" || "EC2AutoScaling" || "ARCRoutingControl" || "ARCRegionSwitchPlan" || "Parallel" || "ECSServiceScaling" || "EKSResourceScaling" || "Route53HealthCheck" || "DocumentDb" || "RdsPromoteReadReplica" || "RdsCreateCrossRegionReplica" || "LambdaEventSourceMapping" || "AuroraServerlessScaling" || "AuroraProvisionedScaling" || "NeptuneGlobalDatabase" || "RdsSwitchoverReadReplica", // required
|
|
547
|
+
* executionBlockType: "CustomActionLambda" || "ManualApproval" || "AuroraGlobalDatabase" || "EC2AutoScaling" || "ARCRoutingControl" || "ARCRegionSwitchPlan" || "Parallel" || "ECSServiceScaling" || "EKSResourceScaling" || "Route53HealthCheck" || "DocumentDb" || "RdsPromoteReadReplica" || "RdsCreateCrossRegionReplica" || "LambdaEventSourceMapping" || "AuroraServerlessScaling" || "AuroraProvisionedScaling" || "NeptuneGlobalDatabase" || "RdsSwitchoverReadReplica" || "SSMSendCommand", // required
|
|
490
548
|
* },
|
|
491
549
|
* ],
|
|
492
550
|
* workflowTargetAction: "activate" || "deactivate" || "postRecovery", // required
|
|
@@ -550,6 +608,7 @@ declare const UpdatePlanCommand_base: {
|
|
|
550
608
|
* // crossAccountRole: "STRING_VALUE",
|
|
551
609
|
* // externalId: "STRING_VALUE",
|
|
552
610
|
* // arn: "STRING_VALUE",
|
|
611
|
+
* // payload: "STRING_VALUE",
|
|
553
612
|
* // },
|
|
554
613
|
* // ],
|
|
555
614
|
* // retryIntervalMinutes: Number("float"), // required
|
|
@@ -617,6 +676,7 @@ declare const UpdatePlanCommand_base: {
|
|
|
617
676
|
* // crossAccountRole: "STRING_VALUE",
|
|
618
677
|
* // externalId: "STRING_VALUE",
|
|
619
678
|
* // arn: "STRING_VALUE",
|
|
679
|
+
* // payload: "STRING_VALUE",
|
|
620
680
|
* // },
|
|
621
681
|
* // ],
|
|
622
682
|
* // retryIntervalMinutes: Number("float"), // required
|
|
@@ -828,8 +888,36 @@ declare const UpdatePlanCommand_base: {
|
|
|
828
888
|
* // ungraceful: "promoteReadReplica",
|
|
829
889
|
* // },
|
|
830
890
|
* // },
|
|
891
|
+
* // ssmSendCommandConfig: { // SsmSendCommandConfiguration
|
|
892
|
+
* // timeoutMinutes: Number("int"),
|
|
893
|
+
* // regionDocuments: { // RegionSsmDocumentMap // required
|
|
894
|
+
* // "<keys>": { // SsmDocumentConfig
|
|
895
|
+
* // crossAccountRole: "STRING_VALUE",
|
|
896
|
+
* // externalId: "STRING_VALUE",
|
|
897
|
+
* // documentArn: "STRING_VALUE", // required
|
|
898
|
+
* // targets: [ // SsmTargetList // required
|
|
899
|
+
* // { // SsmTarget
|
|
900
|
+
* // key: "STRING_VALUE", // required
|
|
901
|
+
* // values: [ // SsmTargetValueList // required
|
|
902
|
+
* // "STRING_VALUE",
|
|
903
|
+
* // ],
|
|
904
|
+
* // },
|
|
905
|
+
* // ],
|
|
906
|
+
* // parameters: { // SsmDocumentParameters
|
|
907
|
+
* // "<keys>": [ // SsmParameterValues
|
|
908
|
+
* // "STRING_VALUE",
|
|
909
|
+
* // ],
|
|
910
|
+
* // },
|
|
911
|
+
* // documentVersion: "STRING_VALUE",
|
|
912
|
+
* // },
|
|
913
|
+
* // },
|
|
914
|
+
* // retryIntervalMinutes: Number("float"), // required
|
|
915
|
+
* // ungraceful: { // SsmSendCommandUngraceful
|
|
916
|
+
* // behavior: "skip",
|
|
917
|
+
* // },
|
|
918
|
+
* // },
|
|
831
919
|
* // },
|
|
832
|
-
* // executionBlockType: "CustomActionLambda" || "ManualApproval" || "AuroraGlobalDatabase" || "EC2AutoScaling" || "ARCRoutingControl" || "ARCRegionSwitchPlan" || "Parallel" || "ECSServiceScaling" || "EKSResourceScaling" || "Route53HealthCheck" || "DocumentDb" || "RdsPromoteReadReplica" || "RdsCreateCrossRegionReplica" || "LambdaEventSourceMapping" || "AuroraServerlessScaling" || "AuroraProvisionedScaling" || "NeptuneGlobalDatabase" || "RdsSwitchoverReadReplica", // required
|
|
920
|
+
* // executionBlockType: "CustomActionLambda" || "ManualApproval" || "AuroraGlobalDatabase" || "EC2AutoScaling" || "ARCRoutingControl" || "ARCRegionSwitchPlan" || "Parallel" || "ECSServiceScaling" || "EKSResourceScaling" || "Route53HealthCheck" || "DocumentDb" || "RdsPromoteReadReplica" || "RdsCreateCrossRegionReplica" || "LambdaEventSourceMapping" || "AuroraServerlessScaling" || "AuroraProvisionedScaling" || "NeptuneGlobalDatabase" || "RdsSwitchoverReadReplica" || "SSMSendCommand", // required
|
|
833
921
|
* // },
|
|
834
922
|
* // ],
|
|
835
923
|
* // },
|
|
@@ -985,8 +1073,36 @@ declare const UpdatePlanCommand_base: {
|
|
|
985
1073
|
* // ungraceful: "promoteReadReplica",
|
|
986
1074
|
* // },
|
|
987
1075
|
* // },
|
|
1076
|
+
* // ssmSendCommandConfig: {
|
|
1077
|
+
* // timeoutMinutes: Number("int"),
|
|
1078
|
+
* // regionDocuments: { // required
|
|
1079
|
+
* // "<keys>": {
|
|
1080
|
+
* // crossAccountRole: "STRING_VALUE",
|
|
1081
|
+
* // externalId: "STRING_VALUE",
|
|
1082
|
+
* // documentArn: "STRING_VALUE", // required
|
|
1083
|
+
* // targets: [ // required
|
|
1084
|
+
* // {
|
|
1085
|
+
* // key: "STRING_VALUE", // required
|
|
1086
|
+
* // values: [ // required
|
|
1087
|
+
* // "STRING_VALUE",
|
|
1088
|
+
* // ],
|
|
1089
|
+
* // },
|
|
1090
|
+
* // ],
|
|
1091
|
+
* // parameters: {
|
|
1092
|
+
* // "<keys>": [
|
|
1093
|
+
* // "STRING_VALUE",
|
|
1094
|
+
* // ],
|
|
1095
|
+
* // },
|
|
1096
|
+
* // documentVersion: "STRING_VALUE",
|
|
1097
|
+
* // },
|
|
1098
|
+
* // },
|
|
1099
|
+
* // retryIntervalMinutes: Number("float"), // required
|
|
1100
|
+
* // ungraceful: {
|
|
1101
|
+
* // behavior: "skip",
|
|
1102
|
+
* // },
|
|
1103
|
+
* // },
|
|
988
1104
|
* // },
|
|
989
|
-
* // executionBlockType: "CustomActionLambda" || "ManualApproval" || "AuroraGlobalDatabase" || "EC2AutoScaling" || "ARCRoutingControl" || "ARCRegionSwitchPlan" || "Parallel" || "ECSServiceScaling" || "EKSResourceScaling" || "Route53HealthCheck" || "DocumentDb" || "RdsPromoteReadReplica" || "RdsCreateCrossRegionReplica" || "LambdaEventSourceMapping" || "AuroraServerlessScaling" || "AuroraProvisionedScaling" || "NeptuneGlobalDatabase" || "RdsSwitchoverReadReplica", // required
|
|
1105
|
+
* // executionBlockType: "CustomActionLambda" || "ManualApproval" || "AuroraGlobalDatabase" || "EC2AutoScaling" || "ARCRoutingControl" || "ARCRegionSwitchPlan" || "Parallel" || "ECSServiceScaling" || "EKSResourceScaling" || "Route53HealthCheck" || "DocumentDb" || "RdsPromoteReadReplica" || "RdsCreateCrossRegionReplica" || "LambdaEventSourceMapping" || "AuroraServerlessScaling" || "AuroraProvisionedScaling" || "NeptuneGlobalDatabase" || "RdsSwitchoverReadReplica" || "SSMSendCommand", // required
|
|
990
1106
|
* // },
|
|
991
1107
|
* // ],
|
|
992
1108
|
* // workflowTargetAction: "activate" || "deactivate" || "postRecovery", // required
|
|
@@ -331,6 +331,17 @@ export declare const RdsUngracefulBehavior: {
|
|
|
331
331
|
* @public
|
|
332
332
|
*/
|
|
333
333
|
export type RdsUngracefulBehavior = (typeof RdsUngracefulBehavior)[keyof typeof RdsUngracefulBehavior];
|
|
334
|
+
/**
|
|
335
|
+
* @public
|
|
336
|
+
* @enum
|
|
337
|
+
*/
|
|
338
|
+
export declare const SsmSendCommandUngracefulBehavior: {
|
|
339
|
+
readonly SKIP: "skip";
|
|
340
|
+
};
|
|
341
|
+
/**
|
|
342
|
+
* @public
|
|
343
|
+
*/
|
|
344
|
+
export type SsmSendCommandUngracefulBehavior = (typeof SsmSendCommandUngracefulBehavior)[keyof typeof SsmSendCommandUngracefulBehavior];
|
|
334
345
|
/**
|
|
335
346
|
* @public
|
|
336
347
|
* @enum
|
|
@@ -354,6 +365,7 @@ export declare const ExecutionBlockType: {
|
|
|
354
365
|
readonly REGION_SWITCH: "ARCRegionSwitchPlan";
|
|
355
366
|
readonly ROUTE53_HEALTH_CHECK: "Route53HealthCheck";
|
|
356
367
|
readonly ROUTING_CONTROL: "ARCRoutingControl";
|
|
368
|
+
readonly SSM_SEND_COMMAND: "SSMSendCommand";
|
|
357
369
|
};
|
|
358
370
|
/**
|
|
359
371
|
* @public
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { AlarmCondition, AlarmType, Approval, DocumentDbDefaultBehavior, DocumentDbUngracefulBehavior, Ec2AsgCapacityMonitoringApproach, EcsCapacityMonitoringApproach, EksCapacityMonitoringApproach, EvaluationStatus, EventSourceMappingAction, ExecutionAction, ExecutionBlockType, ExecutionEventType, ExecutionMode, ExecutionState, FailedReportErrorCode, GlobalAuroraDefaultBehavior, GlobalAuroraUngracefulBehavior, LambdaEventSourceMappingUngracefulBehavior, LambdaUngracefulBehavior, NeptuneDefaultBehavior, NeptuneUngracefulBehavior, RdsUngracefulBehavior, RecoveryApproach, RegionToRunIn, ResourceWarningStatus, Route53HealthCheckStatus, RoutingControlStateChange, ServiceQuotaWarningStatus, StepStatus, UpdatePlanExecutionAction, UpdatePlanExecutionStepAction, WaitELBTargetGroupHealthy, WorkflowTargetAction } from "./enums";
|
|
1
|
+
import type { AlarmCondition, AlarmType, Approval, DocumentDbDefaultBehavior, DocumentDbUngracefulBehavior, Ec2AsgCapacityMonitoringApproach, EcsCapacityMonitoringApproach, EksCapacityMonitoringApproach, EvaluationStatus, EventSourceMappingAction, ExecutionAction, ExecutionBlockType, ExecutionEventType, ExecutionMode, ExecutionState, FailedReportErrorCode, GlobalAuroraDefaultBehavior, GlobalAuroraUngracefulBehavior, LambdaEventSourceMappingUngracefulBehavior, LambdaUngracefulBehavior, NeptuneDefaultBehavior, NeptuneUngracefulBehavior, RdsUngracefulBehavior, RecoveryApproach, RegionToRunIn, ResourceWarningStatus, Route53HealthCheckStatus, RoutingControlStateChange, ServiceQuotaWarningStatus, SsmSendCommandUngracefulBehavior, StepStatus, UpdatePlanExecutionAction, UpdatePlanExecutionStepAction, WaitELBTargetGroupHealthy, WorkflowTargetAction } from "./enums";
|
|
2
2
|
/**
|
|
3
3
|
* <p>A summarized representation of a plan execution. This structure contains key information about an execution without all the detailed step data.</p>
|
|
4
4
|
* @public
|
|
@@ -693,6 +693,11 @@ export interface Lambdas {
|
|
|
693
693
|
* @public
|
|
694
694
|
*/
|
|
695
695
|
arn?: string | undefined;
|
|
696
|
+
/**
|
|
697
|
+
* <p>The JSON payload to send to the Lambda function invocation. If you don't specify a payload, Region switch invokes the function with only the execution metadata.</p> <p>If you provide a JSON object, Region switch merges execution metadata keys (<code>InvokedBy</code>, <code>PlanArn</code>, <code>ExecutionId</code>, <code>StepName</code>) into the top level. If one of your keys has the same name as a metadata key, your key takes precedence.</p> <p>If you provide any other JSON type (string, number, boolean, or array), Region switch forwards it to the Lambda function unchanged, without adding metadata.</p>
|
|
698
|
+
* @public
|
|
699
|
+
*/
|
|
700
|
+
payload?: string | undefined;
|
|
696
701
|
}
|
|
697
702
|
/**
|
|
698
703
|
* <p>Configuration for handling failures when invoking Lambda functions.</p>
|
|
@@ -1056,12 +1061,12 @@ export interface ExecutionApprovalConfiguration {
|
|
|
1056
1061
|
approvalRole: string | undefined;
|
|
1057
1062
|
}
|
|
1058
1063
|
/**
|
|
1059
|
-
* <p>Configuration for
|
|
1064
|
+
* <p>Configuration for an Aurora global database execution block in ungraceful mode.</p>
|
|
1060
1065
|
* @public
|
|
1061
1066
|
*/
|
|
1062
1067
|
export interface GlobalAuroraUngraceful {
|
|
1063
1068
|
/**
|
|
1064
|
-
* <p>The
|
|
1069
|
+
* <p>The ungraceful behavior. The only valid value is <code>failover</code>, which calls <code>FailoverGlobalCluster</code> with <code>AllowDataLoss</code> set to <code>true</code> and might cause data loss.</p>
|
|
1065
1070
|
* @public
|
|
1066
1071
|
*/
|
|
1067
1072
|
ungraceful?: GlobalAuroraUngracefulBehavior | undefined;
|
|
@@ -1087,12 +1092,12 @@ export interface GlobalAuroraConfiguration {
|
|
|
1087
1092
|
*/
|
|
1088
1093
|
externalId?: string | undefined;
|
|
1089
1094
|
/**
|
|
1090
|
-
* <p>The behavior for
|
|
1095
|
+
* <p>The default behavior for the Aurora global database execution block. Valid values:</p> <ul> <li> <p> <code>switchoverOnly</code> - Calls <code>SwitchoverGlobalCluster</code> for a zero-data-loss switchover during graceful execution.</p> </li> <li> <p> <code>failover</code> - Calls <code>FailoverGlobalCluster</code> with <code>AllowDataLoss</code> set to <code>true</code>. This operation might cause data loss, including during graceful execution.</p> </li> </ul>
|
|
1091
1096
|
* @public
|
|
1092
1097
|
*/
|
|
1093
1098
|
behavior: GlobalAuroraDefaultBehavior | undefined;
|
|
1094
1099
|
/**
|
|
1095
|
-
* <p>The
|
|
1100
|
+
* <p>The behavior to use when the plan runs in ungraceful mode. If you omit this value, Region switch uses the value of <code>behavior</code>.</p>
|
|
1096
1101
|
* @public
|
|
1097
1102
|
*/
|
|
1098
1103
|
ungraceful?: GlobalAuroraUngraceful | undefined;
|
|
@@ -1384,6 +1389,95 @@ export interface Route53HealthCheckConfiguration {
|
|
|
1384
1389
|
*/
|
|
1385
1390
|
recordSets?: Route53ResourceRecordSet[] | undefined;
|
|
1386
1391
|
}
|
|
1392
|
+
/**
|
|
1393
|
+
* <p>A single <code>SendCommand</code> target filter, consisting of a target key and the values matched by that key.</p>
|
|
1394
|
+
* @public
|
|
1395
|
+
*/
|
|
1396
|
+
export interface SsmTarget {
|
|
1397
|
+
/**
|
|
1398
|
+
* <p>The target key, such as <code>tag:Environment</code> or <code>InstanceIds</code>.</p>
|
|
1399
|
+
* @public
|
|
1400
|
+
*/
|
|
1401
|
+
key: string | undefined;
|
|
1402
|
+
/**
|
|
1403
|
+
* <p>The values matched by this target key. Multiple values combine with a logical OR.</p>
|
|
1404
|
+
* @public
|
|
1405
|
+
*/
|
|
1406
|
+
values: string[] | undefined;
|
|
1407
|
+
}
|
|
1408
|
+
/**
|
|
1409
|
+
* <p>The Systems Manager document to run and the managed nodes to target for a single Amazon Web Services Region.</p>
|
|
1410
|
+
* @public
|
|
1411
|
+
*/
|
|
1412
|
+
export interface SsmDocumentConfig {
|
|
1413
|
+
/**
|
|
1414
|
+
* <p>The cross-account role for the configuration.</p>
|
|
1415
|
+
* @public
|
|
1416
|
+
*/
|
|
1417
|
+
crossAccountRole?: string | undefined;
|
|
1418
|
+
/**
|
|
1419
|
+
* <p>The external ID (secret key) for the configuration.</p>
|
|
1420
|
+
* @public
|
|
1421
|
+
*/
|
|
1422
|
+
externalId?: string | undefined;
|
|
1423
|
+
/**
|
|
1424
|
+
* <p>The Amazon Resource Name (ARN) of the Systems Manager document to run.</p>
|
|
1425
|
+
* @public
|
|
1426
|
+
*/
|
|
1427
|
+
documentArn: string | undefined;
|
|
1428
|
+
/**
|
|
1429
|
+
* <p>The target filters that Systems Manager resolves to managed nodes when the command runs. To target specific managed nodes, use the <code>InstanceIds</code> key. You can specify up to five target filters.</p>
|
|
1430
|
+
* @public
|
|
1431
|
+
*/
|
|
1432
|
+
targets: SsmTarget[] | undefined;
|
|
1433
|
+
/**
|
|
1434
|
+
* <p>The parameters that are passed to this Region's Systems Manager document. You set parameters for each document, so each Region can run its document with its own parameters.</p>
|
|
1435
|
+
* @public
|
|
1436
|
+
*/
|
|
1437
|
+
parameters?: Record<string, string[]> | undefined;
|
|
1438
|
+
/**
|
|
1439
|
+
* <p>The version of the Systems Manager document to run for this Region. When you omit it, Systems Manager runs the document's default version.</p>
|
|
1440
|
+
* @public
|
|
1441
|
+
*/
|
|
1442
|
+
documentVersion?: string | undefined;
|
|
1443
|
+
}
|
|
1444
|
+
/**
|
|
1445
|
+
* <p>The ungraceful execution settings for an AWS Systems Manager <code>SendCommand</code> execution block.</p>
|
|
1446
|
+
* @public
|
|
1447
|
+
*/
|
|
1448
|
+
export interface SsmSendCommandUngraceful {
|
|
1449
|
+
/**
|
|
1450
|
+
* <p>Specifies whether to skip running this command during an ungraceful execution. Set to <code>skip</code> to skip the command.</p>
|
|
1451
|
+
* @public
|
|
1452
|
+
*/
|
|
1453
|
+
behavior?: SsmSendCommandUngracefulBehavior | undefined;
|
|
1454
|
+
}
|
|
1455
|
+
/**
|
|
1456
|
+
* <p>Configuration for an AWS Systems Manager <code>SendCommand</code> execution block in a Region switch plan. This execution block runs a Systems Manager document on the managed nodes that you target in each Amazon Web Services Region of the plan.</p>
|
|
1457
|
+
* @public
|
|
1458
|
+
*/
|
|
1459
|
+
export interface SsmSendCommandConfiguration {
|
|
1460
|
+
/**
|
|
1461
|
+
* <p>The timeout value specified for the configuration.</p>
|
|
1462
|
+
* @public
|
|
1463
|
+
*/
|
|
1464
|
+
timeoutMinutes?: number | undefined;
|
|
1465
|
+
/**
|
|
1466
|
+
* <p>The Systems Manager document and target configuration for each Amazon Web Services Region in the plan. Provide an entry for each Amazon Web Services Region that you want the command to run in.</p>
|
|
1467
|
+
* @public
|
|
1468
|
+
*/
|
|
1469
|
+
regionDocuments: Record<string, SsmDocumentConfig> | undefined;
|
|
1470
|
+
/**
|
|
1471
|
+
* <p>How often, in minutes, Region switch retries the command if it returns a failure.</p>
|
|
1472
|
+
* @public
|
|
1473
|
+
*/
|
|
1474
|
+
retryIntervalMinutes: number | undefined;
|
|
1475
|
+
/**
|
|
1476
|
+
* <p>Specifies the settings that determine how the execution block behaves when the plan runs ungracefully, such as whether to skip the command.</p>
|
|
1477
|
+
* @public
|
|
1478
|
+
*/
|
|
1479
|
+
ungraceful?: SsmSendCommandUngraceful | undefined;
|
|
1480
|
+
}
|
|
1387
1481
|
/**
|
|
1388
1482
|
* <p>Represents the state of a step in a plan execution.</p>
|
|
1389
1483
|
* @public
|
|
@@ -2072,7 +2166,7 @@ export interface UpdatePlanExecutionStepResponse {
|
|
|
2072
2166
|
* <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>
|
|
2073
2167
|
* @public
|
|
2074
2168
|
*/
|
|
2075
|
-
export type ExecutionBlockConfiguration = ExecutionBlockConfiguration.ArcRoutingControlConfigMember | ExecutionBlockConfiguration.AuroraProvisionedScalingConfigMember | ExecutionBlockConfiguration.AuroraServerlessScalingConfigMember | ExecutionBlockConfiguration.CustomActionLambdaConfigMember | ExecutionBlockConfiguration.DocumentDbConfigMember | ExecutionBlockConfiguration.Ec2AsgCapacityIncreaseConfigMember | ExecutionBlockConfiguration.EcsCapacityIncreaseConfigMember | ExecutionBlockConfiguration.EksResourceScalingConfigMember | ExecutionBlockConfiguration.ExecutionApprovalConfigMember | ExecutionBlockConfiguration.GlobalAuroraConfigMember | ExecutionBlockConfiguration.LambdaEventSourceMappingConfigMember | ExecutionBlockConfiguration.NeptuneGlobalDatabaseConfigMember | ExecutionBlockConfiguration.ParallelConfigMember | ExecutionBlockConfiguration.RdsCreateCrossRegionReadReplicaConfigMember | ExecutionBlockConfiguration.RdsPromoteReadReplicaConfigMember | ExecutionBlockConfiguration.RdsSwitchoverReadReplicaConfigMember | ExecutionBlockConfiguration.RegionSwitchPlanConfigMember | ExecutionBlockConfiguration.Route53HealthCheckConfigMember | ExecutionBlockConfiguration.$UnknownMember;
|
|
2169
|
+
export type ExecutionBlockConfiguration = ExecutionBlockConfiguration.ArcRoutingControlConfigMember | ExecutionBlockConfiguration.AuroraProvisionedScalingConfigMember | ExecutionBlockConfiguration.AuroraServerlessScalingConfigMember | ExecutionBlockConfiguration.CustomActionLambdaConfigMember | ExecutionBlockConfiguration.DocumentDbConfigMember | ExecutionBlockConfiguration.Ec2AsgCapacityIncreaseConfigMember | ExecutionBlockConfiguration.EcsCapacityIncreaseConfigMember | ExecutionBlockConfiguration.EksResourceScalingConfigMember | ExecutionBlockConfiguration.ExecutionApprovalConfigMember | ExecutionBlockConfiguration.GlobalAuroraConfigMember | ExecutionBlockConfiguration.LambdaEventSourceMappingConfigMember | ExecutionBlockConfiguration.NeptuneGlobalDatabaseConfigMember | ExecutionBlockConfiguration.ParallelConfigMember | ExecutionBlockConfiguration.RdsCreateCrossRegionReadReplicaConfigMember | ExecutionBlockConfiguration.RdsPromoteReadReplicaConfigMember | ExecutionBlockConfiguration.RdsSwitchoverReadReplicaConfigMember | ExecutionBlockConfiguration.RegionSwitchPlanConfigMember | ExecutionBlockConfiguration.Route53HealthCheckConfigMember | ExecutionBlockConfiguration.SsmSendCommandConfigMember | ExecutionBlockConfiguration.$UnknownMember;
|
|
2076
2170
|
/**
|
|
2077
2171
|
* @public
|
|
2078
2172
|
*/
|
|
@@ -2100,6 +2194,7 @@ export declare namespace ExecutionBlockConfiguration {
|
|
|
2100
2194
|
auroraProvisionedScalingConfig?: never;
|
|
2101
2195
|
neptuneGlobalDatabaseConfig?: never;
|
|
2102
2196
|
rdsSwitchoverReadReplicaConfig?: never;
|
|
2197
|
+
ssmSendCommandConfig?: never;
|
|
2103
2198
|
$unknown?: never;
|
|
2104
2199
|
}
|
|
2105
2200
|
/**
|
|
@@ -2125,6 +2220,7 @@ export declare namespace ExecutionBlockConfiguration {
|
|
|
2125
2220
|
auroraProvisionedScalingConfig?: never;
|
|
2126
2221
|
neptuneGlobalDatabaseConfig?: never;
|
|
2127
2222
|
rdsSwitchoverReadReplicaConfig?: never;
|
|
2223
|
+
ssmSendCommandConfig?: never;
|
|
2128
2224
|
$unknown?: never;
|
|
2129
2225
|
}
|
|
2130
2226
|
/**
|
|
@@ -2150,6 +2246,7 @@ export declare namespace ExecutionBlockConfiguration {
|
|
|
2150
2246
|
auroraProvisionedScalingConfig?: never;
|
|
2151
2247
|
neptuneGlobalDatabaseConfig?: never;
|
|
2152
2248
|
rdsSwitchoverReadReplicaConfig?: never;
|
|
2249
|
+
ssmSendCommandConfig?: never;
|
|
2153
2250
|
$unknown?: never;
|
|
2154
2251
|
}
|
|
2155
2252
|
/**
|
|
@@ -2175,6 +2272,7 @@ export declare namespace ExecutionBlockConfiguration {
|
|
|
2175
2272
|
auroraProvisionedScalingConfig?: never;
|
|
2176
2273
|
neptuneGlobalDatabaseConfig?: never;
|
|
2177
2274
|
rdsSwitchoverReadReplicaConfig?: never;
|
|
2275
|
+
ssmSendCommandConfig?: never;
|
|
2178
2276
|
$unknown?: never;
|
|
2179
2277
|
}
|
|
2180
2278
|
/**
|
|
@@ -2200,6 +2298,7 @@ export declare namespace ExecutionBlockConfiguration {
|
|
|
2200
2298
|
auroraProvisionedScalingConfig?: never;
|
|
2201
2299
|
neptuneGlobalDatabaseConfig?: never;
|
|
2202
2300
|
rdsSwitchoverReadReplicaConfig?: never;
|
|
2301
|
+
ssmSendCommandConfig?: never;
|
|
2203
2302
|
$unknown?: never;
|
|
2204
2303
|
}
|
|
2205
2304
|
/**
|
|
@@ -2225,6 +2324,7 @@ export declare namespace ExecutionBlockConfiguration {
|
|
|
2225
2324
|
auroraProvisionedScalingConfig?: never;
|
|
2226
2325
|
neptuneGlobalDatabaseConfig?: never;
|
|
2227
2326
|
rdsSwitchoverReadReplicaConfig?: never;
|
|
2327
|
+
ssmSendCommandConfig?: never;
|
|
2228
2328
|
$unknown?: never;
|
|
2229
2329
|
}
|
|
2230
2330
|
/**
|
|
@@ -2250,6 +2350,7 @@ export declare namespace ExecutionBlockConfiguration {
|
|
|
2250
2350
|
auroraProvisionedScalingConfig?: never;
|
|
2251
2351
|
neptuneGlobalDatabaseConfig?: never;
|
|
2252
2352
|
rdsSwitchoverReadReplicaConfig?: never;
|
|
2353
|
+
ssmSendCommandConfig?: never;
|
|
2253
2354
|
$unknown?: never;
|
|
2254
2355
|
}
|
|
2255
2356
|
/**
|
|
@@ -2275,6 +2376,7 @@ export declare namespace ExecutionBlockConfiguration {
|
|
|
2275
2376
|
auroraProvisionedScalingConfig?: never;
|
|
2276
2377
|
neptuneGlobalDatabaseConfig?: never;
|
|
2277
2378
|
rdsSwitchoverReadReplicaConfig?: never;
|
|
2379
|
+
ssmSendCommandConfig?: never;
|
|
2278
2380
|
$unknown?: never;
|
|
2279
2381
|
}
|
|
2280
2382
|
/**
|
|
@@ -2300,6 +2402,7 @@ export declare namespace ExecutionBlockConfiguration {
|
|
|
2300
2402
|
auroraProvisionedScalingConfig?: never;
|
|
2301
2403
|
neptuneGlobalDatabaseConfig?: never;
|
|
2302
2404
|
rdsSwitchoverReadReplicaConfig?: never;
|
|
2405
|
+
ssmSendCommandConfig?: never;
|
|
2303
2406
|
$unknown?: never;
|
|
2304
2407
|
}
|
|
2305
2408
|
/**
|
|
@@ -2325,6 +2428,7 @@ export declare namespace ExecutionBlockConfiguration {
|
|
|
2325
2428
|
auroraProvisionedScalingConfig?: never;
|
|
2326
2429
|
neptuneGlobalDatabaseConfig?: never;
|
|
2327
2430
|
rdsSwitchoverReadReplicaConfig?: never;
|
|
2431
|
+
ssmSendCommandConfig?: never;
|
|
2328
2432
|
$unknown?: never;
|
|
2329
2433
|
}
|
|
2330
2434
|
/**
|
|
@@ -2350,6 +2454,7 @@ export declare namespace ExecutionBlockConfiguration {
|
|
|
2350
2454
|
auroraProvisionedScalingConfig?: never;
|
|
2351
2455
|
neptuneGlobalDatabaseConfig?: never;
|
|
2352
2456
|
rdsSwitchoverReadReplicaConfig?: never;
|
|
2457
|
+
ssmSendCommandConfig?: never;
|
|
2353
2458
|
$unknown?: never;
|
|
2354
2459
|
}
|
|
2355
2460
|
/**
|
|
@@ -2375,6 +2480,7 @@ export declare namespace ExecutionBlockConfiguration {
|
|
|
2375
2480
|
auroraProvisionedScalingConfig?: never;
|
|
2376
2481
|
neptuneGlobalDatabaseConfig?: never;
|
|
2377
2482
|
rdsSwitchoverReadReplicaConfig?: never;
|
|
2483
|
+
ssmSendCommandConfig?: never;
|
|
2378
2484
|
$unknown?: never;
|
|
2379
2485
|
}
|
|
2380
2486
|
/**
|
|
@@ -2400,6 +2506,7 @@ export declare namespace ExecutionBlockConfiguration {
|
|
|
2400
2506
|
auroraProvisionedScalingConfig?: never;
|
|
2401
2507
|
neptuneGlobalDatabaseConfig?: never;
|
|
2402
2508
|
rdsSwitchoverReadReplicaConfig?: never;
|
|
2509
|
+
ssmSendCommandConfig?: never;
|
|
2403
2510
|
$unknown?: never;
|
|
2404
2511
|
}
|
|
2405
2512
|
/**
|
|
@@ -2425,6 +2532,7 @@ export declare namespace ExecutionBlockConfiguration {
|
|
|
2425
2532
|
auroraProvisionedScalingConfig?: never;
|
|
2426
2533
|
neptuneGlobalDatabaseConfig?: never;
|
|
2427
2534
|
rdsSwitchoverReadReplicaConfig?: never;
|
|
2535
|
+
ssmSendCommandConfig?: never;
|
|
2428
2536
|
$unknown?: never;
|
|
2429
2537
|
}
|
|
2430
2538
|
/**
|
|
@@ -2450,6 +2558,7 @@ export declare namespace ExecutionBlockConfiguration {
|
|
|
2450
2558
|
auroraProvisionedScalingConfig?: never;
|
|
2451
2559
|
neptuneGlobalDatabaseConfig?: never;
|
|
2452
2560
|
rdsSwitchoverReadReplicaConfig?: never;
|
|
2561
|
+
ssmSendCommandConfig?: never;
|
|
2453
2562
|
$unknown?: never;
|
|
2454
2563
|
}
|
|
2455
2564
|
/**
|
|
@@ -2475,6 +2584,7 @@ export declare namespace ExecutionBlockConfiguration {
|
|
|
2475
2584
|
auroraProvisionedScalingConfig: AuroraProvisionedScalingConfiguration;
|
|
2476
2585
|
neptuneGlobalDatabaseConfig?: never;
|
|
2477
2586
|
rdsSwitchoverReadReplicaConfig?: never;
|
|
2587
|
+
ssmSendCommandConfig?: never;
|
|
2478
2588
|
$unknown?: never;
|
|
2479
2589
|
}
|
|
2480
2590
|
/**
|
|
@@ -2500,6 +2610,7 @@ export declare namespace ExecutionBlockConfiguration {
|
|
|
2500
2610
|
auroraProvisionedScalingConfig?: never;
|
|
2501
2611
|
neptuneGlobalDatabaseConfig: NeptuneGlobalDatabaseConfiguration;
|
|
2502
2612
|
rdsSwitchoverReadReplicaConfig?: never;
|
|
2613
|
+
ssmSendCommandConfig?: never;
|
|
2503
2614
|
$unknown?: never;
|
|
2504
2615
|
}
|
|
2505
2616
|
/**
|
|
@@ -2525,6 +2636,33 @@ export declare namespace ExecutionBlockConfiguration {
|
|
|
2525
2636
|
auroraProvisionedScalingConfig?: never;
|
|
2526
2637
|
neptuneGlobalDatabaseConfig?: never;
|
|
2527
2638
|
rdsSwitchoverReadReplicaConfig: RdsSwitchoverReadReplicaConfiguration;
|
|
2639
|
+
ssmSendCommandConfig?: never;
|
|
2640
|
+
$unknown?: never;
|
|
2641
|
+
}
|
|
2642
|
+
/**
|
|
2643
|
+
* <p>Specifies an AWS Systems Manager <code>SendCommand</code> execution block.</p>
|
|
2644
|
+
* @public
|
|
2645
|
+
*/
|
|
2646
|
+
interface SsmSendCommandConfigMember {
|
|
2647
|
+
customActionLambdaConfig?: never;
|
|
2648
|
+
ec2AsgCapacityIncreaseConfig?: never;
|
|
2649
|
+
executionApprovalConfig?: never;
|
|
2650
|
+
arcRoutingControlConfig?: never;
|
|
2651
|
+
globalAuroraConfig?: never;
|
|
2652
|
+
parallelConfig?: never;
|
|
2653
|
+
regionSwitchPlanConfig?: never;
|
|
2654
|
+
ecsCapacityIncreaseConfig?: never;
|
|
2655
|
+
eksResourceScalingConfig?: never;
|
|
2656
|
+
route53HealthCheckConfig?: never;
|
|
2657
|
+
documentDbConfig?: never;
|
|
2658
|
+
rdsPromoteReadReplicaConfig?: never;
|
|
2659
|
+
rdsCreateCrossRegionReadReplicaConfig?: never;
|
|
2660
|
+
lambdaEventSourceMappingConfig?: never;
|
|
2661
|
+
auroraServerlessScalingConfig?: never;
|
|
2662
|
+
auroraProvisionedScalingConfig?: never;
|
|
2663
|
+
neptuneGlobalDatabaseConfig?: never;
|
|
2664
|
+
rdsSwitchoverReadReplicaConfig?: never;
|
|
2665
|
+
ssmSendCommandConfig: SsmSendCommandConfiguration;
|
|
2528
2666
|
$unknown?: never;
|
|
2529
2667
|
}
|
|
2530
2668
|
/**
|
|
@@ -2549,6 +2687,7 @@ export declare namespace ExecutionBlockConfiguration {
|
|
|
2549
2687
|
auroraProvisionedScalingConfig?: never;
|
|
2550
2688
|
neptuneGlobalDatabaseConfig?: never;
|
|
2551
2689
|
rdsSwitchoverReadReplicaConfig?: never;
|
|
2690
|
+
ssmSendCommandConfig?: never;
|
|
2552
2691
|
$unknown: [string, any];
|
|
2553
2692
|
}
|
|
2554
2693
|
/**
|
|
@@ -2574,6 +2713,7 @@ export declare namespace ExecutionBlockConfiguration {
|
|
|
2574
2713
|
auroraProvisionedScalingConfig: (value: AuroraProvisionedScalingConfiguration) => T;
|
|
2575
2714
|
neptuneGlobalDatabaseConfig: (value: NeptuneGlobalDatabaseConfiguration) => T;
|
|
2576
2715
|
rdsSwitchoverReadReplicaConfig: (value: RdsSwitchoverReadReplicaConfiguration) => T;
|
|
2716
|
+
ssmSendCommandConfig: (value: SsmSendCommandConfiguration) => T;
|
|
2577
2717
|
_: (name: string, value: any) => T;
|
|
2578
2718
|
}
|
|
2579
2719
|
}
|
|
@@ -95,6 +95,10 @@ export declare var S3ReportOutput$: StaticStructureSchema;
|
|
|
95
95
|
export declare var S3ReportOutputConfiguration$: StaticStructureSchema;
|
|
96
96
|
export declare var Service$: StaticStructureSchema;
|
|
97
97
|
export declare var ServiceQuotaWarningSummary$: StaticStructureSchema;
|
|
98
|
+
export declare var SsmDocumentConfig$: StaticStructureSchema;
|
|
99
|
+
export declare var SsmSendCommandConfiguration$: StaticStructureSchema;
|
|
100
|
+
export declare var SsmSendCommandUngraceful$: StaticStructureSchema;
|
|
101
|
+
export declare var SsmTarget$: StaticStructureSchema;
|
|
98
102
|
export declare var StartPlanExecutionRequest$: StaticStructureSchema;
|
|
99
103
|
export declare var StartPlanExecutionResponse$: StaticStructureSchema;
|
|
100
104
|
export declare var Step$: StaticStructureSchema;
|
|
@@ -159,6 +159,11 @@ export declare const RdsUngracefulBehavior: {
|
|
|
159
159
|
};
|
|
160
160
|
export type RdsUngracefulBehavior =
|
|
161
161
|
(typeof RdsUngracefulBehavior)[keyof typeof RdsUngracefulBehavior];
|
|
162
|
+
export declare const SsmSendCommandUngracefulBehavior: {
|
|
163
|
+
readonly SKIP: "skip";
|
|
164
|
+
};
|
|
165
|
+
export type SsmSendCommandUngracefulBehavior =
|
|
166
|
+
(typeof SsmSendCommandUngracefulBehavior)[keyof typeof SsmSendCommandUngracefulBehavior];
|
|
162
167
|
export declare const ExecutionBlockType: {
|
|
163
168
|
readonly AURORA: "AuroraGlobalDatabase";
|
|
164
169
|
readonly AURORA_PROVISIONED_SCALING: "AuroraProvisionedScaling";
|
|
@@ -178,6 +183,7 @@ export declare const ExecutionBlockType: {
|
|
|
178
183
|
readonly REGION_SWITCH: "ARCRegionSwitchPlan";
|
|
179
184
|
readonly ROUTE53_HEALTH_CHECK: "Route53HealthCheck";
|
|
180
185
|
readonly ROUTING_CONTROL: "ARCRoutingControl";
|
|
186
|
+
readonly SSM_SEND_COMMAND: "SSMSendCommand";
|
|
181
187
|
};
|
|
182
188
|
export type ExecutionBlockType = (typeof ExecutionBlockType)[keyof typeof ExecutionBlockType];
|
|
183
189
|
export declare const StepStatus: {
|