db_parameter_groups

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

Overview

Name	db_parameter_groups
Type	Resource
Id	aws.timestream_influxdb.db_parameter_groups

Fields

The following fields are returned by SELECT queries:

get_db_parameter_group

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 parameter group 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>)
arn	string	The Amazon Resource Name (ARN) of the DB parameter group. (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>)
description	string	A description of the DB parameter group.
parameters	object	The parameters that comprise the DB parameter group.

list_db_parameter_groups

Name	Datatype	Description
id	string	A service-generated unique identifier. (pattern: <code>[a-zA-Z0-9]+</code>)
name	string	This customer-supplied name uniquely identifies the parameter group. (pattern: <code>[a-zA-Z][a-zA-Z0-9](-[a-zA-Z0-9]+)</code>)
arn	string	The Amazon Resource Name (ARN) of the DB parameter group. (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>)
description	string	A description of the DB parameter group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_db_parameter_group	select	region		Returns a Timestream for InfluxDB DB parameter group.
list_db_parameter_groups	select	region		Returns a list of Timestream for InfluxDB DB parameter groups.
create_db_parameter_group	insert	region, name		Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.

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_parameter_group

Returns a Timestream for InfluxDB DB parameter group.

SELECT
id,
name,
arn,
description,
parameters
FROM aws.timestream_influxdb.db_parameter_groups
WHERE region = '{{ region }}' -- required
;

list_db_parameter_groups

Returns a list of Timestream for InfluxDB DB parameter groups.

SELECT
id,
name,
arn,
description
FROM aws.timestream_influxdb.db_parameter_groups
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_db_parameter_group

Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.

INSERT INTO aws.timestream_influxdb.db_parameter_groups (
name,
description,
parameters,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ parameters }}',
'{{ tags }}',
'{{ region }}'
RETURNING
id,
name,
arn,
description,
parameters
;

Manifest

