Skip to content

AwsRdsDbInstanceDetails

Source code in docs_src/capo_securityhub/types/aws_rds_db_instance_details.py
class AwsRdsDbInstanceDetails(TypedDict, closed=True):
    associated_roles: NotRequired[
        "capo_securityhub.types.aws_rds_db_instance_associated_roles.AwsRdsDbInstanceAssociatedRoles"
    ]
    """<p>The IAM roles associated with the DB instance.</p>"""
    ca_certificate_identifier: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The identifier of the CA certificate for this DB instance.</p>"""
    db_cluster_identifier: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.</p>"""
    db_instance_identifier: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.</p>"""
    db_instance_class: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>Contains the name of the compute and memory capacity class of the DB instance.</p>"""
    db_instance_port: NotRequired["capo_securityhub.types.integer.Integer"]
    """<p>Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.</p>"""
    dbi_resource_id: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in CloudTrail log entries whenever the KMS key for the DB instance is accessed. </p>"""
    db_name: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The meaning of this parameter differs according to the database engine you use.</p> <p> <b>MySQL, MariaDB, SQL Server, PostgreSQL</b> </p> <p>Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.</p> <p> <b>Oracle</b> </p> <p>Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters don't apply to an Oracle DB instance. </p>"""
    deletion_protection: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Indicates whether the DB instance has deletion protection enabled.</p> <p>When deletion protection is enabled, the database cannot be deleted.</p>"""
    endpoint: NotRequired[
        "capo_securityhub.types.aws_rds_db_instance_endpoint.AwsRdsDbInstanceEndpoint"
    ]
    """<p>Specifies the connection endpoint.</p>"""
    engine: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>Provides the name of the database engine to use for this DB instance.</p>"""
    engine_version: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>Indicates the database engine version.</p>"""
    iam_database_authentication_enabled: NotRequired[
        "capo_securityhub.types.boolean.Boolean"
    ]
    """<p>True if mapping of IAM accounts to database accounts is enabled, and otherwise false.</p> <p>IAM database authentication can be enabled for the following database engines.</p> <ul> <li> <p>For MySQL 5.6, minor version 5.6.34 or higher</p> </li> <li> <p>For MySQL 5.7, minor version 5.7.16 or higher</p> </li> <li> <p>Aurora 5.6 or higher</p> </li> </ul>"""
    instance_create_time: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>Indicates when the DB instance was created.</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>"""
    kms_key_id: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>If <code>StorageEncrypted</code> is true, the KMS key identifier for the encrypted DB instance.</p>"""
    publicly_accessible: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Specifies the accessibility options for the DB instance.</p> <p>A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address.</p> <p>A value of false specifies an internal instance with a DNS name that resolves to a private IP address. </p>"""
    storage_encrypted: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Specifies whether the DB instance is encrypted.</p>"""
    tde_credential_arn: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The ARN from the key store with which the instance is associated for TDE encryption.</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 instance belongs to.</p>"""
    multi_az: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Whether the DB instance is a multiple Availability Zone deployment.</p>"""
    enhanced_monitoring_resource_arn: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.</p>"""
    db_instance_status: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The current status of the DB instance.</p>"""
    master_username: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The master user name of the DB instance.</p>"""
    allocated_storage: NotRequired["capo_securityhub.types.integer.Integer"]
    """<p>The amount of storage (in gigabytes) to initially allocate for the DB instance.</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>"""
    backup_retention_period: NotRequired["capo_securityhub.types.integer.Integer"]
    """<p>The number of days for which to retain automated backups.</p>"""
    db_security_groups: NotRequired["capo_securityhub.types.string_list.StringList"]
    """<p>A list of the DB security groups to assign to the DB instance.</p>"""
    db_parameter_groups: NotRequired[
        "capo_securityhub.types.aws_rds_db_parameter_groups.AwsRdsDbParameterGroups"
    ]
    """<p>A list of the DB parameter groups to assign to the DB instance.</p>"""
    availability_zone: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The Availability Zone where the DB instance will be created.</p>"""
    db_subnet_group: NotRequired[
        "capo_securityhub.types.aws_rds_db_subnet_group.AwsRdsDbSubnetGroup"
    ]
    """<p>Information about the subnet group that is associated with the DB instance.</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>"""
    pending_modified_values: NotRequired[
        "capo_securityhub.types.aws_rds_db_pending_modified_values.AwsRdsDbPendingModifiedValues"
    ]
    """<p>Changes to the DB instance that are currently pending.</p>"""
    latest_restorable_time: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>Specifies the latest time to which a database can be restored with point-in-time restore.</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>"""
    auto_minor_version_upgrade: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Indicates whether minor version patches are applied automatically.</p>"""
    read_replica_source_db_instance_identifier: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>If this DB instance is a read replica, contains the identifier of the source DB instance.</p>"""
    read_replica_db_instance_identifiers: NotRequired[
        "capo_securityhub.types.string_list.StringList"
    ]
    """<p>List of identifiers of the read replicas associated with this DB instance.</p>"""
    read_replica_db_cluster_identifiers: NotRequired[
        "capo_securityhub.types.string_list.StringList"
    ]
    """<p>List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.</p>"""
    license_model: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>License model information for this DB instance.</p>"""
    iops: NotRequired["capo_securityhub.types.integer.Integer"]
    """<p>Specifies the provisioned IOPS (I/O operations per second) for this DB instance.</p>"""
    option_group_memberships: NotRequired[
        "capo_securityhub.types.aws_rds_db_option_group_memberships.AwsRdsDbOptionGroupMemberships"
    ]
    """<p>The list of option group memberships for this DB instance.</p>"""
    character_set_name: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The name of the character set that this DB instance is associated with.</p>"""
    secondary_availability_zone: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.</p>"""
    status_infos: NotRequired[
        "capo_securityhub.types.aws_rds_db_status_infos.AwsRdsDbStatusInfos"
    ]
    """<p>The status of a read replica. If the instance isn't a read replica, this is empty.</p>"""
    storage_type: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The storage type for the DB instance.</p>"""
    domain_memberships: NotRequired[
        "capo_securityhub.types.aws_rds_db_domain_memberships.AwsRdsDbDomainMemberships"
    ]
    """<p>The Active Directory domain membership records associated with the DB instance.</p>"""
    copy_tags_to_snapshot: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Whether to copy resource tags to snapshots of the DB instance.</p>"""
    monitoring_interval: NotRequired["capo_securityhub.types.integer.Integer"]
    """<p>The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.</p>"""
    monitoring_role_arn: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.</p>"""
    promotion_tier: NotRequired["capo_securityhub.types.integer.Integer"]
    """<p>The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.</p>"""
    timezone: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The time zone of the DB instance.</p>"""
    performance_insights_enabled: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Indicates whether Performance Insights is enabled for the DB instance.</p>"""
    performance_insights_kms_key_id: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The identifier of the KMS key used to encrypt the Performance Insights data.</p>"""
    performance_insights_retention_period: NotRequired[
        "capo_securityhub.types.integer.Integer"
    ]
    """<p>The number of days to retain Performance Insights data.</p>"""
    enabled_cloud_watch_logs_exports: NotRequired[
        "capo_securityhub.types.string_list.StringList"
    ]
    """<p>A list of log types that this DB instance is configured to export to CloudWatch Logs.</p>"""
    processor_features: NotRequired[
        "capo_securityhub.types.aws_rds_db_processor_features.AwsRdsDbProcessorFeatures"
    ]
    """<p>The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.</p>"""
    listener_endpoint: NotRequired[
        "capo_securityhub.types.aws_rds_db_instance_endpoint.AwsRdsDbInstanceEndpoint"
    ]
    max_allocated_storage: NotRequired["capo_securityhub.types.integer.Integer"]
    """<p>The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.</p>"""

