@aws-sdk/client-rds 3.391.0 → 3.396.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -0
- package/dist-cjs/RDS.js +2 -0
- package/dist-cjs/RDSClient.js +4 -2
- package/dist-cjs/clientConfiguration.js +2 -0
- package/dist-cjs/commands/SwitchoverGlobalClusterCommand.js +46 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/models/models_0.js +5 -1
- package/dist-cjs/protocols/Aws_query.js +86 -4
- package/dist-cjs/runtimeConfig.shared.js +1 -0
- package/dist-cjs/runtimeExtensions.js +16 -0
- package/dist-es/RDS.js +2 -0
- package/dist-es/RDSClient.js +4 -2
- package/dist-es/clientConfiguration.js +1 -0
- package/dist-es/commands/SwitchoverGlobalClusterCommand.js +42 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/protocols/Aws_query.js +80 -0
- package/dist-es/runtimeConfig.shared.js +1 -0
- package/dist-es/runtimeExtensions.js +12 -0
- package/dist-types/RDS.d.ts +7 -0
- package/dist-types/RDSClient.d.ts +9 -3
- package/dist-types/clientConfiguration.d.ts +6 -0
- package/dist-types/commands/CreateGlobalClusterCommand.d.ts +2 -0
- package/dist-types/commands/DeleteGlobalClusterCommand.d.ts +2 -0
- package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +2 -0
- package/dist-types/commands/FailoverGlobalClusterCommand.d.ts +38 -11
- package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +3 -1
- package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +2 -0
- package/dist-types/commands/SwitchoverGlobalClusterCommand.d.ts +124 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +46 -245
- package/dist-types/models/models_1.d.ts +286 -8
- package/dist-types/protocols/Aws_query.d.ts +9 -0
- package/dist-types/runtimeConfig.browser.d.ts +1 -0
- package/dist-types/runtimeConfig.d.ts +1 -0
- package/dist-types/runtimeConfig.native.d.ts +1 -0
- package/dist-types/runtimeConfig.shared.d.ts +1 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/RDS.d.ts +17 -0
- package/dist-types/ts3.4/RDSClient.d.ts +9 -0
- package/dist-types/ts3.4/clientConfiguration.d.ts +2 -0
- package/dist-types/ts3.4/commands/DescribeDBEngineVersionsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SwitchoverGlobalClusterCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +8 -12
- package/dist-types/ts3.4/models/models_1.d.ts +21 -0
- package/dist-types/ts3.4/protocols/Aws_query.d.ts +12 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/package.json +3 -3
|
@@ -150,17 +150,19 @@ import { StopDBClusterCommandInput, StopDBClusterCommandOutput } from "./command
|
|
|
150
150
|
import { StopDBInstanceAutomatedBackupsReplicationCommandInput, StopDBInstanceAutomatedBackupsReplicationCommandOutput } from "./commands/StopDBInstanceAutomatedBackupsReplicationCommand";
|
|
151
151
|
import { StopDBInstanceCommandInput, StopDBInstanceCommandOutput } from "./commands/StopDBInstanceCommand";
|
|
152
152
|
import { SwitchoverBlueGreenDeploymentCommandInput, SwitchoverBlueGreenDeploymentCommandOutput } from "./commands/SwitchoverBlueGreenDeploymentCommand";
|
|
153
|
+
import { SwitchoverGlobalClusterCommandInput, SwitchoverGlobalClusterCommandOutput } from "./commands/SwitchoverGlobalClusterCommand";
|
|
153
154
|
import { SwitchoverReadReplicaCommandInput, SwitchoverReadReplicaCommandOutput } from "./commands/SwitchoverReadReplicaCommand";
|
|
154
155
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
156
|
+
import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
|
|
155
157
|
export { __Client };
|
|
156
158
|
/**
|
|
157
159
|
* @public
|
|
158
160
|
*/
|
|
159
|
-
export type ServiceInputTypes = AddRoleToDBClusterCommandInput | AddRoleToDBInstanceCommandInput | AddSourceIdentifierToSubscriptionCommandInput | AddTagsToResourceCommandInput | ApplyPendingMaintenanceActionCommandInput | AuthorizeDBSecurityGroupIngressCommandInput | BacktrackDBClusterCommandInput | CancelExportTaskCommandInput | CopyDBClusterParameterGroupCommandInput | CopyDBClusterSnapshotCommandInput | CopyDBParameterGroupCommandInput | CopyDBSnapshotCommandInput | CopyOptionGroupCommandInput | CreateBlueGreenDeploymentCommandInput | CreateCustomDBEngineVersionCommandInput | CreateDBClusterCommandInput | CreateDBClusterEndpointCommandInput | CreateDBClusterParameterGroupCommandInput | CreateDBClusterSnapshotCommandInput | CreateDBInstanceCommandInput | CreateDBInstanceReadReplicaCommandInput | CreateDBParameterGroupCommandInput | CreateDBProxyCommandInput | CreateDBProxyEndpointCommandInput | CreateDBSecurityGroupCommandInput | CreateDBSnapshotCommandInput | CreateDBSubnetGroupCommandInput | CreateEventSubscriptionCommandInput | CreateGlobalClusterCommandInput | CreateOptionGroupCommandInput | DeleteBlueGreenDeploymentCommandInput | DeleteCustomDBEngineVersionCommandInput | DeleteDBClusterAutomatedBackupCommandInput | DeleteDBClusterCommandInput | DeleteDBClusterEndpointCommandInput | DeleteDBClusterParameterGroupCommandInput | DeleteDBClusterSnapshotCommandInput | DeleteDBInstanceAutomatedBackupCommandInput | DeleteDBInstanceCommandInput | DeleteDBParameterGroupCommandInput | DeleteDBProxyCommandInput | DeleteDBProxyEndpointCommandInput | DeleteDBSecurityGroupCommandInput | DeleteDBSnapshotCommandInput | DeleteDBSubnetGroupCommandInput | DeleteEventSubscriptionCommandInput | DeleteGlobalClusterCommandInput | DeleteOptionGroupCommandInput | DeregisterDBProxyTargetsCommandInput | DescribeAccountAttributesCommandInput | DescribeBlueGreenDeploymentsCommandInput | DescribeCertificatesCommandInput | DescribeDBClusterAutomatedBackupsCommandInput | DescribeDBClusterBacktracksCommandInput | DescribeDBClusterEndpointsCommandInput | DescribeDBClusterParameterGroupsCommandInput | DescribeDBClusterParametersCommandInput | DescribeDBClusterSnapshotAttributesCommandInput | DescribeDBClusterSnapshotsCommandInput | DescribeDBClustersCommandInput | DescribeDBEngineVersionsCommandInput | DescribeDBInstanceAutomatedBackupsCommandInput | DescribeDBInstancesCommandInput | DescribeDBLogFilesCommandInput | DescribeDBParameterGroupsCommandInput | DescribeDBParametersCommandInput | DescribeDBProxiesCommandInput | DescribeDBProxyEndpointsCommandInput | DescribeDBProxyTargetGroupsCommandInput | DescribeDBProxyTargetsCommandInput | DescribeDBSecurityGroupsCommandInput | DescribeDBSnapshotAttributesCommandInput | DescribeDBSnapshotsCommandInput | DescribeDBSubnetGroupsCommandInput | DescribeEngineDefaultClusterParametersCommandInput | DescribeEngineDefaultParametersCommandInput | DescribeEventCategoriesCommandInput | DescribeEventSubscriptionsCommandInput | DescribeEventsCommandInput | DescribeExportTasksCommandInput | DescribeGlobalClustersCommandInput | DescribeOptionGroupOptionsCommandInput | DescribeOptionGroupsCommandInput | DescribeOrderableDBInstanceOptionsCommandInput | DescribePendingMaintenanceActionsCommandInput | DescribeReservedDBInstancesCommandInput | DescribeReservedDBInstancesOfferingsCommandInput | DescribeSourceRegionsCommandInput | DescribeValidDBInstanceModificationsCommandInput | DownloadDBLogFilePortionCommandInput | FailoverDBClusterCommandInput | FailoverGlobalClusterCommandInput | ListTagsForResourceCommandInput | ModifyActivityStreamCommandInput | ModifyCertificatesCommandInput | ModifyCurrentDBClusterCapacityCommandInput | ModifyCustomDBEngineVersionCommandInput | ModifyDBClusterCommandInput | ModifyDBClusterEndpointCommandInput | ModifyDBClusterParameterGroupCommandInput | ModifyDBClusterSnapshotAttributeCommandInput | ModifyDBInstanceCommandInput | ModifyDBParameterGroupCommandInput | ModifyDBProxyCommandInput | ModifyDBProxyEndpointCommandInput | ModifyDBProxyTargetGroupCommandInput | ModifyDBSnapshotAttributeCommandInput | ModifyDBSnapshotCommandInput | ModifyDBSubnetGroupCommandInput | ModifyEventSubscriptionCommandInput | ModifyGlobalClusterCommandInput | ModifyOptionGroupCommandInput | PromoteReadReplicaCommandInput | PromoteReadReplicaDBClusterCommandInput | PurchaseReservedDBInstancesOfferingCommandInput | RebootDBClusterCommandInput | RebootDBInstanceCommandInput | RegisterDBProxyTargetsCommandInput | RemoveFromGlobalClusterCommandInput | RemoveRoleFromDBClusterCommandInput | RemoveRoleFromDBInstanceCommandInput | RemoveSourceIdentifierFromSubscriptionCommandInput | RemoveTagsFromResourceCommandInput | ResetDBClusterParameterGroupCommandInput | ResetDBParameterGroupCommandInput | RestoreDBClusterFromS3CommandInput | RestoreDBClusterFromSnapshotCommandInput | RestoreDBClusterToPointInTimeCommandInput | RestoreDBInstanceFromDBSnapshotCommandInput | RestoreDBInstanceFromS3CommandInput | RestoreDBInstanceToPointInTimeCommandInput | RevokeDBSecurityGroupIngressCommandInput | StartActivityStreamCommandInput | StartDBClusterCommandInput | StartDBInstanceAutomatedBackupsReplicationCommandInput | StartDBInstanceCommandInput | StartExportTaskCommandInput | StopActivityStreamCommandInput | StopDBClusterCommandInput | StopDBInstanceAutomatedBackupsReplicationCommandInput | StopDBInstanceCommandInput | SwitchoverBlueGreenDeploymentCommandInput | SwitchoverReadReplicaCommandInput;
|
|
161
|
+
export type ServiceInputTypes = AddRoleToDBClusterCommandInput | AddRoleToDBInstanceCommandInput | AddSourceIdentifierToSubscriptionCommandInput | AddTagsToResourceCommandInput | ApplyPendingMaintenanceActionCommandInput | AuthorizeDBSecurityGroupIngressCommandInput | BacktrackDBClusterCommandInput | CancelExportTaskCommandInput | CopyDBClusterParameterGroupCommandInput | CopyDBClusterSnapshotCommandInput | CopyDBParameterGroupCommandInput | CopyDBSnapshotCommandInput | CopyOptionGroupCommandInput | CreateBlueGreenDeploymentCommandInput | CreateCustomDBEngineVersionCommandInput | CreateDBClusterCommandInput | CreateDBClusterEndpointCommandInput | CreateDBClusterParameterGroupCommandInput | CreateDBClusterSnapshotCommandInput | CreateDBInstanceCommandInput | CreateDBInstanceReadReplicaCommandInput | CreateDBParameterGroupCommandInput | CreateDBProxyCommandInput | CreateDBProxyEndpointCommandInput | CreateDBSecurityGroupCommandInput | CreateDBSnapshotCommandInput | CreateDBSubnetGroupCommandInput | CreateEventSubscriptionCommandInput | CreateGlobalClusterCommandInput | CreateOptionGroupCommandInput | DeleteBlueGreenDeploymentCommandInput | DeleteCustomDBEngineVersionCommandInput | DeleteDBClusterAutomatedBackupCommandInput | DeleteDBClusterCommandInput | DeleteDBClusterEndpointCommandInput | DeleteDBClusterParameterGroupCommandInput | DeleteDBClusterSnapshotCommandInput | DeleteDBInstanceAutomatedBackupCommandInput | DeleteDBInstanceCommandInput | DeleteDBParameterGroupCommandInput | DeleteDBProxyCommandInput | DeleteDBProxyEndpointCommandInput | DeleteDBSecurityGroupCommandInput | DeleteDBSnapshotCommandInput | DeleteDBSubnetGroupCommandInput | DeleteEventSubscriptionCommandInput | DeleteGlobalClusterCommandInput | DeleteOptionGroupCommandInput | DeregisterDBProxyTargetsCommandInput | DescribeAccountAttributesCommandInput | DescribeBlueGreenDeploymentsCommandInput | DescribeCertificatesCommandInput | DescribeDBClusterAutomatedBackupsCommandInput | DescribeDBClusterBacktracksCommandInput | DescribeDBClusterEndpointsCommandInput | DescribeDBClusterParameterGroupsCommandInput | DescribeDBClusterParametersCommandInput | DescribeDBClusterSnapshotAttributesCommandInput | DescribeDBClusterSnapshotsCommandInput | DescribeDBClustersCommandInput | DescribeDBEngineVersionsCommandInput | DescribeDBInstanceAutomatedBackupsCommandInput | DescribeDBInstancesCommandInput | DescribeDBLogFilesCommandInput | DescribeDBParameterGroupsCommandInput | DescribeDBParametersCommandInput | DescribeDBProxiesCommandInput | DescribeDBProxyEndpointsCommandInput | DescribeDBProxyTargetGroupsCommandInput | DescribeDBProxyTargetsCommandInput | DescribeDBSecurityGroupsCommandInput | DescribeDBSnapshotAttributesCommandInput | DescribeDBSnapshotsCommandInput | DescribeDBSubnetGroupsCommandInput | DescribeEngineDefaultClusterParametersCommandInput | DescribeEngineDefaultParametersCommandInput | DescribeEventCategoriesCommandInput | DescribeEventSubscriptionsCommandInput | DescribeEventsCommandInput | DescribeExportTasksCommandInput | DescribeGlobalClustersCommandInput | DescribeOptionGroupOptionsCommandInput | DescribeOptionGroupsCommandInput | DescribeOrderableDBInstanceOptionsCommandInput | DescribePendingMaintenanceActionsCommandInput | DescribeReservedDBInstancesCommandInput | DescribeReservedDBInstancesOfferingsCommandInput | DescribeSourceRegionsCommandInput | DescribeValidDBInstanceModificationsCommandInput | DownloadDBLogFilePortionCommandInput | FailoverDBClusterCommandInput | FailoverGlobalClusterCommandInput | ListTagsForResourceCommandInput | ModifyActivityStreamCommandInput | ModifyCertificatesCommandInput | ModifyCurrentDBClusterCapacityCommandInput | ModifyCustomDBEngineVersionCommandInput | ModifyDBClusterCommandInput | ModifyDBClusterEndpointCommandInput | ModifyDBClusterParameterGroupCommandInput | ModifyDBClusterSnapshotAttributeCommandInput | ModifyDBInstanceCommandInput | ModifyDBParameterGroupCommandInput | ModifyDBProxyCommandInput | ModifyDBProxyEndpointCommandInput | ModifyDBProxyTargetGroupCommandInput | ModifyDBSnapshotAttributeCommandInput | ModifyDBSnapshotCommandInput | ModifyDBSubnetGroupCommandInput | ModifyEventSubscriptionCommandInput | ModifyGlobalClusterCommandInput | ModifyOptionGroupCommandInput | PromoteReadReplicaCommandInput | PromoteReadReplicaDBClusterCommandInput | PurchaseReservedDBInstancesOfferingCommandInput | RebootDBClusterCommandInput | RebootDBInstanceCommandInput | RegisterDBProxyTargetsCommandInput | RemoveFromGlobalClusterCommandInput | RemoveRoleFromDBClusterCommandInput | RemoveRoleFromDBInstanceCommandInput | RemoveSourceIdentifierFromSubscriptionCommandInput | RemoveTagsFromResourceCommandInput | ResetDBClusterParameterGroupCommandInput | ResetDBParameterGroupCommandInput | RestoreDBClusterFromS3CommandInput | RestoreDBClusterFromSnapshotCommandInput | RestoreDBClusterToPointInTimeCommandInput | RestoreDBInstanceFromDBSnapshotCommandInput | RestoreDBInstanceFromS3CommandInput | RestoreDBInstanceToPointInTimeCommandInput | RevokeDBSecurityGroupIngressCommandInput | StartActivityStreamCommandInput | StartDBClusterCommandInput | StartDBInstanceAutomatedBackupsReplicationCommandInput | StartDBInstanceCommandInput | StartExportTaskCommandInput | StopActivityStreamCommandInput | StopDBClusterCommandInput | StopDBInstanceAutomatedBackupsReplicationCommandInput | StopDBInstanceCommandInput | SwitchoverBlueGreenDeploymentCommandInput | SwitchoverGlobalClusterCommandInput | SwitchoverReadReplicaCommandInput;
|
|
160
162
|
/**
|
|
161
163
|
* @public
|
|
162
164
|
*/
|
|
163
|
-
export type ServiceOutputTypes = AddRoleToDBClusterCommandOutput | AddRoleToDBInstanceCommandOutput | AddSourceIdentifierToSubscriptionCommandOutput | AddTagsToResourceCommandOutput | ApplyPendingMaintenanceActionCommandOutput | AuthorizeDBSecurityGroupIngressCommandOutput | BacktrackDBClusterCommandOutput | CancelExportTaskCommandOutput | CopyDBClusterParameterGroupCommandOutput | CopyDBClusterSnapshotCommandOutput | CopyDBParameterGroupCommandOutput | CopyDBSnapshotCommandOutput | CopyOptionGroupCommandOutput | CreateBlueGreenDeploymentCommandOutput | CreateCustomDBEngineVersionCommandOutput | CreateDBClusterCommandOutput | CreateDBClusterEndpointCommandOutput | CreateDBClusterParameterGroupCommandOutput | CreateDBClusterSnapshotCommandOutput | CreateDBInstanceCommandOutput | CreateDBInstanceReadReplicaCommandOutput | CreateDBParameterGroupCommandOutput | CreateDBProxyCommandOutput | CreateDBProxyEndpointCommandOutput | CreateDBSecurityGroupCommandOutput | CreateDBSnapshotCommandOutput | CreateDBSubnetGroupCommandOutput | CreateEventSubscriptionCommandOutput | CreateGlobalClusterCommandOutput | CreateOptionGroupCommandOutput | DeleteBlueGreenDeploymentCommandOutput | DeleteCustomDBEngineVersionCommandOutput | DeleteDBClusterAutomatedBackupCommandOutput | DeleteDBClusterCommandOutput | DeleteDBClusterEndpointCommandOutput | DeleteDBClusterParameterGroupCommandOutput | DeleteDBClusterSnapshotCommandOutput | DeleteDBInstanceAutomatedBackupCommandOutput | DeleteDBInstanceCommandOutput | DeleteDBParameterGroupCommandOutput | DeleteDBProxyCommandOutput | DeleteDBProxyEndpointCommandOutput | DeleteDBSecurityGroupCommandOutput | DeleteDBSnapshotCommandOutput | DeleteDBSubnetGroupCommandOutput | DeleteEventSubscriptionCommandOutput | DeleteGlobalClusterCommandOutput | DeleteOptionGroupCommandOutput | DeregisterDBProxyTargetsCommandOutput | DescribeAccountAttributesCommandOutput | DescribeBlueGreenDeploymentsCommandOutput | DescribeCertificatesCommandOutput | DescribeDBClusterAutomatedBackupsCommandOutput | DescribeDBClusterBacktracksCommandOutput | DescribeDBClusterEndpointsCommandOutput | DescribeDBClusterParameterGroupsCommandOutput | DescribeDBClusterParametersCommandOutput | DescribeDBClusterSnapshotAttributesCommandOutput | DescribeDBClusterSnapshotsCommandOutput | DescribeDBClustersCommandOutput | DescribeDBEngineVersionsCommandOutput | DescribeDBInstanceAutomatedBackupsCommandOutput | DescribeDBInstancesCommandOutput | DescribeDBLogFilesCommandOutput | DescribeDBParameterGroupsCommandOutput | DescribeDBParametersCommandOutput | DescribeDBProxiesCommandOutput | DescribeDBProxyEndpointsCommandOutput | DescribeDBProxyTargetGroupsCommandOutput | DescribeDBProxyTargetsCommandOutput | DescribeDBSecurityGroupsCommandOutput | DescribeDBSnapshotAttributesCommandOutput | DescribeDBSnapshotsCommandOutput | DescribeDBSubnetGroupsCommandOutput | DescribeEngineDefaultClusterParametersCommandOutput | DescribeEngineDefaultParametersCommandOutput | DescribeEventCategoriesCommandOutput | DescribeEventSubscriptionsCommandOutput | DescribeEventsCommandOutput | DescribeExportTasksCommandOutput | DescribeGlobalClustersCommandOutput | DescribeOptionGroupOptionsCommandOutput | DescribeOptionGroupsCommandOutput | DescribeOrderableDBInstanceOptionsCommandOutput | DescribePendingMaintenanceActionsCommandOutput | DescribeReservedDBInstancesCommandOutput | DescribeReservedDBInstancesOfferingsCommandOutput | DescribeSourceRegionsCommandOutput | DescribeValidDBInstanceModificationsCommandOutput | DownloadDBLogFilePortionCommandOutput | FailoverDBClusterCommandOutput | FailoverGlobalClusterCommandOutput | ListTagsForResourceCommandOutput | ModifyActivityStreamCommandOutput | ModifyCertificatesCommandOutput | ModifyCurrentDBClusterCapacityCommandOutput | ModifyCustomDBEngineVersionCommandOutput | ModifyDBClusterCommandOutput | ModifyDBClusterEndpointCommandOutput | ModifyDBClusterParameterGroupCommandOutput | ModifyDBClusterSnapshotAttributeCommandOutput | ModifyDBInstanceCommandOutput | ModifyDBParameterGroupCommandOutput | ModifyDBProxyCommandOutput | ModifyDBProxyEndpointCommandOutput | ModifyDBProxyTargetGroupCommandOutput | ModifyDBSnapshotAttributeCommandOutput | ModifyDBSnapshotCommandOutput | ModifyDBSubnetGroupCommandOutput | ModifyEventSubscriptionCommandOutput | ModifyGlobalClusterCommandOutput | ModifyOptionGroupCommandOutput | PromoteReadReplicaCommandOutput | PromoteReadReplicaDBClusterCommandOutput | PurchaseReservedDBInstancesOfferingCommandOutput | RebootDBClusterCommandOutput | RebootDBInstanceCommandOutput | RegisterDBProxyTargetsCommandOutput | RemoveFromGlobalClusterCommandOutput | RemoveRoleFromDBClusterCommandOutput | RemoveRoleFromDBInstanceCommandOutput | RemoveSourceIdentifierFromSubscriptionCommandOutput | RemoveTagsFromResourceCommandOutput | ResetDBClusterParameterGroupCommandOutput | ResetDBParameterGroupCommandOutput | RestoreDBClusterFromS3CommandOutput | RestoreDBClusterFromSnapshotCommandOutput | RestoreDBClusterToPointInTimeCommandOutput | RestoreDBInstanceFromDBSnapshotCommandOutput | RestoreDBInstanceFromS3CommandOutput | RestoreDBInstanceToPointInTimeCommandOutput | RevokeDBSecurityGroupIngressCommandOutput | StartActivityStreamCommandOutput | StartDBClusterCommandOutput | StartDBInstanceAutomatedBackupsReplicationCommandOutput | StartDBInstanceCommandOutput | StartExportTaskCommandOutput | StopActivityStreamCommandOutput | StopDBClusterCommandOutput | StopDBInstanceAutomatedBackupsReplicationCommandOutput | StopDBInstanceCommandOutput | SwitchoverBlueGreenDeploymentCommandOutput | SwitchoverReadReplicaCommandOutput;
|
|
165
|
+
export type ServiceOutputTypes = AddRoleToDBClusterCommandOutput | AddRoleToDBInstanceCommandOutput | AddSourceIdentifierToSubscriptionCommandOutput | AddTagsToResourceCommandOutput | ApplyPendingMaintenanceActionCommandOutput | AuthorizeDBSecurityGroupIngressCommandOutput | BacktrackDBClusterCommandOutput | CancelExportTaskCommandOutput | CopyDBClusterParameterGroupCommandOutput | CopyDBClusterSnapshotCommandOutput | CopyDBParameterGroupCommandOutput | CopyDBSnapshotCommandOutput | CopyOptionGroupCommandOutput | CreateBlueGreenDeploymentCommandOutput | CreateCustomDBEngineVersionCommandOutput | CreateDBClusterCommandOutput | CreateDBClusterEndpointCommandOutput | CreateDBClusterParameterGroupCommandOutput | CreateDBClusterSnapshotCommandOutput | CreateDBInstanceCommandOutput | CreateDBInstanceReadReplicaCommandOutput | CreateDBParameterGroupCommandOutput | CreateDBProxyCommandOutput | CreateDBProxyEndpointCommandOutput | CreateDBSecurityGroupCommandOutput | CreateDBSnapshotCommandOutput | CreateDBSubnetGroupCommandOutput | CreateEventSubscriptionCommandOutput | CreateGlobalClusterCommandOutput | CreateOptionGroupCommandOutput | DeleteBlueGreenDeploymentCommandOutput | DeleteCustomDBEngineVersionCommandOutput | DeleteDBClusterAutomatedBackupCommandOutput | DeleteDBClusterCommandOutput | DeleteDBClusterEndpointCommandOutput | DeleteDBClusterParameterGroupCommandOutput | DeleteDBClusterSnapshotCommandOutput | DeleteDBInstanceAutomatedBackupCommandOutput | DeleteDBInstanceCommandOutput | DeleteDBParameterGroupCommandOutput | DeleteDBProxyCommandOutput | DeleteDBProxyEndpointCommandOutput | DeleteDBSecurityGroupCommandOutput | DeleteDBSnapshotCommandOutput | DeleteDBSubnetGroupCommandOutput | DeleteEventSubscriptionCommandOutput | DeleteGlobalClusterCommandOutput | DeleteOptionGroupCommandOutput | DeregisterDBProxyTargetsCommandOutput | DescribeAccountAttributesCommandOutput | DescribeBlueGreenDeploymentsCommandOutput | DescribeCertificatesCommandOutput | DescribeDBClusterAutomatedBackupsCommandOutput | DescribeDBClusterBacktracksCommandOutput | DescribeDBClusterEndpointsCommandOutput | DescribeDBClusterParameterGroupsCommandOutput | DescribeDBClusterParametersCommandOutput | DescribeDBClusterSnapshotAttributesCommandOutput | DescribeDBClusterSnapshotsCommandOutput | DescribeDBClustersCommandOutput | DescribeDBEngineVersionsCommandOutput | DescribeDBInstanceAutomatedBackupsCommandOutput | DescribeDBInstancesCommandOutput | DescribeDBLogFilesCommandOutput | DescribeDBParameterGroupsCommandOutput | DescribeDBParametersCommandOutput | DescribeDBProxiesCommandOutput | DescribeDBProxyEndpointsCommandOutput | DescribeDBProxyTargetGroupsCommandOutput | DescribeDBProxyTargetsCommandOutput | DescribeDBSecurityGroupsCommandOutput | DescribeDBSnapshotAttributesCommandOutput | DescribeDBSnapshotsCommandOutput | DescribeDBSubnetGroupsCommandOutput | DescribeEngineDefaultClusterParametersCommandOutput | DescribeEngineDefaultParametersCommandOutput | DescribeEventCategoriesCommandOutput | DescribeEventSubscriptionsCommandOutput | DescribeEventsCommandOutput | DescribeExportTasksCommandOutput | DescribeGlobalClustersCommandOutput | DescribeOptionGroupOptionsCommandOutput | DescribeOptionGroupsCommandOutput | DescribeOrderableDBInstanceOptionsCommandOutput | DescribePendingMaintenanceActionsCommandOutput | DescribeReservedDBInstancesCommandOutput | DescribeReservedDBInstancesOfferingsCommandOutput | DescribeSourceRegionsCommandOutput | DescribeValidDBInstanceModificationsCommandOutput | DownloadDBLogFilePortionCommandOutput | FailoverDBClusterCommandOutput | FailoverGlobalClusterCommandOutput | ListTagsForResourceCommandOutput | ModifyActivityStreamCommandOutput | ModifyCertificatesCommandOutput | ModifyCurrentDBClusterCapacityCommandOutput | ModifyCustomDBEngineVersionCommandOutput | ModifyDBClusterCommandOutput | ModifyDBClusterEndpointCommandOutput | ModifyDBClusterParameterGroupCommandOutput | ModifyDBClusterSnapshotAttributeCommandOutput | ModifyDBInstanceCommandOutput | ModifyDBParameterGroupCommandOutput | ModifyDBProxyCommandOutput | ModifyDBProxyEndpointCommandOutput | ModifyDBProxyTargetGroupCommandOutput | ModifyDBSnapshotAttributeCommandOutput | ModifyDBSnapshotCommandOutput | ModifyDBSubnetGroupCommandOutput | ModifyEventSubscriptionCommandOutput | ModifyGlobalClusterCommandOutput | ModifyOptionGroupCommandOutput | PromoteReadReplicaCommandOutput | PromoteReadReplicaDBClusterCommandOutput | PurchaseReservedDBInstancesOfferingCommandOutput | RebootDBClusterCommandOutput | RebootDBInstanceCommandOutput | RegisterDBProxyTargetsCommandOutput | RemoveFromGlobalClusterCommandOutput | RemoveRoleFromDBClusterCommandOutput | RemoveRoleFromDBInstanceCommandOutput | RemoveSourceIdentifierFromSubscriptionCommandOutput | RemoveTagsFromResourceCommandOutput | ResetDBClusterParameterGroupCommandOutput | ResetDBParameterGroupCommandOutput | RestoreDBClusterFromS3CommandOutput | RestoreDBClusterFromSnapshotCommandOutput | RestoreDBClusterToPointInTimeCommandOutput | RestoreDBInstanceFromDBSnapshotCommandOutput | RestoreDBInstanceFromS3CommandOutput | RestoreDBInstanceToPointInTimeCommandOutput | RevokeDBSecurityGroupIngressCommandOutput | StartActivityStreamCommandOutput | StartDBClusterCommandOutput | StartDBInstanceAutomatedBackupsReplicationCommandOutput | StartDBInstanceCommandOutput | StartExportTaskCommandOutput | StopActivityStreamCommandOutput | StopDBClusterCommandOutput | StopDBInstanceAutomatedBackupsReplicationCommandOutput | StopDBInstanceCommandOutput | SwitchoverBlueGreenDeploymentCommandOutput | SwitchoverGlobalClusterCommandOutput | SwitchoverReadReplicaCommandOutput;
|
|
164
166
|
/**
|
|
165
167
|
* @public
|
|
166
168
|
*/
|
|
@@ -259,6 +261,10 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
259
261
|
* Optional logger for logging debug/info/warn/error.
|
|
260
262
|
*/
|
|
261
263
|
logger?: __Logger;
|
|
264
|
+
/**
|
|
265
|
+
* Optional extensions
|
|
266
|
+
*/
|
|
267
|
+
extensions?: RuntimeExtension[];
|
|
262
268
|
/**
|
|
263
269
|
* The {@link @smithy/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
|
|
264
270
|
*/
|
|
@@ -278,7 +284,7 @@ export interface RDSClientConfig extends RDSClientConfigType {
|
|
|
278
284
|
/**
|
|
279
285
|
* @public
|
|
280
286
|
*/
|
|
281
|
-
export type RDSClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
|
|
287
|
+
export type RDSClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
|
|
282
288
|
/**
|
|
283
289
|
* @public
|
|
284
290
|
*
|
|
@@ -72,12 +72,14 @@ export interface CreateGlobalClusterCommandOutput extends CreateGlobalClusterRes
|
|
|
72
72
|
* // ],
|
|
73
73
|
* // IsWriter: true || false,
|
|
74
74
|
* // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown",
|
|
75
|
+
* // SynchronizationStatus: "connected" || "pending-resync",
|
|
75
76
|
* // },
|
|
76
77
|
* // ],
|
|
77
78
|
* // FailoverState: { // FailoverState
|
|
78
79
|
* // Status: "pending" || "failing-over" || "cancelling",
|
|
79
80
|
* // FromDbClusterArn: "STRING_VALUE",
|
|
80
81
|
* // ToDbClusterArn: "STRING_VALUE",
|
|
82
|
+
* // IsDataLossAllowed: true || false,
|
|
81
83
|
* // },
|
|
82
84
|
* // },
|
|
83
85
|
* // };
|
|
@@ -58,12 +58,14 @@ export interface DeleteGlobalClusterCommandOutput extends DeleteGlobalClusterRes
|
|
|
58
58
|
* // ],
|
|
59
59
|
* // IsWriter: true || false,
|
|
60
60
|
* // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown",
|
|
61
|
+
* // SynchronizationStatus: "connected" || "pending-resync",
|
|
61
62
|
* // },
|
|
62
63
|
* // ],
|
|
63
64
|
* // FailoverState: { // FailoverState
|
|
64
65
|
* // Status: "pending" || "failing-over" || "cancelling",
|
|
65
66
|
* // FromDbClusterArn: "STRING_VALUE",
|
|
66
67
|
* // ToDbClusterArn: "STRING_VALUE",
|
|
68
|
+
* // IsDataLossAllowed: true || false,
|
|
67
69
|
* // },
|
|
68
70
|
* // },
|
|
69
71
|
* // };
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
2
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
-
import { DBEngineVersionMessage
|
|
4
|
+
import { DBEngineVersionMessage } from "../models/models_0";
|
|
5
|
+
import { DescribeDBEngineVersionsMessage } from "../models/models_1";
|
|
5
6
|
import { RDSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSClient";
|
|
6
7
|
/**
|
|
7
8
|
* @public
|
|
@@ -71,12 +71,14 @@ export interface DescribeGlobalClustersCommandOutput extends GlobalClustersMessa
|
|
|
71
71
|
* // ],
|
|
72
72
|
* // IsWriter: true || false,
|
|
73
73
|
* // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown",
|
|
74
|
+
* // SynchronizationStatus: "connected" || "pending-resync",
|
|
74
75
|
* // },
|
|
75
76
|
* // ],
|
|
76
77
|
* // FailoverState: { // FailoverState
|
|
77
78
|
* // Status: "pending" || "failing-over" || "cancelling",
|
|
78
79
|
* // FromDbClusterArn: "STRING_VALUE",
|
|
79
80
|
* // ToDbClusterArn: "STRING_VALUE",
|
|
81
|
+
* // IsDataLossAllowed: true || false,
|
|
80
82
|
* // },
|
|
81
83
|
* // },
|
|
82
84
|
* // ],
|
|
@@ -23,19 +23,42 @@ export interface FailoverGlobalClusterCommandOutput extends FailoverGlobalCluste
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>
|
|
27
|
-
* <p>A failover for an Aurora global database promotes one of secondary read-only DB clusters to be
|
|
28
|
-
* the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words,
|
|
29
|
-
* the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected
|
|
30
|
-
* secondary DB cluster assumes full read/write capabilities for the Aurora global database.</p>
|
|
31
|
-
* <p>For more information about failing over an Amazon Aurora global database, see
|
|
32
|
-
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-disaster-recovery.managed-failover">Managed planned failover for Amazon Aurora global
|
|
33
|
-
* databases</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
26
|
+
* <p>Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database. Switchover operations were previously called "managed planned failovers."</p>
|
|
34
27
|
* <note>
|
|
35
|
-
* <p>
|
|
36
|
-
*
|
|
37
|
-
* reconfigure your Aurora global database topology.</p>
|
|
28
|
+
* <p>Although this operation can be used either to fail over or to switch over a global database cluster, its intended use is for global database failover.
|
|
29
|
+
* To switch over a global database cluster, we recommend that you use the <a>SwitchoverGlobalCluster</a> operation instead.</p>
|
|
38
30
|
* </note>
|
|
31
|
+
* <p>How you use this operation depends on whether you are failing over or switching over your global database cluster:</p>
|
|
32
|
+
* <ul>
|
|
33
|
+
* <li>
|
|
34
|
+
* <p>Failing over - Specify the <code>AllowDataLoss</code> parameter and don't specify the <code>Switchover</code> parameter.</p>
|
|
35
|
+
* </li>
|
|
36
|
+
* <li>
|
|
37
|
+
* <p>Switching over - Specify the <code>Switchover</code> parameter or omit it, but don't specify the <code>AllowDataLoss</code> parameter.</p>
|
|
38
|
+
* </li>
|
|
39
|
+
* </ul>
|
|
40
|
+
* <p>
|
|
41
|
+
* <b>About failing over and switching over</b>
|
|
42
|
+
* </p>
|
|
43
|
+
* <p>While failing over and switching over a global database cluster both change the primary DB cluster, you use these operations for different reasons:</p>
|
|
44
|
+
* <ul>
|
|
45
|
+
* <li>
|
|
46
|
+
* <p>
|
|
47
|
+
* <i>Failing over</i> - Use this operation to respond to an unplanned event, such as a Regional disaster in the primary Region.
|
|
48
|
+
* Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred.
|
|
49
|
+
* However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees
|
|
50
|
+
* that the data is in a transactionally consistent state.</p>
|
|
51
|
+
* <p>For more information about failing over an Amazon Aurora global database, see
|
|
52
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-failover.managed-unplanned">Performing managed failovers for Aurora global databases</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
53
|
+
* </li>
|
|
54
|
+
* <li>
|
|
55
|
+
* <p>
|
|
56
|
+
* <i>Switching over</i> - Use this operation on a healthy global database cluster for planned events, such as Regional rotation or to
|
|
57
|
+
* fail back to the original primary DB cluster after a failover operation. With this operation, there is no data loss.</p>
|
|
58
|
+
* <p>For more information about switching over an Amazon Aurora global database, see
|
|
59
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-disaster-recovery.managed-failover">Performing switchovers for Aurora global databases</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
60
|
+
* </li>
|
|
61
|
+
* </ul>
|
|
39
62
|
* @example
|
|
40
63
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
64
|
* ```javascript
|
|
@@ -45,6 +68,8 @@ export interface FailoverGlobalClusterCommandOutput extends FailoverGlobalCluste
|
|
|
45
68
|
* const input = { // FailoverGlobalClusterMessage
|
|
46
69
|
* GlobalClusterIdentifier: "STRING_VALUE", // required
|
|
47
70
|
* TargetDbClusterIdentifier: "STRING_VALUE", // required
|
|
71
|
+
* AllowDataLoss: true || false,
|
|
72
|
+
* Switchover: true || false,
|
|
48
73
|
* };
|
|
49
74
|
* const command = new FailoverGlobalClusterCommand(input);
|
|
50
75
|
* const response = await client.send(command);
|
|
@@ -67,12 +92,14 @@ export interface FailoverGlobalClusterCommandOutput extends FailoverGlobalCluste
|
|
|
67
92
|
* // ],
|
|
68
93
|
* // IsWriter: true || false,
|
|
69
94
|
* // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown",
|
|
95
|
+
* // SynchronizationStatus: "connected" || "pending-resync",
|
|
70
96
|
* // },
|
|
71
97
|
* // ],
|
|
72
98
|
* // FailoverState: { // FailoverState
|
|
73
99
|
* // Status: "pending" || "failing-over" || "cancelling",
|
|
74
100
|
* // FromDbClusterArn: "STRING_VALUE",
|
|
75
101
|
* // ToDbClusterArn: "STRING_VALUE",
|
|
102
|
+
* // IsDataLossAllowed: true || false,
|
|
76
103
|
* // },
|
|
77
104
|
* // },
|
|
78
105
|
* // };
|
|
@@ -23,7 +23,7 @@ export interface ModifyGlobalClusterCommandOutput extends ModifyGlobalClusterRes
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Modifies a setting for an Amazon Aurora global cluster. You can change one or more database configuration
|
|
26
|
+
* <p>Modifies a setting for an Amazon Aurora global database cluster. You can change one or more database configuration
|
|
27
27
|
* parameters by specifying these parameters and the new values in the request. For more information on
|
|
28
28
|
* Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> What is Amazon Aurora?</a> in the
|
|
29
29
|
* <i>Amazon Aurora User Guide</i>.</p>
|
|
@@ -64,12 +64,14 @@ export interface ModifyGlobalClusterCommandOutput extends ModifyGlobalClusterRes
|
|
|
64
64
|
* // ],
|
|
65
65
|
* // IsWriter: true || false,
|
|
66
66
|
* // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown",
|
|
67
|
+
* // SynchronizationStatus: "connected" || "pending-resync",
|
|
67
68
|
* // },
|
|
68
69
|
* // ],
|
|
69
70
|
* // FailoverState: { // FailoverState
|
|
70
71
|
* // Status: "pending" || "failing-over" || "cancelling",
|
|
71
72
|
* // FromDbClusterArn: "STRING_VALUE",
|
|
72
73
|
* // ToDbClusterArn: "STRING_VALUE",
|
|
74
|
+
* // IsDataLossAllowed: true || false,
|
|
73
75
|
* // },
|
|
74
76
|
* // },
|
|
75
77
|
* // };
|
|
@@ -60,12 +60,14 @@ export interface RemoveFromGlobalClusterCommandOutput extends RemoveFromGlobalCl
|
|
|
60
60
|
* // ],
|
|
61
61
|
* // IsWriter: true || false,
|
|
62
62
|
* // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown",
|
|
63
|
+
* // SynchronizationStatus: "connected" || "pending-resync",
|
|
63
64
|
* // },
|
|
64
65
|
* // ],
|
|
65
66
|
* // FailoverState: { // FailoverState
|
|
66
67
|
* // Status: "pending" || "failing-over" || "cancelling",
|
|
67
68
|
* // FromDbClusterArn: "STRING_VALUE",
|
|
68
69
|
* // ToDbClusterArn: "STRING_VALUE",
|
|
70
|
+
* // IsDataLossAllowed: true || false,
|
|
69
71
|
* // },
|
|
70
72
|
* // },
|
|
71
73
|
* // };
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { SwitchoverGlobalClusterMessage, SwitchoverGlobalClusterResult } from "../models/models_1";
|
|
5
|
+
import { RDSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link SwitchoverGlobalClusterCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SwitchoverGlobalClusterCommandInput extends SwitchoverGlobalClusterMessage {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SwitchoverGlobalClusterCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SwitchoverGlobalClusterCommandOutput extends SwitchoverGlobalClusterResult, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster.
|
|
27
|
+
* Switchover operations were previously called "managed planned failovers."</p>
|
|
28
|
+
* <p>Aurora promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster
|
|
29
|
+
* to a secondary (read-only) cluster, maintaining the orginal replication topology. All secondary clusters are synchronized with the primary
|
|
30
|
+
* at the beginning of the process so the new primary continues operations for the Aurora global database without losing any data. Your database
|
|
31
|
+
* is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles. For more information about
|
|
32
|
+
* switching over an Aurora global database, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-disaster-recovery.managed-failover">Performing switchovers for Amazon Aurora global databases</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
33
|
+
* <note>
|
|
34
|
+
* <p>This operation is intended for controlled environments, for operations such as "regional rotation" or to fall back to the original
|
|
35
|
+
* primary after a global database failover.</p>
|
|
36
|
+
* </note>
|
|
37
|
+
* @example
|
|
38
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
39
|
+
* ```javascript
|
|
40
|
+
* import { RDSClient, SwitchoverGlobalClusterCommand } from "@aws-sdk/client-rds"; // ES Modules import
|
|
41
|
+
* // const { RDSClient, SwitchoverGlobalClusterCommand } = require("@aws-sdk/client-rds"); // CommonJS import
|
|
42
|
+
* const client = new RDSClient(config);
|
|
43
|
+
* const input = { // SwitchoverGlobalClusterMessage
|
|
44
|
+
* GlobalClusterIdentifier: "STRING_VALUE", // required
|
|
45
|
+
* TargetDbClusterIdentifier: "STRING_VALUE", // required
|
|
46
|
+
* };
|
|
47
|
+
* const command = new SwitchoverGlobalClusterCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* // { // SwitchoverGlobalClusterResult
|
|
50
|
+
* // GlobalCluster: { // GlobalCluster
|
|
51
|
+
* // GlobalClusterIdentifier: "STRING_VALUE",
|
|
52
|
+
* // GlobalClusterResourceId: "STRING_VALUE",
|
|
53
|
+
* // GlobalClusterArn: "STRING_VALUE",
|
|
54
|
+
* // Status: "STRING_VALUE",
|
|
55
|
+
* // Engine: "STRING_VALUE",
|
|
56
|
+
* // EngineVersion: "STRING_VALUE",
|
|
57
|
+
* // DatabaseName: "STRING_VALUE",
|
|
58
|
+
* // StorageEncrypted: true || false,
|
|
59
|
+
* // DeletionProtection: true || false,
|
|
60
|
+
* // GlobalClusterMembers: [ // GlobalClusterMemberList
|
|
61
|
+
* // { // GlobalClusterMember
|
|
62
|
+
* // DBClusterArn: "STRING_VALUE",
|
|
63
|
+
* // Readers: [ // ReadersArnList
|
|
64
|
+
* // "STRING_VALUE",
|
|
65
|
+
* // ],
|
|
66
|
+
* // IsWriter: true || false,
|
|
67
|
+
* // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown",
|
|
68
|
+
* // SynchronizationStatus: "connected" || "pending-resync",
|
|
69
|
+
* // },
|
|
70
|
+
* // ],
|
|
71
|
+
* // FailoverState: { // FailoverState
|
|
72
|
+
* // Status: "pending" || "failing-over" || "cancelling",
|
|
73
|
+
* // FromDbClusterArn: "STRING_VALUE",
|
|
74
|
+
* // ToDbClusterArn: "STRING_VALUE",
|
|
75
|
+
* // IsDataLossAllowed: true || false,
|
|
76
|
+
* // },
|
|
77
|
+
* // },
|
|
78
|
+
* // };
|
|
79
|
+
*
|
|
80
|
+
* ```
|
|
81
|
+
*
|
|
82
|
+
* @param SwitchoverGlobalClusterCommandInput - {@link SwitchoverGlobalClusterCommandInput}
|
|
83
|
+
* @returns {@link SwitchoverGlobalClusterCommandOutput}
|
|
84
|
+
* @see {@link SwitchoverGlobalClusterCommandInput} for command's `input` shape.
|
|
85
|
+
* @see {@link SwitchoverGlobalClusterCommandOutput} for command's `response` shape.
|
|
86
|
+
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link DBClusterNotFoundFault} (client fault)
|
|
89
|
+
* <p>
|
|
90
|
+
* <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link GlobalClusterNotFoundFault} (client fault)
|
|
93
|
+
* <p>The <code>GlobalClusterIdentifier</code> doesn't refer to an existing global database cluster.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link InvalidDBClusterStateFault} (client fault)
|
|
96
|
+
* <p>The requested operation can't be performed while the cluster is in this state.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link InvalidGlobalClusterStateFault} (client fault)
|
|
99
|
+
* <p>The global cluster is in an invalid state and can't perform the requested operation.</p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link RDSServiceException}
|
|
102
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
103
|
+
*
|
|
104
|
+
*/
|
|
105
|
+
export declare class SwitchoverGlobalClusterCommand extends $Command<SwitchoverGlobalClusterCommandInput, SwitchoverGlobalClusterCommandOutput, RDSClientResolvedConfig> {
|
|
106
|
+
readonly input: SwitchoverGlobalClusterCommandInput;
|
|
107
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
108
|
+
/**
|
|
109
|
+
* @public
|
|
110
|
+
*/
|
|
111
|
+
constructor(input: SwitchoverGlobalClusterCommandInput);
|
|
112
|
+
/**
|
|
113
|
+
* @internal
|
|
114
|
+
*/
|
|
115
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RDSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SwitchoverGlobalClusterCommandInput, SwitchoverGlobalClusterCommandOutput>;
|
|
116
|
+
/**
|
|
117
|
+
* @internal
|
|
118
|
+
*/
|
|
119
|
+
private serialize;
|
|
120
|
+
/**
|
|
121
|
+
* @internal
|
|
122
|
+
*/
|
|
123
|
+
private deserialize;
|
|
124
|
+
}
|
|
@@ -140,4 +140,5 @@ export * from "./StopDBClusterCommand";
|
|
|
140
140
|
export * from "./StopDBInstanceAutomatedBackupsReplicationCommand";
|
|
141
141
|
export * from "./StopDBInstanceCommand";
|
|
142
142
|
export * from "./SwitchoverBlueGreenDeploymentCommand";
|
|
143
|
+
export * from "./SwitchoverGlobalClusterCommand";
|
|
143
144
|
export * from "./SwitchoverReadReplicaCommand";
|