Skip to content

DBInstance

Source code in docs_src/capo_rds/types/db_instance.py
class DBInstance(TypedDict, closed=True):
    db_instance_identifier: NotRequired["capo_rds.types.string.String"]
    """<p>The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.</p>"""
    db_instance_class: NotRequired["capo_rds.types.string.String"]
    """<p>The name of the compute and memory capacity class of the DB instance.</p>"""
    engine: NotRequired["capo_rds.types.string.String"]
    """<p>The database engine used for this DB instance.</p>"""
    db_instance_status: NotRequired["capo_rds.types.string.String"]
    """<p>The current state of this database.</p> <p>For information about DB instance statuses, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/accessing-monitoring.html#Overview.DBInstance.Status">Viewing DB instance status</a> in the <i>Amazon RDS User Guide.</i> </p>"""
    master_username: NotRequired["capo_rds.types.string.String"]
    """<p>The master username for the DB instance.</p>"""
    db_name: NotRequired["capo_rds.types.string.String"]
    """<p>The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.</p>"""
    endpoint: NotRequired["capo_rds.types.endpoint.Endpoint"]
    """<p>The connection endpoint for the DB instance.</p> <note> <p>The endpoint might not be shown for instances with the status of <code>creating</code>.</p> </note>"""
    allocated_storage: NotRequired["capo_rds.types.integer.Integer"]
    """<p>The amount of storage in gibibytes (GiB) allocated for the DB instance.</p>"""
    instance_create_time: NotRequired["capo_rds.types.t_stamp.TStamp"]
    """<p>The date and time when the DB instance was created.</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>"""
    backup_retention_period: NotRequired["capo_rds.types.integer.Integer"]
    """<p>The number of days for which automatic DB snapshots are retained.</p>"""
    db_security_groups: NotRequired[
        "capo_rds.types.db_security_group_membership_list.DBSecurityGroupMembershipList"
    ]
    """<p>A list of DB security group elements containing <code>DBSecurityGroup.Name</code> and <code>DBSecurityGroup.Status</code> subelements.</p>"""
    vpc_security_groups: NotRequired[
        "capo_rds.types.vpc_security_group_membership_list.VpcSecurityGroupMembershipList"
    ]
    """<p>The list of Amazon EC2 VPC security groups that the DB instance belongs to.</p>"""
    db_parameter_groups: NotRequired[
        "capo_rds.types.db_parameter_group_status_list.DBParameterGroupStatusList"
    ]
    """<p>The list of DB parameter groups applied to this DB instance.</p>"""
    availability_zone: NotRequired["capo_rds.types.string.String"]
    """<p>The name of the Availability Zone where the DB instance is located.</p>"""
    db_subnet_group: NotRequired["capo_rds.types.db_subnet_group.DBSubnetGroup"]
    """<p>Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.</p>"""
    preferred_maintenance_window: NotRequired["capo_rds.types.string.String"]
    """<p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p>"""
    upgrade_rollout_order: NotRequired[
        "capo_rds.types.upgrade_rollout_order.UpgradeRolloutOrder"
    ]
    """<p>This data type represents the order in which the instances are upgraded.</p> <ul> <li> <p>[first] - Typically used for development or testing environments.</p> </li> <li> <p>[second] - Default order for resources not specifically configured.</p> </li> <li> <p>[last] - Usually reserved for production environments.</p> </li> </ul>"""
    pending_modified_values: NotRequired[
        "capo_rds.types.pending_modified_values.PendingModifiedValues"
    ]
    """<p>Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.</p>"""
    latest_restorable_time: NotRequired["capo_rds.types.t_stamp.TStamp"]
    """<p>The latest time to which a database in this DB instance can be restored with point-in-time restore.</p>"""
    multi_az: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.</p>"""
    engine_version: NotRequired["capo_rds.types.string.String"]
    """<p>The version of the database engine.</p>"""
    auto_minor_version_upgrade: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether minor version patches are applied automatically.</p> <p>For more information about automatic minor version upgrades, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades">Automatically upgrading the minor engine version</a>.</p>"""
    read_replica_source_db_instance_identifier: NotRequired[
        "capo_rds.types.string.String"
    ]
    """<p>The identifier of the source DB instance if this DB instance is a read replica.</p>"""
    read_replica_db_instance_identifiers: NotRequired[
        "capo_rds.types.read_replica_db_instance_identifier_list.ReadReplicaDBInstanceIdentifierList"
    ]
    """<p>The identifiers of the read replicas associated with this DB instance.</p>"""
    read_replica_db_cluster_identifiers: NotRequired[
        "capo_rds.types.read_replica_db_cluster_identifier_list.ReadReplicaDBClusterIdentifierList"
    ]
    """<p>The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.</p> <note> <p>Currently, each RDS DB instance can have only one Aurora read replica.</p> </note>"""
    replica_mode: NotRequired["capo_rds.types.replica_mode.ReplicaMode"]
    """<p>The open mode of a Db2 or an Oracle read replica. The default is <code>open-read-only</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html">Working with replicas for Amazon RDS for Db2</a> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Working with read replicas for Amazon RDS for Oracle</a> in the <i>Amazon RDS User Guide</i>. </p> <note> <p>This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom for Oracle.</p> </note>"""
    license_model: NotRequired["capo_rds.types.string.String"]
    """<p>The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.</p>"""
    iops: NotRequired["capo_rds.types.integer_optional.IntegerOptional"]
    """<p>The Provisioned IOPS (I/O operations per second) value for the DB instance.</p>"""
    storage_throughput: NotRequired["capo_rds.types.integer_optional.IntegerOptional"]
    """<p>The storage throughput for the DB instance.</p> <p>This setting applies only to the <code>gp3</code> storage type.</p>"""
    option_group_memberships: NotRequired[
        "capo_rds.types.option_group_membership_list.OptionGroupMembershipList"
    ]
    """<p>The list of option group memberships for this DB instance.</p>"""
    character_set_name: NotRequired["capo_rds.types.string.String"]
    """<p>If present, specifies the name of the character set that this instance is associated with.</p>"""
    nchar_character_set_name: NotRequired["capo_rds.types.string.String"]
    """<p>The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.</p>"""
    secondary_availability_zone: NotRequired["capo_rds.types.string.String"]
    """<p>If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.</p>"""
    publicly_accessible: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether the DB instance is publicly accessible.</p> <p>When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.</p> <p>When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.</p> <p>For more information, see <a>CreateDBInstance</a>.</p>"""
    status_infos: NotRequired[
        "capo_rds.types.db_instance_status_info_list.DBInstanceStatusInfoList"
    ]
    """<p>The status of a read replica. If the DB instance isn't a read replica, the value is blank.</p>"""
    storage_type: NotRequired["capo_rds.types.string.String"]
    """<p>The storage type associated with the DB instance.</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 DB instance. Possible values:</p> <ul> <li> <p> <code>none</code> - The DB instance is not encrypted.</p> </li> <li> <p> <code>sse-rds</code> - The DB instance is encrypted using an Amazon Web Services owned KMS key.</p> </li> <li> <p> <code>sse-kms</code> - The DB instance is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.</p> </li> </ul>"""
    tde_credential_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The ARN from the key store with which the instance is associated for TDE encryption.</p>"""
    db_instance_port: NotRequired["capo_rds.types.integer.Integer"]
    """<p>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>"""
    db_cluster_identifier: NotRequired["capo_rds.types.string.String"]
    """<p>If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.</p>"""
    storage_encrypted: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether the DB instance is encrypted.</p>"""
    kms_key_id: NotRequired["capo_rds.types.string.String"]
    """<p>If <code>StorageEncrypted</code> is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance.</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>"""
    dbi_resource_id: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.</p>"""
    ca_certificate_identifier: NotRequired["capo_rds.types.string.String"]
    """<p>The identifier of the CA certificate for this DB instance.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html">Using SSL/TLS to encrypt a connection to a DB instance</a> in the <i>Amazon RDS User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html"> Using SSL/TLS to encrypt a connection to a DB cluster</a> in the <i>Amazon Aurora User Guide</i>.</p>"""
    domain_memberships: NotRequired[
        "capo_rds.types.domain_membership_list.DomainMembershipList"
    ]
    """<p>The Active Directory Domain membership records associated with the DB instance.</p>"""
    copy_tags_to_snapshot: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether tags are copied from the DB instance to snapshots of the DB instance.</p> <p>This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see <code>DBCluster</code>.</p>"""
    monitoring_interval: NotRequired["capo_rds.types.integer_optional.IntegerOptional"]
    """<p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.</p>"""
    enhanced_monitoring_resource_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.</p>"""
    monitoring_role_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.</p>"""
    promotion_tier: NotRequired["capo_rds.types.integer_optional.IntegerOptional"]
    """<p>The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance"> Fault Tolerance for an Aurora DB Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p>"""
    db_instance_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the DB instance.</p>"""
    timezone: NotRequired["capo_rds.types.string.String"]
    """<p>The time zone of the DB instance. In most cases, the <code>Timezone</code> element is empty. <code>Timezone</code> content appears only for RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified.</p>"""
    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 for the DB instance.</p> <p>For a list of engine versions that support IAM database authentication, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.html">IAM database authentication</a> in the <i>Amazon RDS User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.Aurora_Fea_Regions_DB-eng.Feature.IAMdbauth.html">IAM database authentication in Aurora</a> in the <i>Amazon Aurora User Guide</i>.</p>"""
    database_insights_mode: NotRequired[
        "capo_rds.types.database_insights_mode.DatabaseInsightsMode"
    ]
    """<p>The mode of Database Insights that is enabled for the instance.</p>"""
    performance_insights_enabled: NotRequired[
        "capo_rds.types.boolean_optional.BooleanOptional"
    ]
    """<p>Indicates whether Performance Insights is enabled for the DB instance.</p>"""
    performance_insights_kms_key_id: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Web Services KMS key identifier for encryption of Performance Insights data.</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>"""
    performance_insights_retention_period: NotRequired[
        "capo_rds.types.integer_optional.IntegerOptional"
    ]
    """<p>The number of days to retain Performance Insights data.</p> <p>Valid Values:</p> <ul> <li> <p> <code>7</code> </p> </li> <li> <p> <i>month</i> * 31, where <i>month</i> is a number of months from 1-23. Examples: <code>93</code> (3 months * 31), <code>341</code> (11 months * 31), <code>589</code> (19 months * 31)</p> </li> <li> <p> <code>731</code> </p> </li> </ul> <p>Default: <code>7</code> days</p>"""
    enabled_cloudwatch_logs_exports: NotRequired[
        "capo_rds.types.log_type_list.LogTypeList"
    ]
    """<p>A list of log types that this DB instance is configured to export to CloudWatch Logs.</p> <p>Log types vary by DB engine. For information about the log types for each DB engine, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html">Monitoring Amazon RDS log files</a> in the <i>Amazon RDS User Guide.</i> </p>"""
    processor_features: NotRequired[
        "capo_rds.types.processor_feature_list.ProcessorFeatureList"
    ]
    """<p>The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.</p>"""
    deletion_protection: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html"> Deleting a DB Instance</a>.</p>"""
    associated_roles: NotRequired["capo_rds.types.db_instance_roles.DBInstanceRoles"]
    """<p>The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.</p>"""
    listener_endpoint: NotRequired["capo_rds.types.endpoint.Endpoint"]
    """<p>The listener connection endpoint for SQL Server Always On.</p>"""
    max_allocated_storage: NotRequired[
        "capo_rds.types.integer_optional.IntegerOptional"
    ]
    """<p>The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.</p>"""
    tag_list: NotRequired["capo_rds.types.tag_list.TagList"]
    automation_mode: NotRequired["capo_rds.types.automation_mode.AutomationMode"]
    """<p>The automation mode of the RDS Custom DB instance: <code>full</code> or <code>all paused</code>. If <code>full</code>, the DB instance automates monitoring and instance recovery. If <code>all paused</code>, the instance pauses automation for the duration set by <code>--resume-full-automation-mode-minutes</code>.</p>"""
    resume_full_automation_mode_time: NotRequired["capo_rds.types.t_stamp.TStamp"]
    """<p>The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.</p>"""
    customer_owned_ip_enabled: NotRequired[
        "capo_rds.types.boolean_optional.BooleanOptional"
    ]
    """<p>Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.</p> <p>A <i>CoIP </i>provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.</p> <p>For more information about RDS on Outposts, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html">Working with Amazon RDS on Amazon Web Services Outposts</a> in the <i>Amazon RDS User Guide</i>.</p> <p>For more information about CoIPs, see <a href="https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing">Customer-owned IP addresses</a> in the <i>Amazon Web Services Outposts User Guide</i>.</p>"""
    network_type: NotRequired["capo_rds.types.string.String"]
    """<p>The network type of the DB instance.</p> <p>The network type is determined by the <code>DBSubnetGroup</code> specified for the DB instance. A <code>DBSubnetGroup</code> can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (<code>DUAL</code>).</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html"> Working with a DB instance in a VPC</a> in the <i>Amazon RDS User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html"> Working with a DB instance in a VPC</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>Valid Values: <code>IPV4 | DUAL</code> </p>"""
    activity_stream_status: NotRequired[
        "capo_rds.types.activity_stream_status.ActivityStreamStatus"
    ]
    """<p>The status of the database activity stream.</p>"""
    activity_stream_kms_key_id: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>"""
    activity_stream_kinesis_stream_name: NotRequired["capo_rds.types.string.String"]
    """<p>The name of the Amazon Kinesis data stream used for the database activity stream.</p>"""
    activity_stream_mode: NotRequired[
        "capo_rds.types.activity_stream_mode.ActivityStreamMode"
    ]
    """<p>The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.</p>"""
    activity_stream_engine_native_audit_fields_included: NotRequired[
        "capo_rds.types.boolean_optional.BooleanOptional"
    ]
    """<p>Indicates whether engine-native audit fields are included in the database activity stream.</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>"""
    db_instance_automated_backups_replications: NotRequired[
        "capo_rds.types.db_instance_automated_backups_replication_list.DBInstanceAutomatedBackupsReplicationList"
    ]
    """<p>The list of replicated automated backups associated with the DB instance.</p>"""
    backup_target: NotRequired["capo_rds.types.string.String"]
    """<p>The location where automated backups and manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.</p>"""
    automatic_restart_time: NotRequired["capo_rds.types.t_stamp.TStamp"]
    """<p>The time when a stopped DB instance is restarted automatically.</p>"""
    custom_iam_instance_profile: NotRequired["capo_rds.types.string.String"]
    """<p>The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:</p> <ul> <li> <p>The profile must exist in your account.</p> </li> <li> <p>The profile must have an IAM role that Amazon EC2 has permissions to assume.</p> </li> <li> <p>The instance profile name and the associated IAM role name must start with the prefix <code>AWSRDSCustom</code>.</p> </li> </ul> <p>For the list of permissions required for the IAM role, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc"> Configure IAM and your VPC</a> in the <i>Amazon RDS User Guide</i>.</p>"""
    activity_stream_policy_status: NotRequired[
        "capo_rds.types.activity_stream_policy_status.ActivityStreamPolicyStatus"
    ]
    """<p>The status of the policy state of the activity stream.</p>"""
    certificate_details: NotRequired[
        "capo_rds.types.certificate_details.CertificateDetails"
    ]
    """<p>The details of the DB instance's server certificate.</p>"""
    db_system_id: NotRequired["capo_rds.types.string.String"]
    """<p>The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.</p>"""
    master_user_secret: NotRequired[
        "capo_rds.types.master_user_secret.MasterUserSecret"
    ]
    """<p>The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html">Password management with Amazon Web Services Secrets Manager</a> in the <i>Amazon RDS User Guide.</i> </p>"""
    read_replica_source_db_cluster_identifier: NotRequired[
        "capo_rds.types.string.String"
    ]
    """<p>The identifier of the source DB cluster if this DB instance is a read replica.</p>"""
    percent_progress: NotRequired["capo_rds.types.string.String"]
    """<p>The progress of the storage optimization operation as a percentage.</p>"""
    multi_tenant: NotRequired["capo_rds.types.boolean_optional.BooleanOptional"]
    """<p>Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).</p>"""
    dedicated_log_volume: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether the DB instance has a dedicated log volume (DLV) enabled.</p>"""
    is_storage_config_upgrade_available: NotRequired[
        "capo_rds.types.boolean_optional.BooleanOptional"
    ]
    """<p>Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.UpgradeFileSystem">Upgrading the storage file system for a DB instance</a>.</p>"""
    engine_lifecycle_support: NotRequired["capo_rds.types.string.String"]
    """<p>The lifecycle type for the DB instance.</p> <p>For more information, see CreateDBInstance.</p>"""
    additional_storage_volumes: NotRequired[
        "capo_rds.types.additional_storage_volumes_output_list.AdditionalStorageVolumesOutputList"
    ]
    """<p>The additional storage volumes associated with the DB instance. RDS supports additional storage volumes for RDS for Oracle and RDS for SQL Server.</p>"""
    storage_volume_status: NotRequired["capo_rds.types.string.String"]
    """<p>The detailed status information for storage volumes associated with the DB instance. This information helps identify which specific volume is causing the instance to be in a storage-full state.</p>"""
    storage_operation_status: NotRequired["capo_rds.types.string.String"]
    """<p>The status of an in-progress storage operation on the DB instance. This field appears only while a storage operation is in progress. It isn't present when no storage operation is active. Possible values:</p> <ul> <li> <p> <code>Initializing</code> - The volume is initializing from a snapshot, such as during a snapshot restore, point-in-time restore, read replica creation, or blue/green deployment. Performance can be lower than provisioned until initialization completes.</p> </li> <li> <p> <code>Optimizing</code> - The volume is optimizing following a storage scaling or modification operation.</p> </li> </ul>"""
    storage_operation_percent_progress: NotRequired[
        "capo_rds.types.integer_optional.IntegerOptional"
    ]
    """<p>The percentage of the in-progress storage operation on the DB instance that has completed, from <code>0</code> to <code>100</code>. This field appears only while a storage operation is in progress. It isn't present when no storage operation is active.</p>"""

