Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . timestream-influxdb ]

create-db-parameter-group¶

Description¶

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

Synopsis¶

  create-db-parameter-group
--name <value>
[--description <value>]
[--parameters <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--name (string)

The name of the DB parameter group. The name must be unique per customer and per region.

--description (string)

A description of the DB parameter group.

--parameters (tagged union structure)

A list of the parameters that comprise the DB parameter group.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: InfluxDBv2, InfluxDBv3Core, InfluxDBv3Enterprise.

InfluxDBv2 -> (structure)

All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.

fluxLogEnabled -> (boolean)

Include option to show detailed logs for Flux queries.

Default: false

logLevel -> (string)

Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.

Default: info

noTasks -> (boolean)

Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.

Default: false

queryConcurrency -> (integer)

Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.

Default: 0

queryQueueSize -> (integer)

Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.

Default: 0

tracingType -> (string)

Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.

metricsDisabled -> (boolean)

Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics .

Default: false

httpIdleTimeout -> (structure)

Maximum duration the server should keep established connections alive while waiting for new requests. Set to 0 for no timeout.

Default: 3 minutes

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

httpReadHeaderTimeout -> (structure)

Maximum duration the server should try to read HTTP headers for new requests. Set to 0 for no timeout.

Default: 10 seconds

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

httpReadTimeout -> (structure)

Maximum duration the server should try to read the entirety of new requests. Set to 0 for no timeout.

Default: 0

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

httpWriteTimeout -> (structure)

Maximum duration the server should spend processing and responding to write requests. Set to 0 for no timeout.

Default: 0

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

influxqlMaxSelectBuckets -> (long)

Maximum number of group by time buckets a SELECT statement can create. 0 allows an unlimited number of buckets.

Default: 0

influxqlMaxSelectPoint -> (long)

Maximum number of points a SELECT statement can process. 0 allows an unlimited number of points. InfluxDB checks the point count every second (so queries exceeding the maximum aren’t immediately aborted).

Default: 0

influxqlMaxSelectSeries -> (long)

Maximum number of series a SELECT statement can return. 0 allows an unlimited number of series.

Default: 0

pprofDisabled -> (boolean)

Disable the /debug/pprof HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging.

Default: true

queryInitialMemoryBytes -> (long)

Initial bytes of memory allocated for a query.

Default: 0

queryMaxMemoryBytes -> (long)

Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.

Default: 0

queryMemoryBytes -> (long)

Maximum bytes of memory allowed for a single query. Must be greater or equal to queryInitialMemoryBytes.

Default: 0

sessionLength -> (integer)

Specifies the Time to Live (TTL) in minutes for newly created user sessions.

Default: 60

sessionRenewDisabled -> (boolean)

Disables automatically extending a user’s session TTL on each request. By default, every request sets the session’s expiration time to five minutes from now. When disabled, sessions expire after the specified session length and the user is redirected to the login page, even if recently active.

Default: false

storageCacheMaxMemorySize -> (long)

Maximum size (in bytes) a shard’s cache can reach before it starts rejecting writes. Must be greater than storageCacheSnapShotMemorySize and lower than instance’s total memory capacity. We recommend setting it to below 15% of the total memory capacity.

Default: 1073741824

storageCacheSnapshotMemorySize -> (long)

Size (in bytes) at which the storage engine will snapshot the cache and write it to a TSM file to make more memory available. Must not be greater than storageCacheMaxMemorySize.

Default: 26214400

storageCacheSnapshotWriteColdDuration -> (structure)

Duration at which the storage engine will snapshot the cache and write it to a new TSM file if the shard hasn’t received writes or deletes.

Default: 10 minutes

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

storageCompactFullWriteColdDuration -> (structure)

Duration at which the storage engine will compact all TSM files in a shard if it hasn’t received writes or deletes.

Default: 4 hours

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

storageCompactThroughputBurst -> (long)

Rate limit (in bytes per second) that TSM compactions can write to disk.

Default: 50331648

storageMaxConcurrentCompactions -> (integer)

Maximum number of full and level compactions that can run concurrently. A value of 0 results in 50% of runtime.GOMAXPROCS(0) used at runtime. Any number greater than zero limits compactions to that value. This setting does not apply to cache snapshotting.

Default: 0

storageMaxIndexLogFileSize -> (long)

Size (in bytes) at which an index write-ahead log (WAL) file will compact into an index file. Lower sizes will cause log files to be compacted more quickly and result in lower heap usage at the expense of write throughput.

Default: 1048576

storageNoValidateFieldSize -> (boolean)

Skip field size validation on incoming write requests.

Default: false

storageRetentionCheckInterval -> (structure)

Interval of retention policy enforcement checks. Must be greater than 0.

Default: 30 minutes

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

storageSeriesFileMaxConcurrentSnapshotCompactions -> (integer)

Maximum number of snapshot compactions that can run concurrently across all series partitions in a database.

Default: 0

storageSeriesIdSetCacheSize -> (long)

Size of the internal cache used in the TSI index to store previously calculated series results. Cached results are returned quickly rather than needing to be recalculated when a subsequent query with the same tag key/value predicate is executed. Setting this value to 0 will disable the cache and may decrease query performance.

Default: 100

storageWalMaxConcurrentWrites -> (integer)

Maximum number writes to the WAL directory to attempt at the same time. Setting this value to 0 results in number of processing units available x2.

Default: 0

storageWalMaxWriteDelay -> (structure)

Maximum amount of time a write request to the WAL directory will wait when the maximum number of concurrent active writes to the WAL directory has been met . Set to 0 to disable the timeout.

Default: 10 minutes

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

uiDisabled -> (boolean)

Disable the InfluxDB user interface (UI). The UI is enabled by default.

Default: false

InfluxDBv3Core -> (structure)

All the customer-modifiable InfluxDB v3 Core parameters in Timestream for InfluxDB.

queryFileLimit -> (integer)

Limits the number of Parquet files a query can access. If a query attempts to read more than this limit, InfluxDB 3 returns an error.

Default: 432

queryLogSize -> (integer)

Defines the size of the query log. Up to this many queries remain in the log before older queries are evicted to make room for new ones.

Default: 1000

logFilter -> (string)

Sets the filter directive for logs.

logFormat -> (string)

Defines the message format for logs.

Default: full

dataFusionNumThreads -> (integer)

Sets the maximum number of DataFusion runtime threads to use.

dataFusionRuntimeType -> (string)

Specifies the DataFusion tokio runtime type.

Default: multi-thread

dataFusionRuntimeDisableLifoSlot -> (boolean)

Disables the LIFO slot of the DataFusion runtime.

dataFusionRuntimeEventInterval -> (integer)

Sets the number of scheduler ticks after which the scheduler of the DataFusion tokio runtime polls for external events–for example: timers, I/O.

dataFusionRuntimeGlobalQueueInterval -> (integer)

Sets the number of scheduler ticks after which the scheduler of the DataFusion runtime polls the global task queue.

dataFusionRuntimeMaxBlockingThreads -> (integer)

Specifies the limit for additional threads spawned by the DataFusion runtime.

dataFusionRuntimeMaxIoEventsPerTick -> (integer)

Configures the maximum number of events processed per tick by the tokio DataFusion runtime.

dataFusionRuntimeThreadKeepAlive -> (structure)

Sets a custom timeout for a thread in the blocking pool of the tokio DataFusion runtime.

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

dataFusionRuntimeThreadPriority -> (integer)

Sets the thread priority for tokio DataFusion runtime workers.

Default: 10

dataFusionMaxParquetFanout -> (integer)

When multiple parquet files are required in a sorted way (deduplication for example), specifies the maximum fanout.

Default: 1000

dataFusionUseCachedParquetLoader -> (boolean)

Uses a cached parquet loader when reading parquet files from the object store.

dataFusionConfig -> (string)

Provides custom configuration to DataFusion as a comma-separated list of key:value pairs.

maxHttpRequestSize -> (long)

Specifies the maximum size of HTTP requests.

Default: 10485760

forceSnapshotMemThreshold -> (tagged union structure)

Specifies the threshold for the internal memory buffer. Supports either a percentage (portion of available memory) or absolute value in MB–for example: 70% or 100

Default: 70%

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: percent, absolute.

percent -> (string)

Percent for InfluxDB parameters.

absolute -> (long)

Absolute long for InfluxDB parameters.

walSnapshotSize -> (integer)

Defines the number of WAL files to attempt to remove in a snapshot. This, multiplied by the interval, determines how often snapshots are taken.

Default: 600

walMaxWriteBufferSize -> (integer)

Specifies the maximum number of write requests that can be buffered before a flush must be executed and succeed.

Default: 100000

snapshottedWalFilesToKeep -> (integer)

Specifies the number of snapshotted WAL files to retain in the object store. Flushing the WAL files does not clear the WAL files immediately; they are deleted when the number of snapshotted WAL files exceeds this number.

Default: 300

preemptiveCacheAge -> (structure)

Specifies the interval to prefetch into the Parquet cache during compaction.

Default: 3d

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

parquetMemCachePrunePercentage -> (float)

Specifies the percentage of entries to prune during a prune operation on the in-memory Parquet cache.

Default: 0.1

parquetMemCachePruneInterval -> (structure)

Sets the interval to check if the in-memory Parquet cache needs to be pruned.

Default: 1s

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

disableParquetMemCache -> (boolean)

Disables the in-memory Parquet cache. By default, the cache is enabled.

parquetMemCacheQueryPathDuration -> (structure)

Specifies the time window for caching recent Parquet files in memory.

Default: 5h

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

lastCacheEvictionInterval -> (structure)

Specifies the interval to evict expired entries from the Last-N-Value cache, expressed as a human-readable duration–for example: 20s, 1m, 1h.

Default: 10s

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

distinctCacheEvictionInterval -> (structure)

Specifies the interval to evict expired entries from the distinct value cache, expressed as a human-readable duration–for example: 20s, 1m, 1h.

Default: 10s

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

gen1Duration -> (structure)

Specifies the duration that Parquet files are arranged into. Data timestamps land each row into a file of this duration. Supported durations are 1m, 5m, and 10m. These files are known as “generation 1” files that the compactor in InfluxDB 3 Enterprise can merge into larger generations.

Default: 10m

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

execMemPoolBytes -> (tagged union structure)

Specifies the size of memory pool used during query execution. Can be given as absolute value in bytes or as a percentage of the total available memory–for example: 8000000000 or 10%.

Default: 20%

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: percent, absolute.

percent -> (string)

Percent for InfluxDB parameters.

absolute -> (long)

Absolute long for InfluxDB parameters.

parquetMemCacheSize -> (tagged union structure)

Specifies the size of the in-memory Parquet cache in megabytes or percentage of total available memory.

Default: 20%

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: percent, absolute.

percent -> (string)

Percent for InfluxDB parameters.

absolute -> (long)

Absolute long for InfluxDB parameters.

walReplayFailOnError -> (boolean)

Determines whether WAL replay should fail when encountering errors.

Default: false

walReplayConcurrencyLimit -> (integer)

Concurrency limit during WAL replay. Setting this number too high can lead to OOM. The default is dynamically determined.

Default: max(num_cpus, 10)

tableIndexCacheMaxEntries -> (integer)

Specifies the maximum number of entries in the table index cache.

Default: 1000

tableIndexCacheConcurrencyLimit -> (integer)

Limits the concurrency level for table index cache operations.

Default: 8

gen1LookbackDuration -> (structure)

Specifies how far back to look when creating generation 1 Parquet files.

Default: 24h

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

retentionCheckInterval -> (structure)

The interval at which retention policies are checked and enforced. Enter as a human-readable time–for example: 30m or 1h.

Default: 30m

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

deleteGracePeriod -> (structure)

Specifies the grace period before permanently deleting data.

Default: 24h

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

hardDeleteDefaultDuration -> (structure)

Sets the default duration for hard deletion of data.

Default: 90d

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

InfluxDBv3Enterprise -> (structure)

All the customer-modifiable InfluxDB v3 Enterprise parameters in Timestream for InfluxDB.

queryFileLimit -> (integer)

Limits the number of Parquet files a query can access. If a query attempts to read more than this limit, InfluxDB 3 returns an error.

Default: 432

queryLogSize -> (integer)

Defines the size of the query log. Up to this many queries remain in the log before older queries are evicted to make room for new ones.

Default: 1000

logFilter -> (string)

Sets the filter directive for logs.

logFormat -> (string)

Defines the message format for logs.

Default: full

dataFusionNumThreads -> (integer)

Sets the maximum number of DataFusion runtime threads to use.

dataFusionRuntimeType -> (string)

Specifies the DataFusion tokio runtime type.

Default: multi-thread

dataFusionRuntimeDisableLifoSlot -> (boolean)

Disables the LIFO slot of the DataFusion runtime.

dataFusionRuntimeEventInterval -> (integer)

Sets the number of scheduler ticks after which the scheduler of the DataFusion tokio runtime polls for external events–for example: timers, I/O.

dataFusionRuntimeGlobalQueueInterval -> (integer)

Sets the number of scheduler ticks after which the scheduler of the DataFusion runtime polls the global task queue.

dataFusionRuntimeMaxBlockingThreads -> (integer)

Specifies the limit for additional threads spawned by the DataFusion runtime.

dataFusionRuntimeMaxIoEventsPerTick -> (integer)

Configures the maximum number of events processed per tick by the tokio DataFusion runtime.

dataFusionRuntimeThreadKeepAlive -> (structure)

Sets a custom timeout for a thread in the blocking pool of the tokio DataFusion runtime.

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

dataFusionRuntimeThreadPriority -> (integer)

Sets the thread priority for tokio DataFusion runtime workers.

Default: 10

dataFusionMaxParquetFanout -> (integer)

When multiple parquet files are required in a sorted way (deduplication for example), specifies the maximum fanout.

Default: 1000

dataFusionUseCachedParquetLoader -> (boolean)

Uses a cached parquet loader when reading parquet files from the object store.

dataFusionConfig -> (string)

Provides custom configuration to DataFusion as a comma-separated list of key:value pairs.

maxHttpRequestSize -> (long)

Specifies the maximum size of HTTP requests.

Default: 10485760

forceSnapshotMemThreshold -> (tagged union structure)

Specifies the threshold for the internal memory buffer. Supports either a percentage (portion of available memory) or absolute value in MB–for example: 70% or 100

Default: 70%

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: percent, absolute.

percent -> (string)

Percent for InfluxDB parameters.

absolute -> (long)

Absolute long for InfluxDB parameters.

walSnapshotSize -> (integer)

Defines the number of WAL files to attempt to remove in a snapshot. This, multiplied by the interval, determines how often snapshots are taken.

Default: 600

walMaxWriteBufferSize -> (integer)

Specifies the maximum number of write requests that can be buffered before a flush must be executed and succeed.

Default: 100000

snapshottedWalFilesToKeep -> (integer)

Specifies the number of snapshotted WAL files to retain in the object store. Flushing the WAL files does not clear the WAL files immediately; they are deleted when the number of snapshotted WAL files exceeds this number.

Default: 300

preemptiveCacheAge -> (structure)

Specifies the interval to prefetch into the Parquet cache during compaction.

Default: 3d

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

parquetMemCachePrunePercentage -> (float)

Specifies the percentage of entries to prune during a prune operation on the in-memory Parquet cache.

Default: 0.1

parquetMemCachePruneInterval -> (structure)

Sets the interval to check if the in-memory Parquet cache needs to be pruned.

Default: 1s

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

disableParquetMemCache -> (boolean)

Disables the in-memory Parquet cache. By default, the cache is enabled.

parquetMemCacheQueryPathDuration -> (structure)

Specifies the time window for caching recent Parquet files in memory.

Default: 5h

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

lastCacheEvictionInterval -> (structure)

Specifies the interval to evict expired entries from the Last-N-Value cache, expressed as a human-readable duration–for example: 20s, 1m, 1h.

Default: 10s

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

distinctCacheEvictionInterval -> (structure)

Specifies the interval to evict expired entries from the distinct value cache, expressed as a human-readable duration–for example: 20s, 1m, 1h.

Default: 10s

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

gen1Duration -> (structure)

Specifies the duration that Parquet files are arranged into. Data timestamps land each row into a file of this duration. Supported durations are 1m, 5m, and 10m. These files are known as “generation 1” files, which the compactor can merge into larger generations.

Default: 10m

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

execMemPoolBytes -> (tagged union structure)

Specifies the size of memory pool used during query execution. Can be given as absolute value in bytes or as a percentage of the total available memory–for example: 8000000000 or 10%.

Default: 20%

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: percent, absolute.

percent -> (string)

Percent for InfluxDB parameters.

absolute -> (long)

Absolute long for InfluxDB parameters.

parquetMemCacheSize -> (tagged union structure)

Specifies the size of the in-memory Parquet cache in megabytes or percentage of total available memory.

Default: 20%

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: percent, absolute.

percent -> (string)

Percent for InfluxDB parameters.

absolute -> (long)

Absolute long for InfluxDB parameters.

walReplayFailOnError -> (boolean)

Determines whether WAL replay should fail when encountering errors.

Default: false

walReplayConcurrencyLimit -> (integer)

Concurrency limit during WAL replay. Setting this number too high can lead to OOM. The default is dynamically determined.

Default: max(num_cpus, 10)

tableIndexCacheMaxEntries -> (integer)

Specifies the maximum number of entries in the table index cache.

Default: 1000

tableIndexCacheConcurrencyLimit -> (integer)

Limits the concurrency level for table index cache operations.

Default: 8

gen1LookbackDuration -> (structure)

Specifies how far back to look when creating generation 1 Parquet files.

Default: 24h

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

retentionCheckInterval -> (structure)

The interval at which retention policies are checked and enforced. Enter as a human-readable time–for example: 30m or 1h.

Default: 30m

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

deleteGracePeriod -> (structure)

Specifies the grace period before permanently deleting data.

Default: 24h

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

hardDeleteDefaultDuration -> (structure)

Sets the default duration for hard deletion of data.

Default: 90d

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

ingestQueryInstances -> (integer)

Specifies number of instances in the DbCluster which can both ingest and query.

queryOnlyInstances -> (integer)

Specifies number of instances in the DbCluster which can only query.

dedicatedCompactor -> (boolean)

Specifies if the compactor instance should be a standalone instance or not.

compactionRowLimit -> (integer)

Specifies the soft limit for the number of rows per file that the compactor writes. The compactor may write more rows than this limit.

Default: 1000000

compactionMaxNumFilesPerPlan -> (integer)

Sets the maximum number of files included in any compaction plan.

Default: 500

compactionGen2Duration -> (structure)

Specifies the duration of the first level of compaction (gen2). Later levels of compaction are multiples of this duration. This value should be equal to or greater than the gen1 duration.

Default: 20m

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

compactionMultipliers -> (string)

Specifies a comma-separated list of multiples defining the duration of each level of compaction. The number of elements in the list determines the number of compaction levels. The first element specifies the duration of the first level (gen3); subsequent levels are multiples of the previous level.

Default: 3,4,6,5

compactionCleanupWait -> (structure)

Specifies the amount of time that the compactor waits after finishing a compaction run to delete files marked as needing deletion during that compaction run.

Default: 10m

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

compactionCheckInterval -> (structure)

Specifies how often the compactor checks for new compaction work to perform.

Default: 10s

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

lastValueCacheDisableFromHistory -> (boolean)

Disables populating the last-N-value cache from historical data. If disabled, the cache is still populated with data from the write-ahead log (WAL).

distinctValueCacheDisableFromHistory -> (boolean)

Disables populating the distinct value cache from historical data. If disabled, the cache is still populated with data from the write-ahead log (WAL).

replicationInterval -> (structure)

Specifies the interval at which data replication occurs between cluster nodes.

Default: 250ms

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

catalogSyncInterval -> (structure)

Defines how often the catalog synchronizes across cluster nodes.

Default: 10s

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

Shorthand Syntax:

InfluxDBv2={fluxLogEnabled=boolean,logLevel=string,noTasks=boolean,queryConcurrency=integer,queryQueueSize=integer,tracingType=string,metricsDisabled=boolean,httpIdleTimeout={durationType=string,value=long},httpReadHeaderTimeout={durationType=string,value=long},httpReadTimeout={durationType=string,value=long},httpWriteTimeout={durationType=string,value=long},influxqlMaxSelectBuckets=long,influxqlMaxSelectPoint=long,influxqlMaxSelectSeries=long,pprofDisabled=boolean,queryInitialMemoryBytes=long,queryMaxMemoryBytes=long,queryMemoryBytes=long,sessionLength=integer,sessionRenewDisabled=boolean,storageCacheMaxMemorySize=long,storageCacheSnapshotMemorySize=long,storageCacheSnapshotWriteColdDuration={durationType=string,value=long},storageCompactFullWriteColdDuration={durationType=string,value=long},storageCompactThroughputBurst=long,storageMaxConcurrentCompactions=integer,storageMaxIndexLogFileSize=long,storageNoValidateFieldSize=boolean,storageRetentionCheckInterval={durationType=string,value=long},storageSeriesFileMaxConcurrentSnapshotCompactions=integer,storageSeriesIdSetCacheSize=long,storageWalMaxConcurrentWrites=integer,storageWalMaxWriteDelay={durationType=string,value=long},uiDisabled=boolean},InfluxDBv3Core={queryFileLimit=integer,queryLogSize=integer,logFilter=string,logFormat=string,dataFusionNumThreads=integer,dataFusionRuntimeType=string,dataFusionRuntimeDisableLifoSlot=boolean,dataFusionRuntimeEventInterval=integer,dataFusionRuntimeGlobalQueueInterval=integer,dataFusionRuntimeMaxBlockingThreads=integer,dataFusionRuntimeMaxIoEventsPerTick=integer,dataFusionRuntimeThreadKeepAlive={durationType=string,value=long},dataFusionRuntimeThreadPriority=integer,dataFusionMaxParquetFanout=integer,dataFusionUseCachedParquetLoader=boolean,dataFusionConfig=string,maxHttpRequestSize=long,forceSnapshotMemThreshold={percent=string,absolute=long},walSnapshotSize=integer,walMaxWriteBufferSize=integer,snapshottedWalFilesToKeep=integer,preemptiveCacheAge={durationType=string,value=long},parquetMemCachePrunePercentage=float,parquetMemCachePruneInterval={durationType=string,value=long},disableParquetMemCache=boolean,parquetMemCacheQueryPathDuration={durationType=string,value=long},lastCacheEvictionInterval={durationType=string,value=long},distinctCacheEvictionInterval={durationType=string,value=long},gen1Duration={durationType=string,value=long},execMemPoolBytes={percent=string,absolute=long},parquetMemCacheSize={percent=string,absolute=long},walReplayFailOnError=boolean,walReplayConcurrencyLimit=integer,tableIndexCacheMaxEntries=integer,tableIndexCacheConcurrencyLimit=integer,gen1LookbackDuration={durationType=string,value=long},retentionCheckInterval={durationType=string,value=long},deleteGracePeriod={durationType=string,value=long},hardDeleteDefaultDuration={durationType=string,value=long}},InfluxDBv3Enterprise={queryFileLimit=integer,queryLogSize=integer,logFilter=string,logFormat=string,dataFusionNumThreads=integer,dataFusionRuntimeType=string,dataFusionRuntimeDisableLifoSlot=boolean,dataFusionRuntimeEventInterval=integer,dataFusionRuntimeGlobalQueueInterval=integer,dataFusionRuntimeMaxBlockingThreads=integer,dataFusionRuntimeMaxIoEventsPerTick=integer,dataFusionRuntimeThreadKeepAlive={durationType=string,value=long},dataFusionRuntimeThreadPriority=integer,dataFusionMaxParquetFanout=integer,dataFusionUseCachedParquetLoader=boolean,dataFusionConfig=string,maxHttpRequestSize=long,forceSnapshotMemThreshold={percent=string,absolute=long},walSnapshotSize=integer,walMaxWriteBufferSize=integer,snapshottedWalFilesToKeep=integer,preemptiveCacheAge={durationType=string,value=long},parquetMemCachePrunePercentage=float,parquetMemCachePruneInterval={durationType=string,value=long},disableParquetMemCache=boolean,parquetMemCacheQueryPathDuration={durationType=string,value=long},lastCacheEvictionInterval={durationType=string,value=long},distinctCacheEvictionInterval={durationType=string,value=long},gen1Duration={durationType=string,value=long},execMemPoolBytes={percent=string,absolute=long},parquetMemCacheSize={percent=string,absolute=long},walReplayFailOnError=boolean,walReplayConcurrencyLimit=integer,tableIndexCacheMaxEntries=integer,tableIndexCacheConcurrencyLimit=integer,gen1LookbackDuration={durationType=string,value=long},retentionCheckInterval={durationType=string,value=long},deleteGracePeriod={durationType=string,value=long},hardDeleteDefaultDuration={durationType=string,value=long},ingestQueryInstances=integer,queryOnlyInstances=integer,dedicatedCompactor=boolean,compactionRowLimit=integer,compactionMaxNumFilesPerPlan=integer,compactionGen2Duration={durationType=string,value=long},compactionMultipliers=string,compactionCleanupWait={durationType=string,value=long},compactionCheckInterval={durationType=string,value=long},lastValueCacheDisableFromHistory=boolean,distinctValueCacheDisableFromHistory=boolean,replicationInterval={durationType=string,value=long},catalogSyncInterval={durationType=string,value=long}}

JSON Syntax:

{
  "InfluxDBv2": {
    "fluxLogEnabled": true|false,
    "logLevel": "debug"|"info"|"error",
    "noTasks": true|false,
    "queryConcurrency": integer,
    "queryQueueSize": integer,
    "tracingType": "log"|"jaeger"|"disabled",
    "metricsDisabled": true|false,
    "httpIdleTimeout": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "httpReadHeaderTimeout": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "httpReadTimeout": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "httpWriteTimeout": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "influxqlMaxSelectBuckets": long,
    "influxqlMaxSelectPoint": long,
    "influxqlMaxSelectSeries": long,
    "pprofDisabled": true|false,
    "queryInitialMemoryBytes": long,
    "queryMaxMemoryBytes": long,
    "queryMemoryBytes": long,
    "sessionLength": integer,
    "sessionRenewDisabled": true|false,
    "storageCacheMaxMemorySize": long,
    "storageCacheSnapshotMemorySize": long,
    "storageCacheSnapshotWriteColdDuration": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "storageCompactFullWriteColdDuration": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "storageCompactThroughputBurst": long,
    "storageMaxConcurrentCompactions": integer,
    "storageMaxIndexLogFileSize": long,
    "storageNoValidateFieldSize": true|false,
    "storageRetentionCheckInterval": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "storageSeriesFileMaxConcurrentSnapshotCompactions": integer,
    "storageSeriesIdSetCacheSize": long,
    "storageWalMaxConcurrentWrites": integer,
    "storageWalMaxWriteDelay": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "uiDisabled": true|false
  },
  "InfluxDBv3Core": {
    "queryFileLimit": integer,
    "queryLogSize": integer,
    "logFilter": "string",
    "logFormat": "full",
    "dataFusionNumThreads": integer,
    "dataFusionRuntimeType": "multi-thread"|"multi-thread-alt",
    "dataFusionRuntimeDisableLifoSlot": true|false,
    "dataFusionRuntimeEventInterval": integer,
    "dataFusionRuntimeGlobalQueueInterval": integer,
    "dataFusionRuntimeMaxBlockingThreads": integer,
    "dataFusionRuntimeMaxIoEventsPerTick": integer,
    "dataFusionRuntimeThreadKeepAlive": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "dataFusionRuntimeThreadPriority": integer,
    "dataFusionMaxParquetFanout": integer,
    "dataFusionUseCachedParquetLoader": true|false,
    "dataFusionConfig": "string",
    "maxHttpRequestSize": long,
    "forceSnapshotMemThreshold": {
      "percent": "string",
      "absolute": long
    },
    "walSnapshotSize": integer,
    "walMaxWriteBufferSize": integer,
    "snapshottedWalFilesToKeep": integer,
    "preemptiveCacheAge": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "parquetMemCachePrunePercentage": float,
    "parquetMemCachePruneInterval": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "disableParquetMemCache": true|false,
    "parquetMemCacheQueryPathDuration": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "lastCacheEvictionInterval": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "distinctCacheEvictionInterval": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "gen1Duration": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "execMemPoolBytes": {
      "percent": "string",
      "absolute": long
    },
    "parquetMemCacheSize": {
      "percent": "string",
      "absolute": long
    },
    "walReplayFailOnError": true|false,
    "walReplayConcurrencyLimit": integer,
    "tableIndexCacheMaxEntries": integer,
    "tableIndexCacheConcurrencyLimit": integer,
    "gen1LookbackDuration": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "retentionCheckInterval": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "deleteGracePeriod": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "hardDeleteDefaultDuration": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    }
  },
  "InfluxDBv3Enterprise": {
    "queryFileLimit": integer,
    "queryLogSize": integer,
    "logFilter": "string",
    "logFormat": "full",
    "dataFusionNumThreads": integer,
    "dataFusionRuntimeType": "multi-thread"|"multi-thread-alt",
    "dataFusionRuntimeDisableLifoSlot": true|false,
    "dataFusionRuntimeEventInterval": integer,
    "dataFusionRuntimeGlobalQueueInterval": integer,
    "dataFusionRuntimeMaxBlockingThreads": integer,
    "dataFusionRuntimeMaxIoEventsPerTick": integer,
    "dataFusionRuntimeThreadKeepAlive": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "dataFusionRuntimeThreadPriority": integer,
    "dataFusionMaxParquetFanout": integer,
    "dataFusionUseCachedParquetLoader": true|false,
    "dataFusionConfig": "string",
    "maxHttpRequestSize": long,
    "forceSnapshotMemThreshold": {
      "percent": "string",
      "absolute": long
    },
    "walSnapshotSize": integer,
    "walMaxWriteBufferSize": integer,
    "snapshottedWalFilesToKeep": integer,
    "preemptiveCacheAge": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "parquetMemCachePrunePercentage": float,
    "parquetMemCachePruneInterval": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "disableParquetMemCache": true|false,
    "parquetMemCacheQueryPathDuration": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "lastCacheEvictionInterval": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "distinctCacheEvictionInterval": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "gen1Duration": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "execMemPoolBytes": {
      "percent": "string",
      "absolute": long
    },
    "parquetMemCacheSize": {
      "percent": "string",
      "absolute": long
    },
    "walReplayFailOnError": true|false,
    "walReplayConcurrencyLimit": integer,
    "tableIndexCacheMaxEntries": integer,
    "tableIndexCacheConcurrencyLimit": integer,
    "gen1LookbackDuration": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "retentionCheckInterval": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "deleteGracePeriod": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "hardDeleteDefaultDuration": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "ingestQueryInstances": integer,
    "queryOnlyInstances": integer,
    "dedicatedCompactor": true|false,
    "compactionRowLimit": integer,
    "compactionMaxNumFilesPerPlan": integer,
    "compactionGen2Duration": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "compactionMultipliers": "string",
    "compactionCleanupWait": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "compactionCheckInterval": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "lastValueCacheDisableFromHistory": true|false,
    "distinctValueCacheDisableFromHistory": true|false,
    "replicationInterval": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    },
    "catalogSyncInterval": {
      "durationType": "hours"|"minutes"|"seconds"|"milliseconds"|"days",
      "value": long
    }
  }
}

