RDS / Client / describe_db_cluster_automated_backups

describe_db_cluster_automated_backups#

RDS.Client.describe_db_cluster_automated_backups(**kwargs)#

Displays backups for both current and deleted DB clusters. For example, use this operation to find details about automated backups for previously deleted clusters. Current clusters are returned for both the DescribeDBClusterAutomatedBackups and DescribeDBClusters operations.

All parameters are optional.

Request Syntax

response = client.describe_db_cluster_automated_backups(
    DbClusterResourceId='string',
    DBClusterIdentifier='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)

Parameters:

DbClusterResourceId (string) – The resource ID of the DB cluster that is the source of the automated backup. This parameter isn’t case-sensitive.
DBClusterIdentifier (string) – (Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must match the identifier of an existing DB cluster. It returns information from the specific DB cluster’s automated backup. This parameter isn’t case-sensitive.
Filters (list) –
A filter that specifies which resources to return based on status.

Supported filters are the following:
- status
  - retained - Automated backups for deleted clusters and after backup replication is stopped.
- db-cluster-id - Accepts DB cluster identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster automated backups identified by these ARNs.
- db-cluster-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster resources identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the response.
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
  
  Note
  Currently, wildcards are not supported in filters.
  
  The following actions can be filtered:
  - DescribeDBClusterBacktracks
  - DescribeDBClusterEndpoints
  - DescribeDBClusters
  - DescribeDBInstances
  - DescribeDBRecommendations
  - DescribeDBShardGroups
  - DescribePendingMaintenanceActions
  - Name (string) – [REQUIRED]
    
    The name of the filter. Filter names are case-sensitive.
  - Values (list) – [REQUIRED]
    
    One or more filter values. Filter values are case-sensitive.
    - (string) –
MaxRecords (integer) – The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Marker (string) – The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'DBClusterAutomatedBackups': [
        {
            'Engine': 'string',
            'VpcId': 'string',
            'DBClusterAutomatedBackupsArn': 'string',
            'DBClusterIdentifier': 'string',
            'RestoreWindow': {
                'EarliestTime': datetime(2015, 1, 1),
                'LatestTime': datetime(2015, 1, 1)
            },
            'MasterUsername': 'string',
            'DbClusterResourceId': 'string',
            'Region': 'string',
            'LicenseModel': 'string',
            'Status': 'string',
            'IAMDatabaseAuthenticationEnabled': True|False,
            'ClusterCreateTime': datetime(2015, 1, 1),
            'StorageEncrypted': True|False,
            'AllocatedStorage': 123,
            'EngineVersion': 'string',
            'DBClusterArn': 'string',
            'BackupRetentionPeriod': 123,
            'EngineMode': 'string',
            'AvailabilityZones': [
                'string',
            ],
            'Port': 123,
            'KmsKeyId': 'string',
            'StorageType': 'string',
            'Iops': 123,
            'AwsBackupRecoveryPointArn': 'string',
            'StorageThroughput': 123
        },
    ]
}

Response Structure

(dict) –
- Marker (string) –
  
  The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
- DBClusterAutomatedBackups (list) –
  
  A list of DBClusterAutomatedBackup backups.
  - (dict) –
    
    An automated backup of a DB cluster. It consists of system backups, transaction logs, and the database cluster properties that existed at the time you deleted the source cluster.
    - Engine (string) –
      
      The name of the database engine for this automated backup.
    - VpcId (string) –
      
      The VPC ID associated with the DB cluster.
    - DBClusterAutomatedBackupsArn (string) –
      
      The Amazon Resource Name (ARN) for the automated backups.
    - DBClusterIdentifier (string) –
      
      The identifier for the source DB cluster, which can’t be changed and which is unique to an Amazon Web Services Region.
    - RestoreWindow (dict) –
      
      Earliest and latest time an 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.
    - MasterUsername (string) –
      
      The master user name of the automated backup.
    - DbClusterResourceId (string) –
      
      The resource ID for the source DB cluster, 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.
    - LicenseModel (string) –
      
      The license model information for this DB cluster automated backup.
    - Status (string) –
      
      A list of status information for an automated backup:
      - retained - Automated backups for deleted clusters.
    - IAMDatabaseAuthenticationEnabled (boolean) –
      
      Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
    - ClusterCreateTime (datetime) –
      
      The time when the DB cluster was created, in Universal Coordinated Time (UTC).
    - StorageEncrypted (boolean) –
      
      Indicates whether the source DB cluster is encrypted.
    - AllocatedStorage (integer) –
      
      For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn’t fixed, but instead automatically adjusts as needed.
    - EngineVersion (string) –
      
      The version of the database engine for the automated backup.
    - DBClusterArn (string) –
      
      The Amazon Resource Name (ARN) for the source DB cluster.
    - BackupRetentionPeriod (integer) –
      
      The retention period for the automated backups.
    - EngineMode (string) –
      
      The engine mode of the database engine for the automated backup.
    - AvailabilityZones (list) –
      
      The Availability Zones where instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
      - (string) –
    - Port (integer) –
      
      The port number that the automated backup used for connections.
      
      Default: Inherits from the source DB cluster
      
      Valid Values: 1150-65535
    - 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.
    - StorageType (string) –
      
      The storage type associated with the DB cluster.
      
      This setting is only for non-Aurora Multi-AZ DB clusters.
    - Iops (integer) –
      
      The IOPS (I/O operations per second) value for the automated backup.
      
      This setting is only for non-Aurora Multi-AZ DB clusters.
    - AwsBackupRecoveryPointArn (string) –
      
      The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
    - StorageThroughput (integer) –
      
      The storage throughput for the automated backup. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
      
      This setting is only for non-Aurora Multi-AZ DB clusters.

Exceptions

RDS.Client.exceptions.DBClusterAutomatedBackupNotFoundFault