Skip to content

DbClusterSummary

Source code in docs_src/capo_timestream_influxdb/types/db_cluster_summary.py
class DbClusterSummary(TypedDict, closed=True):
    id: "capo_timestream_influxdb.types.db_cluster_id.DbClusterId"
    """<p>Service-generated unique identifier of the DB cluster to retrieve.</p>"""
    name: "capo_timestream_influxdb.types.db_cluster_name.DbClusterName"
    """<p>Customer supplied name of the Timestream for InfluxDB cluster.</p>"""
    arn: "capo_timestream_influxdb.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the DB cluster.</p>"""
    status: NotRequired["capo_timestream_influxdb.types.cluster_status.ClusterStatus"]
    """<p>The status of the DB cluster.</p>"""
    endpoint: NotRequired["str"]
    """<p>The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.</p>"""
    reader_endpoint: NotRequired["str"]
    """<p>The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.</p>"""
    port: NotRequired["capo_timestream_influxdb.types.port.Port"]
    """<p>The port number on which InfluxDB accepts connections.</p>"""
    deployment_type: NotRequired[
        "capo_timestream_influxdb.types.cluster_deployment_type.ClusterDeploymentType"
    ]
    """<p>Deployment type of the DB cluster</p>"""
    db_instance_type: NotRequired[
        "capo_timestream_influxdb.types.db_instance_type.DbInstanceType"
    ]
    """<p>The Timestream for InfluxDB DB instance type that InfluxDB runs on.</p>"""
    network_type: NotRequired["capo_timestream_influxdb.types.network_type.NetworkType"]
    """<p>Specifies whether the network type of the Timestream for InfluxDB Cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.</p>"""
    db_storage_type: NotRequired[
        "capo_timestream_influxdb.types.db_storage_type.DbStorageType"
    ]
    """<p>The Timestream for InfluxDB DB storage type that InfluxDB stores data on.</p>"""
    allocated_storage: NotRequired[
        "capo_timestream_influxdb.types.allocated_storage.AllocatedStorage"
    ]
    """<p>The amount of storage allocated for your DB storage type (in gibibytes).</p>"""
    engine_type: NotRequired["capo_timestream_influxdb.types.engine_type.EngineType"]
    """<p>The engine type of your DB cluster.</p>"""

allocated_storage instance-attribute

allocated_storage: NotRequired[AllocatedStorage]

The amount of storage allocated for your DB storage type (in gibibytes).

arn instance-attribute

arn: Arn

The Amazon Resource Name (ARN) of the DB cluster.

db_instance_type instance-attribute

db_instance_type: NotRequired[DbInstanceType]

The Timestream for InfluxDB DB instance type that InfluxDB runs on.

db_storage_type instance-attribute

db_storage_type: NotRequired[DbStorageType]

The Timestream for InfluxDB DB storage type that InfluxDB stores data on.

deployment_type instance-attribute

deployment_type: NotRequired[ClusterDeploymentType]

Deployment type of the DB cluster

endpoint instance-attribute

endpoint: NotRequired[str]

The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.

engine_type instance-attribute

engine_type: NotRequired[EngineType]

The engine type of your DB cluster.

id instance-attribute

Service-generated unique identifier of the DB cluster to retrieve.

name instance-attribute

Customer supplied name of the Timestream for InfluxDB cluster.

network_type instance-attribute

network_type: NotRequired[NetworkType]

Specifies whether the network type of the Timestream for InfluxDB Cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

port instance-attribute

port: NotRequired[Port]

The port number on which InfluxDB accepts connections.

reader_endpoint instance-attribute

reader_endpoint: NotRequired[str]

The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.

status instance-attribute

status: NotRequired[ClusterStatus]

The status of the DB cluster.