Skip to content

RDS  >  Structures  >  DBClusterAutomatedBackup

DBClusterAutomatedBackup

Structure Class

DBClusterAutomatedBackup dataclass

Bases: _SerdeShape

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.

Attributes

allocated_storage class-attribute instance-attribute 
allocated_storage: int | None = ...

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 class-attribute instance-attribute 
availability_zones: list[str] | None = ...

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 class-attribute instance-attribute 
aws_backup_recovery_point_arn: str | None = ...

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

backup_retention_period class-attribute instance-attribute 
backup_retention_period: int | None = ...

The retention period for the automated backups.

cluster_create_time class-attribute instance-attribute 
cluster_create_time: datetime | None = ...

The time when the DB cluster was created, in Universal Coordinated Time (UTC).

db_cluster_arn class-attribute instance-attribute 
db_cluster_arn: str | None = ...

The Amazon Resource Name (ARN) for the source DB cluster.

db_cluster_automated_backups_arn class-attribute instance-attribute 
db_cluster_automated_backups_arn: str | None = ...

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

db_cluster_identifier class-attribute instance-attribute 
db_cluster_identifier: str | None = ...

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 class-attribute instance-attribute 
db_cluster_resource_id: str | None = ...

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

engine class-attribute instance-attribute 
engine: str | None = ...

The name of the database engine for this automated backup.

engine_mode class-attribute instance-attribute 
engine_mode: str | None = ...

The engine mode of the database engine for the automated backup.

engine_version class-attribute instance-attribute 
engine_version: str | None = ...

The version of the database engine for the automated backup.

iam_database_authentication_enabled class-attribute instance-attribute 
iam_database_authentication_enabled: bool | None = ...

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

iops class-attribute instance-attribute 
iops: int | None = ...

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 class-attribute instance-attribute 
kms_key_id: str | None = ...

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 class-attribute instance-attribute 
license_model: str | None = ...

The license model information for this DB cluster automated backup.

master_username class-attribute instance-attribute 
master_username: str | None = ...

The master user name of the automated backup.

port class-attribute instance-attribute 
port: int | None = ...

The port number that the automated backup used for connections.

Default: Inherits from the source DB cluster

Valid Values: 1150-65535

preferred_backup_window class-attribute instance-attribute 
preferred_backup_window: str | None = ...

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

region class-attribute instance-attribute 
region: str | None = ...

The Amazon Web Services Region associated with the automated backup.

restore_window class-attribute instance-attribute 
restore_window: RestoreWindow | None = ...

Earliest and latest time an instance can be restored to:

status class-attribute instance-attribute 
status: str | None = ...

A list of status information for an automated backup:

  • retained - Automated backups for deleted clusters.
storage_encrypted class-attribute instance-attribute 
storage_encrypted: bool | None = ...

Indicates whether the source DB cluster is encrypted.

storage_encryption_type class-attribute instance-attribute 
storage_encryption_type: str | None = ...

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 class-attribute instance-attribute 
storage_throughput: int | None = ...

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 class-attribute instance-attribute 
storage_type: str | None = ...

The storage type associated with the DB cluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

tag_list class-attribute instance-attribute 
tag_list: list[Tag] | None = ...

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 class-attribute instance-attribute 
vpc_id: str | None = ...

The VPC ID associated with the DB cluster.