db_instances

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

Overview

Name	`db_instances`
Type	Resource
Id	`aws.timestream_influxdb.db_instances`

Fields

The following fields are returned by SELECT queries:

get_db_instance
list_db_instances

Name	Datatype	Description
`id`	`string`	A service-generated unique identifier. (pattern: <code>[a-zA-Z0-9]+</code>)
`name`	`string`	The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. (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 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>)
`availability_zone`	`string`	The Availability Zone in which the DB instance resides.
`db_backup_configurations`	`array`	The backup configurations for the DB instance.
`db_cluster_id`	`string`	Specifies the DbCluster to which this DbInstance belongs to. (pattern: <code>[a-zA-Z0-9]+</code>)
`db_instance_type`	`string`	The 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_identifier`	`string`	The id of the DB parameter group assigned to your DB instance. (pattern: <code>[a-zA-Z0-9]+</code>)
`db_storage_type`	`string`	The Timestream for InfluxDB DB storage type that InfluxDB stores data on. (InfluxIOIncludedT1, InfluxIOIncludedT2, InfluxIOIncludedT3)
`deployment_type`	`string`	Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability. (SINGLE_AZ, WITH_MULTIAZ_STANDBY)
`endpoint`	`string`	The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
`influx_auth_parameters_secret_arn`	`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.
`instance_mode`	`string`	Specifies the DbInstance's role in the cluster. (PRIMARY, STANDBY, REPLICA, INGEST, QUERY, COMPACT, PROCESS)
`instance_modes`	`array`	Specifies the DbInstance's roles in the cluster.
`kms_key_id`	`string`	The Amazon Web Services KMS key ARN used for encryption of the DB instance. (pattern: <code>[a-zA-Z0-9:/_-]+</code>)
`last_maintenance_time`	`string (date-time)`	The timestamp of the last completed maintenance operation on the DB instance.
`log_delivery_configuration`	`object`	Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
`maintenance_schedule`	`object`	The maintenance schedule for the DB instance.
`network_type`	`string`	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. (IPV4, DUAL)
`next_maintenance_time`	`string (date-time)`	The timestamp of the next scheduled maintenance operation on the DB instance.
`port`	`integer`	The port number on which InfluxDB accepts connections.
`publicly_accessible`	`boolean`	Indicates if the DB instance has a public IP to facilitate access.
`secondary_availability_zone`	`string`	The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
`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)
`vpc_security_group_ids`	`array`	A list of VPC security group IDs associated with the DB instance.
`vpc_subnet_ids`	`array`	A list of VPC subnet IDs associated with the DB instance.

Name	Datatype	Description
`id`	`string`	The service-generated unique identifier of the DB instance. (pattern: <code>[a-zA-Z0-9]+</code>)
`name`	`string`	This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. (pattern: <code>[a-zA-Z][a-zA-Z0-9](-[a-zA-Z0-9]+)</code>)
`allocated_storage`	`integer`	The amount of storage to allocate for your DbStorageType 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`	Single-Instance or with a MultiAZ Standby for High availability. (SINGLE_AZ, WITH_MULTIAZ_STANDBY)
`endpoint`	`string`	The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
`network_type`	`string`	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. (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	Description
`get_db_instance`	`select`	`region`	Returns a Timestream for InfluxDB DB instance.
`list_db_instances`	`select`	`region`	Returns a list of Timestream for InfluxDB DB instances.
`create_db_instance`	`insert`	`region`, `name`, `password`, `dbInstanceType`, `vpcSubnetIds`, `vpcSecurityGroupIds`, `allocatedStorage`	Creates a new Timestream for InfluxDB DB instance.
`update_db_instance`	`update`	`region`, `identifier`	Updates a Timestream for InfluxDB DB instance.
`delete_db_instance`	`delete`	`region`	Deletes a Timestream for InfluxDB DB instance.

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

get_db_instance
list_db_instances

Returns a Timestream for InfluxDB DB instance.

SELECT
id,
name,
allocated_storage,
arn,
availability_zone,
db_backup_configurations,
db_cluster_id,
db_instance_type,
db_parameter_group_identifier,
db_storage_type,
deployment_type,
endpoint,
influx_auth_parameters_secret_arn,
instance_mode,
instance_modes,
kms_key_id,
last_maintenance_time,
log_delivery_configuration,
maintenance_schedule,
network_type,
next_maintenance_time,
port,
publicly_accessible,
secondary_availability_zone,
status,
vpc_security_group_ids,
vpc_subnet_ids
FROM aws.timestream_influxdb.db_instances
WHERE region = '{{ region }}' -- required
;

Returns a list of Timestream for InfluxDB DB instances.

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

`INSERT` examples

create_db_instance
Manifest

Creates a new Timestream for InfluxDB DB instance.

INSERT INTO aws.timestream_influxdb.db_instances (
name,
username,
password,
organization,
bucket,
dbInstanceType,
vpcSubnetIds,
vpcSecurityGroupIds,
publiclyAccessible,
dbStorageType,
allocatedStorage,
dbParameterGroupIdentifier,
deploymentType,
logDeliveryConfiguration,
maintenanceSchedule,
tags,
port,
networkType,
dbBackupConfigurations,
kmsKeyId,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ username }}',
'{{ password }}' /* required */,
'{{ organization }}',
'{{ bucket }}',
'{{ dbInstanceType }}' /* required */,
'{{ vpcSubnetIds }}' /* required */,
'{{ vpcSecurityGroupIds }}' /* required */,
{{ publiclyAccessible }},
'{{ dbStorageType }}',
{{ allocatedStorage }} /* required */,
'{{ dbParameterGroupIdentifier }}',
'{{ deploymentType }}',
'{{ logDeliveryConfiguration }}',
'{{ maintenanceSchedule }}',
'{{ tags }}',
{{ port }},
'{{ networkType }}',
'{{ dbBackupConfigurations }}',
'{{ kmsKeyId }}',
'{{ region }}'
RETURNING
id,
name,
allocated_storage,
arn,
availability_zone,
db_backup_configurations,
db_cluster_id,
db_instance_type,
db_parameter_group_identifier,
db_storage_type,
deployment_type,
endpoint,
influx_auth_parameters_secret_arn,
instance_mode,
instance_modes,
kms_key_id,
last_maintenance_time,
log_delivery_configuration,
maintenance_schedule,
network_type,
next_maintenance_time,
port,
publicly_accessible,
secondary_availability_zone,
status,
vpc_security_group_ids,
vpc_subnet_ids
;

