Skip to main content

db_clusters

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

Overview​

Namedb_clusters
TypeResource
Idaws.timestream_influxdb.db_clusters

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringService-generated unique identifier of the DB cluster to retrieve. (pattern: <code>[a-zA-Z0-9]+</code>)
namestringCustomer-supplied name of the Timestream for InfluxDB cluster. (pattern: <code>[a-zA-z][a-zA-Z0-9](-[a-zA-Z0-9]+)</code>)
allocated_storageintegerThe amount of storage allocated for your DB storage type (in gibibytes).
arnstringThe Amazon Resource Name (ARN) of the DB cluster. (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>)
cluster_configurationobjectConfiguration for node modes in the DbCluster.
db_backup_configurationsarrayThe backup configurations for the DB cluster.
db_instance_typestringThe Timestream for InfluxDB instance type that InfluxDB runs 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_parameter_group_identifierstringThe ID of the DB parameter group assigned to your DB cluster. (pattern: <code>[a-zA-Z0-9]+</code>)
db_storage_typestringThe Timestream for InfluxDB DB storage type that InfluxDB stores data on. (InfluxIOIncludedT1, InfluxIOIncludedT2, InfluxIOIncludedT3)
deployment_typestringDeployment type of the DB cluster. (MULTI_NODE_READ_REPLICAS)
endpointstringThe endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.
engine_typestringThe engine type of your DB cluster. (INFLUXDB_V2, INFLUXDB_V3_CORE, INFLUXDB_V3_ENTERPRISE)
failover_modestringThe configured failover mode for the DB cluster. (AUTOMATIC, NO_FAILOVER)
influx_auth_parameters_secret_arnstringThe 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_idstringThe Amazon Web Services KMS key ARN used for encryption of the DB cluster. (pattern: <code>[a-zA-Z0-9:/_-]+</code>)
last_maintenance_timestring (date-time)The timestamp of the last completed maintenance operation on the DB cluster.
log_delivery_configurationobjectConfiguration for sending InfluxDB engine logs to send to specified S3 bucket.
maintenance_scheduleobjectThe maintenance schedule for the DB cluster.
network_typestringSpecifies 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. (IPV4, DUAL)
next_maintenance_timestring (date-time)The timestamp of the next scheduled maintenance operation on the DB cluster.
portintegerThe port number on which InfluxDB accepts connections.
publicly_accessiblebooleanIndicates if the DB cluster has a public IP to facilitate access from outside the VPC.
reader_endpointstringThe endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
statusstringThe status of the DB cluster. (CREATING, UPDATING, DELETING, AVAILABLE, FAILED, DELETED, MAINTENANCE, UPDATING_INSTANCE_TYPE, REBOOTING, REBOOT_FAILED, PARTIALLY_AVAILABLE, RESTORING, RESTORE_FAILED)
vpc_security_group_idsarrayA list of VPC security group IDs associated with the DB cluster.
vpc_subnet_idsarrayA list of VPC subnet IDs associated with the DB cluster.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_db_clusterselectregionRetrieves information about a Timestream for InfluxDB cluster.
list_db_clustersselectregionReturns a list of Timestream for InfluxDB DB clusters.
create_db_clusterinsertregion, name, dbInstanceType, vpcSubnetIds, vpcSecurityGroupIdsCreates a new Timestream for InfluxDB cluster.
update_db_clusterupdateregion, dbClusterIdUpdates a Timestream for InfluxDB cluster.
delete_db_clusterdeleteregionDeletes a Timestream for InfluxDB cluster.
reboot_db_clusterexecregion, dbClusterIdReboots a Timestream for InfluxDB cluster.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

Retrieves information about a Timestream for InfluxDB cluster.

SELECT
id,
name,
allocated_storage,
arn,
cluster_configuration,
db_backup_configurations,
db_instance_type,
db_parameter_group_identifier,
db_storage_type,
deployment_type,
endpoint,
engine_type,
failover_mode,
influx_auth_parameters_secret_arn,
kms_key_id,
last_maintenance_time,
log_delivery_configuration,
maintenance_schedule,
network_type,
next_maintenance_time,
port,
publicly_accessible,
reader_endpoint,
status,
vpc_security_group_ids,
vpc_subnet_ids
FROM aws.timestream_influxdb.db_clusters
WHERE region = '{{ region }}' -- required
;

INSERT examples​

Creates a new Timestream for InfluxDB cluster.

INSERT INTO aws.timestream_influxdb.db_clusters (
name,
username,
password,
organization,
bucket,
port,
dbParameterGroupIdentifier,
dbInstanceType,
dbStorageType,
allocatedStorage,
networkType,
publiclyAccessible,
vpcSubnetIds,
vpcSecurityGroupIds,
deploymentType,
failoverMode,
logDeliveryConfiguration,
maintenanceSchedule,
dbBackupConfigurations,
kmsKeyId,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ username }}',
'{{ password }}',
'{{ organization }}',
'{{ bucket }}',
{{ port }},
'{{ dbParameterGroupIdentifier }}',
'{{ dbInstanceType }}' /* required */,
'{{ dbStorageType }}',
{{ allocatedStorage }},
'{{ networkType }}',
{{ publiclyAccessible }},
'{{ vpcSubnetIds }}' /* required */,
'{{ vpcSecurityGroupIds }}' /* required */,
'{{ deploymentType }}',
'{{ failoverMode }}',
'{{ logDeliveryConfiguration }}',
'{{ maintenanceSchedule }}',
'{{ dbBackupConfigurations }}',
'{{ kmsKeyId }}',
'{{ tags }}',
'{{ region }}'
RETURNING
db_cluster_id,
db_cluster_status
;

UPDATE examples​

Updates a Timestream for InfluxDB cluster.

UPDATE aws.timestream_influxdb.db_clusters
SET 
dbClusterId = '{{ dbClusterId }}',
logDeliveryConfiguration = '{{ logDeliveryConfiguration }}',
dbParameterGroupIdentifier = '{{ dbParameterGroupIdentifier }}',
port = {{ port }},
dbInstanceType = '{{ dbInstanceType }}',
failoverMode = '{{ failoverMode }}',
maintenanceSchedule = '{{ maintenanceSchedule }}',
dbBackupConfigurations = '{{ dbBackupConfigurations }}'
WHERE 
region = '{{ region }}' --required
AND dbClusterId = '{{ dbClusterId }}' --required
RETURNING
db_cluster_status;

DELETE examples​

Deletes a Timestream for InfluxDB cluster.

DELETE FROM aws.timestream_influxdb.db_clusters
WHERE region = '{{ region }}' --required
;

Lifecycle Methods​

Reboots a Timestream for InfluxDB cluster.

EXEC aws.timestream_influxdb.db_clusters.reboot_db_cluster 
@region='{{ region }}' --required 
@@json=
'{
"dbClusterId": "{{ dbClusterId }}", 
"instanceIds": "{{ instanceIds }}"
}'
;
Last updated on