# Description fields are for documentation purposes
- name: db_parameter_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the db_parameter_groups resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the DB parameter group. The name must be unique per customer and per region.
  - name: description
    value: "{{ description }}"
    description: |
      A description of the DB parameter group.
  - name: parameters
    description: |
      A list of the parameters that comprise the DB parameter group.
    value:
      InfluxDBv2:
        fluxLogEnabled: {{ fluxLogEnabled }}
        logLevel: "{{ logLevel }}"
        noTasks: {{ noTasks }}
        queryConcurrency: {{ queryConcurrency }}
        queryQueueSize: {{ queryQueueSize }}
        tracingType: "{{ tracingType }}"
        metricsDisabled: {{ metricsDisabled }}
        httpIdleTimeout:
          durationType: "{{ durationType }}"
          value: {{ value }}
        httpReadHeaderTimeout:
          durationType: "{{ durationType }}"
          value: {{ value }}
        httpReadTimeout:
          durationType: "{{ durationType }}"
          value: {{ value }}
        httpWriteTimeout:
          durationType: "{{ durationType }}"
          value: {{ value }}
        influxqlMaxSelectBuckets: {{ influxqlMaxSelectBuckets }}
        influxqlMaxSelectPoint: {{ influxqlMaxSelectPoint }}
        influxqlMaxSelectSeries: {{ influxqlMaxSelectSeries }}
        pprofDisabled: {{ pprofDisabled }}
        queryInitialMemoryBytes: {{ queryInitialMemoryBytes }}
        queryMaxMemoryBytes: {{ queryMaxMemoryBytes }}
        queryMemoryBytes: {{ queryMemoryBytes }}
        sessionLength: {{ sessionLength }}
        sessionRenewDisabled: {{ sessionRenewDisabled }}
        storageCacheMaxMemorySize: {{ storageCacheMaxMemorySize }}
        storageCacheSnapshotMemorySize: {{ storageCacheSnapshotMemorySize }}
        storageCacheSnapshotWriteColdDuration:
          durationType: "{{ durationType }}"
          value: {{ value }}
        storageCompactFullWriteColdDuration:
          durationType: "{{ durationType }}"
          value: {{ value }}
        storageCompactThroughputBurst: {{ storageCompactThroughputBurst }}
        storageMaxConcurrentCompactions: {{ storageMaxConcurrentCompactions }}
        storageMaxIndexLogFileSize: {{ storageMaxIndexLogFileSize }}
        storageNoValidateFieldSize: {{ storageNoValidateFieldSize }}
        storageRetentionCheckInterval:
          durationType: "{{ durationType }}"
          value: {{ value }}
        storageSeriesFileMaxConcurrentSnapshotCompactions: {{ storageSeriesFileMaxConcurrentSnapshotCompactions }}
        storageSeriesIdSetCacheSize: {{ storageSeriesIdSetCacheSize }}
        storageWalMaxConcurrentWrites: {{ storageWalMaxConcurrentWrites }}
        storageWalMaxWriteDelay:
          durationType: "{{ durationType }}"
          value: {{ value }}
        uiDisabled: {{ uiDisabled }}
      InfluxDBv3Core:
        queryFileLimit: {{ queryFileLimit }}
        queryLogSize: {{ queryLogSize }}
        logFilter: "{{ logFilter }}"
        logFormat: "{{ logFormat }}"
        dataFusionNumThreads: {{ dataFusionNumThreads }}
        dataFusionRuntimeType: "{{ dataFusionRuntimeType }}"
        dataFusionRuntimeDisableLifoSlot: {{ dataFusionRuntimeDisableLifoSlot }}
        dataFusionRuntimeEventInterval: {{ dataFusionRuntimeEventInterval }}
        dataFusionRuntimeGlobalQueueInterval: {{ dataFusionRuntimeGlobalQueueInterval }}
        dataFusionRuntimeMaxBlockingThreads: {{ dataFusionRuntimeMaxBlockingThreads }}
        dataFusionRuntimeMaxIoEventsPerTick: {{ dataFusionRuntimeMaxIoEventsPerTick }}
        dataFusionRuntimeThreadKeepAlive:
          durationType: "{{ durationType }}"
          value: {{ value }}
        dataFusionRuntimeThreadPriority: {{ dataFusionRuntimeThreadPriority }}
        dataFusionMaxParquetFanout: {{ dataFusionMaxParquetFanout }}
        dataFusionUseCachedParquetLoader: {{ dataFusionUseCachedParquetLoader }}
        dataFusionConfig: "{{ dataFusionConfig }}"
        maxHttpRequestSize: {{ maxHttpRequestSize }}
        forceSnapshotMemThreshold:
          percent: "{{ percent }}"
          absolute: {{ absolute }}
        walSnapshotSize: {{ walSnapshotSize }}
        walMaxWriteBufferSize: {{ walMaxWriteBufferSize }}
        snapshottedWalFilesToKeep: {{ snapshottedWalFilesToKeep }}
        preemptiveCacheAge:
          durationType: "{{ durationType }}"
          value: {{ value }}
        parquetMemCachePrunePercentage: {{ parquetMemCachePrunePercentage }}
        parquetMemCachePruneInterval:
          durationType: "{{ durationType }}"
          value: {{ value }}
        disableParquetMemCache: {{ disableParquetMemCache }}
        parquetMemCacheQueryPathDuration:
          durationType: "{{ durationType }}"
          value: {{ value }}
        lastCacheEvictionInterval:
          durationType: "{{ durationType }}"
          value: {{ value }}
        distinctCacheEvictionInterval:
          durationType: "{{ durationType }}"
          value: {{ value }}
        gen1Duration:
          durationType: "{{ durationType }}"
          value: {{ value }}
        execMemPoolBytes:
          percent: "{{ percent }}"
          absolute: {{ absolute }}
        parquetMemCacheSize:
          percent: "{{ percent }}"
          absolute: {{ absolute }}
        walReplayFailOnError: {{ walReplayFailOnError }}
        walReplayConcurrencyLimit: {{ walReplayConcurrencyLimit }}
        tableIndexCacheMaxEntries: {{ tableIndexCacheMaxEntries }}
        tableIndexCacheConcurrencyLimit: {{ tableIndexCacheConcurrencyLimit }}
        gen1LookbackDuration:
          durationType: "{{ durationType }}"
          value: {{ value }}
        retentionCheckInterval:
          durationType: "{{ durationType }}"
          value: {{ value }}
        deleteGracePeriod:
          durationType: "{{ durationType }}"
          value: {{ value }}
        hardDeleteDefaultDuration:
          durationType: "{{ durationType }}"
          value: {{ value }}
        pluginRepositoryUrl: "{{ pluginRepositoryUrl }}"
        pluginRepositorySecretArn: "{{ pluginRepositorySecretArn }}"
      InfluxDBv3Enterprise:
        queryFileLimit: {{ queryFileLimit }}
        queryLogSize: {{ queryLogSize }}
        logFilter: "{{ logFilter }}"
        logFormat: "{{ logFormat }}"
        dataFusionNumThreads: {{ dataFusionNumThreads }}
        dataFusionRuntimeType: "{{ dataFusionRuntimeType }}"
        dataFusionRuntimeDisableLifoSlot: {{ dataFusionRuntimeDisableLifoSlot }}
        dataFusionRuntimeEventInterval: {{ dataFusionRuntimeEventInterval }}
        dataFusionRuntimeGlobalQueueInterval: {{ dataFusionRuntimeGlobalQueueInterval }}
        dataFusionRuntimeMaxBlockingThreads: {{ dataFusionRuntimeMaxBlockingThreads }}
        dataFusionRuntimeMaxIoEventsPerTick: {{ dataFusionRuntimeMaxIoEventsPerTick }}
        dataFusionRuntimeThreadKeepAlive:
          durationType: "{{ durationType }}"
          value: {{ value }}
        dataFusionRuntimeThreadPriority: {{ dataFusionRuntimeThreadPriority }}
        dataFusionMaxParquetFanout: {{ dataFusionMaxParquetFanout }}
        dataFusionUseCachedParquetLoader: {{ dataFusionUseCachedParquetLoader }}
        dataFusionConfig: "{{ dataFusionConfig }}"
        maxHttpRequestSize: {{ maxHttpRequestSize }}
        forceSnapshotMemThreshold:
          percent: "{{ percent }}"
          absolute: {{ absolute }}
        walSnapshotSize: {{ walSnapshotSize }}
        walMaxWriteBufferSize: {{ walMaxWriteBufferSize }}
        snapshottedWalFilesToKeep: {{ snapshottedWalFilesToKeep }}
        preemptiveCacheAge:
          durationType: "{{ durationType }}"
          value: {{ value }}
        parquetMemCachePrunePercentage: {{ parquetMemCachePrunePercentage }}
        parquetMemCachePruneInterval:
          durationType: "{{ durationType }}"
          value: {{ value }}
        disableParquetMemCache: {{ disableParquetMemCache }}
        parquetMemCacheQueryPathDuration:
          durationType: "{{ durationType }}"
          value: {{ value }}
        lastCacheEvictionInterval:
          durationType: "{{ durationType }}"
          value: {{ value }}
        distinctCacheEvictionInterval:
          durationType: "{{ durationType }}"
          value: {{ value }}
        gen1Duration:
          durationType: "{{ durationType }}"
          value: {{ value }}
        execMemPoolBytes:
          percent: "{{ percent }}"
          absolute: {{ absolute }}
        parquetMemCacheSize:
          percent: "{{ percent }}"
          absolute: {{ absolute }}
        walReplayFailOnError: {{ walReplayFailOnError }}
        walReplayConcurrencyLimit: {{ walReplayConcurrencyLimit }}
        tableIndexCacheMaxEntries: {{ tableIndexCacheMaxEntries }}
        tableIndexCacheConcurrencyLimit: {{ tableIndexCacheConcurrencyLimit }}
        gen1LookbackDuration:
          durationType: "{{ durationType }}"
          value: {{ value }}
        retentionCheckInterval:
          durationType: "{{ durationType }}"
          value: {{ value }}
        deleteGracePeriod:
          durationType: "{{ durationType }}"
          value: {{ value }}
        hardDeleteDefaultDuration:
          durationType: "{{ durationType }}"
          value: {{ value }}
        pluginRepositoryUrl: "{{ pluginRepositoryUrl }}"
        pluginRepositorySecretArn: "{{ pluginRepositorySecretArn }}"
        ingestQueryInstances: {{ ingestQueryInstances }}
        queryOnlyInstances: {{ queryOnlyInstances }}
        dedicatedCompactor: {{ dedicatedCompactor }}
        compactionRowLimit: {{ compactionRowLimit }}
        compactionMaxNumFilesPerPlan: {{ compactionMaxNumFilesPerPlan }}
        compactionGen2Duration:
          durationType: "{{ durationType }}"
          value: {{ value }}
        compactionMultipliers: "{{ compactionMultipliers }}"
        compactionCleanupWait:
          durationType: "{{ durationType }}"
          value: {{ value }}
        compactionCheckInterval:
          durationType: "{{ durationType }}"
          value: {{ value }}
        lastValueCacheDisableFromHistory: {{ lastValueCacheDisableFromHistory }}
        distinctValueCacheDisableFromHistory: {{ distinctValueCacheDisableFromHistory }}
        replicationInterval:
          durationType: "{{ durationType }}"
          value: {{ value }}
        catalogSyncInterval:
          durationType: "{{ durationType }}"
          value: {{ value }}
  - name: tags
    value: "{{ tags }}"
    description: |
      A list of key-value pairs to associate with the DB parameter group.