activity_stream_engine_native_audit_fields_included instance-attribute

activity_stream_engine_native_audit_fields_included: NotRequired[BooleanOptional]

Indicates whether engine-native audit fields are included in the database activity stream.

activity_stream_kinesis_stream_name instance-attribute

activity_stream_kinesis_stream_name: NotRequired[String]

The name of the Amazon Kinesis data stream used for the database activity stream.

activity_stream_kms_key_id instance-attribute

activity_stream_kms_key_id: NotRequired[String]

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

activity_stream_mode instance-attribute

activity_stream_mode: NotRequired[ActivityStreamMode]

The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.

activity_stream_policy_status instance-attribute

activity_stream_policy_status: NotRequired[ActivityStreamPolicyStatus]

The status of the policy state of the activity stream.

activity_stream_status instance-attribute

activity_stream_status: NotRequired[ActivityStreamStatus]

The status of the database activity stream.

additional_storage_volumes instance-attribute

additional_storage_volumes: NotRequired[AdditionalStorageVolumesOutputList]

The additional storage volumes associated with the DB instance. RDS supports additional storage volumes for RDS for Oracle and RDS for SQL Server.

allocated_storage instance-attribute

allocated_storage: NotRequired[Integer]

The amount of storage in gibibytes (GiB) allocated for the DB instance.