# Description fields are for documentation purposes
- name: db_instances
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the db_instances resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. DB instance names must be unique per customer and per region.
  - name: username
    value: "{{ username }}"
    description: |
      The username of the initial admin user created in InfluxDB. Must start with a letter and can't end with a hyphen or contain two consecutive hyphens. For example, my-user1. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Amazon Secrets Manager in your account.
  - name: password
    value: "{{ password }}"
    description: |
      The password of the initial admin user created in InfluxDB v2. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Secrets Manager in your account.
  - name: organization
    value: "{{ organization }}"
    description: |
      The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.
  - name: bucket
    value: "{{ bucket }}"
    description: |
      The name of the initial InfluxDB bucket. All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization.
  - name: dbInstanceType
    value: "{{ dbInstanceType }}"
    description: |
      The Timestream for InfluxDB DB instance type to run InfluxDB on.
    valid_values: ['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']
  - name: vpcSubnetIds
    value:
      - "{{ vpcSubnetIds }}"
    description: |
      A list of VPC subnet IDs to associate with the DB instance. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.
  - name: vpcSecurityGroupIds
    value:
      - "{{ vpcSecurityGroupIds }}"
    description: |
      A list of VPC security group IDs to associate with the DB instance.
  - name: publiclyAccessible
    value: {{ publiclyAccessible }}
    description: |
      Configures the DB instance with a public IP to facilitate access.
  - name: dbStorageType
    value: "{{ dbStorageType }}"
    description: |
      The Timestream for InfluxDB DB storage type to read and write InfluxDB data. You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements: Influx IO Included 3000 IOPS Influx IO Included 12000 IOPS Influx IO Included 16000 IOPS
    valid_values: ['InfluxIOIncludedT1', 'InfluxIOIncludedT2', 'InfluxIOIncludedT3']
  - name: allocatedStorage
    value: {{ allocatedStorage }}
    description: |
      The amount of storage to allocate for your DB storage type in GiB (gibibytes).
  - name: dbParameterGroupIdentifier
    value: "{{ dbParameterGroupIdentifier }}"
    description: |
      The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.
  - name: deploymentType
    value: "{{ deploymentType }}"
    description: |
      Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
    valid_values: ['SINGLE_AZ', 'WITH_MULTIAZ_STANDBY']
  - name: logDeliveryConfiguration
    description: |
      Configuration for sending InfluxDB engine logs to a specified S3 bucket.
    value:
      s3Configuration:
        bucketName: "{{ bucketName }}"
        enabled: {{ enabled }}
  - name: maintenanceSchedule
    description: |
      Specifies the maintenance schedule for the DB instance, including the preferred maintenance window and timezone.
    value:
      timezone: "{{ timezone }}"
      preferredMaintenanceWindow: "{{ preferredMaintenanceWindow }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      A list of key-value pairs to associate with the DB instance.
  - name: port
    value: {{ port }}
    description: |
      The port number on which InfluxDB accepts connections. Valid Values: 1024-65535 Default: 8086 Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680
  - name: networkType
    value: "{{ networkType }}"
    description: |
      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.
    valid_values: ['IPV4', 'DUAL']
  - name: dbBackupConfigurations
    description: |
      A list of backup configurations to enable automated backups for the DB instance.
    value:
      - type_: "{{ type_ }}"
        retentionDays: {{ retentionDays }}
        enabled: {{ enabled }}
        customSchedule: "{{ customSchedule }}"
  - name: kmsKeyId
    value: "{{ kmsKeyId }}"
    description: |
      The Amazon Web Services KMS key identifier to use for encryption of the DB instance. Can be a key ID, key ARN, alias name, or alias ARN.

