Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1419176143.1 KB

Returns a Timestream for InfluxDB DB instance.

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

Headers

X-Amz-Target'AmazonTimestreamInfluxDB.GetDbInstance' required

Request body

identifierstring required

The id of the DB instance.

Response

Success

idstring required

A service-generated unique identifier.

namestring required

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

arnstring required

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

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

The status of the DB instance.

endpointstring

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

portinteger

The port number on which InfluxDB accepts connections.

networkType'IPV4' | 'DUAL'

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.

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.

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).

deploymentType'SINGLE_AZ' | 'WITH_MULTIAZ_STANDBY'

Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.

vpcSubnetIdsVpcSubnetId[] required

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

publiclyAccessibleboolean

Indicates if the DB instance has a public IP to facilitate access.

vpcSecurityGroupIdsVpcSecurityGroupId[]

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

dbParameterGroupIdentifierstring

The id of the DB parameter group assigned to your DB instance.

availabilityZonestring

The Availability Zone in which the DB instance resides.

secondaryAvailabilityZonestring

The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.

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.

dbClusterIdstring

Specifies the DbCluster to which this DbInstance belongs to.

instanceMode'PRIMARY' | 'STANDBY' | 'REPLICA' | 'INGEST' | 'QUERY' | 'COMPACT' | 'PROCESS'

Specifies the DbInstance's role in the cluster.

instanceModesInstanceMode[]

Specifies the DbInstance's roles in the cluster.

lastMaintenanceTimestring date-time

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

nextMaintenanceTimestring date-time

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