Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1419176143.1 KB

Retrieves information about a Timestream for InfluxDB cluster.

post/#X-Amz-Target=AmazonTimestreamInfluxDB.GetDbCluster

Headers

X-Amz-Target'AmazonTimestreamInfluxDB.GetDbCluster' required

Request body

dbClusterIdstring required

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

Response

Success

idstring required

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

namestring required

Customer-supplied name of the Timestream for InfluxDB cluster.

arnstring required

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

status'CREATING' | 'UPDATING' | 'DELETING' | 'AVAILABLE' | 'FAILED' | 'DELETED' | 'MAINTENANCE' | 'UPDATING_INSTANCE_TYPE' | 'REBOOTING' | 'REBOOT_FAILED' | 'PARTIALLY_AVAILABLE'

The status of the DB cluster.

endpointstring

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

readerEndpointstring

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

portinteger

The port number on which InfluxDB accepts connections.

deploymentType'MULTI_NODE_READ_REPLICAS'

Deployment type of the DB cluster.

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' | 'db.influx.24xlarge'

The Timestream for InfluxDB instance type that InfluxDB runs on.

networkType'IPV4' | 'DUAL'

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'InfluxIOIncludedT1' | 'InfluxIOIncludedT2' | 'InfluxIOIncludedT3'

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

allocatedStorageinteger

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

engineType'INFLUXDB_V2' | 'INFLUXDB_V3_CORE' | 'INFLUXDB_V3_ENTERPRISE'

The engine type of your DB cluster.

publiclyAccessibleboolean

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

dbParameterGroupIdentifierstring

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

lastMaintenanceTimestring date-time

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

nextMaintenanceTimestring date-time

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

influxAuthParametersSecretArnstring

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.

vpcSubnetIdsVpcSubnetId[]

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

vpcSecurityGroupIdsVpcSecurityGroupId[]

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

failoverMode'AUTOMATIC' | 'NO_FAILOVER'

The configured failover mode for the DB cluster.