`UPDATE` examples

update_db_instance

Updates a Timestream for InfluxDB DB instance.

UPDATE aws.timestream_influxdb.db_instances
SET 
identifier = '{{ identifier }}',
logDeliveryConfiguration = '{{ logDeliveryConfiguration }}',
dbParameterGroupIdentifier = '{{ dbParameterGroupIdentifier }}',
port = {{ port }},
dbInstanceType = '{{ dbInstanceType }}',
deploymentType = '{{ deploymentType }}',
dbStorageType = '{{ dbStorageType }}',
allocatedStorage = {{ allocatedStorage }},
maintenanceSchedule = '{{ maintenanceSchedule }}',
dbBackupConfigurations = '{{ dbBackupConfigurations }}'
WHERE 
region = '{{ region }}' --required
AND identifier = '{{ identifier }}' --required
RETURNING
id,
name,
allocated_storage,
arn,
availability_zone,
db_backup_configurations,
db_cluster_id,
db_instance_type,
db_parameter_group_identifier,
db_storage_type,
deployment_type,
endpoint,
influx_auth_parameters_secret_arn,
instance_mode,
instance_modes,
kms_key_id,
last_maintenance_time,
log_delivery_configuration,
maintenance_schedule,
network_type,
next_maintenance_time,
port,
publicly_accessible,
secondary_availability_zone,
status,
vpc_security_group_ids,
vpc_subnet_ids;

`DELETE` examples

delete_db_instance

Deletes a Timestream for InfluxDB DB instance.

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

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​