DBCluster ¶

class DBCluster(TypedDict, closed=True):
    allocated_storage: NotRequired[
        "capo_neptune.types.integer_optional.IntegerOptional"
    ]
    """<p> <code>AllocatedStorage</code> always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.</p>"""
    availability_zones: NotRequired[
        "capo_neptune.types.availability_zones.AvailabilityZones"
    ]
    """<p>Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.</p>"""
    backup_retention_period: NotRequired[
        "capo_neptune.types.integer_optional.IntegerOptional"
    ]
    """<p>Specifies the number of days for which automatic DB snapshots are retained.</p>"""
    character_set_name: NotRequired["capo_neptune.types.string.String"]
    """<p>Not supported by Neptune.</p>"""
    database_name: NotRequired["capo_neptune.types.string.String"]
    """<p>Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.</p>"""
    db_cluster_identifier: NotRequired["capo_neptune.types.string.String"]
    """<p>Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.</p>"""
    db_cluster_parameter_group: NotRequired["capo_neptune.types.string.String"]
    """<p>Specifies the name of the DB cluster parameter group for the DB cluster.</p>"""
    db_subnet_group: NotRequired["capo_neptune.types.string.String"]
    """<p>Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.</p>"""
    status: NotRequired["capo_neptune.types.string.String"]
    """<p>Specifies the current state of this DB cluster.</p>"""
    percent_progress: NotRequired["capo_neptune.types.string.String"]
    """<p>Specifies the progress of the operation as a percentage.</p>"""
    earliest_restorable_time: NotRequired["capo_neptune.types.t_stamp.TStamp"]
    """<p>Specifies the earliest time to which a database can be restored with point-in-time restore.</p>"""
    endpoint: NotRequired["capo_neptune.types.string.String"]
    """<p>Specifies the connection endpoint for the primary instance of the DB cluster.</p>"""
    reader_endpoint: NotRequired["capo_neptune.types.string.String"]
    """<p>The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster.</p> <p>If a failover occurs, and the Read 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 Read Replicas in the cluster, you can then reconnect to the reader endpoint.</p>"""
    multi_az: NotRequired["capo_neptune.types.boolean.Boolean"]
    """<p>Specifies whether the DB cluster has instances in multiple Availability Zones.</p>"""
    engine: NotRequired["capo_neptune.types.string.String"]
    """<p>Provides the name of the database engine to be used for this DB cluster.</p>"""
    engine_version: NotRequired["capo_neptune.types.string.String"]
    """<p>Indicates the database engine version.</p>"""
    latest_restorable_time: NotRequired["capo_neptune.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_neptune.types.integer_optional.IntegerOptional"]
    """<p>Specifies the port that the database engine is listening on.</p>"""
    master_username: NotRequired["capo_neptune.types.string.String"]
    """<p>Not supported by Neptune.</p>"""
    db_cluster_option_group_memberships: NotRequired[
        "capo_neptune.types.db_cluster_option_group_memberships.DBClusterOptionGroupMemberships"
    ]
    """<p>Not supported by Neptune.</p>"""
    preferred_backup_window: NotRequired["capo_neptune.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_neptune.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_neptune.types.string.String"]
    """<p>Not supported by Neptune.</p>"""
    read_replica_identifiers: NotRequired[
        "capo_neptune.types.read_replica_identifier_list.ReadReplicaIdentifierList"
    ]
    """<p>Contains one or more identifiers of the Read Replicas associated with this DB cluster.</p>"""
    db_cluster_members: NotRequired[
        "capo_neptune.types.db_cluster_member_list.DBClusterMemberList"
    ]
    """<p>Provides the list of instances that make up the DB cluster.</p>"""
    vpc_security_groups: NotRequired[
        "capo_neptune.types.vpc_security_group_membership_list.VpcSecurityGroupMembershipList"
    ]
    """<p>Provides a list of VPC security groups that the DB cluster belongs to.</p>"""
    hosted_zone_id: NotRequired["capo_neptune.types.string.String"]
    """<p>Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.</p>"""
    storage_encrypted: NotRequired["capo_neptune.types.boolean.Boolean"]
    """<p>Specifies whether the DB cluster is encrypted.</p>"""
    kms_key_id: NotRequired["capo_neptune.types.string.String"]
    """<p>If <code>StorageEncrypted</code> is true, the Amazon KMS key identifier for the encrypted DB cluster.</p>"""
    db_cluster_resource_id: NotRequired["capo_neptune.types.string.String"]
    """<p>The Amazon Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon CloudTrail log entries whenever the Amazon KMS key for the DB cluster is accessed.</p>"""
    db_cluster_arn: NotRequired["capo_neptune.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the DB cluster.</p>"""
    associated_roles: NotRequired["capo_neptune.types.db_cluster_roles.DBClusterRoles"]
    """<p>Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.</p>"""
    iam_database_authentication_enabled: NotRequired[
        "capo_neptune.types.boolean.Boolean"
    ]
    """<p>True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.</p>"""
    clone_group_id: NotRequired["capo_neptune.types.string.String"]
    """<p>Identifies the clone group to which the DB cluster is associated.</p>"""
    cluster_create_time: NotRequired["capo_neptune.types.t_stamp.TStamp"]
    """<p>Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).</p>"""
    copy_tags_to_snapshot: NotRequired[
        "capo_neptune.types.boolean_optional.BooleanOptional"
    ]
    """<p> <i>If set to <code>true</code>, tags are copied to any snapshot of the DB cluster that is created.</i> </p>"""
    enabled_cloudwatch_logs_exports: NotRequired[
        "capo_neptune.types.log_type_list.LogTypeList"
    ]
    """<p>A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: <code>audit</code> (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html">Publishing Neptune logs to Amazon CloudWatch logs</a>.</p>"""
    pending_modified_values: NotRequired[
        "capo_neptune.types.cluster_pending_modified_values.ClusterPendingModifiedValues"
    ]
    """<p>This data type is used as a response element in the <code>ModifyDBCluster</code> operation and contains changes that will be applied during the next maintenance window.</p>"""
    deletion_protection: NotRequired[
        "capo_neptune.types.boolean_optional.BooleanOptional"
    ]
    """<p>Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.</p>"""
    cross_account_clone: NotRequired[
        "capo_neptune.types.boolean_optional.BooleanOptional"
    ]
    """<p>If set to <code>true</code>, the DB cluster can be cloned across accounts.</p>"""
    automatic_restart_time: NotRequired["capo_neptune.types.t_stamp.TStamp"]
    """<p>Time at which the DB cluster will be automatically restarted.</p>"""
    serverless_v2_scaling_configuration: NotRequired[
        "capo_neptune.types.serverless_v2_scaling_configuration_info.ServerlessV2ScalingConfigurationInfo"
    ]
    """<p>Shows the scaling configuration for a Neptune Serverless DB cluster.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html">Using Amazon Neptune Serverless</a> in the <i>Amazon Neptune User Guide</i>.</p>"""
    global_cluster_identifier: NotRequired[
        "capo_neptune.types.global_cluster_identifier.GlobalClusterIdentifier"
    ]
    """<p>Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.</p>"""
    io_optimized_next_allowed_modification_time: NotRequired[
        "capo_neptune.types.t_stamp.TStamp"
    ]
    """<p>The next time you can modify the DB cluster to use the <code>iopt1</code> storage type.</p>"""
    storage_type: NotRequired["capo_neptune.types.string.String"]
    """<p>The storage type used by the DB cluster.</p> <p>Valid Values:</p> <ul> <li> <p> <b> <code>standard</code> </b> – ( <i>the default</i> ) Provides cost-effective database storage for applications with moderate to small I/O usage.</p> </li> <li> <p> <b> <code>iopt1</code> </b> – Enables <a href="https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage">I/O-Optimized storage</a> that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput.</p> <p>Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.</p> </li> </ul>"""
    network_type: NotRequired["capo_neptune.types.string.String"]
    """<p>The network type of the DB cluster.</p> <p>Valid Values:</p> <ul> <li> <p> <b> <code>IPV4</code> </b> – The DB cluster uses only IPv4 addresses for communication.</p> </li> <li> <p> <b> <code>DUAL</code> </b> – The DB cluster uses both IPv4 and IPv6 addresses for communication.</p> </li> </ul>"""