--tags (map)

A list of key-value pairs to associate with the DB parameter group.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output¶

id -> (string)

A service-generated unique identifier.

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.

arn -> (string)

The Amazon Resource Name (ARM) of the DB parameter group.

description -> (string)

The description of the DB parameter group.

parameters -> (tagged union structure)

A list of the parameters that comprise the DB parameter group.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: InfluxDBv2, InfluxDBv3Core, InfluxDBv3Enterprise.

InfluxDBv2 -> (structure)

All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.

fluxLogEnabled -> (boolean)

Include option to show detailed logs for Flux queries.

Default: false

logLevel -> (string)

Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.

Default: info

noTasks -> (boolean)

Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.

Default: false

queryConcurrency -> (integer)

Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.

Default: 0

queryQueueSize -> (integer)

Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.

Default: 0

tracingType -> (string)

Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.

metricsDisabled -> (boolean)

Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics .

Default: false

httpIdleTimeout -> (structure)

Maximum duration the server should keep established connections alive while waiting for new requests. Set to 0 for no timeout.

Default: 3 minutes

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

httpReadHeaderTimeout -> (structure)

Maximum duration the server should try to read HTTP headers for new requests. Set to 0 for no timeout.

Default: 10 seconds

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

httpReadTimeout -> (structure)

Maximum duration the server should try to read the entirety of new requests. Set to 0 for no timeout.

