Skip to content

Start Db Instance Automated Backups Replication

rds_start_db_instance_automated_backups_replication R Documentation

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

Description

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.

Usage

rds_start_db_instance_automated_backups_replication(SourceDBInstanceArn,
  BackupRetentionPeriod, KmsKeyId, PreSignedUrl)

Arguments

SourceDBInstanceArn

[required] 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

The retention period for the replicated automated backups.
KmsKeyId

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

In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request for the start_db_instance_automated_backups_replication operation to call in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the start_db_instance_automated_backups_replication 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.

Value

A list with the following syntax:

list(
  DBInstanceAutomatedBackup = list(
    DBInstanceArn = "string",
    DbiResourceId = "string",
    Region = "string",
    DBInstanceIdentifier = "string",
    RestoreWindow = list(
      EarliestTime = as.POSIXct(
        "2015-01-01"
      ),
      LatestTime = as.POSIXct(
        "2015-01-01"
      )
    ),
    AllocatedStorage = 123,
    Status = "string",
    Port = 123,
    AvailabilityZone = "string",
    VpcId = "string",
    InstanceCreateTime = as.POSIXct(
      "2015-01-01"
    ),
    MasterUsername = "string",
    Engine = "string",
    EngineVersion = "string",
    LicenseModel = "string",
    Iops = 123,
    OptionGroupName = "string",
    TdeCredentialArn = "string",
    Encrypted = TRUE|FALSE,
    StorageType = "string",
    KmsKeyId = "string",
    Timezone = "string",
    IAMDatabaseAuthenticationEnabled = TRUE|FALSE,
    BackupRetentionPeriod = 123,
    DBInstanceAutomatedBackupsArn = "string",
    DBInstanceAutomatedBackupsReplications = list(
      list(
        DBInstanceAutomatedBackupsArn = "string"
      )
    ),
    BackupTarget = "string",
    StorageThroughput = 123,
    AwsBackupRecoveryPointArn = "string",
    DedicatedLogVolume = TRUE|FALSE,
    MultiTenant = TRUE|FALSE
  )
)

Request syntax

svc$start_db_instance_automated_backups_replication(
  SourceDBInstanceArn = "string",
  BackupRetentionPeriod = 123,
  KmsKeyId = "string",
  PreSignedUrl = "string"
)