Skip to content

DbInstanceSummary

Source code in docs_src/capo_timestream_influxdb/types/db_instance_summary.py
class DbInstanceSummary(TypedDict, closed=True):
    id: "capo_timestream_influxdb.types.db_instance_id.DbInstanceId"
    """<p>The service-generated unique identifier of the DB instance.</p>"""
    name: "capo_timestream_influxdb.types.db_instance_name.DbInstanceName"
    """<p>This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.</p>"""
    arn: "capo_timestream_influxdb.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the DB instance.</p>"""
    status: NotRequired["capo_timestream_influxdb.types.status.Status"]
    """<p>The status of the DB instance.</p>"""
    endpoint: NotRequired["str"]
    """<p>The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.</p>"""
    port: NotRequired["capo_timestream_influxdb.types.port.Port"]
    """<p>The port number on which InfluxDB accepts connections.</p>"""
    network_type: NotRequired["capo_timestream_influxdb.types.network_type.NetworkType"]
    """<p>Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.</p>"""
    db_instance_type: NotRequired[
        "capo_timestream_influxdb.types.db_instance_type.DbInstanceType"
    ]
    """<p>The Timestream for InfluxDB instance type to run InfluxDB on.</p>"""
    db_storage_type: NotRequired[
        "capo_timestream_influxdb.types.db_storage_type.DbStorageType"
    ]
    """<p>The storage type for your DB instance.</p>"""
    allocated_storage: NotRequired[
        "capo_timestream_influxdb.types.allocated_storage.AllocatedStorage"
    ]
    """<p>The amount of storage to allocate for your DbStorageType in GiB (gibibytes).</p>"""
    deployment_type: NotRequired[
        "capo_timestream_influxdb.types.deployment_type.DeploymentType"
    ]
    """<p>Single-Instance or with a MultiAZ Standby for High availability.</p>"""

allocated_storage instance-attribute

allocated_storage: NotRequired[AllocatedStorage]

The amount of storage to allocate for your DbStorageType in GiB (gibibytes).

arn instance-attribute

arn: Arn

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

db_instance_type instance-attribute

db_instance_type: NotRequired[DbInstanceType]

The Timestream for InfluxDB instance type to run InfluxDB on.

db_storage_type instance-attribute

db_storage_type: NotRequired[DbStorageType]

The storage type for your DB instance.

deployment_type instance-attribute

deployment_type: NotRequired[DeploymentType]

Single-Instance or with a MultiAZ Standby for High availability.

endpoint instance-attribute

endpoint: NotRequired[str]

The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

id instance-attribute

The service-generated unique identifier of the DB instance.

name instance-attribute

This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.

network_type instance-attribute

network_type: NotRequired[NetworkType]

Specifies whether the networkType of the Timestream for InfluxDB instance 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.

status instance-attribute

status: NotRequired[Status]

The status of the DB instance.