Default: 0

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

httpWriteTimeout -> (structure)

Maximum duration the server should spend processing and responding to write requests. Set to 0 for no timeout.

Default: 0

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

influxqlMaxSelectBuckets -> (long)

Maximum number of group by time buckets a SELECT statement can create. 0 allows an unlimited number of buckets.

Default: 0

influxqlMaxSelectPoint -> (long)

Maximum number of points a SELECT statement can process. 0 allows an unlimited number of points. InfluxDB checks the point count every second (so queries exceeding the maximum aren’t immediately aborted).

Default: 0

influxqlMaxSelectSeries -> (long)

Maximum number of series a SELECT statement can return. 0 allows an unlimited number of series.

Default: 0

pprofDisabled -> (boolean)

Disable the /debug/pprof HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging.

Default: true

queryInitialMemoryBytes -> (long)

Initial bytes of memory allocated for a query.

Default: 0

queryMaxMemoryBytes -> (long)

Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.

Default: 0

queryMemoryBytes -> (long)

Maximum bytes of memory allowed for a single query. Must be greater or equal to queryInitialMemoryBytes.

Default: 0

sessionLength -> (integer)

Specifies the Time to Live (TTL) in minutes for newly created user sessions.

Default: 60

sessionRenewDisabled -> (boolean)

