AWS timestream documentation change
Summary
Various documentation improvements including typo fixes, capitalization corrections, command syntax updates, and clarifications on parameter configurations. Notably, the default value for the 'pprof-disabled' parameter is documented as being set to true by AWS to disable the /debug/pprof endpoint by default.
Security assessment
The change documents that AWS sets 'pprof-disabled' to true by default, which disables a debugging endpoint and improves security posture. However, there is no evidence this addresses a specific active security vulnerability. Other changes are routine documentation improvements without explicit security context.
Diff
diff --git a/timestream/latest/developerguide/timestream-for-influx-db-connecting.md index 94b5c9c41..2efdf0046 100644 --- a/timestream/latest/developerguide/timestream-for-influx-db-connecting.md +++ b/timestream/latest/developerguide/timestream-for-influx-db-connecting.md @@ -5 +5 @@ -Finding the connection information for an Amazon Timestream for InfluxDB DB instanceDatabase authentication optionsWorking with Parameter Groups +Finding the connection information for an Amazon Timestream for InfluxDB DB instanceDatabase authentication optionsWorking with parameter groups @@ -9 +9 @@ Finding the connection information for an Amazon Timestream for InfluxDB DB inst -Before you can connect to a DB instance, you must create the DB instance. For information, see [Creating a DB instance](./timestream-for-influx-configuring.html#timestream-for-influx-configuring-create-db). After Amazon Timestream provisions your DB instance, use the influxDB API, Influx CLI or any compatible client or utility for InfluxDB to connect to the DB instance. +Before you can connect to a DB instance, you must create the DB instance. For information, see [Creating a DB instance](./timestream-for-influx-configuring.html#timestream-for-influx-configuring-create-db). After Amazon Timestream provisions your DB instance, use the InfluxDB API, influx CLI, or any compatible client or utility for InfluxDB to connect to the DB instance. @@ -15 +15 @@ Before you can connect to a DB instance, you must create the DB instance. For in - * Working with Parameter Groups + * Working with parameter groups @@ -21 +21 @@ Before you can connect to a DB instance, you must create the DB instance. For in -The connection information for a DB instance includes its endpoint, port, username, password and a valid access token, such as the operator or all access token. For example, for an Timestream for InfluxDB DB instance, suppose that the endpoint value is `c5vasdqn0b-3ksj4dla5nfjhi.timestream-influxdb.us-east-1.on.aws`. In this case, the port value is 8086, and the database user is _admin_. Given this information, to access the instance you will use: +The connection information for a DB instance includes its endpoint, port, username, password, and a valid access token, such as the operator or all-access token. For example, for a Timestream for InfluxDB DB instance, suppose that the endpoint value is `c5vasdqn0b-3ksj4dla5nfjhi.timestream-influxdb.us-east-1.on.aws`. In this case, the port value is 8086, and the database user is _admin_. Given this information, to access the instance you will use: @@ -25 +25 @@ The connection information for a DB instance includes its endpoint, port, userna - * Either the username and passwords supplied when creating the instance or valid access token. + * Either the username and password supplied when creating the instance or valid access token. @@ -30 +30 @@ The connection information for a DB instance includes its endpoint, port, userna -Instances created before 12/09/2024 will have an endpoint that contains the instance name instead of the instance id. For example: `influxdb1-123456789.us-east-1.timestream-influxdb.amazonaws.com`. +Instances created before December 9, 2024 will have an endpoint that contains the instance name instead of the instance ID. For example: `influxdb1-123456789.us-east-1.timestream-influxdb.amazonaws.com`. @@ -34 +34 @@ Instances created before 12/09/2024 will have an endpoint that contains the inst -When you created your Timestream for InfluxDB Db instance, part of the DBInstance response object you receive a `influxAuthParametersSecretArn`. This will hold an arn to a SecretsManager secret in your account. It will only be populated after your InfluxDB DB instances is available. The secret contains influx authentication parameters provided during the `CreateDbInstance` process. This is a READONLY copy as any updates/modifications/deletions to this secret doesn't impact the created DB instance. If you delete this secret, our API response will still refer to the deleted secret arn. +As part of the DB instance response object, you will receive a `influxAuthParametersSecretArn`. This will hold an ARN to a Secrets Manager secret in your account. t will only be populated after your InfluxDB DB instances are available. The secret contains Influx authentication parameters provided during the `CreateDbInstance` process. This is a **read-only** copy as any updates/modifications/deletions to this secret doesn't impact the created DB instance. If you delete this secret, our API response will still refer to the deleted secret ARN. @@ -36 +36 @@ When you created your Timestream for InfluxDB Db instance, part of the DBInstanc -The endpoint is unique for each DB instance, and the values of the port and user can vary. To connect to a DB instance, you can use the Influx CLI, Influx API, or any client compatible with InfluxDB. +The endpoint is unique for each DB instance, and the values of the port and user can vary. To connect to a DB instance, you can use the influx CLI, InfluxDB API, or any client compatible with InfluxDB. @@ -38 +38 @@ The endpoint is unique for each DB instance, and the values of the port and user -To find the connection information for a DB instance, use the AWS Management Console. You can also use the AWS Command Line Interface (AWS CLI) `describe-db-instances` command or the Timestream-influxdb API `GetDBInstance` operation. +To find the connection information for a DB instance, use the AWS Management Console. You can also use the AWS Command Line Interface (AWS CLI) `describe-db-instances` command or the Timestream for InfluxDB API `GetDBInstance` operation. @@ -48 +48 @@ To find the connection information for a DB instance, use the AWS Management Con - 4. On the **Summary** section , copy the endpoint. Also, note the port number. You need both the endpoint and the port number to connect to the DB instance. + 4. In the **Summary** section, copy the endpoint. Also, note the port number. You will need both the endpoint and the port number to connect to the DB instance. @@ -57 +57 @@ If you need to find the user name and password information, choose the **Configu - * To find the connection information for a InfluxDB DB instance by using the AWS CLI, call the get-db-instance command. In the call, query for the DB instance ID, endpoint, port, and influxAuthParametersSecret. + * To find the connection information for a InfluxDB DB instance by using the AWS CLI, call the `get-db-instance` command. In the call, query for the DB instance ID, endpoint, port, and influxAuthParametersSecretArn. @@ -66 +66 @@ For Windows: - aws timestream-influxdb get-db-instance --identifier id \ + aws timestream-influxdb get-db-instance --identifier id ^ @@ -69 +69 @@ For Windows: -Your output should be similar to the following. To access the username information you will need to check the `InfluxAuthParameterSecret`. +Your output should be similar to the following. To access the username information, you will need to check the `InfluxAuthParameterSecret`. @@ -84 +84 @@ Your output should be similar to the following. To access the username informati -With this information you are going to be able to connect for your instance to retrieve or create your access tokens. There are several ways to achieve this: +With this information, you are going to be able to connect to your instance to retrieve or create your access tokens. There are several ways to achieve this: @@ -90 +90 @@ With this information you are going to be able to connect for your instance to r - 2. When configuring your Influx CLI config use `--username-password` to authenticate. + 2. When configuring your influx CLI config, use `--username-password` to authenticate. @@ -98 +98 @@ With this information you are going to be able to connect for your instance to r - 4. Once you have the operator token, you can use the [influx auth list](https://docs.influxdata.com/influxdb/v2/reference/cli/influx/auth/list) command to view tokens all your tokens. You can use the [influx auth create](https://docs.influxdata.com/influxdb/v2/reference/cli/influx/auth/create/) command to create an all access token. + 4. Once you have the operator token, you can use the [influx auth list](https://docs.influxdata.com/influxdb/v2/reference/cli/influx/auth/list) command to view all your tokens. You can use the [influx auth create](https://docs.influxdata.com/influxdb/v2/reference/cli/influx/auth/create/) command to create an all-access token. @@ -105 +105 @@ With this information you are going to be able to connect for your instance to r -You will need to perform this step to obtain your operator token first, to then be able to create new tokens using the InfluxDB API or CLI. +You will need to perform this step to obtain your operator token first. Then you will be able to create new tokens using the InfluxDB API or CLI. @@ -107 +107 @@ You will need to perform this step to obtain your operator token first, to then -###### Using the Influx UI +###### Using the InfluxDB UI @@ -111 +111 @@ You will need to perform this step to obtain your operator token first, to then -Alternatively you can open the InfluxUI from the Timestream for InfluxDB management Console: +Alternatively you can open the InfluxDB UI from the Amazon Timestream for InfluxDB console: @@ -113 +113 @@ Alternatively you can open the InfluxUI from the Timestream for InfluxDB managem - 1. Sign in to the AWS Management Console and open the Amazon Timestream for InfluxDB console at [https://console.aws.amazon.com/timestream/.](https://console.aws.amazon.com/console.aws.amazon.com/timestream/) + 1. Sign in to the AWS Management Console and open the Timestream for InfluxDB console at [https://console.aws.amazon.com/timestream/.](https://console.aws.amazon.com/timestream/) @@ -117 +117 @@ Alternatively you can open the InfluxUI from the Timestream for InfluxDB managem - 3. In the **Databases** list, choose the name of your InfluxDB instance to show its details. In the upper right corner, choose **Open Influx UI**. + 3. In the **Databases** list, choose the name of your InfluxDB instance to show its details. In the upper right corner, choose **InfluxDB UI**. @@ -119 +119 @@ Alternatively you can open the InfluxUI from the Timestream for InfluxDB managem - 2. Once logged into your InfluxUI, navigate to **Load Data** and then **API Tokens** using the left navigation bar. + 2. Once logged in to your InfluxDB UI, navigate to **Load Data** and then **API Tokens** using the left navigation bar. @@ -121 +121 @@ Alternatively you can open the InfluxUI from the Timestream for InfluxDB managem - 3. Choose **\+ GENERATE API TOKEN** and select **All Access API Token**. + 3. Choose **Generate API Token** and select **All Access API Token**. @@ -132 +132 @@ Alternatively you can open the InfluxUI from the Timestream for InfluxDB managem -When creating tokens from the InfluxUI, the newly created tokens are only going to be shown once. Make sure you copy these since if not, you will need to re-created them. +When creating tokens from the InfluxDB UI, the newly created tokens are only going to be shown once. Make sure you copy these. Otherwise, you will need to re-create them. @@ -165 +165 @@ Include the following with your request: -The following example uses `curl` and the InfluxDB API to generate an all access token: +The following example uses `curl` and the InfluxDB API to generate an all-access token: @@ -233 +233 @@ Amazon Timestream for InfluxDB supports the following ways to authenticate datab - * **Password authentication** – Your DB instance performs all administration of user accounts. You create users, specify passwords, and administer tokens using the InfluxUI, Influx CLI or influx API. + * **Password authentication** – Your DB instance performs all administration of user accounts. You create users, specify passwords, and administer tokens using the InfluxDB UI, influx CLI, or InfluxDB API. @@ -235 +235 @@ Amazon Timestream for InfluxDB supports the following ways to authenticate datab - * **Token Authentication** – Your DB instance performs all administration of user accounts. You can create users, specify password, and administer tokens using your operator token using the Influx CLI, and Influx API. + * **Token authentication** – Your DB instance performs all administration of user accounts. You can create users, specify passwords, and administer tokens using your operator token via the influx CLI and InfluxDB API. @@ -244 +244 @@ You can use Secure Socket Layer (SSL) or Transport Layer Security (TLS) from you -## Working with Parameter Groups +## Working with parameter groups @@ -283 +283 @@ The following limitations apply to the DB parameter group name: - * If you create a DB instance without specifying a DB parameter group, the DB instance uses the influxDB engine defaults. + * If you create a DB instance without specifying a DB parameter group, the DB instance uses the InfluxDB engine defaults. @@ -319 +319 @@ To determine the supported parameters for your DB instance, view the parameters -For more information about all parameter supported by the open-source version of InfluxDB, see [InfluxDB configuration options](https://docs.influxdata.com/influxdb/v2/reference/config-options/?t=JSON). Currently you will only be able to modify the following InfluxDB parameters: +For more information about all parameters supported by the open-source version of InfluxDB, see [InfluxDB configuration options](https://docs.influxdata.com/influxdb/v2/reference/config-options/?t=JSON). Currently you will only be able to modify the following InfluxDB parameters: @@ -323 +323 @@ Parameter | Description | Default value | Value | Valid range | Note -[flux-log-enabled](https://docs.influxdata.com/influxdb/v2/reference/config-options/?t=JSON) | Include option to show detailed logs for Flux queries | FALSE | true, false | N/A | +[flux-log-enabled](https://docs.influxdata.com/influxdb/v2/reference/config-options/?t=JSON) | Include option to show detailed logs for Flux queries | FALSE | Boolean | N/A | @@ -325,3 +325,3 @@ Parameter | Description | Default value | Value | Valid range | Note -[no-tasks](https://docs.influxdata.com/influxdb/v2/reference/config-options/#no-tasks) | Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries. | FALSE | true, false | N/A | -[query-concurrency](https://docs.influxdata.com/influxdb/v2/reference/config-options/#query-concurrency) | Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks. | 1024 | | N/A | -[query-queue-size](https://docs.influxdata.com/influxdb/v2/reference/config-options/#query-queue-size) | 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. | 1024 | | N/A | +[no-tasks](https://docs.influxdata.com/influxdb/v2/reference/config-options/#no-tasks) | Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks. | FALSE | Boolean | N/A | +[query-concurrency](https://docs.influxdata.com/influxdb/v2/reference/config-options/#query-concurrency) | Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries. | 1,024 | | N/A | +[query-queue-size](https://docs.influxdata.com/influxdb/v2/reference/config-options/#query-queue-size) | 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. | 1,024 | | N/A | @@ -330,4 +330,4 @@ Parameter | Description | Default value | Value | Valid range | Note -[http-idle-timeout](https://docs.influxdata.com/influxdb/v2/reference/config-options/#http-idle-timeout) | Maximum duration the server should keep established connections alive while waiting for new requests. Set to `0` for no timeout. | 3m0s | Duration with unit `hours`, `minutes`, `seconds`, `milliseconds`. Example: `durationType=minutes,value=10` | Hours:-Minimum: 0-Maximum: 256205Minutes:-Minimum: 0-Maximum: 15372286Seconds:-Minimum: 0-Maximum: 922337203Milliseconds:-Minimum: 0-Maximum: 922337203685 | -[http-read-header-timeout](https://docs.influxdata.com/influxdb/v2/reference/config-options/#http-read-header-timeout) | Maximum duration the server should try to read HTTP headers for new requests. Set to `0` for no time out. | 10s | Duration with unit `hours`, `minutes`, `seconds`, `milliseconds`. Example: `durationType=minutes,value=10` | Hours:-Minimum: 0-Maximum: 256205Minutes:-Minimum: 0-Maximum: 15372286Seconds:-Minimum: 0-Maximum: 922337203Milliseconds:-Minimum: 0-Maximum: 922337203685 | -[http-read-timeout](https://docs.influxdata.com/influxdb/v2/reference/config-options/#http-read-timeout) | Maximum duration the server should try to read the entirety of new requests. Set to `0` for no time out. | 0 | Duration with unit `hours`, `minutes`, `seconds`, `milliseconds`. Example: `durationType=minutes,value=10` | Hours:-Minimum: 0-Maximum: 256205Minutes:-Minimum: 0-Maximum: 15372286Seconds:-Minimum: 0-Maximum: 922337203Milliseconds:-Minimum: 0-Maximum: 922337203685 | -[http-write-timeout](https://docs.influxdata.com/influxdb/v2/reference/config-options/#http-write-timeout) | Maximum duration the server should spend processing and responding to write requests. Set to `0` for no time out. | 0 | Duration with unit `hours`, `minutes`, `seconds`, `milliseconds`. Example: `durationType=minutes,value=10` | Hours:-Minimum: 0-Maximum: 256205Minutes:-Minimum: 0-Maximum: 15372286Seconds:-Minimum: 0-Maximum: 922337203Milliseconds:-Minimum: 0-Maximum: 922337203685 | +[http-idle-timeout](https://docs.influxdata.com/influxdb/v2/reference/config-options/#http-idle-timeout) | Maximum duration the server should keep established connections alive while waiting for new requests. Set to `0` for no timeout. | 3m0s | Duration with unit `hours`, `minutes`, `seconds`, `milliseconds`. Example: `durationType=minutes,value=10` | Hours:-Minimum: 0-Maximum: 256,205Minutes:-Minimum: 0-Maximum: 15,372,286Seconds:-Minimum: 0-Maximum: 922,337,203Milliseconds:-Minimum: 0-Maximum: 922,337,203,685 | +[http-read-header-timeout](https://docs.influxdata.com/influxdb/v2/reference/config-options/#http-read-header-timeout) | Maximum duration the server should try to read HTTP headers for new requests. Set to `0` for no timeout. | 10s | Duration with unit `hours`, `minutes`, `seconds`, `milliseconds`. Example: `durationType=minutes,value=10` | Hours:-Minimum: 0-Maximum: 256,205Minutes:-Minimum: 0-Maximum: 15,372,286Seconds:-Minimum: 0-Maximum: 922,337,203Milliseconds:-Minimum: 0-Maximum: 922,337,203,685 | +[http-read-timeout](https://docs.influxdata.com/influxdb/v2/reference/config-options/#http-read-timeout) | Maximum duration the server should try to read the entirety of new requests. Set to `0` for no timeout. | 0 | Duration with unit `hours`, `minutes`, `seconds`, `milliseconds`. Example: `durationType=minutes,value=10` | Hours:-Minimum: 0-Maximum: 256,205Minutes:-Minimum: 0-Maximum: 15,372,286Seconds:-Minimum: 0-Maximum: 922,337,203Milliseconds:-Minimum: 0-Maximum: 922,337,203,685 | +[http-write-timeout](https://docs.influxdata.com/influxdb/v2/reference/config-options/#http-write-timeout) | Maximum duration the server should spend processing and responding to write requests. Set to `0` for no timeout. | 0 | Duration with unit `hours`, `minutes`, `seconds`, `milliseconds`. Example: `durationType=minutes,value=10` | Hours:-Minimum: 0-Maximum: 256,205Minutes:-Minimum: 0-Maximum: 15,372,286Seconds:-Minimum: 0-Maximum: 922,337,203Milliseconds:-Minimum: 0-Maximum: 922,337,203,685 | @@ -337 +337 @@ Parameter | Description | Default value | Value | Valid range | Note -[pprof-disabled](https://docs.influxdata.com/influxdb/v2/reference/config-options/#pprof-disabled) | Disable the `/debug/pprof` HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging. | FALSE | Boolean | N/A | +[pprof-disabled](https://docs.influxdata.com/influxdb/v2/reference/config-options/#pprof-disabled) | Disable the `/debug/pprof` HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging. | TRUE | Boolean | N/A | While InfluxDB sets pprof-disabled as `false` by default, AWS sets it as `true` by default. @@ -341,9 +341,9 @@ Parameter | Description | Default value | Value | Valid range | Note -[session-length](https://docs.influxdata.com/influxdb/v2/reference/config-options/#session-length) | Specifies the Time to Live (TTL) in minutes for newly created user sessions. | 60 | Integer | Minimum: 0Maximum: 2880 | -[session-renew-disabled](https://docs.influxdata.com/influxdb/v2/reference/config-options/#session-renew-disabled) | 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](https://docs.influxdata.com/influxdb/v2/reference/config-options/#session-length) and the user is redirected to the login page, even if recently active. | FALSE | Boolean | N/A | -[storage-cache-max-memory-size](https://docs.influxdata.com/influxdb/v2/reference/config-options/#storage-cache-max-memory-size) | Maximum size (in bytes) a shard’s cache can reach before it starts rejecting writes. | 1073741824 | Long | Minimum: 0Maximum: 549755813888 | Must be lower than instance's total memory capacity.We recommend setting it to below 15% of the total memory capacity. -[storage-cache-snapshot-memory-size](https://docs.influxdata.com/influxdb/v2/reference/config-options/#storage-cache-snapshot-memory-size) | Size (in bytes) at which the storage engine will snapshot the cache and write it to a TSM file to make more memory available. | 26214400 | Long | Minimum: 0Maximum: 549755813888 | Must be lower than storage-cache-max-memory-size. -[storage-cache-snapshot-write-cold-duration](https://docs.influxdata.com/influxdb/v2/reference/config-options/#storage-cache-snapshot-write-cold-duration) | 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. | 10m0s | Duration with unit `hours`, `minutes`, `seconds`, `milliseconds`. Example: `durationType=minutes,value=10` | Hours:-Minimum: 0-Maximum: 256205Minutes:-Minimum: 0-Maximum: 15372286Seconds:-Minimum: 0-Maximum: 922337203Milliseconds:-Minimum: 0-Maximum: 922337203685 | -[storage-compact-full-write-cold-duration](https://docs.influxdata.com/influxdb/v2/reference/config-options/#storage-compact-full-write-cold-duration) | Duration at which the storage engine will compact all TSM files in a shard if it hasn’t received writes or deletes. | 4h0m0s | Duration with unit `hours`, `minutes`, `seconds`, `milliseconds`. Example: `durationType=minutes,value=10` | Hours:-Minimum: 0-Maximum: 256205Minutes:-Minimum: 0-Maximum: 15372286Seconds:-Minimum: 0-Maximum: 922337203Milliseconds:-Minimum: 0-Maximum: 922337203685 | -[storage-compact-throughput-burst](https://docs.influxdata.com/influxdb/v2/reference/config-options/#storage-compact-throughput-burst) | Rate limit (in bytes per second) that TSM compactions can write to disk. | 50331648 | Long | Minimum: 0Maximum: 9,223,372,036,854,775,807 | -[storage-max-concurrent-compactions](https://docs.influxdata.com/influxdb/v2/reference/config-options/#storage-max-concurrent-compactions) | 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. | 0 | Integer | Minimum: 0Maximum: 64 | -[storage-max-index-log-file-size](https://docs.influxdata.com/influxdb/v2/reference/config-options/#storage-max-index-log-file-size) | 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. | 1048576 | Long | Minimum: 0Maximum: 9,223,372,036,854,775,807 | +[session-length](https://docs.influxdata.com/influxdb/v2/reference/config-options/#session-length) | Specifies the Time to Live (TTL) in minutes for newly created user sessions. | 60 | Integer | Minimum: 0Maximum: 2,880 | +[session-renew-disabled](https://docs.influxdata.com/influxdb/v2/reference/config-options/#session-renew-disabled) | Disables automatically extending a user’s session TTL on each request. By default, every request sets the session’s expiration time to 5 minutes from now. When disabled, sessions expire after the specified [session length](https://docs.influxdata.com/influxdb/v2/reference/config-options/#session-length) and the user is redirected to the login page, even if recently active. | FALSE | Boolean | N/A | +[storage-cache-max-memory-size](https://docs.influxdata.com/influxdb/v2/reference/config-options/#storage-cache-max-memory-size) | Maximum size (in bytes) a shard’s cache can reach before it starts rejecting writes. | 1,073,741,824 | Long | Minimum: 0Maximum: 549,755,813,888 | Must be lower than instance's total memory capacity.We recommend setting it to below 15 percent of the total memory capacity. +[storage-cache-snapshot-memory-size](https://docs.influxdata.com/influxdb/v2/reference/config-options/#storage-cache-snapshot-memory-size) | Size (in bytes) at which the storage engine will snapshot the cache and write it to a TSM file to make more memory available. | 26,214,400 | Long | Minimum: 0Maximum: 549,755,813,888 | Must be lower than storage-cache-max-memory-size. +[storage-cache-snapshot-write-cold-duration](https://docs.influxdata.com/influxdb/v2/reference/config-options/#storage-cache-snapshot-write-cold-duration) | 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. | 10m0s | Duration with unit `hours`, `minutes`, `seconds`, `milliseconds`. Example: `durationType=minutes,value=10` | Hours:-Minimum: 0-Maximum: 256,205Minutes:-Minimum: 0-Maximum: 15,372,286Seconds:-Minimum: 0-Maximum: 922,337,203Milliseconds:-Minimum: 0-Maximum: 922,337,203,685 | +[storage-compact-full-write-cold-duration](https://docs.influxdata.com/influxdb/v2/reference/config-options/#storage-compact-full-write-cold-duration) | Duration at which the storage engine will compact all TSM files in a shard if it hasn’t received writes or deletes. | 4h0m0s | Duration with unit `hours`, `minutes`, `seconds`, `milliseconds`. Example: `durationType=minutes,value=10` | Hours:-Minimum: 0-Maximum: 256,205Minutes:-Minimum: 0-Maximum: 15,372,286Seconds:-Minimum: 0-Maximum: 922,337,203Milliseconds:-Minimum: 0-Maximum: 922,337,203,685 | +[storage-compact-throughput-burst](https://docs.influxdata.com/influxdb/v2/reference/config-options/#storage-compact-throughput-burst) | Rate limit (in bytes per second) that TSM compactions can write to disk. | 50,331,648 | Long | Minimum: 0Maximum: 9,223,372,036,854,775,807 | +[storage-max-concurrent-compactions](https://docs.influxdata.com/influxdb/v2/reference/config-options/#storage-max-concurrent-compactions) | Maximum number of full and level compactions that can run concurrently. A value of `0` results in 50 percent 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. | 0 | Integer | Minimum: 0Maximum: 64 | +[storage-max-index-log-file-size](https://docs.influxdata.com/influxdb/v2/reference/config-options/#storage-max-index-log-file-size) | 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. | 1,048,576 | Long | Minimum: 0Maximum: 9,223,372,036,854,775,807 | @@ -351 +351 @@ Parameter | Description | Default value | Value | Valid range | Note -[storage-retention-check-interval](https://docs.influxdata.com/influxdb/v2/reference/config-options/#storage-retention-check-interval) | Interval of retention policy enforcement checks. | 30m0s | Duration with unit `hours`, `minutes`, `seconds`, `milliseconds`. Example: `durationType=minutes,value=10` | N/A | Hours:-Minimum: 0-Maximum: 256205Minutes:-Minimum: 0-Maximum: 15372286Seconds:-Minimum: 0-Maximum: 922337203Milliseconds:-Minimum: 0-Maximum: 922337203685 +[storage-retention-check-interval](https://docs.influxdata.com/influxdb/v2/reference/config-options/#storage-retention-check-interval) | Interval of retention policy enforcement checks. | 30m0s | Duration with unit `hours`, `minutes`, `seconds`, `milliseconds`. Example: `durationType=minutes,value=10` | N/A | Hours:-Minimum: 0-Maximum: 256,205Minutes:-Minimum: 0-Maximum: 15,372,286Seconds:-Minimum: 0-Maximum: 922,337,203Milliseconds:-Minimum: 0-Maximum: 922,337,203,685 @@ -355 +355 @@ Parameter | Description | Default value | Value | Valid range | Note -[storage-wal-max-write-delay](https://docs.influxdata.com/influxdb/v2/reference/config-options/#storage-wal-max-write-delay) | Maximum amount of time a write request to the WAL directory will wait when the the maximum number of concurrent active writes to the WAL directory has been met. Set to `0` to disable the timeout. | 10m | Duration with unit `hours`, `minutes`, `seconds`, `milliseconds`. Example: `durationType=minutes,value=10` | Hours:-Minimum: 0-Maximum: 256205Minutes:-Minimum: 0-Maximum: 15372286Seconds:-Minimum: 0-Maximum: 922337203Milliseconds:-Minimum: 0-Maximum: 922337203685 | +[storage-wal-max-write-delay](https://docs.influxdata.com/influxdb/v2/reference/config-options/#storage-wal-max-write-delay) | Maximum amount of time a write request to the WAL directory will wait when the the maximum number of concurrent active writes to the WAL directory has been met. Set to `0` to disable the timeout. | 10m | Duration with unit `hours`, `minutes`, `seconds`, `milliseconds`. Example: `durationType=minutes,value=10` | Hours:-Minimum: 0-Maximum: 256205Minutes:-Minimum: 0-Maximum: 15,372,286Seconds:-Minimum: 0-Maximum: 922,337,203Milliseconds:-Minimum: 0-Maximum: 922,337,203,685 | @@ -358 +358 @@ Parameter | Description | Default value | Value | Valid range | Note -Improperly setting parameters in a parameter group can have unintended adverse effects, including degraded performance and system instability. Always be cautious when modifying database parameters.Try parameter group setting changes on a test DB instance before applying those parameter group changes to a production DB instance. +Improperly setting parameters in a parameter group can have unintended adverse effects, including degraded performance and system instability. Always be cautious when modifying database parameters. Test parameter group setting changes on a test DB instance before applying those parameter group changes to a production DB instance. @@ -383 +383 @@ DB instances use DB parameter groups. The following sections describe configurin - 4. In the **Group name** box, enter the name of the new DB parameter group. + 4. In the **Parameter group name** box, enter the name of the new DB parameter group. @@ -389 +389 @@ DB instances use DB parameter groups. The following sections describe configurin - 7. Choose **Save**. + 7. Choose **Create parameter group**. @@ -411 +411 @@ For information about each setting, see [Settings for DB instances](./timestream - --endpoint-url YOUR_ENDPOINT + --endpoint-url YOUR_ENDPOINT \ @@ -421 +421 @@ For information about each setting, see [Settings for DB instances](./timestream -You can create your own DB parameter groups with customized settings. You can associate a DB parameter group with a DB instance using the AWS Management Console, the AWS Command Line Interface, or the Timestream-InfluxDB API. You can do so when you create or modify a DB instance. +You can create your own DB parameter groups with customized settings. You can associate a DB parameter group with a DB instance using the AWS Management Console, the AWS Command Line Interface, or the Timestream for InfluxDB API. You can do so when you create or modify a DB instance. @@ -423 +423 @@ You can create your own DB parameter groups with customized settings. You can as -For information about creating a DB parameter group, see Creating a DB parameter group. For information about creating a DB instance, see [Creating a DB instance](./timestream-for-influx-configuring.html#timestream-for-influx-configuring-create-db). For information about modifying a DB instance, see [Updating DB instances](./timestream-for-influx-managing-modifying-db.html).. +For information about creating a DB parameter group, see Creating a DB parameter group. For information about creating a DB instance, see [Creating a DB instance](./timestream-for-influx-configuring.html#timestream-for-influx-configuring-create-db). For information about modifying a DB instance, see [Updating DB instances](./timestream-for-influx-managing-modifying-db.html). @@ -431 +431 @@ When you associate a new DB parameter group with a DB instance, the modified sta - 1. Sign in to the AWS Management Console and open the [Amazon Timestream for InfluxDB console](console.aws.amazon.com/timestream/). + 1. Sign in to the AWS Management Console and open the [Amazon Timestream for InfluxDB console](https://console.aws.amazon.com/timestream/). @@ -476 +476 @@ You can list the DB parameter groups you've created for your AWS account. - 1. Sign in to the AWS Management Console and open the [Amazon Timestream for InfluxDB console](console.aws.amazon.com/timestream/). + 1. Sign in to the AWS Management Console and open the [Amazon Timestream for InfluxDB console](https://console.aws.amazon.com/timestream/). @@ -503 +503 @@ You can get a list of all parameters in a DB parameter group and their values. - 1. Sign in to the AWS Management Console and open the [Amazon Timestream for InfluxDB console](console.aws.amazon.com/timestream/). + 1. Sign in to the AWS Management Console and open the [Amazon Timestream for InfluxDB console](https://console.aws.amazon.com/timestream/).