associated_roles instance-attribute

associated_roles: NotRequired[DBInstanceRoles]

The Amazon Web Services Identity and Access Management (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.

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

automatic_restart_time instance-attribute

automatic_restart_time: NotRequired[TStamp]

The time when a stopped DB instance is restarted automatically.

automation_mode instance-attribute

automation_mode: NotRequired[AutomationMode]

The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.

availability_zone instance-attribute

availability_zone: NotRequired[String]

The name of the Availability Zone where the DB instance is located.

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[Integer]

The number of days for which automatic DB snapshots are retained.

backup_target instance-attribute

backup_target: NotRequired[String]

The location where automated backups and manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.

ca_certificate_identifier instance-attribute

ca_certificate_identifier: NotRequired[String]

The identifier of the CA certificate for this DB instance.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

certificate_details instance-attribute

certificate_details: NotRequired[CertificateDetails]

The details of the DB instance's server certificate.

character_set_name instance-attribute

character_set_name: NotRequired[String]

If present, specifies the name of the character set that this instance is associated with.

copy_tags_to_snapshot instance-attribute

copy_tags_to_snapshot: NotRequired[Boolean]

Indicates whether tags are copied from the DB instance to snapshots of the DB instance.

This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

custom_iam_instance_profile instance-attribute

custom_iam_instance_profile: NotRequired[String]

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

  • The profile must exist in your account.

  • The profile must have an IAM role that Amazon EC2 has permissions to assume.

  • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

customer_owned_ip_enabled instance-attribute

customer_owned_ip_enabled: NotRequired[BooleanOptional]

Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

database_insights_mode instance-attribute

database_insights_mode: NotRequired[DatabaseInsightsMode]

The mode of Database Insights that is enabled for the instance.

db_cluster_identifier instance-attribute

db_cluster_identifier: NotRequired[String]

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

db_instance_arn instance-attribute

db_instance_arn: NotRequired[String]

The Amazon Resource Name (ARN) for the DB instance.

db_instance_automated_backups_replications instance-attribute

db_instance_automated_backups_replications: NotRequired[
    DBInstanceAutomatedBackupsReplicationList
]

The list of replicated automated backups associated with the DB instance.

db_instance_class instance-attribute

db_instance_class: NotRequired[String]

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

db_instance_identifier instance-attribute

db_instance_identifier: NotRequired[String]

The 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]

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[String]