allocated_storage instance-attribute

allocated_storage: NotRequired[Integer]

The amount of storage (in gigabytes) to initially allocate for the DB instance.

associated_roles instance-attribute

associated_roles: NotRequired[AwsRdsDbInstanceAssociatedRoles]

The IAM roles associated with the DB instance.

auto_minor_version_upgrade instance-attribute

auto_minor_version_upgrade: NotRequired[Boolean]

Indicates whether minor version patches are applied automatically.

availability_zone instance-attribute

availability_zone: NotRequired[NonEmptyString]

The Availability Zone where the DB instance will be created.

backup_retention_period instance-attribute

backup_retention_period: NotRequired[Integer]

The number of days for which to retain automated backups.

ca_certificate_identifier instance-attribute

ca_certificate_identifier: NotRequired[NonEmptyString]

The identifier of the CA certificate for this DB instance.

character_set_name instance-attribute

character_set_name: NotRequired[NonEmptyString]

The name of the character set that this DB instance is associated with.

copy_tags_to_snapshot instance-attribute

copy_tags_to_snapshot: NotRequired[Boolean]

Whether to copy resource tags to snapshots of the DB instance.

db_cluster_identifier instance-attribute

db_cluster_identifier: NotRequired[NonEmptyString]

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

db_instance_class instance-attribute

