Learn R Programming

paws.database (version 0.1.12)

rds_start_db_instance_automated_backups_replication: Enables replication of automated backups to a different AWS Region

Description

Enables replication of automated backups to a different AWS Region.

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

Usage

rds_start_db_instance_automated_backups_replication(SourceDBInstanceArn,
  BackupRetentionPeriod, KmsKeyId, PreSignedUrl)

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"
      )
    )
  )
)

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 AWS 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 AWS Region, for example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.

PreSignedUrl

A URL that contains a Signature Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication action to be called in the AWS Region of the source DB instance. The presigned URL must be a valid request for the StartDBInstanceAutomatedBackupsReplication API action that can be executed in the AWS Region that contains the source DB instance.

Request syntax

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