Disables automatically extending a user’s session TTL on each request. By default, every request sets the session’s expiration time to five minutes from now. When disabled, sessions expire after the specified session length and the user is redirected to the login page, even if recently active.

Default: false

storageCacheMaxMemorySize -> (long)

Maximum size (in bytes) a shard’s cache can reach before it starts rejecting writes. Must be greater than storageCacheSnapShotMemorySize and lower than instance’s total memory capacity. We recommend setting it to below 15% of the total memory capacity.

Default: 1073741824

storageCacheSnapshotMemorySize -> (long)

Size (in bytes) at which the storage engine will snapshot the cache and write it to a TSM file to make more memory available. Must not be greater than storageCacheMaxMemorySize.

Default: 26214400

storageCacheSnapshotWriteColdDuration -> (structure)

Duration at which the storage engine will snapshot the cache and write it to a new TSM file if the shard hasn’t received writes or deletes.

Default: 10 minutes

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

storageCompactFullWriteColdDuration -> (structure)

Duration at which the storage engine will compact all TSM files in a shard if it hasn’t received writes or deletes.

Default: 4 hours

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

storageCompactThroughputBurst -> (long)

Rate limit (in bytes per second) that TSM compactions can write to disk.

Default: 50331648

storageMaxConcurrentCompactions -> (integer)

