Skip to content

AwsRdsDbClusterDetails

Source code in docs_src/capo_securityhub/types/aws_rds_db_cluster_details.py
class AwsRdsDbClusterDetails(TypedDict, closed=True):
    allocated_storage: NotRequired["capo_securityhub.types.integer.Integer"]
    """<p>For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).</p>"""
    availability_zones: NotRequired["capo_securityhub.types.string_list.StringList"]
    """<p>A list of Availability Zones (AZs) where instances in the DB cluster can be created.</p>"""
    backup_retention_period: NotRequired["capo_securityhub.types.integer.Integer"]
    """<p>The number of days for which automated backups are retained.</p>"""
    database_name: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The name of the database.</p>"""
    status: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The current status of this DB cluster.</p>"""
    endpoint: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The connection endpoint for the primary instance of the DB cluster.</p>"""
    reader_endpoint: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The reader endpoint for the DB cluster.</p>"""
    custom_endpoints: NotRequired["capo_securityhub.types.string_list.StringList"]
    """<p>A list of custom endpoints for the DB cluster.</p>"""
    multi_az: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Whether the DB cluster has instances in multiple Availability Zones.</p>"""
    engine: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The name of the database engine to use for this DB cluster. Valid values are as follows:</p> <ul> <li> <p> <code>aurora</code> </p> </li> <li> <p> <code>aurora-mysql</code> </p> </li> <li> <p> <code>aurora-postgresql</code> </p> </li> </ul>"""
    engine_version: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The version number of the database engine to use.</p>"""
    port: NotRequired["capo_securityhub.types.integer.Integer"]
    """<p>The port number on which the DB instances in the DB cluster accept connections.</p>"""
    master_username: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The name of the master user for the DB cluster.</p>"""
    preferred_backup_window: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The range of time each day when automated backups are created, if automated backups are enabled.</p> <p>Uses the format <code>HH:MM-HH:MM</code>. For example, <code>04:52-05:22</code>.</p>"""
    preferred_maintenance_window: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p> <p>Uses the format <code><day>:HH:MM-<day>:HH:MM</code>.</p> <p>For the day values, use <code>mon</code>|<code>tue</code>|<code>wed</code>|<code>thu</code>|<code>fri</code>|<code>sat</code>|<code>sun</code>.</p> <p>For example, <code>sun:09:32-sun:10:02</code>.</p>"""
    read_replica_identifiers: NotRequired[
        "capo_securityhub.types.string_list.StringList"
    ]
    """<p>The identifiers of the read replicas that are associated with this DB cluster.</p>"""
    vpc_security_groups: NotRequired[
        "capo_securityhub.types.aws_rds_db_instance_vpc_security_groups.AwsRdsDbInstanceVpcSecurityGroups"
    ]
    """<p>A list of VPC security groups that the DB cluster belongs to.</p>"""
    hosted_zone_id: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>Specifies the identifier that Amazon Route 53 assigns when you create a hosted zone.</p>"""
    storage_encrypted: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Whether the DB cluster is encrypted.</p>"""
    kms_key_id: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster.</p>"""
    db_cluster_resource_id: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The identifier of the DB cluster. The identifier must be unique within each Amazon Web Services Region and is immutable.</p>"""
    associated_roles: NotRequired[
        "capo_securityhub.types.aws_rds_db_cluster_associated_roles.AwsRdsDbClusterAssociatedRoles"
    ]
    """<p>A list of the IAM roles that are associated with the DB cluster.</p>"""
    cluster_create_time: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""
    enabled_cloud_watch_logs_exports: NotRequired[
        "capo_securityhub.types.string_list.StringList"
    ]
    """<p>A list of log types that this DB cluster is configured to export to CloudWatch Logs.</p>"""
    engine_mode: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The database engine mode of the DB cluster.Valid values are as follows:</p> <ul> <li> <p> <code>global</code> </p> </li> <li> <p> <code>multimaster</code> </p> </li> <li> <p> <code>parallelquery</code> </p> </li> <li> <p> <code>provisioned</code> </p> </li> <li> <p> <code>serverless</code> </p> </li> </ul>"""
    deletion_protection: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Whether the DB cluster has deletion protection enabled.</p>"""
    http_endpoint_enabled: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.</p>"""
    activity_stream_status: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The status of the database activity stream. Valid values are as follows:</p> <ul> <li> <p> <code>started</code> </p> </li> <li> <p> <code>starting</code> </p> </li> <li> <p> <code>stopped</code> </p> </li> <li> <p> <code>stopping</code> </p> </li> </ul>"""
    copy_tags_to_snapshot: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Whether tags are copied from the DB cluster to snapshots of the DB cluster.</p>"""
    cross_account_clone: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.</p>"""
    domain_memberships: NotRequired[
        "capo_securityhub.types.aws_rds_db_domain_memberships.AwsRdsDbDomainMemberships"
    ]
    """<p>The Active Directory domain membership records that are associated with the DB cluster.</p>"""
    db_cluster_parameter_group: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The name of the DB cluster parameter group for the DB cluster.</p>"""
    db_subnet_group: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.</p>"""
    db_cluster_option_group_memberships: NotRequired[
        "capo_securityhub.types.aws_rds_db_cluster_option_group_memberships.AwsRdsDbClusterOptionGroupMemberships"
    ]
    """<p>The list of option group memberships for this DB cluster.</p>"""
    db_cluster_identifier: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The DB cluster identifier that the user assigned to the cluster. This identifier is the unique key that identifies a DB cluster.</p>"""
    db_cluster_members: NotRequired[
        "capo_securityhub.types.aws_rds_db_cluster_members.AwsRdsDbClusterMembers"
    ]
    """<p>The list of instances that make up the DB cluster.</p>"""
    iam_database_authentication_enabled: NotRequired[
        "capo_securityhub.types.boolean.Boolean"
    ]
    """<p>Whether the mapping of IAM accounts to database accounts is enabled.</p>"""
    auto_minor_version_upgrade: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p> Indicates if minor version upgrades are automatically applied to the cluster.</p>"""

