@aws-sdk/client-arc-region-switch 3.955.0 → 3.957.0

package/dist-types/models/models_0.d.ts

@@ -1,4 +1,4 @@
-import { AlarmCondition, AlarmType, Approval, Ec2AsgCapacityMonitoringApproach, EcsCapacityMonitoringApproach, EksCapacityMonitoringApproach, EvaluationStatus, ExecutionAction, ExecutionBlockType, ExecutionEventType, ExecutionMode, ExecutionState, GlobalAuroraDefaultBehavior, GlobalAuroraUngracefulBehavior, LambdaUngracefulBehavior, RecoveryApproach, RegionToRunIn, ResourceWarningStatus, Route53HealthCheckStatus, RoutingControlStateChange, StepStatus, UpdatePlanExecutionAction, UpdatePlanExecutionStepAction, WorkflowTargetAction } from "./enums";
+import { AlarmCondition, AlarmType, Approval, DocumentDbDefaultBehavior, DocumentDbUngracefulBehavior, Ec2AsgCapacityMonitoringApproach, EcsCapacityMonitoringApproach, EksCapacityMonitoringApproach, EvaluationStatus, ExecutionAction, ExecutionBlockType, ExecutionEventType, ExecutionMode, ExecutionState, FailedReportErrorCode, GlobalAuroraDefaultBehavior, GlobalAuroraUngracefulBehavior, LambdaUngracefulBehavior, RecoveryApproach, RegionToRunIn, ResourceWarningStatus, Route53HealthCheckStatus, RoutingControlStateChange, StepStatus, UpdatePlanExecutionAction, UpdatePlanExecutionStepAction, WorkflowTargetAction } from "./enums";
 /**
  * <p>A summarized representation of a plan execution. This structure contains key information about an execution without all the detailed step data.</p>
  * @public
@@ -333,6 +333,94 @@ export interface GetPlanExecutionRequest {
      */
     nextToken?: string | undefined;
 }
+/**
+ * <p>Information about a report generation that failed.</p>
+ * @public
+ */
+export interface FailedReportOutput {
+    /**
+     * <p>The error code for the failed report generation.</p>
+     * @public
+     */
+    errorCode?: FailedReportErrorCode | undefined;
+    /**
+     * <p>The error message for the failed report generation.</p>
+     * @public
+     */
+    errorMessage?: string | undefined;
+}
+/**
+ * <p>Information about a report delivered to Amazon S3.</p>
+ * @public
+ */
+export interface S3ReportOutput {
+    /**
+     * <p>The S3 object key where the generated report is stored.</p>
+     * @public
+     */
+    s3ObjectKey?: string | undefined;
+}
+/**
+ * <p>The output location or cause of a failure in report generation.</p>
+ * @public
+ */
+export type ReportOutput = ReportOutput.FailedReportOutputMember | ReportOutput.S3ReportOutputMember | ReportOutput.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ReportOutput {
+    /**
+     * <p>Information about a report delivered to Amazon S3.</p>
+     * @public
+     */
+    interface S3ReportOutputMember {
+        s3ReportOutput: S3ReportOutput;
+        failedReportOutput?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The details about a failed report generation.</p>
+     * @public
+     */
+    interface FailedReportOutputMember {
+        s3ReportOutput?: never;
+        failedReportOutput: FailedReportOutput;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        s3ReportOutput?: never;
+        failedReportOutput?: never;
+        $unknown: [string, any];
+    }
+    /**
+     * @deprecated unused in schema-serde mode.
+     *
+     */
+    interface Visitor<T> {
+        s3ReportOutput: (value: S3ReportOutput) => T;
+        failedReportOutput: (value: FailedReportOutput) => T;
+        _: (name: string, value: any) => T;
+    }
+}
+/**
+ * <p>Information about a generated execution report.</p>
+ * @public
+ */
+export interface GeneratedReport {
+    /**
+     * <p>The timestamp when the report was generated.</p>
+     * @public
+     */
+    reportGenerationTime?: Date | undefined;
+    /**
+     * <p>The output location or cause of a failure in report generation.</p>
+     * @public
+     */
+    reportOutput?: ReportOutput | undefined;
+}
 /**
  * <p>An Amazon CloudWatch alarm associated with a Region switch plan. These alarms can be used to trigger automatic execution of the plan.</p>
  * @public
@@ -359,6 +447,66 @@ export interface AssociatedAlarm {
      */
     alarmType: AlarmType | undefined;
 }
