Timestream InfluxDB 2023-01-27
- Client: Aws\TimestreamInfluxDB\TimestreamInfluxDBClient
- Service ID: timestream-influxdb
- Version: 2023-01-27
This page describes the parameters and results for the operations of the Timestream InfluxDB (2023-01-27), and shows how to use the Aws\TimestreamInfluxDB\TimestreamInfluxDBClient object to call the described operations. This documentation is specific to the 2023-01-27 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- CreateDbInstance ( array $params = [] )
- Creates a new Timestream for InfluxDB DB instance.
- CreateDbParameterGroup ( array $params = [] )
- Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.
- DeleteDbInstance ( array $params = [] )
- Deletes a Timestream for InfluxDB DB instance.
- GetDbInstance ( array $params = [] )
- Returns a Timestream for InfluxDB DB instance.
- GetDbParameterGroup ( array $params = [] )
- Returns a Timestream for InfluxDB DB parameter group.
- ListDbInstances ( array $params = [] )
- Returns a list of Timestream for InfluxDB DB instances.
- ListDbParameterGroups ( array $params = [] )
- Returns a list of Timestream for InfluxDB DB parameter groups.
- ListTagsForResource ( array $params = [] )
- A list of tags applied to the resource.
- TagResource ( array $params = [] )
- Tags are composed of a Key/Value pairs.
- UntagResource ( array $params = [] )
- Removes the tag from the specified resource.
- UpdateDbInstance ( array $params = [] )
- Updates a Timestream for InfluxDB DB instance.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateDbInstance
$result = $client->createDbInstance
([/* ... */]); $promise = $client->createDbInstanceAsync
([/* ... */]);
Creates a new Timestream for InfluxDB DB instance.
Parameter Syntax
$result = $client->createDbInstance([ 'allocatedStorage' => <integer>, // REQUIRED 'bucket' => '<string>', 'dbInstanceType' => 'db.influx.medium|db.influx.large|db.influx.xlarge|db.influx.2xlarge|db.influx.4xlarge|db.influx.8xlarge|db.influx.12xlarge|db.influx.16xlarge', // REQUIRED 'dbParameterGroupIdentifier' => '<string>', 'dbStorageType' => 'InfluxIOIncludedT1|InfluxIOIncludedT2|InfluxIOIncludedT3', 'deploymentType' => 'SINGLE_AZ|WITH_MULTIAZ_STANDBY', 'logDeliveryConfiguration' => [ 's3Configuration' => [ // REQUIRED 'bucketName' => '<string>', // REQUIRED 'enabled' => true || false, // REQUIRED ], ], 'name' => '<string>', // REQUIRED 'organization' => '<string>', 'password' => '<string>', // REQUIRED 'port' => <integer>, 'publiclyAccessible' => true || false, 'tags' => ['<string>', ...], 'username' => '<string>', 'vpcSecurityGroupIds' => ['<string>', ...], // REQUIRED 'vpcSubnetIds' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- allocatedStorage
-
- Required: Yes
- Type: int
The amount of storage to allocate for your DB storage type in GiB (gibibytes).
- bucket
-
- Type: string
The name of the initial InfluxDB bucket. All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization.
- dbInstanceType
-
- Required: Yes
- Type: string
The Timestream for InfluxDB DB instance type to run InfluxDB on.
- dbParameterGroupIdentifier
-
- Type: string
The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.
- dbStorageType
-
- Type: string
The Timestream for InfluxDB DB storage type to read and write InfluxDB data.
You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements:
-
Influx IO Included 3000 IOPS
-
Influx IO Included 12000 IOPS
-
Influx IO Included 16000 IOPS
- deploymentType
-
- Type: string
Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
- logDeliveryConfiguration
-
- Type: LogDeliveryConfiguration structure
Configuration for sending InfluxDB engine logs to a specified S3 bucket.
- name
-
- Required: Yes
- Type: string
The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. DB instance names must be unique per customer and per region.
- organization
-
- Type: string
The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.
- password
-
- Required: Yes
- Type: string
The password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in AWS SecretManager in your account.
- port
-
- Type: int
The port number on which InfluxDB accepts connections.
Valid Values: 1024-65535
Default: 8086
Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680
- publiclyAccessible
-
- Type: boolean
Configures the DB instance with a public IP to facilitate access.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of key-value pairs to associate with the DB instance.
- username
-
- Type: string
The username of the initial admin user created in InfluxDB. Must start with a letter and can't end with a hyphen or contain two consecutive hyphens. For example, my-user1. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Amazon Secrets Manager in your account.
- vpcSecurityGroupIds
-
- Required: Yes
- Type: Array of strings
A list of VPC security group IDs to associate with the DB instance.
- vpcSubnetIds
-
- Required: Yes
- Type: Array of strings
A list of VPC subnet IDs to associate with the DB instance. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.
Result Syntax
[ 'allocatedStorage' => <integer>, 'arn' => '<string>', 'availabilityZone' => '<string>', 'dbInstanceType' => 'db.influx.medium|db.influx.large|db.influx.xlarge|db.influx.2xlarge|db.influx.4xlarge|db.influx.8xlarge|db.influx.12xlarge|db.influx.16xlarge', 'dbParameterGroupIdentifier' => '<string>', 'dbStorageType' => 'InfluxIOIncludedT1|InfluxIOIncludedT2|InfluxIOIncludedT3', 'deploymentType' => 'SINGLE_AZ|WITH_MULTIAZ_STANDBY', 'endpoint' => '<string>', 'id' => '<string>', 'influxAuthParametersSecretArn' => '<string>', 'logDeliveryConfiguration' => [ 's3Configuration' => [ 'bucketName' => '<string>', 'enabled' => true || false, ], ], 'name' => '<string>', 'port' => <integer>, 'publiclyAccessible' => true || false, 'secondaryAvailabilityZone' => '<string>', 'status' => 'CREATING|AVAILABLE|DELETING|MODIFYING|UPDATING|DELETED|FAILED|UPDATING_DEPLOYMENT_TYPE|UPDATING_INSTANCE_TYPE', 'vpcSecurityGroupIds' => ['<string>', ...], 'vpcSubnetIds' => ['<string>', ...], ]
Result Details
Members
- allocatedStorage
-
- Type: int
The amount of storage allocated for your DB storage type (in gibibytes).
- arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the DB instance.
- availabilityZone
-
- Type: string
The Availability Zone in which the DB instance resides.
- dbInstanceType
-
- Type: string
The Timestream for InfluxDB instance type that InfluxDB runs on.
- dbParameterGroupIdentifier
-
- Type: string
The id of the DB parameter group assigned to your DB instance.
- dbStorageType
-
- Type: string
The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
- deploymentType
-
- Type: string
Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
- endpoint
-
- Type: string
The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
- id
-
- Required: Yes
- Type: string
A service-generated unique identifier.
- influxAuthParametersSecretArn
-
- Type: string
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
- logDeliveryConfiguration
-
- Type: LogDeliveryConfiguration structure
Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
- name
-
- Required: Yes
- Type: string
The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
- port
-
- Type: int
The port number on which InfluxDB accepts connections. The default value is 8086.
- publiclyAccessible
-
- Type: boolean
Indicates if the DB instance has a public IP to facilitate access.
- secondaryAvailabilityZone
-
- Type: string
The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
- status
-
- Type: string
The status of the DB instance.
- vpcSecurityGroupIds
-
- Type: Array of strings
A list of VPC security group IDs associated with the DB instance.
- vpcSubnetIds
-
- Required: Yes
- Type: Array of strings
A list of VPC subnet IDs associated with the DB instance.
Errors
- ServiceQuotaExceededException:
The request exceeds the service quota.
- ValidationException:
The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- InternalServerException:
The request processing has failed because of an unknown error, exception or failure.
- ConflictException:
The request conflicts with an existing resource in Timestream for InfluxDB.
- ResourceNotFoundException:
The requested resource was not found or does not exist.
- ThrottlingException:
The request was denied due to request throttling.
CreateDbParameterGroup
$result = $client->createDbParameterGroup
([/* ... */]); $promise = $client->createDbParameterGroupAsync
([/* ... */]);
Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.
Parameter Syntax
$result = $client->createDbParameterGroup([ 'description' => '<string>', 'name' => '<string>', // REQUIRED 'parameters' => [ 'InfluxDBv2' => [ 'fluxLogEnabled' => true || false, 'httpIdleTimeout' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', // REQUIRED 'value' => <integer>, // REQUIRED ], 'httpReadHeaderTimeout' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', // REQUIRED 'value' => <integer>, // REQUIRED ], 'httpReadTimeout' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', // REQUIRED 'value' => <integer>, // REQUIRED ], 'httpWriteTimeout' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', // REQUIRED 'value' => <integer>, // REQUIRED ], 'influxqlMaxSelectBuckets' => <integer>, 'influxqlMaxSelectPoint' => <integer>, 'influxqlMaxSelectSeries' => <integer>, 'logLevel' => 'debug|info|error', 'metricsDisabled' => true || false, 'noTasks' => true || false, 'pprofDisabled' => true || false, 'queryConcurrency' => <integer>, 'queryInitialMemoryBytes' => <integer>, 'queryMaxMemoryBytes' => <integer>, 'queryMemoryBytes' => <integer>, 'queryQueueSize' => <integer>, 'sessionLength' => <integer>, 'sessionRenewDisabled' => true || false, 'storageCacheMaxMemorySize' => <integer>, 'storageCacheSnapshotMemorySize' => <integer>, 'storageCacheSnapshotWriteColdDuration' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', // REQUIRED 'value' => <integer>, // REQUIRED ], 'storageCompactFullWriteColdDuration' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', // REQUIRED 'value' => <integer>, // REQUIRED ], 'storageCompactThroughputBurst' => <integer>, 'storageMaxConcurrentCompactions' => <integer>, 'storageMaxIndexLogFileSize' => <integer>, 'storageNoValidateFieldSize' => true || false, 'storageRetentionCheckInterval' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', // REQUIRED 'value' => <integer>, // REQUIRED ], 'storageSeriesFileMaxConcurrentSnapshotCompactions' => <integer>, 'storageSeriesIdSetCacheSize' => <integer>, 'storageWalMaxConcurrentWrites' => <integer>, 'storageWalMaxWriteDelay' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', // REQUIRED 'value' => <integer>, // REQUIRED ], 'tracingType' => 'log|jaeger', 'uiDisabled' => true || false, ], ], 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- description
-
- Type: string
A description of the DB parameter group.
- name
-
- Required: Yes
- Type: string
The name of the DB parameter group. The name must be unique per customer and per region.
- parameters
-
- Type: Parameters structure
A list of the parameters that comprise the DB parameter group.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of key-value pairs to associate with the DB parameter group.
Result Syntax
[ 'arn' => '<string>', 'description' => '<string>', 'id' => '<string>', 'name' => '<string>', 'parameters' => [ 'InfluxDBv2' => [ 'fluxLogEnabled' => true || false, 'httpIdleTimeout' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', 'value' => <integer>, ], 'httpReadHeaderTimeout' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', 'value' => <integer>, ], 'httpReadTimeout' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', 'value' => <integer>, ], 'httpWriteTimeout' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', 'value' => <integer>, ], 'influxqlMaxSelectBuckets' => <integer>, 'influxqlMaxSelectPoint' => <integer>, 'influxqlMaxSelectSeries' => <integer>, 'logLevel' => 'debug|info|error', 'metricsDisabled' => true || false, 'noTasks' => true || false, 'pprofDisabled' => true || false, 'queryConcurrency' => <integer>, 'queryInitialMemoryBytes' => <integer>, 'queryMaxMemoryBytes' => <integer>, 'queryMemoryBytes' => <integer>, 'queryQueueSize' => <integer>, 'sessionLength' => <integer>, 'sessionRenewDisabled' => true || false, 'storageCacheMaxMemorySize' => <integer>, 'storageCacheSnapshotMemorySize' => <integer>, 'storageCacheSnapshotWriteColdDuration' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', 'value' => <integer>, ], 'storageCompactFullWriteColdDuration' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', 'value' => <integer>, ], 'storageCompactThroughputBurst' => <integer>, 'storageMaxConcurrentCompactions' => <integer>, 'storageMaxIndexLogFileSize' => <integer>, 'storageNoValidateFieldSize' => true || false, 'storageRetentionCheckInterval' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', 'value' => <integer>, ], 'storageSeriesFileMaxConcurrentSnapshotCompactions' => <integer>, 'storageSeriesIdSetCacheSize' => <integer>, 'storageWalMaxConcurrentWrites' => <integer>, 'storageWalMaxWriteDelay' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', 'value' => <integer>, ], 'tracingType' => 'log|jaeger', 'uiDisabled' => true || false, ], ], ]
Result Details
Members
- arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARM) of the DB parameter group.
- description
-
- Type: string
The description of the DB parameter group.
- id
-
- Required: Yes
- Type: string
A service-generated unique identifier.
- name
-
- Required: Yes
- Type: string
The customer-supplied name that uniquely identifies the DB parameter group when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
- parameters
-
- Type: Parameters structure
A list of the parameters that comprise the DB parameter group.
Errors
- ServiceQuotaExceededException:
The request exceeds the service quota.
- ValidationException:
The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- InternalServerException:
The request processing has failed because of an unknown error, exception or failure.
- ConflictException:
The request conflicts with an existing resource in Timestream for InfluxDB.
- ResourceNotFoundException:
The requested resource was not found or does not exist.
- ThrottlingException:
The request was denied due to request throttling.
DeleteDbInstance
$result = $client->deleteDbInstance
([/* ... */]); $promise = $client->deleteDbInstanceAsync
([/* ... */]);
Deletes a Timestream for InfluxDB DB instance.
Parameter Syntax
$result = $client->deleteDbInstance([ 'identifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- identifier
-
- Required: Yes
- Type: string
The id of the DB instance.
Result Syntax
[ 'allocatedStorage' => <integer>, 'arn' => '<string>', 'availabilityZone' => '<string>', 'dbInstanceType' => 'db.influx.medium|db.influx.large|db.influx.xlarge|db.influx.2xlarge|db.influx.4xlarge|db.influx.8xlarge|db.influx.12xlarge|db.influx.16xlarge', 'dbParameterGroupIdentifier' => '<string>', 'dbStorageType' => 'InfluxIOIncludedT1|InfluxIOIncludedT2|InfluxIOIncludedT3', 'deploymentType' => 'SINGLE_AZ|WITH_MULTIAZ_STANDBY', 'endpoint' => '<string>', 'id' => '<string>', 'influxAuthParametersSecretArn' => '<string>', 'logDeliveryConfiguration' => [ 's3Configuration' => [ 'bucketName' => '<string>', 'enabled' => true || false, ], ], 'name' => '<string>', 'port' => <integer>, 'publiclyAccessible' => true || false, 'secondaryAvailabilityZone' => '<string>', 'status' => 'CREATING|AVAILABLE|DELETING|MODIFYING|UPDATING|DELETED|FAILED|UPDATING_DEPLOYMENT_TYPE|UPDATING_INSTANCE_TYPE', 'vpcSecurityGroupIds' => ['<string>', ...], 'vpcSubnetIds' => ['<string>', ...], ]
Result Details
Members
- allocatedStorage
-
- Type: int
The amount of storage allocated for your DB storage type (in gibibytes).
- arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the DB instance.
- availabilityZone
-
- Type: string
The Availability Zone in which the DB instance resides.
- dbInstanceType
-
- Type: string
The Timestream for InfluxDB instance type that InfluxDB runs on.
- dbParameterGroupIdentifier
-
- Type: string
The id of the DB parameter group assigned to your DB instance.
- dbStorageType
-
- Type: string
The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
- deploymentType
-
- Type: string
Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
- endpoint
-
- Type: string
The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
- id
-
- Required: Yes
- Type: string
A service-generated unique identifier.
- influxAuthParametersSecretArn
-
- Type: string
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
- logDeliveryConfiguration
-
- Type: LogDeliveryConfiguration structure
Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
- name
-
- Required: Yes
- Type: string
The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
- port
-
- Type: int
The port number on which InfluxDB accepts connections.
- publiclyAccessible
-
- Type: boolean
Indicates if the DB instance has a public IP to facilitate access.
- secondaryAvailabilityZone
-
- Type: string
The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
- status
-
- Type: string
The status of the DB instance.
- vpcSecurityGroupIds
-
- Type: Array of strings
A list of VPC security group IDs associated with the DB instance.
- vpcSubnetIds
-
- Required: Yes
- Type: Array of strings
A list of VPC subnet IDs associated with the DB instance.
Errors
- ValidationException:
The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- InternalServerException:
The request processing has failed because of an unknown error, exception or failure.
- ConflictException:
The request conflicts with an existing resource in Timestream for InfluxDB.
- ResourceNotFoundException:
The requested resource was not found or does not exist.
- ThrottlingException:
The request was denied due to request throttling.
GetDbInstance
$result = $client->getDbInstance
([/* ... */]); $promise = $client->getDbInstanceAsync
([/* ... */]);
Returns a Timestream for InfluxDB DB instance.
Parameter Syntax
$result = $client->getDbInstance([ 'identifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- identifier
-
- Required: Yes
- Type: string
The id of the DB instance.
Result Syntax
[ 'allocatedStorage' => <integer>, 'arn' => '<string>', 'availabilityZone' => '<string>', 'dbInstanceType' => 'db.influx.medium|db.influx.large|db.influx.xlarge|db.influx.2xlarge|db.influx.4xlarge|db.influx.8xlarge|db.influx.12xlarge|db.influx.16xlarge', 'dbParameterGroupIdentifier' => '<string>', 'dbStorageType' => 'InfluxIOIncludedT1|InfluxIOIncludedT2|InfluxIOIncludedT3', 'deploymentType' => 'SINGLE_AZ|WITH_MULTIAZ_STANDBY', 'endpoint' => '<string>', 'id' => '<string>', 'influxAuthParametersSecretArn' => '<string>', 'logDeliveryConfiguration' => [ 's3Configuration' => [ 'bucketName' => '<string>', 'enabled' => true || false, ], ], 'name' => '<string>', 'port' => <integer>, 'publiclyAccessible' => true || false, 'secondaryAvailabilityZone' => '<string>', 'status' => 'CREATING|AVAILABLE|DELETING|MODIFYING|UPDATING|DELETED|FAILED|UPDATING_DEPLOYMENT_TYPE|UPDATING_INSTANCE_TYPE', 'vpcSecurityGroupIds' => ['<string>', ...], 'vpcSubnetIds' => ['<string>', ...], ]
Result Details
Members
- allocatedStorage
-
- Type: int
The amount of storage allocated for your DB storage type (in gibibytes).
- arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the DB instance.
- availabilityZone
-
- Type: string
The Availability Zone in which the DB instance resides.
- dbInstanceType
-
- Type: string
The Timestream for InfluxDB instance type that InfluxDB runs on.
- dbParameterGroupIdentifier
-
- Type: string
The id of the DB parameter group assigned to your DB instance.
- dbStorageType
-
- Type: string
The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
- deploymentType
-
- Type: string
Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
- endpoint
-
- Type: string
The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
- id
-
- Required: Yes
- Type: string
A service-generated unique identifier.
- influxAuthParametersSecretArn
-
- Type: string
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
- logDeliveryConfiguration
-
- Type: LogDeliveryConfiguration structure
Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
- name
-
- Required: Yes
- Type: string
The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
- port
-
- Type: int
The port number on which InfluxDB accepts connections.
- publiclyAccessible
-
- Type: boolean
Indicates if the DB instance has a public IP to facilitate access.
- secondaryAvailabilityZone
-
- Type: string
The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
- status
-
- Type: string
The status of the DB instance.
- vpcSecurityGroupIds
-
- Type: Array of strings
A list of VPC security group IDs associated with the DB instance.
- vpcSubnetIds
-
- Required: Yes
- Type: Array of strings
A list of VPC subnet IDs associated with the DB instance.
Errors
- ValidationException:
The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- InternalServerException:
The request processing has failed because of an unknown error, exception or failure.
- ResourceNotFoundException:
The requested resource was not found or does not exist.
- ThrottlingException:
The request was denied due to request throttling.
GetDbParameterGroup
$result = $client->getDbParameterGroup
([/* ... */]); $promise = $client->getDbParameterGroupAsync
([/* ... */]);
Returns a Timestream for InfluxDB DB parameter group.
Parameter Syntax
$result = $client->getDbParameterGroup([ 'identifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- identifier
-
- Required: Yes
- Type: string
The id of the DB parameter group.
Result Syntax
[ 'arn' => '<string>', 'description' => '<string>', 'id' => '<string>', 'name' => '<string>', 'parameters' => [ 'InfluxDBv2' => [ 'fluxLogEnabled' => true || false, 'httpIdleTimeout' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', 'value' => <integer>, ], 'httpReadHeaderTimeout' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', 'value' => <integer>, ], 'httpReadTimeout' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', 'value' => <integer>, ], 'httpWriteTimeout' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', 'value' => <integer>, ], 'influxqlMaxSelectBuckets' => <integer>, 'influxqlMaxSelectPoint' => <integer>, 'influxqlMaxSelectSeries' => <integer>, 'logLevel' => 'debug|info|error', 'metricsDisabled' => true || false, 'noTasks' => true || false, 'pprofDisabled' => true || false, 'queryConcurrency' => <integer>, 'queryInitialMemoryBytes' => <integer>, 'queryMaxMemoryBytes' => <integer>, 'queryMemoryBytes' => <integer>, 'queryQueueSize' => <integer>, 'sessionLength' => <integer>, 'sessionRenewDisabled' => true || false, 'storageCacheMaxMemorySize' => <integer>, 'storageCacheSnapshotMemorySize' => <integer>, 'storageCacheSnapshotWriteColdDuration' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', 'value' => <integer>, ], 'storageCompactFullWriteColdDuration' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', 'value' => <integer>, ], 'storageCompactThroughputBurst' => <integer>, 'storageMaxConcurrentCompactions' => <integer>, 'storageMaxIndexLogFileSize' => <integer>, 'storageNoValidateFieldSize' => true || false, 'storageRetentionCheckInterval' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', 'value' => <integer>, ], 'storageSeriesFileMaxConcurrentSnapshotCompactions' => <integer>, 'storageSeriesIdSetCacheSize' => <integer>, 'storageWalMaxConcurrentWrites' => <integer>, 'storageWalMaxWriteDelay' => [ 'durationType' => 'hours|minutes|seconds|milliseconds', 'value' => <integer>, ], 'tracingType' => 'log|jaeger', 'uiDisabled' => true || false, ], ], ]
Result Details
Members
- arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the DB parameter group.
- description
-
- Type: string
A description of the DB parameter group.
- id
-
- Required: Yes
- Type: string
A service-generated unique identifier.
- name
-
- Required: Yes
- Type: string
The customer-supplied name that uniquely identifies the DB parameter group when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
- parameters
-
- Type: Parameters structure
The parameters that comprise the DB parameter group.
Errors
- ValidationException:
The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- InternalServerException:
The request processing has failed because of an unknown error, exception or failure.
- ResourceNotFoundException:
The requested resource was not found or does not exist.
- ThrottlingException:
The request was denied due to request throttling.
ListDbInstances
$result = $client->listDbInstances
([/* ... */]); $promise = $client->listDbInstancesAsync
([/* ... */]);
Returns a list of Timestream for InfluxDB DB instances.
Parameter Syntax
$result = $client->listDbInstances([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
- nextToken
-
- Type: string
The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
Result Syntax
[ 'items' => [ [ 'allocatedStorage' => <integer>, 'arn' => '<string>', 'dbInstanceType' => 'db.influx.medium|db.influx.large|db.influx.xlarge|db.influx.2xlarge|db.influx.4xlarge|db.influx.8xlarge|db.influx.12xlarge|db.influx.16xlarge', 'dbStorageType' => 'InfluxIOIncludedT1|InfluxIOIncludedT2|InfluxIOIncludedT3', 'deploymentType' => 'SINGLE_AZ|WITH_MULTIAZ_STANDBY', 'endpoint' => '<string>', 'id' => '<string>', 'name' => '<string>', 'port' => <integer>, 'status' => 'CREATING|AVAILABLE|DELETING|MODIFYING|UPDATING|DELETED|FAILED|UPDATING_DEPLOYMENT_TYPE|UPDATING_INSTANCE_TYPE', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- items
-
- Required: Yes
- Type: Array of DbInstanceSummary structures
A list of Timestream for InfluxDB DB instance summaries.
- nextToken
-
- Type: string
Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off.
Errors
- ValidationException:
The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- InternalServerException:
The request processing has failed because of an unknown error, exception or failure.
- ResourceNotFoundException:
The requested resource was not found or does not exist.
- ThrottlingException:
The request was denied due to request throttling.
ListDbParameterGroups
$result = $client->listDbParameterGroups
([/* ... */]); $promise = $client->listDbParameterGroupsAsync
([/* ... */]);
Returns a list of Timestream for InfluxDB DB parameter groups.
Parameter Syntax
$result = $client->listDbParameterGroups([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
- nextToken
-
- Type: string
The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
Result Syntax
[ 'items' => [ [ 'arn' => '<string>', 'description' => '<string>', 'id' => '<string>', 'name' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- items
-
- Required: Yes
- Type: Array of DbParameterGroupSummary structures
A list of Timestream for InfluxDB DB parameter group summaries.
- nextToken
-
- Type: string
Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off.
Errors
- ValidationException:
The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- InternalServerException:
The request processing has failed because of an unknown error, exception or failure.
- ResourceNotFoundException:
The requested resource was not found or does not exist.
- ThrottlingException:
The request was denied due to request throttling.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
A list of tags applied to the resource.
Parameter Syntax
$result = $client->listTagsForResource([ 'resourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the tagged resource.
Result Syntax
[ 'tags' => ['<string>', ...], ]
Result Details
Members
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of tags used to categorize and track resources.
Errors
- ResourceNotFoundException:
The requested resource was not found or does not exist.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Tags are composed of a Key/Value pairs. You can use tags to categorize and track your Timestream for InfluxDB resources.
Parameter Syntax
$result = $client->tagResource([ 'resourceArn' => '<string>', // REQUIRED 'tags' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the tagged resource.
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
A list of tags used to categorize and track resources.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The requested resource was not found or does not exist.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes the tag from the specified resource.
Parameter Syntax
$result = $client->untagResource([ 'resourceArn' => '<string>', // REQUIRED 'tagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the tagged resource.
- tagKeys
-
- Required: Yes
- Type: Array of strings
The keys used to identify the tags.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The requested resource was not found or does not exist.
UpdateDbInstance
$result = $client->updateDbInstance
([/* ... */]); $promise = $client->updateDbInstanceAsync
([/* ... */]);
Updates a Timestream for InfluxDB DB instance.
Parameter Syntax
$result = $client->updateDbInstance([ 'dbInstanceType' => 'db.influx.medium|db.influx.large|db.influx.xlarge|db.influx.2xlarge|db.influx.4xlarge|db.influx.8xlarge|db.influx.12xlarge|db.influx.16xlarge', 'dbParameterGroupIdentifier' => '<string>', 'deploymentType' => 'SINGLE_AZ|WITH_MULTIAZ_STANDBY', 'identifier' => '<string>', // REQUIRED 'logDeliveryConfiguration' => [ 's3Configuration' => [ // REQUIRED 'bucketName' => '<string>', // REQUIRED 'enabled' => true || false, // REQUIRED ], ], 'port' => <integer>, ]);
Parameter Details
Members
- dbInstanceType
-
- Type: string
The Timestream for InfluxDB DB instance type to run InfluxDB on.
- dbParameterGroupIdentifier
-
- Type: string
The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.
- deploymentType
-
- Type: string
Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
- identifier
-
- Required: Yes
- Type: string
The id of the DB instance.
- logDeliveryConfiguration
-
- Type: LogDeliveryConfiguration structure
Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
- port
-
- Type: int
The port number on which InfluxDB accepts connections.
If you change the Port value, your database restarts immediately.
Valid Values: 1024-65535
Default: 8086
Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680
Result Syntax
[ 'allocatedStorage' => <integer>, 'arn' => '<string>', 'availabilityZone' => '<string>', 'dbInstanceType' => 'db.influx.medium|db.influx.large|db.influx.xlarge|db.influx.2xlarge|db.influx.4xlarge|db.influx.8xlarge|db.influx.12xlarge|db.influx.16xlarge', 'dbParameterGroupIdentifier' => '<string>', 'dbStorageType' => 'InfluxIOIncludedT1|InfluxIOIncludedT2|InfluxIOIncludedT3', 'deploymentType' => 'SINGLE_AZ|WITH_MULTIAZ_STANDBY', 'endpoint' => '<string>', 'id' => '<string>', 'influxAuthParametersSecretArn' => '<string>', 'logDeliveryConfiguration' => [ 's3Configuration' => [ 'bucketName' => '<string>', 'enabled' => true || false, ], ], 'name' => '<string>', 'port' => <integer>, 'publiclyAccessible' => true || false, 'secondaryAvailabilityZone' => '<string>', 'status' => 'CREATING|AVAILABLE|DELETING|MODIFYING|UPDATING|DELETED|FAILED|UPDATING_DEPLOYMENT_TYPE|UPDATING_INSTANCE_TYPE', 'vpcSecurityGroupIds' => ['<string>', ...], 'vpcSubnetIds' => ['<string>', ...], ]
Result Details
Members
- allocatedStorage
-
- Type: int
The amount of storage allocated for your DB storage type (in gibibytes).
- arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the DB instance.
- availabilityZone
-
- Type: string
The Availability Zone in which the DB instance resides.
- dbInstanceType
-
- Type: string
The Timestream for InfluxDB instance type that InfluxDB runs on.
- dbParameterGroupIdentifier
-
- Type: string
The id of the DB parameter group assigned to your DB instance.
- dbStorageType
-
- Type: string
The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
- deploymentType
-
- Type: string
Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
- endpoint
-
- Type: string
The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
- id
-
- Required: Yes
- Type: string
A service-generated unique identifier.
- influxAuthParametersSecretArn
-
- Type: string
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
- logDeliveryConfiguration
-
- Type: LogDeliveryConfiguration structure
Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
- name
-
- Required: Yes
- Type: string
This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands.
- port
-
- Type: int
The port number on which InfluxDB accepts connections.
- publiclyAccessible
-
- Type: boolean
Indicates if the DB instance has a public IP to facilitate access.
- secondaryAvailabilityZone
-
- Type: string
The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
- status
-
- Type: string
The status of the DB instance.
- vpcSecurityGroupIds
-
- Type: Array of strings
A list of VPC security group IDs associated with the DB instance.
- vpcSubnetIds
-
- Required: Yes
- Type: Array of strings
A list of VPC subnet IDs associated with the DB instance.
Errors
- ValidationException:
The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- InternalServerException:
The request processing has failed because of an unknown error, exception or failure.
- ConflictException:
The request conflicts with an existing resource in Timestream for InfluxDB.
- ResourceNotFoundException:
The requested resource was not found or does not exist.
- ThrottlingException:
The request was denied due to request throttling.
Shapes
AccessDeniedException
Description
You do not have sufficient access to perform this action.
Members
- message
-
- Required: Yes
- Type: string
ConflictException
Description
The request conflicts with an existing resource in Timestream for InfluxDB.
Members
- message
-
- Required: Yes
- Type: string
- resourceId
-
- Required: Yes
- Type: string
The identifier for the Timestream for InfluxDB resource associated with the request.
- resourceType
-
- Required: Yes
- Type: string
The type of Timestream for InfluxDB resource associated with the request.
DbInstanceSummary
Description
Contains a summary of a DB instance.
Members
- allocatedStorage
-
- Type: int
The amount of storage to allocate for your DbStorageType in GiB (gibibytes).
- arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the DB instance.
- dbInstanceType
-
- Type: string
The Timestream for InfluxDB instance type to run InfluxDB on.
- dbStorageType
-
- Type: string
The storage type for your DB instance.
- deploymentType
-
- Type: string
Single-Instance or with a MultiAZ Standby for High availability.
- endpoint
-
- Type: string
The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
- id
-
- Required: Yes
- Type: string
The service-generated unique identifier of the DB instance.
- name
-
- Required: Yes
- Type: string
This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands.
- port
-
- Type: int
The port number on which InfluxDB accepts connections.
- status
-
- Type: string
The status of the DB instance.
DbParameterGroupSummary
Description
Contains a summary of a DB parameter group.
Members
- arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the DB parameter group.
- description
-
- Type: string
A description of the DB parameter group.
- id
-
- Required: Yes
- Type: string
A service-generated unique identifier.
- name
-
- Required: Yes
- Type: string
This customer-supplied name uniquely identifies the parameter group.
Duration
Description
Duration for InfluxDB parameters in Timestream for InfluxDB.
Members
- durationType
-
- Required: Yes
- Type: string
The type of duration for InfluxDB parameters.
- value
-
- Required: Yes
- Type: long (int|float)
The value of duration for InfluxDB parameters.
InfluxDBv2Parameters
Description
All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.
Members
- fluxLogEnabled
-
- Type: boolean
Include option to show detailed logs for Flux queries.
Default: false
- httpIdleTimeout
-
- Type: Duration structure
Maximum duration the server should keep established connections alive while waiting for new requests. Set to 0 for no timeout.
Default: 3 minutes
- httpReadHeaderTimeout
-
- Type: Duration structure
Maximum duration the server should try to read HTTP headers for new requests. Set to 0 for no timeout.
Default: 10 seconds
- httpReadTimeout
-
- Type: Duration structure
Maximum duration the server should try to read the entirety of new requests. Set to 0 for no timeout.
Default: 0
- httpWriteTimeout
-
- Type: Duration structure
Maximum duration the server should spend processing and responding to write requests. Set to 0 for no timeout.
Default: 0
- influxqlMaxSelectBuckets
-
- Type: long (int|float)
Maximum number of group by time buckets a SELECT statement can create. 0 allows an unlimited number of buckets.
Default: 0
- influxqlMaxSelectPoint
-
- Type: long (int|float)
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
-
- Type: long (int|float)
Maximum number of series a SELECT statement can return. 0 allows an unlimited number of series.
Default: 0
- logLevel
-
- Type: string
Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.
Default: info
- metricsDisabled
-
- Type: boolean
Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.
Default: false
- noTasks
-
- Type: 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
- pprofDisabled
-
- Type: boolean
Disable the /debug/pprof HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging.
Default: false
- queryConcurrency
-
- Type: int
Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.
Default: 0
- queryInitialMemoryBytes
-
- Type: long (int|float)
Initial bytes of memory allocated for a query.
Default: 0
- queryMaxMemoryBytes
-
- Type: long (int|float)
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
-
- Type: long (int|float)
Maximum bytes of memory allowed for a single query. Must be greater or equal to queryInitialMemoryBytes.
Default: 0
- queryQueueSize
-
- Type: int
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
- sessionLength
-
- Type: int
Specifies the Time to Live (TTL) in minutes for newly created user sessions.
Default: 60
- sessionRenewDisabled
-
- Type: 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
-
- Type: long (int|float)
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
-
- Type: long (int|float)
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
-
- Type: Duration 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
- storageCompactFullWriteColdDuration
-
- Type: Duration 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
- storageCompactThroughputBurst
-
- Type: long (int|float)
Rate limit (in bytes per second) that TSM compactions can write to disk.
Default: 50331648
- storageMaxConcurrentCompactions
-
- Type: int
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
-
- Type: long (int|float)
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
-
- Type: boolean
Skip field size validation on incoming write requests.
Default: false
- storageRetentionCheckInterval
-
- Type: Duration structure
Interval of retention policy enforcement checks. Must be greater than 0.
Default: 30 minutes
- storageSeriesFileMaxConcurrentSnapshotCompactions
-
- Type: int
Maximum number of snapshot compactions that can run concurrently across all series partitions in a database.
Default: 0
- storageSeriesIdSetCacheSize
-
- Type: long (int|float)
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
-
- Type: int
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
-
- Type: Duration 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
- tracingType
-
- Type: string
Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.
- uiDisabled
-
- Type: boolean
Disable the InfluxDB user interface (UI). The UI is enabled by default.
Default: false
InternalServerException
Description
The request processing has failed because of an unknown error, exception or failure.
Members
- message
-
- Required: Yes
- Type: string
LogDeliveryConfiguration
Description
Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
Members
- s3Configuration
-
- Required: Yes
- Type: S3Configuration structure
Configuration for S3 bucket log delivery.
Parameters
Description
The parameters that comprise the parameter group.
Members
- InfluxDBv2
-
- Type: InfluxDBv2Parameters structure
All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.
ResourceNotFoundException
Description
The requested resource was not found or does not exist.
Members
- message
-
- Required: Yes
- Type: string
- resourceId
-
- Required: Yes
- Type: string
The identifier for the Timestream for InfluxDB resource associated with the request.
- resourceType
-
- Required: Yes
- Type: string
The type of Timestream for InfluxDB resource associated with the request.
S3Configuration
Description
Configuration for S3 bucket log delivery.
Members
- bucketName
-
- Required: Yes
- Type: string
The name of the S3 bucket to deliver logs to.
- enabled
-
- Required: Yes
- Type: boolean
Indicates whether log delivery to the S3 bucket is enabled.
ServiceQuotaExceededException
Description
The request exceeds the service quota.
Members
- message
-
- Required: Yes
- Type: string
ThrottlingException
Description
The request was denied due to request throttling.
Members
- message
-
- Required: Yes
- Type: string
- retryAfterSeconds
-
- Type: int
The number of seconds the caller should wait before retrying.
ValidationException
Description
The input fails to satisfy the constraints specified by Timestream for InfluxDB.
Members
- message
-
- Required: Yes
- Type: string
- reason
-
- Required: Yes
- Type: string
The reason that validation failed.