activity_stream_status instance-attribute

activity_stream_status: NotRequired[NonEmptyString]

The status of the database activity stream. Valid values are as follows:

  • started

  • starting

  • stopped

  • stopping

allocated_storage instance-attribute

allocated_storage: NotRequired[Integer]

For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).

associated_roles instance-attribute

associated_roles: NotRequired[AwsRdsDbClusterAssociatedRoles]

A list of the IAM roles that are associated with the DB cluster.

auto_minor_version_upgrade instance-attribute

auto_minor_version_upgrade: NotRequired[Boolean]

Indicates if minor version upgrades are automatically applied to the cluster.

availability_zones instance-attribute

availability_zones: NotRequired[StringList]

A list of Availability Zones (AZs) where instances in the DB cluster can be created.

backup_retention_period instance-attribute

backup_retention_period: NotRequired[Integer]

The number of days for which automated backups are retained.

cluster_create_time instance-attribute

cluster_create_time: NotRequired[NonEmptyString]

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

For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.

copy_tags_to_snapshot instance-attribute

copy_tags_to_snapshot: NotRequired[Boolean]

Whether tags are copied from the DB cluster to snapshots of the DB cluster.

cross_account_clone instance-attribute

cross_account_clone: NotRequired[Boolean]

Whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

custom_endpoints instance-attribute

custom_endpoints: NotRequired[StringList]

A list of custom endpoints for the DB cluster.

database_name instance-attribute

database_name: NotRequired[NonEmptyString]

The name of the database.

db_cluster_identifier instance-attribute

db_cluster_identifier: NotRequired[NonEmptyString]

The DB cluster identifier that the user assigned to the cluster. This identifier is the unique key that identifies a DB cluster.

db_cluster_members instance-attribute