The current state of this database.

For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.

db_name instance-attribute

db_name: NotRequired[String]

The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.

db_parameter_groups instance-attribute

db_parameter_groups: NotRequired[DBParameterGroupStatusList]

The list of DB parameter groups applied to this DB instance.

db_security_groups instance-attribute

db_security_groups: NotRequired[DBSecurityGroupMembershipList]

A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

db_subnet_group instance-attribute

db_subnet_group: NotRequired[DBSubnetGroup]

Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

db_system_id instance-attribute

db_system_id: NotRequired[String]

The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.

dbi_resource_id instance-attribute

dbi_resource_id: NotRequired[String]

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

dedicated_log_volume instance-attribute

dedicated_log_volume: NotRequired[Boolean]

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

deletion_protection instance-attribute

deletion_protection: NotRequired[Boolean]

Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.

domain_memberships instance-attribute

domain_memberships: NotRequired[DomainMembershipList]

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

enabled_cloudwatch_logs_exports instance-attribute

enabled_cloudwatch_logs_exports: NotRequired[LogTypeList]

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

Log types vary by DB engine. For information about the log types for each DB engine, see Monitoring Amazon RDS log files in the Amazon RDS User Guide.

endpoint instance-attribute

endpoint: NotRequired[Endpoint]

The connection endpoint for the DB instance.