db_instance_class: NotRequired[NonEmptyString]

Contains the name of the compute and memory capacity class of the DB instance.

db_instance_identifier instance-attribute

db_instance_identifier: NotRequired[NonEmptyString]

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

db_instance_port instance-attribute

db_instance_port: NotRequired[Integer]

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

db_instance_status instance-attribute

db_instance_status: NotRequired[NonEmptyString]

The current status of the DB instance.

db_name instance-attribute

db_name: NotRequired[NonEmptyString]

The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters don't apply to an Oracle DB instance.

db_parameter_groups instance-attribute

db_parameter_groups: NotRequired[AwsRdsDbParameterGroups]

A list of the DB parameter groups to assign to the DB instance.

db_security_groups instance-attribute

db_security_groups: NotRequired[StringList]

A list of the DB security groups to assign to the DB instance.

db_subnet_group instance-attribute

db_subnet_group: NotRequired[AwsRdsDbSubnetGroup]

Information about the subnet group that is associated with the DB instance.

dbi_resource_id instance-attribute

dbi_resource_id: NotRequired[NonEmptyString]

The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in CloudTrail log entries whenever the KMS key for the DB instance is accessed.

deletion_protection instance-attribute

deletion_protection: NotRequired[Boolean]

Indicates whether the DB instance has deletion protection enabled.

When deletion protection is enabled, the database cannot be deleted.

domain_memberships instance-attribute

domain_memberships: NotRequired[AwsRdsDbDomainMemberships]

The Active Directory domain membership records associated with the DB instance.

enabled_cloud_watch_logs_exports instance-attribute

enabled_cloud_watch_logs_exports: NotRequired[StringList]

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

endpoint instance-attribute

endpoint: NotRequired[AwsRdsDbInstanceEndpoint]

Specifies the connection endpoint.

engine instance-attribute

engine: NotRequired[NonEmptyString]

Provides the name of the database engine to use for this DB instance.

engine_version instance-attribute

engine_version: NotRequired[NonEmptyString]

Indicates the database engine version.

enhanced_monitoring_resource_arn instance-attribute

enhanced_monitoring_resource_arn: NotRequired[NonEmptyString]

The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.

iam_database_authentication_enabled instance-attribute

iam_database_authentication_enabled: NotRequired[Boolean]

True if mapping of IAM accounts to database accounts is enabled, and otherwise false.

IAM database authentication can be enabled for the following database engines.

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • Aurora 5.6 or higher