db_cluster_members: NotRequired[AwsRdsDbClusterMembers]

The list of instances that make up the DB cluster.

db_cluster_option_group_memberships instance-attribute

db_cluster_option_group_memberships: NotRequired[AwsRdsDbClusterOptionGroupMemberships]

The list of option group memberships for this DB cluster.

db_cluster_parameter_group instance-attribute

db_cluster_parameter_group: NotRequired[NonEmptyString]

The name of the DB cluster parameter group for the DB cluster.

db_cluster_resource_id instance-attribute

db_cluster_resource_id: NotRequired[NonEmptyString]

The identifier of the DB cluster. The identifier must be unique within each Amazon Web Services Region and is immutable.

db_subnet_group instance-attribute

db_subnet_group: NotRequired[NonEmptyString]

The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.

deletion_protection instance-attribute

deletion_protection: NotRequired[Boolean]

Whether the DB cluster has deletion protection enabled.

domain_memberships instance-attribute

domain_memberships: NotRequired[AwsRdsDbDomainMemberships]

The Active Directory domain membership records that are associated with the DB cluster.

enabled_cloud_watch_logs_exports instance-attribute

enabled_cloud_watch_logs_exports: NotRequired[StringList]

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

endpoint instance-attribute

endpoint: NotRequired[NonEmptyString]

The connection endpoint for the primary instance of the DB cluster.

engine instance-attribute

engine: NotRequired[NonEmptyString]

The name of the database engine to use for this DB cluster. Valid values are as follows:

  • aurora

  • aurora-mysql

  • aurora-postgresql

engine_mode instance-attribute

engine_mode: NotRequired[NonEmptyString]

The database engine mode of the DB cluster.Valid values are as follows:

  • global

  • multimaster

  • parallelquery

  • provisioned

  • serverless

engine_version instance-attribute

engine_version: NotRequired[NonEmptyString]

The version number of the database engine to use.

hosted_zone_id instance-attribute

hosted_zone_id: NotRequired[NonEmptyString]

Specifies the identifier that Amazon Route 53 assigns when you create a hosted zone.

http_endpoint_enabled instance-attribute

http_endpoint_enabled: NotRequired[Boolean]

Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

iam_database_authentication_enabled instance-attribute

iam_database_authentication_enabled: NotRequired[Boolean]

Whether the mapping of IAM accounts to database accounts is enabled.

kms_key_id instance-attribute

kms_key_id: NotRequired[NonEmptyString]

The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster.

master_username instance-attribute

master_username: NotRequired[NonEmptyString]

The name of the master user for the DB cluster.

multi_az instance-attribute

multi_az: NotRequired[Boolean]

Whether the DB cluster has instances in multiple Availability Zones.

port instance-attribute

port: NotRequired[Integer]

The port number on which the DB instances in the DB cluster accept connections.

preferred_backup_window instance-attribute

preferred_backup_window: NotRequired[NonEmptyString]

The range of time each day when automated backups are created, if automated backups are enabled.

Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

preferred_maintenance_window instance-attribute

preferred_maintenance_window: NotRequired[NonEmptyString]

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Uses the format :HH:MM-:HH:MM.

For the day values, use mon|tue|wed|thu|fri|sat|sun.

For example, sun:09:32-sun:10:02.

read_replica_identifiers instance-attribute

read_replica_identifiers: NotRequired[StringList]

The identifiers of the read replicas that are associated with this DB cluster.

reader_endpoint instance-attribute

reader_endpoint: NotRequired[NonEmptyString]

The reader endpoint for the DB cluster.

status instance-attribute

status: NotRequired[NonEmptyString]

The current status of this DB cluster.

storage_encrypted instance-attribute

storage_encrypted: NotRequired[Boolean]

Whether the DB cluster is encrypted.

vpc_security_groups instance-attribute

vpc_security_groups: NotRequired[AwsRdsDbInstanceVpcSecurityGroups]

A list of VPC security groups that the DB cluster belongs to.