Maximum number of full and level compactions that can run concurrently. A value of 0 results in 50% of runtime.GOMAXPROCS(0) used at runtime. Any number greater than zero limits compactions to that value. This setting does not apply to cache snapshotting.

Default: 0

storageMaxIndexLogFileSize -> (long)

Size (in bytes) at which an index write-ahead log (WAL) file will compact into an index file. Lower sizes will cause log files to be compacted more quickly and result in lower heap usage at the expense of write throughput.

Default: 1048576

storageNoValidateFieldSize -> (boolean)

Skip field size validation on incoming write requests.

Default: false

storageRetentionCheckInterval -> (structure)

Interval of retention policy enforcement checks. Must be greater than 0.

Default: 30 minutes

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

storageSeriesFileMaxConcurrentSnapshotCompactions -> (integer)

Maximum number of snapshot compactions that can run concurrently across all series partitions in a database.

Default: 0

storageSeriesIdSetCacheSize -> (long)

Size of the internal cache used in the TSI index to store previously calculated series results. Cached results are returned quickly rather than needing to be recalculated when a subsequent query with the same tag key/value predicate is executed. Setting this value to 0 will disable the cache and may decrease query performance.

Default: 100

storageWalMaxConcurrentWrites -> (integer)

Maximum number writes to the WAL directory to attempt at the same time. Setting this value to 0 results in number of processing units available x2.

