DBInstance ¶

class DBInstance(TypedDict, closed=True):
    db_instance_identifier: NotRequired["capo_docdb.types.string.String"]
    """<p>Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.</p>"""
    db_instance_class: NotRequired["capo_docdb.types.string.String"]
    """<p>Contains the name of the compute and memory capacity class of the instance.</p>"""
    engine: NotRequired["capo_docdb.types.string.String"]
    """<p>Provides the name of the database engine to be used for this instance.</p>"""
    db_instance_status: NotRequired["capo_docdb.types.string.String"]
    """<p>Specifies the current state of this database.</p>"""
    endpoint: NotRequired["capo_docdb.types.endpoint.Endpoint"]
    """<p>Specifies the connection endpoint.</p>"""
    instance_create_time: NotRequired["capo_docdb.types.t_stamp.TStamp"]
    """<p>Provides the date and time that the instance was created.</p>"""
    preferred_backup_window: NotRequired["capo_docdb.types.string.String"]
    """<p> Specifies 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_docdb.types.integer.Integer"]
    """<p>Specifies the number of days for which automatic snapshots are retained.</p>"""
    vpc_security_groups: NotRequired[
        "capo_docdb.types.vpc_security_group_membership_list.VpcSecurityGroupMembershipList"
    ]
    """<p>Provides a list of VPC security group elements that the instance belongs to.</p>"""
    availability_zone: NotRequired["capo_docdb.types.string.String"]
    """<p>Specifies the name of the Availability Zone that the instance is located in.</p>"""
    db_subnet_group: NotRequired["capo_docdb.types.db_subnet_group.DBSubnetGroup"]
    """<p>Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.</p>"""
    preferred_maintenance_window: NotRequired["capo_docdb.types.string.String"]
    """<p>Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p>"""
    pending_modified_values: NotRequired[
        "capo_docdb.types.pending_modified_values.PendingModifiedValues"
    ]
    """<p>Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.</p>"""
    latest_restorable_time: NotRequired["capo_docdb.types.t_stamp.TStamp"]
    """<p>Specifies the latest time to which a database can be restored with point-in-time restore.</p>"""
    engine_version: NotRequired["capo_docdb.types.string.String"]
    """<p>Indicates the database engine version.</p>"""
    auto_minor_version_upgrade: NotRequired["capo_docdb.types.boolean.Boolean"]
    """<p>Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.</p>"""
    publicly_accessible: NotRequired["capo_docdb.types.boolean.Boolean"]
    """<p>Not supported. Amazon DocumentDB does not currently support public endpoints. The value of <code>PubliclyAccessible</code> is always <code>false</code>.</p>"""
    status_infos: NotRequired[
        "capo_docdb.types.db_instance_status_info_list.DBInstanceStatusInfoList"
    ]
    """<p>The status of a read replica. If the instance is not a read replica, this is blank.</p>"""
    db_cluster_identifier: NotRequired["capo_docdb.types.string.String"]
    """<p>Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.</p>"""
    storage_encrypted: NotRequired["capo_docdb.types.boolean.Boolean"]
    """<p>Specifies whether or not the instance is encrypted.</p>"""
    kms_key_id: NotRequired["capo_docdb.types.string.String"]
    """<p> If <code>StorageEncrypted</code> is <code>true</code>, the KMS key identifier for the encrypted instance. </p>"""
    dbi_resource_id: NotRequired["capo_docdb.types.string.String"]
    """<p>The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.</p>"""
    ca_certificate_identifier: NotRequired["capo_docdb.types.string.String"]
    """<p>The identifier of the CA certificate for this DB instance.</p>"""
    copy_tags_to_snapshot: NotRequired[
        "capo_docdb.types.boolean_optional.BooleanOptional"
    ]
    """<p>A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.</p>"""
    promotion_tier: NotRequired["capo_docdb.types.integer_optional.IntegerOptional"]
    """<p>A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.</p>"""
    db_instance_arn: NotRequired["capo_docdb.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the instance.</p>"""
    enabled_cloudwatch_logs_exports: NotRequired[
        "capo_docdb.types.log_type_list.LogTypeList"
    ]
    """<p>A list of log types that this instance is configured to export to CloudWatch Logs.</p>"""
    certificate_details: NotRequired[
        "capo_docdb.types.certificate_details.CertificateDetails"
    ]
    """<p>The details of the DB instance's server certificate.</p>"""
    performance_insights_enabled: NotRequired[
        "capo_docdb.types.boolean_optional.BooleanOptional"
    ]
    """<p>Set to <code>true</code> if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise <code>false</code>.</p>"""
    performance_insights_kms_key_id: NotRequired["capo_docdb.types.string.String"]
    """<p>The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.</p>"""