TimestreamInfluxDB / Client / get_db_cluster

get_db_cluster

TimestreamInfluxDB.Client.get_db_cluster(**kwargs)

Retrieves information about a Timestream for InfluxDB cluster.

See also: AWS API Documentation

Request Syntax

response = client.get_db_cluster(
    dbClusterId='string'
)

Parameters:

dbClusterId (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'arn': 'string',
    'status': 'CREATING'|'UPDATING'|'DELETING'|'AVAILABLE'|'FAILED'|'DELETED',
    'endpoint': 'string',
    'readerEndpoint': 'string',
    'port': 123,
    'deploymentType': 'MULTI_NODE_READ_REPLICAS',
    'dbInstanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge',
    'networkType': 'IPV4'|'DUAL',
    'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
    'allocatedStorage': 123,
    'publiclyAccessible': True|False,
    'dbParameterGroupIdentifier': 'string',
    'logDeliveryConfiguration': {
        's3Configuration': {
            'bucketName': 'string',
            'enabled': True|False
        }
    },
    'influxAuthParametersSecretArn': 'string',
    'vpcSubnetIds': [
        'string',
    ],
    'vpcSecurityGroupIds': [
        'string',
    ],
    'failoverMode': 'AUTOMATIC'|'NO_FAILOVER'
}

Response Structure

• (dict) –

  • id (string) –

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

  • name (string) –

    Customer-supplied name of the Timestream for InfluxDB cluster.

  • arn (string) –

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

  • status (string) –

    The status of the DB cluster.

  • endpoint (string) –

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

  • readerEndpoint (string) –

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

  • port (integer) –

    The port number on which InfluxDB accepts connections.

  • deploymentType (string) –

    Deployment type of the DB cluster.

  • dbInstanceType (string) –

    The Timestream for InfluxDB instance type that InfluxDB runs on.

  • networkType (string) –

    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.

  • dbStorageType (string) –

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

  • allocatedStorage (integer) –

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

  • publiclyAccessible (boolean) –

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

  • dbParameterGroupIdentifier (string) –

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

  • logDeliveryConfiguration (dict) –

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

    • s3Configuration (dict) –

      Configuration for S3 bucket log delivery.

      • bucketName (string) –

        The name of the S3 bucket to deliver logs to.

      • enabled (boolean) –

        Indicates whether log delivery to the S3 bucket is enabled.

  • influxAuthParametersSecretArn (string) –

    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.

  • vpcSubnetIds (list) –

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

    • (string) –

  • vpcSecurityGroupIds (list) –

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

    • (string) –

  • failoverMode (string) –

    The configured failover mode for the DB cluster.

Exceptions

• TimestreamInfluxDB.Client.exceptions.ValidationException

• TimestreamInfluxDB.Client.exceptions.AccessDeniedException

• TimestreamInfluxDB.Client.exceptions.InternalServerException

• TimestreamInfluxDB.Client.exceptions.ResourceNotFoundException

• TimestreamInfluxDB.Client.exceptions.ThrottlingException