The endpoint might not be shown for instances with the status of creating.

engine instance-attribute

engine: NotRequired[String]

The database engine used for this DB instance.

engine_lifecycle_support instance-attribute

engine_lifecycle_support: NotRequired[String]

The lifecycle type for the DB instance.

For more information, see CreateDBInstance.

engine_version instance-attribute

engine_version: NotRequired[String]

The version of the database engine.

enhanced_monitoring_resource_arn instance-attribute

enhanced_monitoring_resource_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the Amazon 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]

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

For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.

instance_create_time instance-attribute

instance_create_time: NotRequired[TStamp]

The date and time when the DB instance was created.

iops instance-attribute

iops: NotRequired[IntegerOptional]

The Provisioned IOPS (I/O operations per second) value for the DB instance.

is_storage_config_upgrade_available instance-attribute

is_storage_config_upgrade_available: NotRequired[BooleanOptional]

Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see Upgrading the storage file system for a DB instance.

kms_key_id instance-attribute

kms_key_id: NotRequired[String]

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

latest_restorable_time instance-attribute

latest_restorable_time: NotRequired[TStamp]

The latest time to which a database in this DB instance can be restored with point-in-time restore.

license_model instance-attribute

license_model: NotRequired[String]

The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

listener_endpoint instance-attribute