+/**
+ * <p>Configuration for delivering generated reports to an Amazon S3 bucket.</p>
+ * @public
+ */
+export interface S3ReportOutputConfiguration {
+    /**
+     * <p>The S3 bucket name and optional prefix where reports are stored. Format: bucket-name or bucket-name/prefix.</p>
+     * @public
+     */
+    bucketPath?: string | undefined;
+    /**
+     * <p>The Amazon Web Services account ID that owns the S3 bucket. Required to ensure the bucket is still owned by the same expected owner at generation time.</p>
+     * @public
+     */
+    bucketOwner?: string | undefined;
+}
+/**
+ * <p>Configuration for report output destinations used in a Region switch plan.</p>
+ * @public
+ */
+export type ReportOutputConfiguration = ReportOutputConfiguration.S3ConfigurationMember | ReportOutputConfiguration.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ReportOutputConfiguration {
+    /**
+     * <p>Configuration for delivering reports to an Amazon S3 bucket.</p>
+     * @public
+     */
+    interface S3ConfigurationMember {
+        s3Configuration: S3ReportOutputConfiguration;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        s3Configuration?: never;
+        $unknown: [string, any];
+    }
+    /**
+     * @deprecated unused in schema-serde mode.
+     *
+     */
+    interface Visitor<T> {
+        s3Configuration: (value: S3ReportOutputConfiguration) => T;
+        _: (name: string, value: any) => T;
+    }
+}
+/**
+ * <p>Configuration for automatic report generation for plan executions. When configured, Region switch automatically generates a report after each plan execution that includes execution events, plan configuration, and CloudWatch alarm states.</p>
+ * @public
+ */
+export interface ReportConfiguration {
+    /**
+     * <p>The output configuration for the report.</p>
+     * @public
+     */
+    reportOutput?: ReportOutputConfiguration[] | undefined;
+}
 /**
  * <p>Defines a condition that must be met for a trigger to fire.</p>
  * @public
@@ -511,6 +659,58 @@ export interface CustomActionLambdaConfiguration {
      */
     ungraceful?: LambdaUngraceful | undefined;
 }
+/**
+ * <p>Configuration for handling failures when performing operations on DocumentDB global clusters.</p>
+ * @public
+ */
+export interface DocumentDbUngraceful {
+    /**
+     * <p>The settings for ungraceful execution.</p>
+     * @public
+     */
+    ungraceful?: DocumentDbUngracefulBehavior | undefined;
+}
+/**
+ * <p>Configuration for Amazon DocumentDB global clusters used in a Region switch plan.</p>
+ * @public
+ */
+export interface DocumentDbConfiguration {
+    /**
+     * <p>The timeout value specified for the configuration.</p>
+     * @public
+     */
+    timeoutMinutes?: number | undefined;
+    /**
+     * <p>The cross account role for the configuration.</p>
+     * @public
+     */
+    crossAccountRole?: string | undefined;
+    /**
+     * <p>The external ID (secret key) for the configuration.</p>
+     * @public
+     */
+    externalId?: string | undefined;
+    /**
+     * <p>The behavior for a global cluster, that is, only allow switchover or also allow failover.</p>
+     * @public
+     */
+    behavior: DocumentDbDefaultBehavior | undefined;
+    /**
+     * <p>The settings for ungraceful execution.</p>
+     * @public
+     */
+    ungraceful?: DocumentDbUngraceful | undefined;
+    /**
+     * <p>The global cluster identifier for a DocumentDB global cluster.</p>
+     * @public
+     */
+    globalClusterIdentifier: string | undefined;
+    /**
+     * <p>The database cluster Amazon Resource Names (ARNs) for a DocumentDB global cluster.</p>
+     * @public
+     */
+    databaseClusterArns: string[] | undefined;
+}
 /**
  * <p>Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.</p>
  * @public
@@ -1470,7 +1670,7 @@ export interface UpdatePlanExecutionStepResponse {
  * <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>
  * @public
  */
-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;
+export type ExecutionBlockConfiguration = ExecutionBlockConfiguration.ArcRoutingControlConfigMember | ExecutionBlockConfiguration.CustomActionLambdaConfigMember | ExecutionBlockConfiguration.DocumentDbConfigMember | ExecutionBlockConfiguration.Ec2AsgCapacityIncreaseConfigMember | ExecutionBlockConfiguration.EcsCapacityIncreaseConfigMember | ExecutionBlockConfiguration.EksResourceScalingConfigMember | ExecutionBlockConfiguration.ExecutionApprovalConfigMember | ExecutionBlockConfiguration.GlobalAuroraConfigMember | ExecutionBlockConfiguration.ParallelConfigMember | ExecutionBlockConfiguration.RegionSwitchPlanConfigMember | ExecutionBlockConfiguration.Route53HealthCheckConfigMember | ExecutionBlockConfiguration.$UnknownMember;
 /**
  * @public
  */