instance_create_time instance-attribute

instance_create_time: NotRequired[NonEmptyString]

Indicates when the DB instance was created.

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

iops instance-attribute

iops: NotRequired[Integer]

Specifies the provisioned IOPS (I/O operations per second) for this DB instance.

kms_key_id instance-attribute

kms_key_id: NotRequired[NonEmptyString]

If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.

latest_restorable_time instance-attribute

latest_restorable_time: NotRequired[NonEmptyString]

Specifies the latest time to which a database can be restored with point-in-time restore.

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

license_model instance-attribute

license_model: NotRequired[NonEmptyString]

License model information for this DB instance.

listener_endpoint instance-attribute

listener_endpoint: NotRequired[AwsRdsDbInstanceEndpoint]

master_username instance-attribute

master_username: NotRequired[NonEmptyString]

The master user name of the DB instance.

max_allocated_storage instance-attribute

max_allocated_storage: NotRequired[Integer]

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

monitoring_interval instance-attribute

monitoring_interval: NotRequired[Integer]

The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.

monitoring_role_arn instance-attribute

monitoring_role_arn: NotRequired[NonEmptyString]

The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.

multi_az instance-attribute

multi_az: NotRequired[Boolean]

Whether the DB instance is a multiple Availability Zone deployment.

option_group_memberships instance-attribute

option_group_memberships: NotRequired[AwsRdsDbOptionGroupMemberships]

The list of option group memberships for this DB instance.

pending_modified_values instance-attribute

pending_modified_values: NotRequired[AwsRdsDbPendingModifiedValues]

Changes to the DB instance that are currently pending.

performance_insights_enabled instance-attribute

performance_insights_enabled: NotRequired[Boolean]

Indicates whether Performance Insights is enabled for the DB instance.

performance_insights_kms_key_id instance-attribute

performance_insights_kms_key_id: NotRequired[NonEmptyString]

The identifier of the KMS key used to encrypt the Performance Insights data.

performance_insights_retention_period instance-attribute

performance_insights_retention_period: NotRequired[Integer]

The number of days to retain Performance Insights data.

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.

processor_features instance-attribute

processor_features: NotRequired[AwsRdsDbProcessorFeatures]

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

promotion_tier instance-attribute

promotion_tier: NotRequired[Integer]

The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.

publicly_accessible instance-attribute

publicly_accessible: NotRequired[Boolean]

Specifies the accessibility options for the DB instance.

A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address.

A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

read_replica_db_cluster_identifiers instance-attribute

read_replica_db_cluster_identifiers: NotRequired[StringList]

List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.

read_replica_db_instance_identifiers instance-attribute

read_replica_db_instance_identifiers: NotRequired[StringList]

List of identifiers of the read replicas associated with this DB instance.

read_replica_source_db_instance_identifier instance-attribute

read_replica_source_db_instance_identifier: NotRequired[NonEmptyString]

If this DB instance is a read replica, contains the identifier of the source DB instance.

secondary_availability_zone instance-attribute

secondary_availability_zone: NotRequired[NonEmptyString]

For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.

status_infos instance-attribute

status_infos: NotRequired[AwsRdsDbStatusInfos]

The status of a read replica. If the instance isn't a read replica, this is empty.

storage_encrypted instance-attribute

storage_encrypted: NotRequired[Boolean]

Specifies whether the DB instance is encrypted.

storage_type instance-attribute

storage_type: NotRequired[NonEmptyString]

The storage type for the DB instance.

tde_credential_arn instance-attribute

tde_credential_arn: NotRequired[NonEmptyString]

The ARN from the key store with which the instance is associated for TDE encryption.

timezone instance-attribute

timezone: NotRequired[NonEmptyString]

The time zone of the DB instance.

vpc_security_groups instance-attribute

vpc_security_groups: NotRequired[AwsRdsDbInstanceVpcSecurityGroups]

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