db_cluster_automated_backups
Creates, updates, deletes, gets or lists a db_cluster_automated_backups resource.
Overview
| Name | db_cluster_automated_backups |
| Type | Resource |
| Id | aws.rds.db_cluster_automated_backups |
Fields
The following fields are returned by SELECT queries:
- describe_db_cluster_automated_backups
| Name | Datatype | Description |
|---|---|---|
allocated_storage | 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. |
availability_zones | string | 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. |
aws_backup_recovery_point_arn | string | The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup. |
backup_retention_period | integer | The retention period for the automated backups. |
cluster_create_time | string | The time when the DB cluster was created, in Universal Coordinated Time (UTC). |
db_cluster_arn | string | The Amazon Resource Name (ARN) for the source DB cluster. |
db_cluster_automated_backups_arn | string | The Amazon Resource Name (ARN) for the automated backups. |
db_cluster_identifier | string | The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region. |
db_cluster_resource_id | string | The resource ID for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region. |
engine | string | The name of the database engine for this automated backup. |
engine_mode | string | The engine mode of the database engine for the automated backup. |
engine_version | string | The version of the database engine for the automated backup. |
iam_database_authentication_enabled | boolean | Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. |
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. |
kms_key_id | 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. |
license_model | string | The license model information for this DB cluster automated backup. |
master_username | string | The master user name of the automated backup. |
port | integer | The port number that the automated backup used for connections. Default: Inherits from the source DB cluster Valid Values: 1150-65535 |
preferred_backup_window | string | The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. |
region | string | The Amazon Web Services Region associated with the automated backup. |
restore_window | string | Earliest and latest time an instance can be restored to: |
status | string | A list of status information for an automated backup: retained - Automated backups for deleted clusters. |
storage_encrypted | boolean | Indicates whether the source DB cluster is encrypted. |
storage_encryption_type | string | The type of encryption used to protect data at rest in the automated backup. Possible values: none - The automated backup is not encrypted. sse-rds - The automated backup is encrypted using an Amazon Web Services owned KMS key. sse-kms - The automated backup is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key. |
storage_throughput | 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. |
storage_type | string | The storage type associated with the DB cluster. This setting is only for non-Aurora Multi-AZ DB clusters. |
tag_list | string | A list of tags. For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide. |
vpc_id | string | The VPC ID associated with the DB cluster. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_db_cluster_automated_backups | select | region | DbClusterResourceId, DBClusterIdentifier, Filters, MaxRecords, Marker | 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. |
delete_db_cluster_automated_backup | delete | DbClusterResourceId, region | Deletes automated backups using the DbClusterResourceId value of the source DB cluster or the Amazon Resource Name (ARN) of the automated backups. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
DbClusterResourceId | string | The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region. |
region | string | AWS region (default: us-east-1) |
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. |
DbClusterResourceId | string | The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive. |
Filters | array | 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. |
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. |
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. |
SELECT examples
- describe_db_cluster_automated_backups
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.
SELECT
allocated_storage,
availability_zones,
aws_backup_recovery_point_arn,
backup_retention_period,
cluster_create_time,
db_cluster_arn,
db_cluster_automated_backups_arn,
db_cluster_identifier,
db_cluster_resource_id,
engine,
engine_mode,
engine_version,
iam_database_authentication_enabled,
iops,
kms_key_id,
license_model,
master_username,
port,
preferred_backup_window,
region,
restore_window,
status,
storage_encrypted,
storage_encryption_type,
storage_throughput,
storage_type,
tag_list,
vpc_id
FROM aws.rds.db_cluster_automated_backups
WHERE region = '{{ region }}' -- required
AND DbClusterResourceId = '{{ DbClusterResourceId }}'
AND DBClusterIdentifier = '{{ DBClusterIdentifier }}'
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;
DELETE examples
- delete_db_cluster_automated_backup
Deletes automated backups using the DbClusterResourceId value of the source DB cluster or the Amazon Resource Name (ARN) of the automated backups.
DELETE FROM aws.rds.db_cluster_automated_backups
WHERE DbClusterResourceId = '{{ DbClusterResourceId }}' --required
AND region = '{{ region }}' --required
;