@@ -1490,6 +1690,7 @@ export declare namespace ExecutionBlockConfiguration {
         ecsCapacityIncreaseConfig?: never;
         eksResourceScalingConfig?: never;
         route53HealthCheckConfig?: never;
+        documentDbConfig?: never;
         $unknown?: never;
     }
     /**
@@ -1507,6 +1708,7 @@ export declare namespace ExecutionBlockConfiguration {
         ecsCapacityIncreaseConfig?: never;
         eksResourceScalingConfig?: never;
         route53HealthCheckConfig?: never;
+        documentDbConfig?: never;
         $unknown?: never;
     }
     /**
@@ -1524,6 +1726,7 @@ export declare namespace ExecutionBlockConfiguration {
         ecsCapacityIncreaseConfig?: never;
         eksResourceScalingConfig?: never;
         route53HealthCheckConfig?: never;
+        documentDbConfig?: never;
         $unknown?: never;
     }
     /**
@@ -1541,6 +1744,7 @@ export declare namespace ExecutionBlockConfiguration {
         ecsCapacityIncreaseConfig?: never;
         eksResourceScalingConfig?: never;
         route53HealthCheckConfig?: never;
+        documentDbConfig?: never;
         $unknown?: never;
     }
     /**
@@ -1558,6 +1762,7 @@ export declare namespace ExecutionBlockConfiguration {
         ecsCapacityIncreaseConfig?: never;
         eksResourceScalingConfig?: never;
         route53HealthCheckConfig?: never;
+        documentDbConfig?: never;
         $unknown?: never;
     }
     /**
@@ -1575,6 +1780,7 @@ export declare namespace ExecutionBlockConfiguration {
         ecsCapacityIncreaseConfig?: never;
         eksResourceScalingConfig?: never;
         route53HealthCheckConfig?: never;
+        documentDbConfig?: never;
         $unknown?: never;
     }
     /**
@@ -1592,6 +1798,7 @@ export declare namespace ExecutionBlockConfiguration {
         ecsCapacityIncreaseConfig?: never;
         eksResourceScalingConfig?: never;
         route53HealthCheckConfig?: never;
+        documentDbConfig?: never;
         $unknown?: never;
     }
     /**
@@ -1609,6 +1816,7 @@ export declare namespace ExecutionBlockConfiguration {
         ecsCapacityIncreaseConfig: EcsCapacityIncreaseConfiguration;
         eksResourceScalingConfig?: never;
         route53HealthCheckConfig?: never;
+        documentDbConfig?: never;
         $unknown?: never;
     }
     /**
@@ -1626,6 +1834,7 @@ export declare namespace ExecutionBlockConfiguration {
         ecsCapacityIncreaseConfig?: never;
         eksResourceScalingConfig: EksResourceScalingConfiguration;
         route53HealthCheckConfig?: never;
+        documentDbConfig?: never;
         $unknown?: never;
     }
     /**
@@ -1643,6 +1852,25 @@ export declare namespace ExecutionBlockConfiguration {
         ecsCapacityIncreaseConfig?: never;
         eksResourceScalingConfig?: never;
         route53HealthCheckConfig: Route53HealthCheckConfiguration;
+        documentDbConfig?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Configuration for Amazon DocumentDB global clusters used in a Region switch plan.</p>
+     * @public
+     */
+    interface DocumentDbConfigMember {
+        customActionLambdaConfig?: never;
+        ec2AsgCapacityIncreaseConfig?: never;
+        executionApprovalConfig?: never;
+        arcRoutingControlConfig?: never;
+        globalAuroraConfig?: never;
+        parallelConfig?: never;
+        regionSwitchPlanConfig?: never;
+        ecsCapacityIncreaseConfig?: never;
+        eksResourceScalingConfig?: never;
+        route53HealthCheckConfig?: never;
+        documentDbConfig: DocumentDbConfiguration;
         $unknown?: never;
     }
     /**
@@ -1659,6 +1887,7 @@ export declare namespace ExecutionBlockConfiguration {
         ecsCapacityIncreaseConfig?: never;
         eksResourceScalingConfig?: never;
         route53HealthCheckConfig?: never;
+        documentDbConfig?: never;
         $unknown: [string, any];
     }
     /**
@@ -1676,6 +1905,7 @@ export declare namespace ExecutionBlockConfiguration {
         ecsCapacityIncreaseConfig: (value: EcsCapacityIncreaseConfiguration) => T;
         eksResourceScalingConfig: (value: EksResourceScalingConfiguration) => T;
         route53HealthCheckConfig: (value: Route53HealthCheckConfiguration) => T;
+        documentDbConfig: (value: DocumentDbConfiguration) => T;
         _: (name: string, value: any) => T;
     }
 }
@@ -1776,6 +2006,11 @@ export interface CreatePlanRequest {
      * @public
      */
     triggers?: Trigger[] | undefined;
