Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

StartDBInstanceAutomatedBackupsReplicationCommand

Enables replication of automated backups to a different Amazon Web Services Region.

This command doesn't apply to RDS Custom.

For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RDSClient, StartDBInstanceAutomatedBackupsReplicationCommand } from "@aws-sdk/client-rds"; // ES Modules import
// const { RDSClient, StartDBInstanceAutomatedBackupsReplicationCommand } = require("@aws-sdk/client-rds"); // CommonJS import
const client = new RDSClient(config);
const input = { // StartDBInstanceAutomatedBackupsReplicationMessage
  SourceDBInstanceArn: "STRING_VALUE", // required
  BackupRetentionPeriod: Number("int"),
  KmsKeyId: "STRING_VALUE",
  PreSignedUrl: "STRING_VALUE",
};
const command = new StartDBInstanceAutomatedBackupsReplicationCommand(input);
const response = await client.send(command);
// { // StartDBInstanceAutomatedBackupsReplicationResult
//   DBInstanceAutomatedBackup: { // DBInstanceAutomatedBackup
//     DBInstanceArn: "STRING_VALUE",
//     DbiResourceId: "STRING_VALUE",
//     Region: "STRING_VALUE",
//     DBInstanceIdentifier: "STRING_VALUE",
//     RestoreWindow: { // RestoreWindow
//       EarliestTime: new Date("TIMESTAMP"),
//       LatestTime: new Date("TIMESTAMP"),
//     },
//     AllocatedStorage: Number("int"),
//     Status: "STRING_VALUE",
//     Port: Number("int"),
//     AvailabilityZone: "STRING_VALUE",
//     VpcId: "STRING_VALUE",
//     InstanceCreateTime: new Date("TIMESTAMP"),
//     MasterUsername: "STRING_VALUE",
//     Engine: "STRING_VALUE",
//     EngineVersion: "STRING_VALUE",
//     LicenseModel: "STRING_VALUE",
//     Iops: Number("int"),
//     OptionGroupName: "STRING_VALUE",
//     TdeCredentialArn: "STRING_VALUE",
//     Encrypted: true || false,
//     StorageType: "STRING_VALUE",
//     KmsKeyId: "STRING_VALUE",
//     Timezone: "STRING_VALUE",
//     IAMDatabaseAuthenticationEnabled: true || false,
//     BackupRetentionPeriod: Number("int"),
//     DBInstanceAutomatedBackupsArn: "STRING_VALUE",
//     DBInstanceAutomatedBackupsReplications: [ // DBInstanceAutomatedBackupsReplicationList
//       { // DBInstanceAutomatedBackupsReplication
//         DBInstanceAutomatedBackupsArn: "STRING_VALUE",
//       },
//     ],
//     BackupTarget: "STRING_VALUE",
//     StorageThroughput: Number("int"),
//     AwsBackupRecoveryPointArn: "STRING_VALUE",
//     DedicatedLogVolume: true || false,
//     MultiTenant: true || false,
//   },
// };

Example Usage

There was an error loading the code editor. Retry

StartDBInstanceAutomatedBackupsReplicationCommand Input

See StartDBInstanceAutomatedBackupsReplicationCommandInput for more details

Parameter	Type	Description
`SourceDBInstanceArn` Required	`string \| undefined`	The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example, `arn:aws:rds:us-west-2:123456789012:db:mydatabase`.
`BackupRetentionPeriod`	`number \| undefined`	The retention period for the replicated automated backups.
`KmsKeyId`	`string \| undefined`	The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for example, `arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE`.
`PreSignedUrl`	`string \| undefined`	In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request for the `StartDBInstanceAutomatedBackupsReplication` operation to call in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the `StartDBInstanceAutomatedBackupsReplication` API operation that can run in the Amazon Web Services Region that contains the source DB instance. This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process . If you are using an Amazon Web Services SDK tool or the CLI, you can specify `SourceRegion` (or `--source-region` for the CLI) instead of specifying `PreSignedUrl` manually. Specifying `SourceRegion` autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

StartDBInstanceAutomatedBackupsReplicationCommand Output

See StartDBInstanceAutomatedBackupsReplicationCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`DBInstanceAutomatedBackup`	`DBInstanceAutomatedBackup \| undefined`	An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.

Throws

Name	Fault	Details
DBInstanceAutomatedBackupQuotaExceededFault	client	The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB instance quota.
DBInstanceNotFoundFault	client	`DBInstanceIdentifier` doesn't refer to an existing DB instance.
InvalidDBInstanceStateFault	client	The DB instance isn't in a valid state.
KMSKeyNotAccessibleFault	client	An error occurred accessing an Amazon Web Services KMS key.
StorageTypeNotSupportedFault	client	The specified `StorageType` can't be associated with the DB instance.
RDSServiceException		Base exception class for all service exceptions from RDS service.

Getting Started