Default: 0

storageWalMaxWriteDelay -> (structure)

Maximum amount of time a write request to the WAL directory will wait when the maximum number of concurrent active writes to the WAL directory has been met . Set to 0 to disable the timeout.

Default: 10 minutes

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

uiDisabled -> (boolean)

Disable the InfluxDB user interface (UI). The UI is enabled by default.

Default: false

InfluxDBv3Core -> (structure)

All the customer-modifiable InfluxDB v3 Core parameters in Timestream for InfluxDB.

queryFileLimit -> (integer)

Limits the number of Parquet files a query can access. If a query attempts to read more than this limit, InfluxDB 3 returns an error.

Default: 432

queryLogSize -> (integer)

Defines the size of the query log. Up to this many queries remain in the log before older queries are evicted to make room for new ones.

Default: 1000

logFilter -> (string)

Sets the filter directive for logs.

logFormat -> (string)

Defines the message format for logs.

Default: full

dataFusionNumThreads -> (integer)

Sets the maximum number of DataFusion runtime threads to use.

dataFusionRuntimeType -> (string)

Specifies the DataFusion tokio runtime type.

Default: multi-thread

dataFusionRuntimeDisableLifoSlot -> (boolean)

Disables the LIFO slot of the DataFusion runtime.

dataFusionRuntimeEventInterval -> (integer)

Sets the number of scheduler ticks after which the scheduler of the DataFusion tokio runtime polls for external events–for example: timers, I/O.

dataFusionRuntimeGlobalQueueInterval -> (integer)

Sets the number of scheduler ticks after which the scheduler of the DataFusion runtime polls the global task queue.

dataFusionRuntimeMaxBlockingThreads -> (integer)

Specifies the limit for additional threads spawned by the DataFusion runtime.

dataFusionRuntimeMaxIoEventsPerTick -> (integer)

Configures the maximum number of events processed per tick by the tokio DataFusion runtime.

dataFusionRuntimeThreadKeepAlive -> (structure)

Sets a custom timeout for a thread in the blocking pool of the tokio DataFusion runtime.

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

dataFusionRuntimeThreadPriority -> (integer)