listener_endpoint: NotRequired[Endpoint]

The listener connection endpoint for SQL Server Always On.

master_user_secret instance-attribute

master_user_secret: NotRequired[MasterUserSecret]

The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

master_username instance-attribute

master_username: NotRequired[String]

The master username for the DB instance.

max_allocated_storage instance-attribute

max_allocated_storage: NotRequired[IntegerOptional]

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

monitoring_interval instance-attribute

monitoring_interval: NotRequired[IntegerOptional]

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[String]

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

multi_az instance-attribute

multi_az: NotRequired[Boolean]

Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.

multi_tenant instance-attribute

multi_tenant: NotRequired[BooleanOptional]

Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

nchar_character_set_name instance-attribute

nchar_character_set_name: NotRequired[String]

The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

network_type instance-attribute

network_type: NotRequired[String]

The network type of the DB instance.

The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.

Valid Values: IPV4 | DUAL

option_group_memberships instance-attribute

option_group_memberships: NotRequired[OptionGroupMembershipList]

The list of option group memberships for this DB instance.

pending_modified_values instance-attribute

pending_modified_values: NotRequired[PendingModifiedValues]

Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.

percent_progress instance-attribute

percent_progress: NotRequired[String]

The progress of the storage optimization operation as a percentage.

performance_insights_enabled instance-attribute

performance_insights_enabled: NotRequired[BooleanOptional]

Indicates whether Performance Insights is enabled for the DB instance.

performance_insights_kms_key_id instance-attribute