+    /**
+     * <p>Configuration for automatic report generation for plan executions. When configured, Region switch automatically generates a report after each plan execution that includes execution events, plan configuration, and CloudWatch alarm states.</p>
+     * @public
+     */
+    reportConfiguration?: ReportConfiguration | undefined;
     /**
      * <p>The name of a Region switch plan.</p>
      * @public
@@ -1842,6 +2077,11 @@ export interface Plan {
      * @public
      */
     triggers?: Trigger[] | undefined;
+    /**
+     * <p>The report configuration for a plan.</p>
+     * @public
+     */
+    reportConfiguration?: ReportConfiguration | undefined;
     /**
      * <p>The name for a plan.</p>
      * @public
@@ -1917,6 +2157,11 @@ export interface UpdatePlanRequest {
      * @public
      */
     triggers?: Trigger[] | undefined;
+    /**
+     * <p>The updated report configuration for the plan.</p>
+     * @public
+     */
+    reportConfiguration?: ReportConfiguration | undefined;
 }
 /**
  * @public
@@ -2002,6 +2247,11 @@ export interface GetPlanExecutionResponse {
      * @public
      */
     actualRecoveryTime?: string | undefined;
+    /**
+     * <p>Information about the location of a generated report, or the cause of its failure.</p>
+     * @public
+     */
+    generatedReportDetails?: GeneratedReport[] | undefined;
     /**
      * <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>
      * @public

package/dist-types/schemas/schemas_0.d.ts

@@ -1,4 +1,4 @@
-import type { StaticErrorSchema, StaticOperationSchema, StaticStructureSchema } from "@smithy/types";
+import type { StaticErrorSchema, StaticOperationSchema, StaticStructureSchema, StaticUnionSchema } from "@smithy/types";
 export declare var AbbreviatedExecution$: StaticStructureSchema;
 export declare var AbbreviatedPlan$: StaticStructureSchema;
 export declare var AccessDeniedException$: StaticErrorSchema;
@@ -15,6 +15,8 @@ export declare var CreatePlanResponse$: StaticStructureSchema;
 export declare var CustomActionLambdaConfiguration$: StaticStructureSchema;
 export declare var DeletePlanRequest$: StaticStructureSchema;
 export declare var DeletePlanResponse$: StaticStructureSchema;
+export declare var DocumentDbConfiguration$: StaticStructureSchema;
+export declare var DocumentDbUngraceful$: StaticStructureSchema;
 export declare var Ec2AsgCapacityIncreaseConfiguration$: StaticStructureSchema;
 export declare var Ec2Ungraceful$: StaticStructureSchema;
 export declare var EcsCapacityIncreaseConfiguration$: StaticStructureSchema;
@@ -24,6 +26,8 @@ export declare var EksResourceScalingConfiguration$: StaticStructureSchema;
 export declare var EksResourceScalingUngraceful$: StaticStructureSchema;
 export declare var ExecutionApprovalConfiguration$: StaticStructureSchema;
 export declare var ExecutionEvent$: StaticStructureSchema;
+export declare var FailedReportOutput$: StaticStructureSchema;
+export declare var GeneratedReport$: StaticStructureSchema;
 export declare var GetPlanEvaluationStatusRequest$: StaticStructureSchema;
 export declare var GetPlanEvaluationStatusResponse$: StaticStructureSchema;
 export declare var GetPlanExecutionRequest$: StaticStructureSchema;
@@ -59,11 +63,14 @@ export declare var MinimalWorkflow$: StaticStructureSchema;
 export declare var ParallelExecutionBlockConfiguration$: StaticStructureSchema;
 export declare var Plan$: StaticStructureSchema;
 export declare var RegionSwitchPlanConfiguration$: StaticStructureSchema;
+export declare var ReportConfiguration$: StaticStructureSchema;
 export declare var ResourceNotFoundException$: StaticErrorSchema;
 export declare var ResourceWarning$: StaticStructureSchema;
 export declare var Route53HealthCheck$: StaticStructureSchema;
 export declare var Route53HealthCheckConfiguration$: StaticStructureSchema;
 export declare var Route53ResourceRecordSet$: StaticStructureSchema;
+export declare var S3ReportOutput$: StaticStructureSchema;
+export declare var S3ReportOutputConfiguration$: StaticStructureSchema;
 export declare var Service$: StaticStructureSchema;
 export declare var StartPlanExecutionRequest$: StaticStructureSchema;
 export declare var StartPlanExecutionResponse$: StaticStructureSchema;
@@ -83,7 +90,9 @@ export declare var UpdatePlanRequest$: StaticStructureSchema;
 export declare var UpdatePlanResponse$: StaticStructureSchema;
 export declare var Workflow$: StaticStructureSchema;
 export declare var ARCRegionSwitchServiceException$: StaticErrorSchema;
-export declare var ExecutionBlockConfiguration$: StaticStructureSchema;
+export declare var ExecutionBlockConfiguration$: StaticUnionSchema;
+export declare var ReportOutput$: StaticUnionSchema;
+export declare var ReportOutputConfiguration$: StaticUnionSchema;
 export declare var ApprovePlanExecutionStep$: StaticOperationSchema;
 export declare var CancelPlanExecution$: StaticOperationSchema;
 export declare var CreatePlan$: StaticOperationSchema;

package/dist-types/ts3.4/models/enums.d.ts

@@ -60,6 +60,13 @@ export declare const ResourceWarningStatus: {
 };
 export type ResourceWarningStatus =
   (typeof ResourceWarningStatus)[keyof typeof ResourceWarningStatus];
+export declare const FailedReportErrorCode: {
+  readonly CONFIGURATION_ERROR: "configurationError";
+  readonly INSUFFICIENT_PERMISSIONS: "insufficientPermissions";
+  readonly INVALID_RESOURCE: "invalidResource";
+};
+export type FailedReportErrorCode =
+  (typeof FailedReportErrorCode)[keyof typeof FailedReportErrorCode];
 export declare const WorkflowTargetAction: {
   readonly ACTIVATE: "activate";
   readonly DEACTIVATE: "deactivate";
@@ -82,6 +89,17 @@ export declare const LambdaUngracefulBehavior: {
 };
 export type LambdaUngracefulBehavior =
   (typeof LambdaUngracefulBehavior)[keyof typeof LambdaUngracefulBehavior];
+export declare const DocumentDbDefaultBehavior: {
+  readonly FAILOVER: "failover";
+  readonly SWITCHOVER_ONLY: "switchoverOnly";
+};
+export type DocumentDbDefaultBehavior =
+  (typeof DocumentDbDefaultBehavior)[keyof typeof DocumentDbDefaultBehavior];
+export declare const DocumentDbUngracefulBehavior: {
+  readonly FAILOVER: "failover";
+};
+export type DocumentDbUngracefulBehavior =
+  (typeof DocumentDbUngracefulBehavior)[keyof typeof DocumentDbUngracefulBehavior];
 export declare const Ec2AsgCapacityMonitoringApproach: {
   readonly AUTOSCALING_MAX_IN_LAST_24_HOURS: "autoscalingMaxInLast24Hours";
   readonly SAMPLED_MAX_IN_LAST_24_HOURS: "sampledMaxInLast24Hours";
@@ -113,6 +131,7 @@ export type GlobalAuroraUngracefulBehavior =
 export declare const ExecutionBlockType: {
   readonly AURORA: "AuroraGlobalDatabase";
   readonly CUSTOM_ACTION_LAMBDA: "CustomActionLambda";
+  readonly DOCUMENTDB: "DocumentDb";
   readonly EC2_ASG: "EC2AutoScaling";
   readonly ECS: "ECSServiceScaling";
   readonly EKS_RESOURCE_SCALING: "EKSResourceScaling";
@@ -148,6 +167,7 @@ export declare const ExecutionEventType: {
   readonly EXECUTION_STARTED: "executionStarted";
   readonly EXECUTION_SUCCEEDED: "executionSucceeded";
   readonly EXECUTION_SUCCESS_MONITORING_APPLICATION_HEALTH: "executionSuccessMonitoringApplicationHealth";
+  readonly PLAN_EVALUATION_WARNING: "planEvaluationWarning";
   readonly STEP_CANCELED: "stepCanceled";
   readonly STEP_EXECUTION_BEHAVIOR_CHANGED_TO_UNGRACEFUL: "stepExecutionBehaviorChangedToUngraceful";
   readonly STEP_FAILED: "stepFailed";