Skip to content

DBClusterAutomatedBackup

Source code in docs_src/capo_rds/types/db_cluster_automated_backup.py
class DBClusterAutomatedBackup(TypedDict, closed=True):
    engine: NotRequired["capo_rds.types.string.String"]
    """<p>The name of the database engine for this automated backup.</p>"""
    vpc_id: NotRequired["capo_rds.types.string.String"]
    """<p>The VPC ID associated with the DB cluster.</p>"""
    db_cluster_automated_backups_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the automated backups.</p>"""
    db_cluster_identifier: NotRequired["capo_rds.types.string.String"]
    """<p>The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.</p>"""
    restore_window: NotRequired["capo_rds.types.restore_window.RestoreWindow"]
    master_username: NotRequired["capo_rds.types.string.String"]
    """<p>The master user name of the automated backup.</p>"""
    db_cluster_resource_id: NotRequired["capo_rds.types.string.String"]
    """<p>The resource ID for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.</p>"""
    region: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Web Services Region associated with the automated backup.</p>"""
    license_model: NotRequired["capo_rds.types.string.String"]
    """<p>The license model information for this DB cluster automated backup.</p>"""
    status: NotRequired["capo_rds.types.string.String"]
    """<p>A list of status information for an automated backup:</p> <ul> <li> <p> <code>retained</code> - Automated backups for deleted clusters.</p> </li> </ul>"""
    iam_database_authentication_enabled: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.</p>"""
    cluster_create_time: NotRequired["capo_rds.types.t_stamp.TStamp"]
    """<p>The time when the DB cluster was created, in Universal Coordinated Time (UTC).</p>"""
    storage_encrypted: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether the source DB cluster is encrypted.</p>"""
    storage_encryption_type: NotRequired[
        "capo_rds.types.storage_encryption_type.StorageEncryptionType"
    ]
    """<p>The type of encryption used to protect data at rest in the automated backup. Possible values:</p> <ul> <li> <p> <code>none</code> - The automated backup is not encrypted.</p> </li> <li> <p> <code>sse-rds</code> - The automated backup is encrypted using an Amazon Web Services owned KMS key.</p> </li> <li> <p> <code>sse-kms</code> - The automated backup is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.</p> </li> </ul>"""
    allocated_storage: NotRequired["capo_rds.types.integer.Integer"]
    """<p>For all database engines except Amazon Aurora, <code>AllocatedStorage</code> specifies the allocated storage size in gibibytes (GiB). For Aurora, <code>AllocatedStorage</code> always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.</p>"""
    engine_version: NotRequired["capo_rds.types.string.String"]
    """<p>The version of the database engine for the automated backup.</p>"""
    db_cluster_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the source DB cluster.</p>"""
    backup_retention_period: NotRequired[
        "capo_rds.types.integer_optional.IntegerOptional"
    ]
    """<p>The retention period for the automated backups.</p>"""
    preferred_backup_window: NotRequired["capo_rds.types.string.String"]
    """<p>The daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>BackupRetentionPeriod</code>.</p>"""
    engine_mode: NotRequired["capo_rds.types.string.String"]
    """<p>The engine mode of the database engine for the automated backup.</p>"""
    availability_zones: NotRequired[
        "capo_rds.types.availability_zones.AvailabilityZones"
    ]
    """<p>The Availability Zones where instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html">Regions and Availability Zones</a>.</p>"""
    port: NotRequired["capo_rds.types.integer.Integer"]
    """<p>The port number that the automated backup used for connections.</p> <p>Default: Inherits from the source DB cluster</p> <p>Valid Values: <code>1150-65535</code> </p>"""
    kms_key_id: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Web Services KMS key ID for an automated backup.</p> <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>"""
    storage_type: NotRequired["capo_rds.types.string.String"]
    """<p>The storage type associated with the DB cluster.</p> <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>"""
    iops: NotRequired["capo_rds.types.integer_optional.IntegerOptional"]
    """<p>The IOPS (I/O operations per second) value for the automated backup.</p> <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>"""
    storage_throughput: NotRequired["capo_rds.types.integer_optional.IntegerOptional"]
    """<p>The storage throughput for the automated backup. The throughput is automatically set based on the IOPS that you provision, and is not configurable.</p> <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>"""
    aws_backup_recovery_point_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.</p>"""
    tag_list: NotRequired["capo_rds.types.tag_list.TagList"]

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.

restore_window instance-attribute

restore_window: NotRequired[RestoreWindow]

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.

storage_type instance-attribute

storage_type: NotRequired[String]

The storage type associated with the DB cluster.

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

tag_list instance-attribute

tag_list: NotRequired[TagList]

vpc_id instance-attribute

vpc_id: NotRequired[String]

The VPC ID associated with the DB cluster.