Sets the thread priority for tokio DataFusion runtime workers.

Default: 10

dataFusionMaxParquetFanout -> (integer)

When multiple parquet files are required in a sorted way (deduplication for example), specifies the maximum fanout.

Default: 1000

dataFusionUseCachedParquetLoader -> (boolean)

Uses a cached parquet loader when reading parquet files from the object store.

dataFusionConfig -> (string)

Provides custom configuration to DataFusion as a comma-separated list of key:value pairs.

maxHttpRequestSize -> (long)

Specifies the maximum size of HTTP requests.

Default: 10485760

forceSnapshotMemThreshold -> (tagged union structure)

Specifies the threshold for the internal memory buffer. Supports either a percentage (portion of available memory) or absolute value in MB–for example: 70% or 100

Default: 70%

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: percent, absolute.

percent -> (string)

Percent for InfluxDB parameters.

absolute -> (long)

Absolute long for InfluxDB parameters.

walSnapshotSize -> (integer)

Defines the number of WAL files to attempt to remove in a snapshot. This, multiplied by the interval, determines how often snapshots are taken.

Default: 600

walMaxWriteBufferSize -> (integer)

Specifies the maximum number of write requests that can be buffered before a flush must be executed and succeed.

Default: 100000

snapshottedWalFilesToKeep -> (integer)

Specifies the number of snapshotted WAL files to retain in the object store. Flushing the WAL files does not clear the WAL files immediately; they are deleted when the number of snapshotted WAL files exceeds this number.

Default: 300

preemptiveCacheAge -> (structure)

Specifies the interval to prefetch into the Parquet cache during compaction.

Default: 3d

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

parquetMemCachePrunePercentage -> (float)

Specifies the percentage of entries to prune during a prune operation on the in-memory Parquet cache.

Default: 0.1

parquetMemCachePruneInterval -> (structure)

Sets the interval to check if the in-memory Parquet cache needs to be pruned.

Default: 1s

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

disableParquetMemCache -> (boolean)

Disables the in-memory Parquet cache. By default, the cache is enabled.

parquetMemCacheQueryPathDuration -> (structure)

Specifies the time window for caching recent Parquet files in memory.

Default: 5h

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

lastCacheEvictionInterval -> (structure)

Specifies the interval to evict expired entries from the Last-N-Value cache, expressed as a human-readable duration–for example: 20s, 1m, 1h.

Default: 10s

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

distinctCacheEvictionInterval -> (structure)

Specifies the interval to evict expired entries from the distinct value cache, expressed as a human-readable duration–for example: 20s, 1m, 1h.

Default: 10s

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

gen1Duration -> (structure)

Specifies the duration that Parquet files are arranged into. Data timestamps land each row into a file of this duration. Supported durations are 1m, 5m, and 10m. These files are known as “generation 1” files that the compactor in InfluxDB 3 Enterprise can merge into larger generations.

Default: 10m

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

execMemPoolBytes -> (tagged union structure)

Specifies the size of memory pool used during query execution. Can be given as absolute value in bytes or as a percentage of the total available memory–for example: 8000000000 or 10%.

Default: 20%

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: percent, absolute.

percent -> (string)

Percent for InfluxDB parameters.

absolute -> (long)

Absolute long for InfluxDB parameters.

parquetMemCacheSize -> (tagged union structure)

Specifies the size of the in-memory Parquet cache in megabytes or percentage of total available memory.

Default: 20%

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: percent, absolute.

percent -> (string)

Percent for InfluxDB parameters.

absolute -> (long)

Absolute long for InfluxDB parameters.

walReplayFailOnError -> (boolean)

Determines whether WAL replay should fail when encountering errors.

Default: false

walReplayConcurrencyLimit -> (integer)

Concurrency limit during WAL replay. Setting this number too high can lead to OOM. The default is dynamically determined.

Default: max(num_cpus, 10)

tableIndexCacheMaxEntries -> (integer)

Specifies the maximum number of entries in the table index cache.

Default: 1000

tableIndexCacheConcurrencyLimit -> (integer)

Limits the concurrency level for table index cache operations.

Default: 8

gen1LookbackDuration -> (structure)

Specifies how far back to look when creating generation 1 Parquet files.

Default: 24h

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

retentionCheckInterval -> (structure)

The interval at which retention policies are checked and enforced. Enter as a human-readable time–for example: 30m or 1h.

Default: 30m

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

deleteGracePeriod -> (structure)

Specifies the grace period before permanently deleting data.

Default: 24h

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

hardDeleteDefaultDuration -> (structure)

Sets the default duration for hard deletion of data.

Default: 90d

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

InfluxDBv3Enterprise -> (structure)

All the customer-modifiable InfluxDB v3 Enterprise parameters in Timestream for InfluxDB.

queryFileLimit -> (integer)

Limits the number of Parquet files a query can access. If a query attempts to read more than this limit, InfluxDB 3 returns an error.

Default: 432

queryLogSize -> (integer)

Defines the size of the query log. Up to this many queries remain in the log before older queries are evicted to make room for new ones.

Default: 1000

logFilter -> (string)

Sets the filter directive for logs.

logFormat -> (string)

Defines the message format for logs.

Default: full

dataFusionNumThreads -> (integer)

Sets the maximum number of DataFusion runtime threads to use.

dataFusionRuntimeType -> (string)

Specifies the DataFusion tokio runtime type.

Default: multi-thread

dataFusionRuntimeDisableLifoSlot -> (boolean)

Disables the LIFO slot of the DataFusion runtime.

dataFusionRuntimeEventInterval -> (integer)

Sets the number of scheduler ticks after which the scheduler of the DataFusion tokio runtime polls for external events–for example: timers, I/O.

dataFusionRuntimeGlobalQueueInterval -> (integer)

Sets the number of scheduler ticks after which the scheduler of the DataFusion runtime polls the global task queue.

dataFusionRuntimeMaxBlockingThreads -> (integer)

Specifies the limit for additional threads spawned by the DataFusion runtime.

dataFusionRuntimeMaxIoEventsPerTick -> (integer)

Configures the maximum number of events processed per tick by the tokio DataFusion runtime.

dataFusionRuntimeThreadKeepAlive -> (structure)

Sets a custom timeout for a thread in the blocking pool of the tokio DataFusion runtime.

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

dataFusionRuntimeThreadPriority -> (integer)

Sets the thread priority for tokio DataFusion runtime workers.

Default: 10

dataFusionMaxParquetFanout -> (integer)

When multiple parquet files are required in a sorted way (deduplication for example), specifies the maximum fanout.

Default: 1000

