RDS / Client / start_db_instance_automated_backups_replication

start_db_instance_automated_backups_replication

RDS.Client.start_db_instance_automated_backups_replication(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.start_db_instance_automated_backups_replication(
    SourceDBInstanceArn='string',
    BackupRetentionPeriod=123,
    KmsKeyId='string',
    SourceRegion='string'
)

Parameters:

• SourceDBInstanceArn (string) –

  [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 (integer) – The retention period for the replicated automated backups.

• KmsKeyId (string) – 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) –

  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.

  Note

  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.

  Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required

• SourceRegion (string) – The ID of the region that contains the source for the db instance.

Return type:

dict

Returns:

Response Syntax

{
    'DBInstanceAutomatedBackup': {
        'DBInstanceArn': 'string',
        'DbiResourceId': 'string',
        'Region': 'string',
        'DBInstanceIdentifier': 'string',
        'RestoreWindow': {
            'EarliestTime': datetime(2015, 1, 1),
            'LatestTime': datetime(2015, 1, 1)
        },
        'AllocatedStorage': 123,
        'Status': 'string',
        'Port': 123,
        'AvailabilityZone': 'string',
        'VpcId': 'string',
        'InstanceCreateTime': datetime(2015, 1, 1),
        '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': [
            {
                'DBInstanceAutomatedBackupsArn': 'string'
            },
        ],
        'BackupTarget': 'string',
        'StorageThroughput': 123,
        'AwsBackupRecoveryPointArn': 'string',
        'DedicatedLogVolume': True|False,
        'MultiTenant': True|False
    }
}

Response Structure

• (dict) –

  • DBInstanceAutomatedBackup (dict) –

    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.

    • DBInstanceArn (string) –

      The Amazon Resource Name (ARN) for the automated backups.

    • DbiResourceId (string) –

      The resource ID for the source DB instance, which can’t be changed and which is unique to an Amazon Web Services Region.

    • Region (string) –

      The Amazon Web Services Region associated with the automated backup.

    • DBInstanceIdentifier (string) –

      The identifier for the source DB instance, which can’t be changed and which is unique to an Amazon Web Services Region.

    • RestoreWindow (dict) –

      The earliest and latest time a DB instance can be restored to.

      • EarliestTime (datetime) –

        The earliest time you can restore an instance to.

      • LatestTime (datetime) –

        The latest time you can restore an instance to.

    • AllocatedStorage (integer) –

      The allocated storage size for the the automated backup in gibibytes (GiB).

    • Status (string) –

      A list of status information for an automated backup:

      • active - Automated backups for current instances.

      • retained - Automated backups for deleted instances.

      • creating - Automated backups that are waiting for the first automated snapshot to be available.

    • Port (integer) –

      The port number that the automated backup used for connections.

      Default: Inherits from the source DB instance

      Valid Values: 1150-65535

    • AvailabilityZone (string) –

      The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

    • VpcId (string) –

      The VPC ID associated with the DB instance.

    • InstanceCreateTime (datetime) –

      The date and time when the DB instance was created.

    • MasterUsername (string) –

      The master user name of an automated backup.

    • Engine (string) –

      The name of the database engine for this automated backup.

    • EngineVersion (string) –

      The version of the database engine for the automated backup.

    • LicenseModel (string) –

      The license model information for the automated backup.

    • Iops (integer) –

      The IOPS (I/O operations per second) value for the automated backup.

    • OptionGroupName (string) –

      The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

    • TdeCredentialArn (string) –

      The ARN from the key store with which the automated backup is associated for TDE encryption.

    • Encrypted (boolean) –

      Indicates whether the automated backup is encrypted.

    • StorageType (string) –

      The storage type associated with the automated backup.

    • KmsKeyId (string) –

      The Amazon Web Services KMS key ID for an automated backup.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

    • Timezone (string) –

      The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

    • IAMDatabaseAuthenticationEnabled (boolean) –

      True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    • BackupRetentionPeriod (integer) –

      The retention period for the automated backups.

    • DBInstanceAutomatedBackupsArn (string) –

      The Amazon Resource Name (ARN) for the replicated automated backups.

    • DBInstanceAutomatedBackupsReplications (list) –

      The list of replications to different Amazon Web Services Regions associated with the automated backup.

      • (dict) –

        Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.

        • DBInstanceAutomatedBackupsArn (string) –

          The Amazon Resource Name (ARN) of the replicated automated backups.

    • BackupTarget (string) –

      The location where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

    • StorageThroughput (integer) –

      The storage throughput for the automated backup.

    • AwsBackupRecoveryPointArn (string) –

      The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

    • DedicatedLogVolume (boolean) –

      Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

    • MultiTenant (boolean) –

      Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

Exceptions

• RDS.Client.exceptions.DBInstanceNotFoundFault

• RDS.Client.exceptions.InvalidDBInstanceStateFault

• RDS.Client.exceptions.KMSKeyNotAccessibleFault

• RDS.Client.exceptions.DBInstanceAutomatedBackupQuotaExceededFault

• RDS.Client.exceptions.StorageTypeNotSupportedFault