Skip to content

GetDbClusterOutput

Source code in docs_src/capo_timestream_influxdb/types/get_db_cluster_output.py
class GetDbClusterOutput(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 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>"""
    publicly_accessible: NotRequired["bool"]
    """<p>Indicates if the DB cluster has a public IP to facilitate access from outside the VPC.</p>"""
    db_parameter_group_identifier: NotRequired[
        "capo_timestream_influxdb.types.db_parameter_group_identifier.DbParameterGroupIdentifier"
    ]
    """<p>The ID of the DB parameter group assigned to your DB cluster.</p>"""
    effective_db_parameter_group_identifier: NotRequired[
        "capo_timestream_influxdb.types.db_parameter_group_identifier.DbParameterGroupIdentifier"
    ]
    """<p>The ID of the DB parameter group actually applied to your DB cluster. When the service applies optimized defaults, it creates a service-managed DB parameter group and this field reflects that group, while dbParameterGroupIdentifier reflects the customer-provided DB parameter group. When no service-managed DB parameter group is applied, this value matches dbParameterGroupIdentifier.</p>"""
    log_delivery_configuration: NotRequired[
        "capo_timestream_influxdb.types.log_delivery_configuration.LogDeliveryConfiguration"
    ]
    """<p>Configuration for sending InfluxDB engine logs to send to specified S3 bucket.</p>"""
    maintenance_schedule: NotRequired[
        "capo_timestream_influxdb.types.maintenance_schedule.MaintenanceSchedule"
    ]
    """<p>The maintenance schedule for the DB cluster.</p>"""
    last_maintenance_time: NotRequired["datetime.datetime"]
    """<p>The timestamp of the last completed maintenance operation on the DB cluster.</p>"""
    next_maintenance_time: NotRequired["datetime.datetime"]
    """<p>The timestamp of the next scheduled maintenance operation on the DB cluster.</p>"""
    influx_auth_parameters_secret_arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) of the Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.</p>"""
    vpc_subnet_ids: NotRequired[
        "capo_timestream_influxdb.types.vpc_subnet_id_list.VpcSubnetIdList"
    ]
    """<p>A list of VPC subnet IDs associated with the DB cluster.</p>"""
    vpc_security_group_ids: NotRequired[
        "capo_timestream_influxdb.types.vpc_security_group_id_list.VpcSecurityGroupIdList"
    ]
    """<p>A list of VPC security group IDs associated with the DB cluster.</p>"""
    failover_mode: NotRequired[
        "capo_timestream_influxdb.types.failover_mode.FailoverMode"
    ]
    """<p>The configured failover mode for the DB cluster.</p>"""
    cluster_configuration: NotRequired[
        "capo_timestream_influxdb.types.cluster_configuration.ClusterConfiguration"
    ]
    """<p>Configuration for node modes in the DbCluster.</p>"""
    db_backup_configurations: NotRequired[
        "capo_timestream_influxdb.types.db_backup_configuration_output_list.DbBackupConfigurationOutputList"
    ]
    """<p>The backup configurations for the DB cluster.</p>"""
    kms_key_id: NotRequired["capo_timestream_influxdb.types.kms_key_id.KmsKeyId"]
    """<p>The Amazon Web Services KMS key ARN used for encryption of the 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.

cluster_configuration instance-attribute

cluster_configuration: NotRequired[ClusterConfiguration]

Configuration for node modes in the DbCluster.

db_backup_configurations instance-attribute

db_backup_configurations: NotRequired[DbBackupConfigurationOutputList]

The backup configurations for the DB cluster.

db_instance_type instance-attribute

db_instance_type: NotRequired[DbInstanceType]

The Timestream for InfluxDB instance type that InfluxDB runs on.

db_parameter_group_identifier instance-attribute

db_parameter_group_identifier: NotRequired[DbParameterGroupIdentifier]

The ID of the DB parameter group assigned to your DB cluster.

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.

effective_db_parameter_group_identifier instance-attribute

effective_db_parameter_group_identifier: NotRequired[DbParameterGroupIdentifier]

The ID of the DB parameter group actually applied to your DB cluster. When the service applies optimized defaults, it creates a service-managed DB parameter group and this field reflects that group, while dbParameterGroupIdentifier reflects the customer-provided DB parameter group. When no service-managed DB parameter group is applied, this value matches dbParameterGroupIdentifier.

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.

failover_mode instance-attribute

failover_mode: NotRequired[FailoverMode]

The configured failover mode for the DB cluster.

id instance-attribute

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

influx_auth_parameters_secret_arn instance-attribute

influx_auth_parameters_secret_arn: NotRequired[str]

The Amazon Resource Name (ARN) of the Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

The Amazon Web Services KMS key ARN used for encryption of the DB cluster.

last_maintenance_time instance-attribute

last_maintenance_time: NotRequired[datetime]

The timestamp of the last completed maintenance operation on the DB cluster.

log_delivery_configuration instance-attribute

log_delivery_configuration: NotRequired[LogDeliveryConfiguration]

Configuration for sending InfluxDB engine logs to send to specified S3 bucket.

maintenance_schedule instance-attribute

maintenance_schedule: NotRequired[MaintenanceSchedule]

The maintenance schedule for the DB cluster.

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.

next_maintenance_time instance-attribute

next_maintenance_time: NotRequired[datetime]

The timestamp of the next scheduled maintenance operation on the DB cluster.

port instance-attribute

port: NotRequired[Port]

The port number on which InfluxDB accepts connections.

publicly_accessible instance-attribute

publicly_accessible: NotRequired[bool]

Indicates if the DB cluster has a public IP to facilitate access from outside the VPC.

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.

vpc_security_group_ids instance-attribute

vpc_security_group_ids: NotRequired[VpcSecurityGroupIdList]

A list of VPC security group IDs associated with the DB cluster.

vpc_subnet_ids instance-attribute

vpc_subnet_ids: NotRequired[VpcSubnetIdList]

A list of VPC subnet IDs associated with the DB cluster.