dataFusionUseCachedParquetLoader -> (boolean)

Uses a cached parquet loader when reading parquet files from the object store.

dataFusionConfig -> (string)

Provides custom configuration to DataFusion as a comma-separated list of key:value pairs.

maxHttpRequestSize -> (long)

Specifies the maximum size of HTTP requests.

Default: 10485760

forceSnapshotMemThreshold -> (tagged union structure)

Specifies the threshold for the internal memory buffer. Supports either a percentage (portion of available memory) or absolute value in MB–for example: 70% or 100

Default: 70%

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: percent, absolute.

percent -> (string)

Percent for InfluxDB parameters.

absolute -> (long)

Absolute long for InfluxDB parameters.

walSnapshotSize -> (integer)

Defines the number of WAL files to attempt to remove in a snapshot. This, multiplied by the interval, determines how often snapshots are taken.

Default: 600

walMaxWriteBufferSize -> (integer)

Specifies the maximum number of write requests that can be buffered before a flush must be executed and succeed.

Default: 100000

snapshottedWalFilesToKeep -> (integer)

Specifies the number of snapshotted WAL files to retain in the object store. Flushing the WAL files does not clear the WAL files immediately; they are deleted when the number of snapshotted WAL files exceeds this number.

Default: 300

preemptiveCacheAge -> (structure)

Specifies the interval to prefetch into the Parquet cache during compaction.

Default: 3d

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

parquetMemCachePrunePercentage -> (float)

Specifies the percentage of entries to prune during a prune operation on the in-memory Parquet cache.

Default: 0.1

parquetMemCachePruneInterval -> (structure)

Sets the interval to check if the in-memory Parquet cache needs to be pruned.

Default: 1s

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

disableParquetMemCache -> (boolean)

Disables the in-memory Parquet cache. By default, the cache is enabled.

parquetMemCacheQueryPathDuration -> (structure)

Specifies the time window for caching recent Parquet files in memory.

Default: 5h

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

lastCacheEvictionInterval -> (structure)

Specifies the interval to evict expired entries from the Last-N-Value cache, expressed as a human-readable duration–for example: 20s, 1m, 1h.

Default: 10s

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

distinctCacheEvictionInterval -> (structure)

Specifies the interval to evict expired entries from the distinct value cache, expressed as a human-readable duration–for example: 20s, 1m, 1h.

Default: 10s

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

gen1Duration -> (structure)

Specifies the duration that Parquet files are arranged into. Data timestamps land each row into a file of this duration. Supported durations are 1m, 5m, and 10m. These files are known as “generation 1” files, which the compactor can merge into larger generations.

Default: 10m

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

execMemPoolBytes -> (tagged union structure)

Specifies the size of memory pool used during query execution. Can be given as absolute value in bytes or as a percentage of the total available memory–for example: 8000000000 or 10%.

Default: 20%

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: percent, absolute.

percent -> (string)

Percent for InfluxDB parameters.

absolute -> (long)

Absolute long for InfluxDB parameters.

parquetMemCacheSize -> (tagged union structure)

Specifies the size of the in-memory Parquet cache in megabytes or percentage of total available memory.

Default: 20%

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: percent, absolute.

percent -> (string)

Percent for InfluxDB parameters.

absolute -> (long)

Absolute long for InfluxDB parameters.

walReplayFailOnError -> (boolean)

Determines whether WAL replay should fail when encountering errors.

Default: false

walReplayConcurrencyLimit -> (integer)

Concurrency limit during WAL replay. Setting this number too high can lead to OOM. The default is dynamically determined.

Default: max(num_cpus, 10)

tableIndexCacheMaxEntries -> (integer)

Specifies the maximum number of entries in the table index cache.

Default: 1000

tableIndexCacheConcurrencyLimit -> (integer)

Limits the concurrency level for table index cache operations.

Default: 8

gen1LookbackDuration -> (structure)

Specifies how far back to look when creating generation 1 Parquet files.

Default: 24h

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

retentionCheckInterval -> (structure)

The interval at which retention policies are checked and enforced. Enter as a human-readable time–for example: 30m or 1h.

Default: 30m

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

deleteGracePeriod -> (structure)

Specifies the grace period before permanently deleting data.

Default: 24h

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

hardDeleteDefaultDuration -> (structure)

Sets the default duration for hard deletion of data.

Default: 90d

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

ingestQueryInstances -> (integer)

Specifies number of instances in the DbCluster which can both ingest and query.

queryOnlyInstances -> (integer)

Specifies number of instances in the DbCluster which can only query.

dedicatedCompactor -> (boolean)

Specifies if the compactor instance should be a standalone instance or not.

compactionRowLimit -> (integer)

Specifies the soft limit for the number of rows per file that the compactor writes. The compactor may write more rows than this limit.

Default: 1000000

compactionMaxNumFilesPerPlan -> (integer)

Sets the maximum number of files included in any compaction plan.

Default: 500

compactionGen2Duration -> (structure)

Specifies the duration of the first level of compaction (gen2). Later levels of compaction are multiples of this duration. This value should be equal to or greater than the gen1 duration.

Default: 20m

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

compactionMultipliers -> (string)

Specifies a comma-separated list of multiples defining the duration of each level of compaction. The number of elements in the list determines the number of compaction levels. The first element specifies the duration of the first level (gen3); subsequent levels are multiples of the previous level.

Default: 3,4,6,5

compactionCleanupWait -> (structure)

Specifies the amount of time that the compactor waits after finishing a compaction run to delete files marked as needing deletion during that compaction run.

Default: 10m

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

compactionCheckInterval -> (structure)

Specifies how often the compactor checks for new compaction work to perform.

Default: 10s

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

lastValueCacheDisableFromHistory -> (boolean)

Disables populating the last-N-value cache from historical data. If disabled, the cache is still populated with data from the write-ahead log (WAL).

distinctValueCacheDisableFromHistory -> (boolean)

Disables populating the distinct value cache from historical data. If disabled, the cache is still populated with data from the write-ahead log (WAL).

replicationInterval -> (structure)

Specifies the interval at which data replication occurs between cluster nodes.

Default: 250ms

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

catalogSyncInterval -> (structure)

Defines how often the catalog synchronizes across cluster nodes.

Default: 10s

durationType -> (string)

The type of duration for InfluxDB parameters.

value -> (long)

The value of duration for InfluxDB parameters.

Table of Contents

Feedback

User Guide

Note:

create-db-parameter-group¶

Description¶

Synopsis¶

Options¶

Note

Note

Note

Note

Note

Note

Note

Global Options¶

Output¶

Note

Note

Note

Note

Note

Note

Note