SDK for PHP 3.x
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 */).
- CreateDbCluster ( array $params = [] )
- Creates a new Timestream for InfluxDB cluster.
- 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.
- DeleteDbCluster ( array $params = [] )
- Deletes a Timestream for InfluxDB cluster.
- DeleteDbInstance ( array $params = [] )
- Deletes a Timestream for InfluxDB DB instance.
- GetDbCluster ( array $params = [] )
- Retrieves information about a Timestream for InfluxDB cluster.
- GetDbInstance ( array $params = [] )
- Returns a Timestream for InfluxDB DB instance.
- GetDbParameterGroup ( array $params = [] )
- Returns a Timestream for InfluxDB DB parameter group.
- ListDbClusters ( array $params = [] )
- Returns a list of Timestream for InfluxDB DB clusters.
- ListDbInstances ( array $params = [] )
- Returns a list of Timestream for InfluxDB DB instances.
- ListDbInstancesForCluster ( array $params = [] )
- Returns a list of Timestream for InfluxDB clusters.
- 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.
- UpdateDbCluster ( array $params = [] )
- Updates a Timestream for InfluxDB cluster.
- 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
CreateDbCluster
$result = $client->createDbCluster([/* ... */]); $promise = $client->createDbClusterAsync([/* ... */]);
Creates a new Timestream for InfluxDB cluster.
Parameter Syntax
$result = $client->createDbCluster([
'allocatedStorage' => <integer>,
'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|db.influx.24xlarge', // REQUIRED
'dbParameterGroupIdentifier' => '<string>',
'dbStorageType' => 'InfluxIOIncludedT1|InfluxIOIncludedT2|InfluxIOIncludedT3',
'deploymentType' => 'MULTI_NODE_READ_REPLICAS',
'failoverMode' => 'AUTOMATIC|NO_FAILOVER',
'logDeliveryConfiguration' => [
's3Configuration' => [ // REQUIRED
'bucketName' => '<string>', // REQUIRED
'enabled' => true || false, // REQUIRED
],
],
'name' => '<string>', // REQUIRED
'networkType' => 'IPV4|DUAL',
'organization' => '<string>',
'password' => '<string>',
'port' => <integer>,
'publiclyAccessible' => true || false,
'tags' => ['<string>', ...],
'username' => '<string>',
'vpcSecurityGroupIds' => ['<string>', ...], // REQUIRED
'vpcSubnetIds' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- allocatedStorage
-
- 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 cluster. 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 three different types of provisioned Influx IOPS Included storage according to your workload requirements:
-
Influx I/O Included 3000 IOPS
-
Influx I/O Included 12000 IOPS
-
Influx I/O Included 16000 IOPS
- deploymentType
-
- Type: string
Specifies the type of cluster to create.
- failoverMode
-
- Type: string
Specifies the behavior of failure recovery when the primary node of the cluster fails.
- 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 cluster when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. DB cluster names must be unique per customer and per region.
- networkType
-
- Type: string
Specifies whether the network type of the Timestream for InfluxDB cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
- 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
-
- 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 Secrets Manager in your account.
- port
-
- Type: int
The port number on which InfluxDB accepts connections.
Valid Values: 1024-65535
Default: 8086 for InfluxDB v2, 8181 for InfluxDB v3
Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680
- publiclyAccessible
-
- Type: boolean
Configures the Timestream for InfluxDB cluster with a public IP to facilitate access from outside the VPC.
- 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 Secrets Manager in your account.
- vpcSecurityGroupIds
-
- Required: Yes
- Type: Array of strings
A list of VPC security group IDs to associate with the Timestream for InfluxDB cluster.
- vpcSubnetIds
-
- Required: Yes
- Type: Array of strings
A list of VPC subnet IDs to associate with the DB cluster. Provide at least two VPC subnet IDs in different Availability Zones when deploying with a Multi-AZ standby.
Result Syntax
[
'dbClusterId' => '<string>',
'dbClusterStatus' => 'CREATING|UPDATING|DELETING|AVAILABLE|FAILED|DELETED|MAINTENANCE',
]
Result Details
Members
- dbClusterId
-
- Type: string
A service-generated unique identifier.
- dbClusterStatus
-
- Type: string
The status of the DB cluster.
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.
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|db.influx.24xlarge', // 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
'networkType' => 'IPV4|DUAL',
'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.
- networkType
-
- Type: string
Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
- 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 v2. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Secrets Manager in your account.
- 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>',
'dbClusterId' => '<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|db.influx.24xlarge',
'dbParameterGroupIdentifier' => '<string>',
'dbStorageType' => 'InfluxIOIncludedT1|InfluxIOIncludedT2|InfluxIOIncludedT3',
'deploymentType' => 'SINGLE_AZ|WITH_MULTIAZ_STANDBY',
'endpoint' => '<string>',
'id' => '<string>',
'influxAuthParametersSecretArn' => '<string>',
'instanceMode' => 'PRIMARY|STANDBY|REPLICA|INGEST|QUERY|COMPACT|PROCESS',
'instanceModes' => ['<string>', ...],
'logDeliveryConfiguration' => [
's3Configuration' => [
'bucketName' => '<string>',
'enabled' => true || false,
],
],
'name' => '<string>',
'networkType' => 'IPV4|DUAL',
'port' => <integer>,
'publiclyAccessible' => true || false,
'secondaryAvailabilityZone' => '<string>',
'status' => 'CREATING|AVAILABLE|DELETING|MODIFYING|UPDATING|DELETED|FAILED|UPDATING_DEPLOYMENT_TYPE|UPDATING_INSTANCE_TYPE|MAINTENANCE',
'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.
- dbClusterId
-
- Type: string
Specifies the DbCluster to which this DbInstance belongs to.
- 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 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.
- instanceMode
-
- Type: string
Specifies the DbInstance's role in the cluster.
- instanceModes
-
- Type: Array of strings
Specifies the DbInstance's roles in the cluster.
- 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.
- networkType
-
- Type: string
Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
- 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|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'httpReadHeaderTimeout' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'httpReadTimeout' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'httpWriteTimeout' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // 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|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'storageCompactFullWriteColdDuration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'storageCompactThroughputBurst' => <integer>,
'storageMaxConcurrentCompactions' => <integer>,
'storageMaxIndexLogFileSize' => <integer>,
'storageNoValidateFieldSize' => true || false,
'storageRetentionCheckInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'storageSeriesFileMaxConcurrentSnapshotCompactions' => <integer>,
'storageSeriesIdSetCacheSize' => <integer>,
'storageWalMaxConcurrentWrites' => <integer>,
'storageWalMaxWriteDelay' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'tracingType' => 'log|jaeger|disabled',
'uiDisabled' => true || false,
],
'InfluxDBv3Core' => [
'dataFusionConfig' => '<string>',
'dataFusionMaxParquetFanout' => <integer>,
'dataFusionNumThreads' => <integer>,
'dataFusionRuntimeDisableLifoSlot' => true || false,
'dataFusionRuntimeEventInterval' => <integer>,
'dataFusionRuntimeGlobalQueueInterval' => <integer>,
'dataFusionRuntimeMaxBlockingThreads' => <integer>,
'dataFusionRuntimeMaxIoEventsPerTick' => <integer>,
'dataFusionRuntimeThreadKeepAlive' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'dataFusionRuntimeThreadPriority' => <integer>,
'dataFusionRuntimeType' => 'multi-thread|multi-thread-alt',
'dataFusionUseCachedParquetLoader' => true || false,
'deleteGracePeriod' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'disableParquetMemCache' => true || false,
'distinctCacheEvictionInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'execMemPoolBytes' => [
'absolute' => <integer>,
'percent' => '<string>',
],
'forceSnapshotMemThreshold' => [
'absolute' => <integer>,
'percent' => '<string>',
],
'gen1Duration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'gen1LookbackDuration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'hardDeleteDefaultDuration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'lastCacheEvictionInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'logFilter' => '<string>',
'logFormat' => 'full',
'maxHttpRequestSize' => <integer>,
'parquetMemCachePruneInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'parquetMemCachePrunePercentage' => <float>,
'parquetMemCacheQueryPathDuration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'parquetMemCacheSize' => [
'absolute' => <integer>,
'percent' => '<string>',
],
'preemptiveCacheAge' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'queryFileLimit' => <integer>,
'queryLogSize' => <integer>,
'retentionCheckInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'snapshottedWalFilesToKeep' => <integer>,
'tableIndexCacheConcurrencyLimit' => <integer>,
'tableIndexCacheMaxEntries' => <integer>,
'walMaxWriteBufferSize' => <integer>,
'walReplayConcurrencyLimit' => <integer>,
'walReplayFailOnError' => true || false,
'walSnapshotSize' => <integer>,
],
'InfluxDBv3Enterprise' => [
'catalogSyncInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'compactionCheckInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'compactionCleanupWait' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'compactionGen2Duration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'compactionMaxNumFilesPerPlan' => <integer>,
'compactionMultipliers' => '<string>',
'compactionRowLimit' => <integer>,
'dataFusionConfig' => '<string>',
'dataFusionMaxParquetFanout' => <integer>,
'dataFusionNumThreads' => <integer>,
'dataFusionRuntimeDisableLifoSlot' => true || false,
'dataFusionRuntimeEventInterval' => <integer>,
'dataFusionRuntimeGlobalQueueInterval' => <integer>,
'dataFusionRuntimeMaxBlockingThreads' => <integer>,
'dataFusionRuntimeMaxIoEventsPerTick' => <integer>,
'dataFusionRuntimeThreadKeepAlive' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'dataFusionRuntimeThreadPriority' => <integer>,
'dataFusionRuntimeType' => 'multi-thread|multi-thread-alt',
'dataFusionUseCachedParquetLoader' => true || false,
'dedicatedCompactor' => true || false, // REQUIRED
'deleteGracePeriod' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'disableParquetMemCache' => true || false,
'distinctCacheEvictionInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'distinctValueCacheDisableFromHistory' => true || false,
'execMemPoolBytes' => [
'absolute' => <integer>,
'percent' => '<string>',
],
'forceSnapshotMemThreshold' => [
'absolute' => <integer>,
'percent' => '<string>',
],
'gen1Duration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'gen1LookbackDuration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'hardDeleteDefaultDuration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'ingestQueryInstances' => <integer>, // REQUIRED
'lastCacheEvictionInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'lastValueCacheDisableFromHistory' => true || false,
'logFilter' => '<string>',
'logFormat' => 'full',
'maxHttpRequestSize' => <integer>,
'parquetMemCachePruneInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'parquetMemCachePrunePercentage' => <float>,
'parquetMemCacheQueryPathDuration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'parquetMemCacheSize' => [
'absolute' => <integer>,
'percent' => '<string>',
],
'preemptiveCacheAge' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'queryFileLimit' => <integer>,
'queryLogSize' => <integer>,
'queryOnlyInstances' => <integer>, // REQUIRED
'replicationInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'retentionCheckInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days', // REQUIRED
'value' => <integer>, // REQUIRED
],
'snapshottedWalFilesToKeep' => <integer>,
'tableIndexCacheConcurrencyLimit' => <integer>,
'tableIndexCacheMaxEntries' => <integer>,
'walMaxWriteBufferSize' => <integer>,
'walReplayConcurrencyLimit' => <integer>,
'walReplayFailOnError' => true || false,
'walSnapshotSize' => <integer>,
],
],
'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|days',
'value' => <integer>,
],
'httpReadHeaderTimeout' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'httpReadTimeout' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'httpWriteTimeout' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'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|days',
'value' => <integer>,
],
'storageCompactFullWriteColdDuration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'storageCompactThroughputBurst' => <integer>,
'storageMaxConcurrentCompactions' => <integer>,
'storageMaxIndexLogFileSize' => <integer>,
'storageNoValidateFieldSize' => true || false,
'storageRetentionCheckInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'storageSeriesFileMaxConcurrentSnapshotCompactions' => <integer>,
'storageSeriesIdSetCacheSize' => <integer>,
'storageWalMaxConcurrentWrites' => <integer>,
'storageWalMaxWriteDelay' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'tracingType' => 'log|jaeger|disabled',
'uiDisabled' => true || false,
],
'InfluxDBv3Core' => [
'dataFusionConfig' => '<string>',
'dataFusionMaxParquetFanout' => <integer>,
'dataFusionNumThreads' => <integer>,
'dataFusionRuntimeDisableLifoSlot' => true || false,
'dataFusionRuntimeEventInterval' => <integer>,
'dataFusionRuntimeGlobalQueueInterval' => <integer>,
'dataFusionRuntimeMaxBlockingThreads' => <integer>,
'dataFusionRuntimeMaxIoEventsPerTick' => <integer>,
'dataFusionRuntimeThreadKeepAlive' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'dataFusionRuntimeThreadPriority' => <integer>,
'dataFusionRuntimeType' => 'multi-thread|multi-thread-alt',
'dataFusionUseCachedParquetLoader' => true || false,
'deleteGracePeriod' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'disableParquetMemCache' => true || false,
'distinctCacheEvictionInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'execMemPoolBytes' => [
'absolute' => <integer>,
'percent' => '<string>',
],
'forceSnapshotMemThreshold' => [
'absolute' => <integer>,
'percent' => '<string>',
],
'gen1Duration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'gen1LookbackDuration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'hardDeleteDefaultDuration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'lastCacheEvictionInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'logFilter' => '<string>',
'logFormat' => 'full',
'maxHttpRequestSize' => <integer>,
'parquetMemCachePruneInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'parquetMemCachePrunePercentage' => <float>,
'parquetMemCacheQueryPathDuration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'parquetMemCacheSize' => [
'absolute' => <integer>,
'percent' => '<string>',
],
'preemptiveCacheAge' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'queryFileLimit' => <integer>,
'queryLogSize' => <integer>,
'retentionCheckInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'snapshottedWalFilesToKeep' => <integer>,
'tableIndexCacheConcurrencyLimit' => <integer>,
'tableIndexCacheMaxEntries' => <integer>,
'walMaxWriteBufferSize' => <integer>,
'walReplayConcurrencyLimit' => <integer>,
'walReplayFailOnError' => true || false,
'walSnapshotSize' => <integer>,
],
'InfluxDBv3Enterprise' => [
'catalogSyncInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'compactionCheckInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'compactionCleanupWait' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'compactionGen2Duration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'compactionMaxNumFilesPerPlan' => <integer>,
'compactionMultipliers' => '<string>',
'compactionRowLimit' => <integer>,
'dataFusionConfig' => '<string>',
'dataFusionMaxParquetFanout' => <integer>,
'dataFusionNumThreads' => <integer>,
'dataFusionRuntimeDisableLifoSlot' => true || false,
'dataFusionRuntimeEventInterval' => <integer>,
'dataFusionRuntimeGlobalQueueInterval' => <integer>,
'dataFusionRuntimeMaxBlockingThreads' => <integer>,
'dataFusionRuntimeMaxIoEventsPerTick' => <integer>,
'dataFusionRuntimeThreadKeepAlive' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'dataFusionRuntimeThreadPriority' => <integer>,
'dataFusionRuntimeType' => 'multi-thread|multi-thread-alt',
'dataFusionUseCachedParquetLoader' => true || false,
'dedicatedCompactor' => true || false,
'deleteGracePeriod' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'disableParquetMemCache' => true || false,
'distinctCacheEvictionInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'distinctValueCacheDisableFromHistory' => true || false,
'execMemPoolBytes' => [
'absolute' => <integer>,
'percent' => '<string>',
],
'forceSnapshotMemThreshold' => [
'absolute' => <integer>,
'percent' => '<string>',
],
'gen1Duration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'gen1LookbackDuration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'hardDeleteDefaultDuration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'ingestQueryInstances' => <integer>,
'lastCacheEvictionInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'lastValueCacheDisableFromHistory' => true || false,
'logFilter' => '<string>',
'logFormat' => 'full',
'maxHttpRequestSize' => <integer>,
'parquetMemCachePruneInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'parquetMemCachePrunePercentage' => <float>,
'parquetMemCacheQueryPathDuration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'parquetMemCacheSize' => [
'absolute' => <integer>,
'percent' => '<string>',
],
'preemptiveCacheAge' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'queryFileLimit' => <integer>,
'queryLogSize' => <integer>,
'queryOnlyInstances' => <integer>,
'replicationInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'retentionCheckInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'snapshottedWalFilesToKeep' => <integer>,
'tableIndexCacheConcurrencyLimit' => <integer>,
'tableIndexCacheMaxEntries' => <integer>,
'walMaxWriteBufferSize' => <integer>,
'walReplayConcurrencyLimit' => <integer>,
'walReplayFailOnError' => true || false,
'walSnapshotSize' => <integer>,
],
],
]
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.
DeleteDbCluster
$result = $client->deleteDbCluster([/* ... */]); $promise = $client->deleteDbClusterAsync([/* ... */]);
Deletes a Timestream for InfluxDB cluster.
Parameter Syntax
$result = $client->deleteDbCluster([
'dbClusterId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- dbClusterId
-
- Required: Yes
- Type: string
Service-generated unique identifier of the DB cluster.
Result Syntax
[
'dbClusterStatus' => 'CREATING|UPDATING|DELETING|AVAILABLE|FAILED|DELETED|MAINTENANCE',
]
Result Details
Members
- dbClusterStatus
-
- Type: string
The status of the DB cluster.
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.
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>',
'dbClusterId' => '<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|db.influx.24xlarge',
'dbParameterGroupIdentifier' => '<string>',
'dbStorageType' => 'InfluxIOIncludedT1|InfluxIOIncludedT2|InfluxIOIncludedT3',
'deploymentType' => 'SINGLE_AZ|WITH_MULTIAZ_STANDBY',
'endpoint' => '<string>',
'id' => '<string>',
'influxAuthParametersSecretArn' => '<string>',
'instanceMode' => 'PRIMARY|STANDBY|REPLICA|INGEST|QUERY|COMPACT|PROCESS',
'instanceModes' => ['<string>', ...],
'logDeliveryConfiguration' => [
's3Configuration' => [
'bucketName' => '<string>',
'enabled' => true || false,
],
],
'name' => '<string>',
'networkType' => 'IPV4|DUAL',
'port' => <integer>,
'publiclyAccessible' => true || false,
'secondaryAvailabilityZone' => '<string>',
'status' => 'CREATING|AVAILABLE|DELETING|MODIFYING|UPDATING|DELETED|FAILED|UPDATING_DEPLOYMENT_TYPE|UPDATING_INSTANCE_TYPE|MAINTENANCE',
'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.
- dbClusterId
-
- Type: string
Specifies the DbCluster to which this DbInstance belongs to.
- 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 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.
- instanceMode
-
- Type: string
Specifies the DbInstance's role in the cluster.
- instanceModes
-
- Type: Array of strings
Specifies the DbInstance's roles in the cluster.
- 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.
- networkType
-
- Type: string
Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
- 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.
GetDbCluster
$result = $client->getDbCluster([/* ... */]); $promise = $client->getDbClusterAsync([/* ... */]);
Retrieves information about a Timestream for InfluxDB cluster.
Parameter Syntax
$result = $client->getDbCluster([
'dbClusterId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- dbClusterId
-
- Required: Yes
- Type: string
Service-generated unique identifier of the DB cluster to retrieve.
Result Syntax
[
'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|db.influx.24xlarge',
'dbParameterGroupIdentifier' => '<string>',
'dbStorageType' => 'InfluxIOIncludedT1|InfluxIOIncludedT2|InfluxIOIncludedT3',
'deploymentType' => 'MULTI_NODE_READ_REPLICAS',
'endpoint' => '<string>',
'engineType' => 'INFLUXDB_V2|INFLUXDB_V3_CORE|INFLUXDB_V3_ENTERPRISE',
'failoverMode' => 'AUTOMATIC|NO_FAILOVER',
'id' => '<string>',
'influxAuthParametersSecretArn' => '<string>',
'logDeliveryConfiguration' => [
's3Configuration' => [
'bucketName' => '<string>',
'enabled' => true || false,
],
],
'name' => '<string>',
'networkType' => 'IPV4|DUAL',
'port' => <integer>,
'publiclyAccessible' => true || false,
'readerEndpoint' => '<string>',
'status' => 'CREATING|UPDATING|DELETING|AVAILABLE|FAILED|DELETED|MAINTENANCE',
'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 cluster.
- 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 cluster.
- dbStorageType
-
- Type: string
The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
- deploymentType
-
- Type: string
Deployment type of the DB cluster.
- endpoint
-
- Type: string
The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.
- engineType
-
- Type: string
The engine type of your DB cluster.
- failoverMode
-
- Type: string
The configured failover mode for the DB cluster.
- id
-
- Required: Yes
- Type: string
Service-generated unique identifier of the DB cluster to retrieve.
- influxAuthParametersSecretArn
-
- Type: string
The Amazon Resource Name (ARN) of the Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
- logDeliveryConfiguration
-
- Type: LogDeliveryConfiguration structure
Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
- name
-
- Required: Yes
- Type: string
Customer-supplied name of the Timestream for InfluxDB cluster.
- networkType
-
- Type: string
Specifies whether the network type of the Timestream for InfluxDB cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
- port
-
- Type: int
The port number on which InfluxDB accepts connections.
- publiclyAccessible
-
- Type: boolean
Indicates if the DB cluster has a public IP to facilitate access from outside the VPC.
- readerEndpoint
-
- Type: string
The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
- status
-
- Type: string
The status of the DB cluster.
- vpcSecurityGroupIds
-
- Type: Array of strings
A list of VPC security group IDs associated with the DB cluster.
- vpcSubnetIds
-
- Type: Array of strings
A list of VPC subnet IDs associated with the DB cluster.
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.
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>',
'dbClusterId' => '<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|db.influx.24xlarge',
'dbParameterGroupIdentifier' => '<string>',
'dbStorageType' => 'InfluxIOIncludedT1|InfluxIOIncludedT2|InfluxIOIncludedT3',
'deploymentType' => 'SINGLE_AZ|WITH_MULTIAZ_STANDBY',
'endpoint' => '<string>',
'id' => '<string>',
'influxAuthParametersSecretArn' => '<string>',
'instanceMode' => 'PRIMARY|STANDBY|REPLICA|INGEST|QUERY|COMPACT|PROCESS',
'instanceModes' => ['<string>', ...],
'logDeliveryConfiguration' => [
's3Configuration' => [
'bucketName' => '<string>',
'enabled' => true || false,
],
],
'name' => '<string>',
'networkType' => 'IPV4|DUAL',
'port' => <integer>,
'publiclyAccessible' => true || false,
'secondaryAvailabilityZone' => '<string>',
'status' => 'CREATING|AVAILABLE|DELETING|MODIFYING|UPDATING|DELETED|FAILED|UPDATING_DEPLOYMENT_TYPE|UPDATING_INSTANCE_TYPE|MAINTENANCE',
'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.
- dbClusterId
-
- Type: string
Specifies the DbCluster to which this DbInstance belongs to.
- 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 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.
- instanceMode
-
- Type: string
Specifies the DbInstance's role in the cluster.
- instanceModes
-
- Type: Array of strings
Specifies the DbInstance's roles in the cluster.
- 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.
- networkType
-
- Type: string
Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
- 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|days',
'value' => <integer>,
],
'httpReadHeaderTimeout' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'httpReadTimeout' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'httpWriteTimeout' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'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|days',
'value' => <integer>,
],
'storageCompactFullWriteColdDuration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'storageCompactThroughputBurst' => <integer>,
'storageMaxConcurrentCompactions' => <integer>,
'storageMaxIndexLogFileSize' => <integer>,
'storageNoValidateFieldSize' => true || false,
'storageRetentionCheckInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'storageSeriesFileMaxConcurrentSnapshotCompactions' => <integer>,
'storageSeriesIdSetCacheSize' => <integer>,
'storageWalMaxConcurrentWrites' => <integer>,
'storageWalMaxWriteDelay' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'tracingType' => 'log|jaeger|disabled',
'uiDisabled' => true || false,
],
'InfluxDBv3Core' => [
'dataFusionConfig' => '<string>',
'dataFusionMaxParquetFanout' => <integer>,
'dataFusionNumThreads' => <integer>,
'dataFusionRuntimeDisableLifoSlot' => true || false,
'dataFusionRuntimeEventInterval' => <integer>,
'dataFusionRuntimeGlobalQueueInterval' => <integer>,
'dataFusionRuntimeMaxBlockingThreads' => <integer>,
'dataFusionRuntimeMaxIoEventsPerTick' => <integer>,
'dataFusionRuntimeThreadKeepAlive' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'dataFusionRuntimeThreadPriority' => <integer>,
'dataFusionRuntimeType' => 'multi-thread|multi-thread-alt',
'dataFusionUseCachedParquetLoader' => true || false,
'deleteGracePeriod' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'disableParquetMemCache' => true || false,
'distinctCacheEvictionInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'execMemPoolBytes' => [
'absolute' => <integer>,
'percent' => '<string>',
],
'forceSnapshotMemThreshold' => [
'absolute' => <integer>,
'percent' => '<string>',
],
'gen1Duration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'gen1LookbackDuration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'hardDeleteDefaultDuration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'lastCacheEvictionInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'logFilter' => '<string>',
'logFormat' => 'full',
'maxHttpRequestSize' => <integer>,
'parquetMemCachePruneInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'parquetMemCachePrunePercentage' => <float>,
'parquetMemCacheQueryPathDuration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'parquetMemCacheSize' => [
'absolute' => <integer>,
'percent' => '<string>',
],
'preemptiveCacheAge' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'queryFileLimit' => <integer>,
'queryLogSize' => <integer>,
'retentionCheckInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'snapshottedWalFilesToKeep' => <integer>,
'tableIndexCacheConcurrencyLimit' => <integer>,
'tableIndexCacheMaxEntries' => <integer>,
'walMaxWriteBufferSize' => <integer>,
'walReplayConcurrencyLimit' => <integer>,
'walReplayFailOnError' => true || false,
'walSnapshotSize' => <integer>,
],
'InfluxDBv3Enterprise' => [
'catalogSyncInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'compactionCheckInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'compactionCleanupWait' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'compactionGen2Duration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'compactionMaxNumFilesPerPlan' => <integer>,
'compactionMultipliers' => '<string>',
'compactionRowLimit' => <integer>,
'dataFusionConfig' => '<string>',
'dataFusionMaxParquetFanout' => <integer>,
'dataFusionNumThreads' => <integer>,
'dataFusionRuntimeDisableLifoSlot' => true || false,
'dataFusionRuntimeEventInterval' => <integer>,
'dataFusionRuntimeGlobalQueueInterval' => <integer>,
'dataFusionRuntimeMaxBlockingThreads' => <integer>,
'dataFusionRuntimeMaxIoEventsPerTick' => <integer>,
'dataFusionRuntimeThreadKeepAlive' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'dataFusionRuntimeThreadPriority' => <integer>,
'dataFusionRuntimeType' => 'multi-thread|multi-thread-alt',
'dataFusionUseCachedParquetLoader' => true || false,
'dedicatedCompactor' => true || false,
'deleteGracePeriod' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'disableParquetMemCache' => true || false,
'distinctCacheEvictionInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'distinctValueCacheDisableFromHistory' => true || false,
'execMemPoolBytes' => [
'absolute' => <integer>,
'percent' => '<string>',
],
'forceSnapshotMemThreshold' => [
'absolute' => <integer>,
'percent' => '<string>',
],
'gen1Duration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'gen1LookbackDuration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'hardDeleteDefaultDuration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'ingestQueryInstances' => <integer>,
'lastCacheEvictionInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'lastValueCacheDisableFromHistory' => true || false,
'logFilter' => '<string>',
'logFormat' => 'full',
'maxHttpRequestSize' => <integer>,
'parquetMemCachePruneInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'parquetMemCachePrunePercentage' => <float>,
'parquetMemCacheQueryPathDuration' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'parquetMemCacheSize' => [
'absolute' => <integer>,
'percent' => '<string>',
],
'preemptiveCacheAge' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'queryFileLimit' => <integer>,
'queryLogSize' => <integer>,
'queryOnlyInstances' => <integer>,
'replicationInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'retentionCheckInterval' => [
'durationType' => 'hours|minutes|seconds|milliseconds|days',
'value' => <integer>,
],
'snapshottedWalFilesToKeep' => <integer>,
'tableIndexCacheConcurrencyLimit' => <integer>,
'tableIndexCacheMaxEntries' => <integer>,
'walMaxWriteBufferSize' => <integer>,
'walReplayConcurrencyLimit' => <integer>,
'walReplayFailOnError' => true || false,
'walSnapshotSize' => <integer>,
],
],
]
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.
ListDbClusters
$result = $client->listDbClusters([/* ... */]); $promise = $client->listDbClustersAsync([/* ... */]);
Returns a list of Timestream for InfluxDB DB clusters.
Parameter Syntax
$result = $client->listDbClusters([
'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 an argument of a subsequent API invocation.
- nextToken
-
- Type: string
The pagination token. To resume pagination, provide the nextToken value as an 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|db.influx.24xlarge',
'dbStorageType' => 'InfluxIOIncludedT1|InfluxIOIncludedT2|InfluxIOIncludedT3',
'deploymentType' => 'MULTI_NODE_READ_REPLICAS',
'endpoint' => '<string>',
'engineType' => 'INFLUXDB_V2|INFLUXDB_V3_CORE|INFLUXDB_V3_ENTERPRISE',
'id' => '<string>',
'name' => '<string>',
'networkType' => 'IPV4|DUAL',
'port' => <integer>,
'readerEndpoint' => '<string>',
'status' => 'CREATING|UPDATING|DELETING|AVAILABLE|FAILED|DELETED|MAINTENANCE',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Required: Yes
- Type: Array of DbClusterSummary structures
A list of Timestream for InfluxDB cluster 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.
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|db.influx.24xlarge',
'dbStorageType' => 'InfluxIOIncludedT1|InfluxIOIncludedT2|InfluxIOIncludedT3',
'deploymentType' => 'SINGLE_AZ|WITH_MULTIAZ_STANDBY',
'endpoint' => '<string>',
'id' => '<string>',
'name' => '<string>',
'networkType' => 'IPV4|DUAL',
'port' => <integer>,
'status' => 'CREATING|AVAILABLE|DELETING|MODIFYING|UPDATING|DELETED|FAILED|UPDATING_DEPLOYMENT_TYPE|UPDATING_INSTANCE_TYPE|MAINTENANCE',
],
// ...
],
'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.
ListDbInstancesForCluster
$result = $client->listDbInstancesForCluster([/* ... */]); $promise = $client->listDbInstancesForClusterAsync([/* ... */]);
Returns a list of Timestream for InfluxDB clusters.
Parameter Syntax
$result = $client->listDbInstancesForCluster([
'dbClusterId' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- dbClusterId
-
- Required: Yes
- Type: string
Service-generated unique identifier of the DB cluster.
- 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 an argument of a subsequent API invocation.
- nextToken
-
- Type: string
The pagination token. To resume pagination, provide the nextToken value as an 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|db.influx.24xlarge',
'dbStorageType' => 'InfluxIOIncludedT1|InfluxIOIncludedT2|InfluxIOIncludedT3',
'deploymentType' => 'SINGLE_AZ|WITH_MULTIAZ_STANDBY',
'endpoint' => '<string>',
'id' => '<string>',
'instanceMode' => 'PRIMARY|STANDBY|REPLICA|INGEST|QUERY|COMPACT|PROCESS',
'instanceModes' => ['<string>', ...],
'name' => '<string>',
'networkType' => 'IPV4|DUAL',
'port' => <integer>,
'status' => 'CREATING|AVAILABLE|DELETING|MODIFYING|UPDATING|DELETED|FAILED|UPDATING_DEPLOYMENT_TYPE|UPDATING_INSTANCE_TYPE|MAINTENANCE',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Required: Yes
- Type: Array of DbInstanceForClusterSummary structures
A list of Timestream for InfluxDB instance summaries belonging to the cluster.
- 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
- ServiceQuotaExceededException:
The request exceeds the service quota.
- 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.
UpdateDbCluster
$result = $client->updateDbCluster([/* ... */]); $promise = $client->updateDbClusterAsync([/* ... */]);
Updates a Timestream for InfluxDB cluster.
Parameter Syntax
$result = $client->updateDbCluster([
'dbClusterId' => '<string>', // REQUIRED
'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|db.influx.24xlarge',
'dbParameterGroupIdentifier' => '<string>',
'failoverMode' => 'AUTOMATIC|NO_FAILOVER',
'logDeliveryConfiguration' => [
's3Configuration' => [ // REQUIRED
'bucketName' => '<string>', // REQUIRED
'enabled' => true || false, // REQUIRED
],
],
'port' => <integer>,
]);
Parameter Details
Members
- dbClusterId
-
- Required: Yes
- Type: string
Service-generated unique identifier of the DB cluster to update.
- dbInstanceType
-
- Type: string
Update the DB cluster to use the specified DB instance Type.
- dbParameterGroupIdentifier
-
- Type: string
Update the DB cluster to use the specified DB parameter group.
- failoverMode
-
- Type: string
Update the DB cluster's failover behavior.
- logDeliveryConfiguration
-
- Type: LogDeliveryConfiguration structure
The log delivery configuration to apply to the DB cluster.
- port
-
- Type: int
Update the DB cluster to use the specified port.
Result Syntax
[
'dbClusterStatus' => 'CREATING|UPDATING|DELETING|AVAILABLE|FAILED|DELETED|MAINTENANCE',
]
Result Details
Members
- dbClusterStatus
-
- Type: string
The status of the DB cluster.
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.
UpdateDbInstance
$result = $client->updateDbInstance([/* ... */]); $promise = $client->updateDbInstanceAsync([/* ... */]);
Updates a Timestream for InfluxDB DB instance.
Parameter Syntax
$result = $client->updateDbInstance([
'allocatedStorage' => <integer>,
'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|db.influx.24xlarge',
'dbParameterGroupIdentifier' => '<string>',
'dbStorageType' => 'InfluxIOIncludedT1|InfluxIOIncludedT2|InfluxIOIncludedT3',
'deploymentType' => 'SINGLE_AZ|WITH_MULTIAZ_STANDBY',
'identifier' => '<string>', // REQUIRED
'logDeliveryConfiguration' => [
's3Configuration' => [ // REQUIRED
'bucketName' => '<string>', // REQUIRED
'enabled' => true || false, // REQUIRED
],
],
'port' => <integer>,
]);
Parameter Details
Members
- allocatedStorage
-
- Type: int
The amount of storage to allocate for your DB storage type (in gibibytes).
- 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.
- dbStorageType
-
- Type: string
The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
- 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>',
'dbClusterId' => '<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|db.influx.24xlarge',
'dbParameterGroupIdentifier' => '<string>',
'dbStorageType' => 'InfluxIOIncludedT1|InfluxIOIncludedT2|InfluxIOIncludedT3',
'deploymentType' => 'SINGLE_AZ|WITH_MULTIAZ_STANDBY',
'endpoint' => '<string>',
'id' => '<string>',
'influxAuthParametersSecretArn' => '<string>',
'instanceMode' => 'PRIMARY|STANDBY|REPLICA|INGEST|QUERY|COMPACT|PROCESS',
'instanceModes' => ['<string>', ...],
'logDeliveryConfiguration' => [
's3Configuration' => [
'bucketName' => '<string>',
'enabled' => true || false,
],
],
'name' => '<string>',
'networkType' => 'IPV4|DUAL',
'port' => <integer>,
'publiclyAccessible' => true || false,
'secondaryAvailabilityZone' => '<string>',
'status' => 'CREATING|AVAILABLE|DELETING|MODIFYING|UPDATING|DELETED|FAILED|UPDATING_DEPLOYMENT_TYPE|UPDATING_INSTANCE_TYPE|MAINTENANCE',
'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.
- dbClusterId
-
- Type: string
Specifies the DbCluster to which this DbInstance belongs to.
- 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 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.
- instanceMode
-
- Type: string
Specifies the DbInstance's role in the cluster.
- instanceModes
-
- Type: Array of strings
Specifies the DbInstance's roles in the cluster.
- 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 CLI commands.
- networkType
-
- Type: string
Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
- 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.
DbClusterSummary
Description
Describes a summary of a Timestream for InfluxDB cluster.
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 cluster.
- dbInstanceType
-
- Type: string
The Timestream for InfluxDB DB instance type that InfluxDB runs on.
- dbStorageType
-
- Type: string
The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
- deploymentType
-
- Type: string
Deployment type of the DB cluster
- endpoint
-
- Type: string
The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.
- engineType
-
- Type: string
The engine type of your DB cluster.
- id
-
- Required: Yes
- Type: string
Service-generated unique identifier of the DB cluster to retrieve.
- name
-
- Required: Yes
- Type: string
Customer supplied name of the Timestream for InfluxDB cluster.
- networkType
-
- Type: string
Specifies whether the network type of the Timestream for InfluxDB Cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
- port
-
- Type: int
The port number on which InfluxDB accepts connections.
- readerEndpoint
-
- Type: string
The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
- status
-
- Type: string
The status of the DB cluster.
DbInstanceForClusterSummary
Description
Contains a summary of a DB instance belonging to a DB cluster.
Members
- allocatedStorage
-
- Type: int
The amount of storage allocated for your DB storage type 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
Specifies the deployment type if applicable.
- 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.
- instanceMode
-
- Type: string
Specifies the DB instance's role in the cluster.
- instanceModes
-
- Type: Array of strings
Specifies the DB instance's roles in the cluster.
- name
-
- Required: Yes
- Type: string
A service-generated name for the DB instance based on the customer-supplied name for the DB cluster.
- networkType
-
- Type: string
Specifies whether the network type of the Timestream for InfluxDB instance is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
- port
-
- Type: int
The port number on which InfluxDB accepts connections.
- status
-
- Type: string
The status of the DB instance.
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 CLI commands.
- networkType
-
- Type: string
Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
- 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: true
- 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
InfluxDBv3CoreParameters
Description
All the customer-modifiable InfluxDB v3 Core parameters in Timestream for InfluxDB.
Members
- dataFusionConfig
-
- Type: string
Provides custom configuration to DataFusion as a comma-separated list of key:value pairs.
- dataFusionMaxParquetFanout
-
- Type: int
When multiple parquet files are required in a sorted way (deduplication for example), specifies the maximum fanout.
Default: 1000
- dataFusionNumThreads
-
- Type: int
Sets the maximum number of DataFusion runtime threads to use.
- dataFusionRuntimeDisableLifoSlot
-
- Type: boolean
Disables the LIFO slot of the DataFusion runtime.
- dataFusionRuntimeEventInterval
-
- Type: int
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
-
- Type: int
Sets the number of scheduler ticks after which the scheduler of the DataFusion runtime polls the global task queue.
- dataFusionRuntimeMaxBlockingThreads
-
- Type: int
Specifies the limit for additional threads spawned by the DataFusion runtime.
- dataFusionRuntimeMaxIoEventsPerTick
-
- Type: int
Configures the maximum number of events processed per tick by the tokio DataFusion runtime.
- dataFusionRuntimeThreadKeepAlive
-
- Type: Duration structure
Sets a custom timeout for a thread in the blocking pool of the tokio DataFusion runtime.
- dataFusionRuntimeThreadPriority
-
- Type: int
Sets the thread priority for tokio DataFusion runtime workers.
Default: 10
- dataFusionRuntimeType
-
- Type: string
Specifies the DataFusion tokio runtime type.
Default: multi-thread
- dataFusionUseCachedParquetLoader
-
- Type: boolean
Uses a cached parquet loader when reading parquet files from the object store.
- deleteGracePeriod
-
- Type: Duration structure
Specifies the grace period before permanently deleting data.
Default: 24h
- disableParquetMemCache
-
- Type: boolean
Disables the in-memory Parquet cache. By default, the cache is enabled.
- distinctCacheEvictionInterval
-
- Type: Duration 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
- execMemPoolBytes
-
- Type: PercentOrAbsoluteLong 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%
- forceSnapshotMemThreshold
-
- Type: PercentOrAbsoluteLong 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%
- gen1Duration
-
- Type: Duration 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
- gen1LookbackDuration
-
- Type: Duration structure
Specifies how far back to look when creating generation 1 Parquet files.
Default: 24h
- hardDeleteDefaultDuration
-
- Type: Duration structure
Sets the default duration for hard deletion of data.
Default: 90d
- lastCacheEvictionInterval
-
- Type: Duration 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
- logFilter
-
- Type: string
Sets the filter directive for logs.
- logFormat
-
- Type: string
Defines the message format for logs.
Default: full
- maxHttpRequestSize
-
- Type: long (int|float)
Specifies the maximum size of HTTP requests.
Default: 10485760
- parquetMemCachePruneInterval
-
- Type: Duration structure
Sets the interval to check if the in-memory Parquet cache needs to be pruned.
Default: 1s
- parquetMemCachePrunePercentage
-
- Type: float
Specifies the percentage of entries to prune during a prune operation on the in-memory Parquet cache.
Default: 0.1
- parquetMemCacheQueryPathDuration
-
- Type: Duration structure
Specifies the time window for caching recent Parquet files in memory.
Default: 5h
- parquetMemCacheSize
-
- Type: PercentOrAbsoluteLong structure
Specifies the size of the in-memory Parquet cache in megabytes or percentage of total available memory.
Default: 20%
- preemptiveCacheAge
-
- Type: Duration structure
Specifies the interval to prefetch into the Parquet cache during compaction.
Default: 3d
- queryFileLimit
-
- Type: int
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
-
- Type: int
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
- retentionCheckInterval
-
- Type: Duration structure
The interval at which retention policies are checked and enforced. Enter as a human-readable time–for example: 30m or 1h.
Default: 30m
- snapshottedWalFilesToKeep
-
- Type: int
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
- tableIndexCacheConcurrencyLimit
-
- Type: int
Limits the concurrency level for table index cache operations.
Default: 8
- tableIndexCacheMaxEntries
-
- Type: int
Specifies the maximum number of entries in the table index cache.
Default: 1000
- walMaxWriteBufferSize
-
- Type: int
Specifies the maximum number of write requests that can be buffered before a flush must be executed and succeed.
Default: 100000
- walReplayConcurrencyLimit
-
- Type: int
Concurrency limit during WAL replay. Setting this number too high can lead to OOM. The default is dynamically determined.
Default: max(num_cpus, 10)
- walReplayFailOnError
-
- Type: boolean
Determines whether WAL replay should fail when encountering errors.
Default: false
- walSnapshotSize
-
- Type: int
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
InfluxDBv3EnterpriseParameters
Description
All the customer-modifiable InfluxDB v3 Enterprise parameters in Timestream for InfluxDB.
Members
- catalogSyncInterval
-
- Type: Duration structure
Defines how often the catalog synchronizes across cluster nodes.
Default: 10s
- compactionCheckInterval
-
- Type: Duration structure
Specifies how often the compactor checks for new compaction work to perform.
Default: 10s
- compactionCleanupWait
-
- Type: Duration 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
- compactionGen2Duration
-
- Type: Duration 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
- compactionMaxNumFilesPerPlan
-
- Type: int
Sets the maximum number of files included in any compaction plan.
Default: 500
- compactionMultipliers
-
- Type: 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
- compactionRowLimit
-
- Type: int
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
- dataFusionConfig
-
- Type: string
Provides custom configuration to DataFusion as a comma-separated list of key:value pairs.
- dataFusionMaxParquetFanout
-
- Type: int
When multiple parquet files are required in a sorted way (deduplication for example), specifies the maximum fanout.
Default: 1000
- dataFusionNumThreads
-
- Type: int
Sets the maximum number of DataFusion runtime threads to use.
- dataFusionRuntimeDisableLifoSlot
-
- Type: boolean
Disables the LIFO slot of the DataFusion runtime.
- dataFusionRuntimeEventInterval
-
- Type: int
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
-
- Type: int
Sets the number of scheduler ticks after which the scheduler of the DataFusion runtime polls the global task queue.
- dataFusionRuntimeMaxBlockingThreads
-
- Type: int
Specifies the limit for additional threads spawned by the DataFusion runtime.
- dataFusionRuntimeMaxIoEventsPerTick
-
- Type: int
Configures the maximum number of events processed per tick by the tokio DataFusion runtime.
- dataFusionRuntimeThreadKeepAlive
-
- Type: Duration structure
Sets a custom timeout for a thread in the blocking pool of the tokio DataFusion runtime.
- dataFusionRuntimeThreadPriority
-
- Type: int
Sets the thread priority for tokio DataFusion runtime workers.
Default: 10
- dataFusionRuntimeType
-
- Type: string
Specifies the DataFusion tokio runtime type.
Default: multi-thread
- dataFusionUseCachedParquetLoader
-
- Type: boolean
Uses a cached parquet loader when reading parquet files from the object store.
- dedicatedCompactor
-
- Required: Yes
- Type: boolean
Specifies if the compactor instance should be a standalone instance or not.
- deleteGracePeriod
-
- Type: Duration structure
Specifies the grace period before permanently deleting data.
Default: 24h
- disableParquetMemCache
-
- Type: boolean
Disables the in-memory Parquet cache. By default, the cache is enabled.
- distinctCacheEvictionInterval
-
- Type: Duration 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
- distinctValueCacheDisableFromHistory
-
- Type: 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).
- execMemPoolBytes
-
- Type: PercentOrAbsoluteLong 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%
- forceSnapshotMemThreshold
-
- Type: PercentOrAbsoluteLong 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%
- gen1Duration
-
- Type: Duration 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
- gen1LookbackDuration
-
- Type: Duration structure
Specifies how far back to look when creating generation 1 Parquet files.
Default: 24h
- hardDeleteDefaultDuration
-
- Type: Duration structure
Sets the default duration for hard deletion of data.
Default: 90d
- ingestQueryInstances
-
- Required: Yes
- Type: int
Specifies number of instances in the DbCluster which can both ingest and query.
- lastCacheEvictionInterval
-
- Type: Duration 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
- lastValueCacheDisableFromHistory
-
- Type: 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).
- logFilter
-
- Type: string
Sets the filter directive for logs.
- logFormat
-
- Type: string
Defines the message format for logs.
Default: full
- maxHttpRequestSize
-
- Type: long (int|float)
Specifies the maximum size of HTTP requests.
Default: 10485760
- parquetMemCachePruneInterval
-
- Type: Duration structure
Sets the interval to check if the in-memory Parquet cache needs to be pruned.
Default: 1s
- parquetMemCachePrunePercentage
-
- Type: float
Specifies the percentage of entries to prune during a prune operation on the in-memory Parquet cache.
Default: 0.1
- parquetMemCacheQueryPathDuration
-
- Type: Duration structure
Specifies the time window for caching recent Parquet files in memory.
Default: 5h
- parquetMemCacheSize
-
- Type: PercentOrAbsoluteLong structure
Specifies the size of the in-memory Parquet cache in megabytes or percentage of total available memory.
Default: 20%
- preemptiveCacheAge
-
- Type: Duration structure
Specifies the interval to prefetch into the Parquet cache during compaction.
Default: 3d
- queryFileLimit
-
- Type: int
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
-
- Type: int
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
- queryOnlyInstances
-
- Required: Yes
- Type: int
Specifies number of instances in the DbCluster which can only query.
- replicationInterval
-
- Type: Duration structure
Specifies the interval at which data replication occurs between cluster nodes.
Default: 250ms
- retentionCheckInterval
-
- Type: Duration structure
The interval at which retention policies are checked and enforced. Enter as a human-readable time–for example: 30m or 1h.
Default: 30m
- snapshottedWalFilesToKeep
-
- Type: int
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
- tableIndexCacheConcurrencyLimit
-
- Type: int
Limits the concurrency level for table index cache operations.
Default: 8
- tableIndexCacheMaxEntries
-
- Type: int
Specifies the maximum number of entries in the table index cache.
Default: 1000
- walMaxWriteBufferSize
-
- Type: int
Specifies the maximum number of write requests that can be buffered before a flush must be executed and succeed.
Default: 100000
- walReplayConcurrencyLimit
-
- Type: int
Concurrency limit during WAL replay. Setting this number too high can lead to OOM. The default is dynamically determined.
Default: max(num_cpus, 10)
- walReplayFailOnError
-
- Type: boolean
Determines whether WAL replay should fail when encountering errors.
Default: false
- walSnapshotSize
-
- Type: int
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
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.
- InfluxDBv3Core
-
- Type: InfluxDBv3CoreParameters structure
All the customer-modifiable InfluxDB v3 Core parameters in Timestream for InfluxDB.
- InfluxDBv3Enterprise
-
- Type: InfluxDBv3EnterpriseParameters structure
All the customer-modifiable InfluxDB v3 Enterprise parameters in Timestream for InfluxDB.
PercentOrAbsoluteLong
Description
Percent or Absolute Long for InfluxDB parameters
Members
- absolute
-
- Type: long (int|float)
Absolute long for InfluxDB parameters.
- percent
-
- Type: string
Percent for InfluxDB parameters.
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.