DBClusterAutomatedBackup
¶
Source code in docs_src/capo_rds/types/db_cluster_automated_backup.py
allocated_storage
instance-attribute
¶
allocated_storage: NotRequired[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
instance-attribute
¶
availability_zones: NotRequired[AvailabilityZones]
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
instance-attribute
¶
aws_backup_recovery_point_arn: NotRequired[String]
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
backup_retention_period
instance-attribute
¶
backup_retention_period: NotRequired[IntegerOptional]
The retention period for the automated backups.
cluster_create_time
instance-attribute
¶
cluster_create_time: NotRequired[TStamp]
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
db_cluster_arn
instance-attribute
¶
db_cluster_arn: NotRequired[String]
The Amazon Resource Name (ARN) for the source DB cluster.
db_cluster_automated_backups_arn
instance-attribute
¶
db_cluster_automated_backups_arn: NotRequired[String]
The Amazon Resource Name (ARN) for the automated backups.
db_cluster_identifier
instance-attribute
¶
db_cluster_identifier: NotRequired[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
instance-attribute
¶
db_cluster_resource_id: NotRequired[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
instance-attribute
¶
engine: NotRequired[String]
The name of the database engine for this automated backup.
engine_mode
instance-attribute
¶
engine_mode: NotRequired[String]
The engine mode of the database engine for the automated backup.
engine_version
instance-attribute
¶
engine_version: NotRequired[String]
The version of the database engine for the automated backup.
iam_database_authentication_enabled
instance-attribute
¶
iam_database_authentication_enabled: NotRequired[Boolean]
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
iops
instance-attribute
¶
iops: NotRequired[IntegerOptional]
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
instance-attribute
¶
kms_key_id: NotRequired[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
instance-attribute
¶
license_model: NotRequired[String]
The license model information for this DB cluster automated backup.
master_username
instance-attribute
¶
master_username: NotRequired[String]
The master user name of the automated backup.
port
instance-attribute
¶
port: NotRequired[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
instance-attribute
¶
preferred_backup_window: NotRequired[String]
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
region
instance-attribute
¶
region: NotRequired[String]
The Amazon Web Services Region associated with the automated backup.
status
instance-attribute
¶
status: NotRequired[String]
A list of status information for an automated backup:
-
retained- Automated backups for deleted clusters.
storage_encrypted
instance-attribute
¶
storage_encrypted: NotRequired[Boolean]
Indicates whether the source DB cluster is encrypted.
storage_encryption_type
instance-attribute
¶
storage_encryption_type: NotRequired[StorageEncryptionType]
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
instance-attribute
¶
storage_throughput: NotRequired[IntegerOptional]
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.