DBCluster ¶

class DBCluster(TypedDict, closed=True):
    availability_zones: NotRequired[
        "capo_docdb.types.availability_zones.AvailabilityZones"
    ]
    """<p>Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.</p>"""
    backup_retention_period: NotRequired[
        "capo_docdb.types.integer_optional.IntegerOptional"
    ]
    """<p>Specifies the number of days for which automatic snapshots are retained.</p>"""
    db_cluster_identifier: NotRequired["capo_docdb.types.string.String"]
    """<p>Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.</p>"""
    db_cluster_parameter_group: NotRequired["capo_docdb.types.string.String"]
    """<p>Specifies the name of the cluster parameter group for the cluster.</p>"""
    db_subnet_group: NotRequired["capo_docdb.types.string.String"]
    """<p>Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.</p>"""
    status: NotRequired["capo_docdb.types.string.String"]
    """<p>Specifies the current state of this cluster.</p>"""
    percent_progress: NotRequired["capo_docdb.types.string.String"]
    """<p>Specifies the progress of the operation as a percentage.</p>"""
    earliest_restorable_time: NotRequired["capo_docdb.types.t_stamp.TStamp"]
    """<p>The earliest time to which a database can be restored with point-in-time restore.</p>"""
    endpoint: NotRequired["capo_docdb.types.string.String"]
    """<p>Specifies the connection endpoint for the primary instance of the cluster.</p>"""
    reader_endpoint: NotRequired["capo_docdb.types.string.String"]
    """<p>The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster. </p> <p>If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.</p>"""
    multi_az: NotRequired["capo_docdb.types.boolean.Boolean"]
    """<p>Specifies whether the cluster has instances in multiple Availability Zones.</p>"""
    engine: NotRequired["capo_docdb.types.string.String"]
    """<p>Provides the name of the database engine to be used for this cluster.</p>"""
    engine_version: NotRequired["capo_docdb.types.string.String"]
    """<p>Indicates the database engine version.</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>"""
    port: NotRequired["capo_docdb.types.integer_optional.IntegerOptional"]
    """<p>Specifies the port that the database engine is listening on.</p>"""
    master_username: NotRequired["capo_docdb.types.string.String"]
    """<p>Contains the master user name for the cluster.</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>"""
    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>"""
    replication_source_identifier: NotRequired["capo_docdb.types.string.String"]
    """<p>Contains the identifier of the source cluster if this cluster is a secondary cluster.</p>"""
    read_replica_identifiers: NotRequired[
        "capo_docdb.types.read_replica_identifier_list.ReadReplicaIdentifierList"
    ]
    """<p>Contains one or more identifiers of the secondary clusters that are associated with this cluster.</p>"""
    db_cluster_members: NotRequired[
        "capo_docdb.types.db_cluster_member_list.DBClusterMemberList"
    ]
    """<p>Provides the list of instances that make up the cluster.</p>"""
    vpc_security_groups: NotRequired[
        "capo_docdb.types.vpc_security_group_membership_list.VpcSecurityGroupMembershipList"
    ]
    """<p>Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.</p>"""
    hosted_zone_id: NotRequired["capo_docdb.types.string.String"]
    """<p>Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.</p>"""
    storage_encrypted: NotRequired["capo_docdb.types.boolean.Boolean"]
    """<p>Specifies whether the cluster 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 cluster.</p>"""
    db_cluster_resource_id: NotRequired["capo_docdb.types.string.String"]
    """<p>The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.</p>"""
    db_cluster_arn: NotRequired["capo_docdb.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the cluster.</p>"""
    associated_roles: NotRequired["capo_docdb.types.db_cluster_roles.DBClusterRoles"]
    """<p>Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.</p>"""
    clone_group_id: NotRequired["capo_docdb.types.string.String"]
    """<p>Identifies the clone group to which the DB cluster is associated.</p>"""
    cluster_create_time: NotRequired["capo_docdb.types.t_stamp.TStamp"]
    """<p>Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).</p>"""
    enabled_cloudwatch_logs_exports: NotRequired[
        "capo_docdb.types.log_type_list.LogTypeList"
    ]
    """<p>A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.</p>"""
    deletion_protection: NotRequired["capo_docdb.types.boolean.Boolean"]
    """<p>Specifies whether this cluster can be deleted. If <code>DeletionProtection</code> is enabled, the cluster cannot be deleted unless it is modified and <code>DeletionProtection</code> is disabled. <code>DeletionProtection</code> protects clusters from being accidentally deleted.</p>"""
    io_optimized_next_allowed_modification_time: NotRequired[
        "capo_docdb.types.t_stamp.TStamp"
    ]
    """<p>The next time you can modify the Amazon DocumentDB cluster to use the iopt1 storage type.</p>"""
    storage_type: NotRequired["capo_docdb.types.string.String"]
    """<p>Storage type associated with your cluster</p> <p>For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the <i>Amazon DocumentDB Developer Guide</i>.</p> <p>Valid values for storage type - <code>standard | iopt1</code> </p> <p>Default value is <code>standard </code> </p>"""
    serverless_v2_scaling_configuration: NotRequired[
        "capo_docdb.types.serverless_v2_scaling_configuration_info.ServerlessV2ScalingConfigurationInfo"
    ]
    """<p>The scaling configuration of an Amazon DocumentDB Serverless cluster.</p>"""
    master_user_secret: NotRequired[
        "capo_docdb.types.cluster_master_user_secret.ClusterMasterUserSecret"
    ]
    """<p>The secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.</p>"""
    network_type: NotRequired["capo_docdb.types.string.String"]
    """<p>The network type of the cluster.</p> <p>The network type is determined by the <code>DBSubnetGroup</code> specified for the cluster. 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/documentdb/latest/devguide/vpc-clusters.html">DocumentDB clusters in a VPC</a> in the Amazon DocumentDB Developer Guide.</p> <p>Valid Values: <code>IPV4</code> | <code>DUAL</code> </p>"""
    copy_tags_to_snapshot: NotRequired[
        "capo_docdb.types.boolean_optional.BooleanOptional"
    ]
    """<p>Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.</p>"""