performance_insights_kms_key_id: NotRequired[String]

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

performance_insights_retention_period instance-attribute

performance_insights_retention_period: NotRequired[IntegerOptional]

The number of days to retain Performance Insights data.

Valid Values:

  • 7

  • month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

  • 731

Default: 7 days

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.

preferred_maintenance_window instance-attribute

preferred_maintenance_window: NotRequired[String]

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

processor_features instance-attribute

processor_features: NotRequired[ProcessorFeatureList]

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[IntegerOptional]

The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

publicly_accessible instance-attribute

publicly_accessible: NotRequired[Boolean]

Indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

read_replica_db_cluster_identifiers instance-attribute

read_replica_db_cluster_identifiers: NotRequired[ReadReplicaDBClusterIdentifierList]

The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.

Currently, each RDS DB instance can have only one Aurora read replica.

read_replica_db_instance_identifiers instance-attribute

read_replica_db_instance_identifiers: NotRequired[ReadReplicaDBInstanceIdentifierList]

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

read_replica_source_db_cluster_identifier instance-attribute

read_replica_source_db_cluster_identifier: NotRequired[String]

The identifier of the source DB cluster if this DB instance is a read replica.

read_replica_source_db_instance_identifier instance-attribute

read_replica_source_db_instance_identifier: NotRequired[String]

The identifier of the source DB instance if this DB instance is a read replica.

replica_mode instance-attribute

replica_mode: NotRequired[ReplicaMode]

The open mode of a Db2 or an Oracle read replica. The default is open-read-only. For more information, see Working with replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the Amazon RDS User Guide.

This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom for Oracle.

resume_full_automation_mode_time instance-attribute

resume_full_automation_mode_time: NotRequired[TStamp]

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

secondary_availability_zone instance-attribute

secondary_availability_zone: NotRequired[String]

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

status_infos instance-attribute

status_infos: NotRequired[DBInstanceStatusInfoList]

The status of a read replica. If the DB instance isn't a read replica, the value is blank.

storage_encrypted instance-attribute

storage_encrypted: NotRequired[Boolean]

Indicates whether the DB instance is encrypted.

storage_encryption_type instance-attribute

storage_encryption_type: NotRequired[StorageEncryptionType]

The type of encryption used to protect data at rest in the DB instance. Possible values:

  • none - The DB instance is not encrypted.

  • sse-rds - The DB instance is encrypted using an Amazon Web Services owned KMS key.

  • sse-kms - The DB instance is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.

storage_operation_percent_progress instance-attribute

storage_operation_percent_progress: NotRequired[IntegerOptional]

The percentage of the in-progress storage operation on the DB instance that has completed, from 0 to 100. This field appears only while a storage operation is in progress. It isn't present when no storage operation is active.

storage_operation_status instance-attribute

storage_operation_status: NotRequired[String]

The status of an in-progress storage operation on the DB instance. This field appears only while a storage operation is in progress. It isn't present when no storage operation is active. Possible values:

  • Initializing - The volume is initializing from a snapshot, such as during a snapshot restore, point-in-time restore, read replica creation, or blue/green deployment. Performance can be lower than provisioned until initialization completes.

  • Optimizing - The volume is optimizing following a storage scaling or modification operation.

storage_throughput instance-attribute

storage_throughput: NotRequired[IntegerOptional]

The storage throughput for the DB instance.

This setting applies only to the gp3 storage type.

storage_type instance-attribute

storage_type: NotRequired[String]

The storage type associated with the DB instance.

storage_volume_status instance-attribute

storage_volume_status: NotRequired[String]

The detailed status information for storage volumes associated with the DB instance. This information helps identify which specific volume is causing the instance to be in a storage-full state.

tag_list instance-attribute

tag_list: NotRequired[TagList]

tde_credential_arn instance-attribute

tde_credential_arn: NotRequired[String]

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

timezone instance-attribute

timezone: NotRequired[String]

The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified.

upgrade_rollout_order instance-attribute

upgrade_rollout_order: NotRequired[UpgradeRolloutOrder]

This data type represents the order in which the instances are upgraded.

  • [first] - Typically used for development or testing environments.

  • [second] - Default order for resources not specifically configured.

  • [last] - Usually reserved for production environments.

vpc_security_groups instance-attribute

vpc_security_groups: NotRequired[VpcSecurityGroupMembershipList]

The list of Amazon EC2 VPC security groups that the DB instance belongs to.