db_instances_for_clusters

Creates, updates, deletes, gets or lists a db_instances_for_clusters resource.

Overview

Name	db_instances_for_clusters
Type	Resource
Id	aws.timestream_influxdb.db_instances_for_clusters

Fields

The following fields are returned by SELECT queries:

list_db_instances_for_cluster

Name	Datatype	Description
id	string	The service-generated unique identifier of the DB instance. (pattern: <code>[a-zA-Z0-9]+</code>)
name	string	A service-generated name for the DB instance based on the customer-supplied name for the DB cluster. (pattern: <code>[a-zA-Z][a-zA-Z0-9](-[a-zA-Z0-9]+)</code>)
allocated_storage	integer	The amount of storage allocated for your DB storage type in GiB (gibibytes).
arn	string	The Amazon Resource Name (ARN) of the DB instance. (pattern: <code>arn:aws[a-z-]*:timestream-influxdb:[a-z0-9-]+:[0-9]{12}:(db-instance|db-cluster|db-parameter-group|db-backup)/[a-zA-Z0-9]{3,64}</code>)
db_instance_type	string	The Timestream for InfluxDB instance type to run InfluxDB on. (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)
db_storage_type	string	The storage type for your DB instance. (InfluxIOIncludedT1, InfluxIOIncludedT2, InfluxIOIncludedT3)
deployment_type	string	Specifies the deployment type if applicable. (SINGLE_AZ, WITH_MULTIAZ_STANDBY)
endpoint	string	The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
instance_mode	string	Specifies the DB instance's role in the cluster. (PRIMARY, STANDBY, REPLICA, INGEST, QUERY, COMPACT, PROCESS)
instance_modes	array	Specifies the DB instance's roles in the cluster.
network_type	string	Specifies whether the network type 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. (IPV4, DUAL)
port	integer	The port number on which InfluxDB accepts connections.
status	string	The status of the DB instance. (CREATING, AVAILABLE, DELETING, MODIFYING, UPDATING, DELETED, FAILED, UPDATING_DEPLOYMENT_TYPE, UPDATING_INSTANCE_TYPE, MAINTENANCE, REBOOTING, REBOOT_FAILED, RESTORING, RESTORE_FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_db_instances_for_cluster	select	region		Returns a list of Timestream for InfluxDB clusters.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_db_instances_for_cluster

Returns a list of Timestream for InfluxDB clusters.

SELECT
id,
name,
allocated_storage,
arn,
db_instance_type,
db_storage_type,
deployment_type,
endpoint,
instance_mode,
instance_modes,
network_type,
port,
status
FROM aws.timestream_influxdb.db_instances_for_clusters
WHERE region = '{{ region }}' -- required
;