2024/10/01 - Timestream InfluxDB - 7 updated api methods
Changes Timestream for InfluxDB now supports port configuration and additional customer-modifiable InfluxDB v2 parameters. This release adds Port to the CreateDbInstance and UpdateDbInstance API, and additional InfluxDB v2 parameters to the CreateDbParameterGroup API.
{'port': 'integer'}
Creates a new Timestream for InfluxDB DB instance.
See also: AWS API Documentation
Request Syntax
client.create_db_instance(
name='string',
username='string',
password='string',
organization='string',
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',
vpcSubnetIds=[
'string',
],
vpcSecurityGroupIds=[
'string',
],
publiclyAccessible=True|False,
dbStorageType='InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
allocatedStorage=123,
dbParameterGroupIdentifier='string',
deploymentType='SINGLE_AZ'|'WITH_MULTIAZ_STANDBY',
logDeliveryConfiguration={
's3Configuration': {
'bucketName': 'string',
'enabled': True|False
}
},
tags={
'string': 'string'
},
port=123
)
string
[REQUIRED]
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.
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.
string
[REQUIRED]
The password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in AWS SecretManager in your account.
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.
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.
string
[REQUIRED]
The Timestream for InfluxDB DB instance type to run InfluxDB on.
list
[REQUIRED]
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.
(string) --
list
[REQUIRED]
A list of VPC security group IDs to associate with the DB instance.
(string) --
boolean
Configures the DB instance with a public IP to facilitate access.
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
integer
[REQUIRED]
The amount of storage to allocate for your DB storage type in GiB (gibibytes).
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.
string
Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
dict
Configuration for sending InfluxDB engine logs to a specified S3 bucket.
s3Configuration (dict) -- [REQUIRED]
Configuration for S3 bucket log delivery.
bucketName (string) -- [REQUIRED]
The name of the S3 bucket to deliver logs to.
enabled (boolean) -- [REQUIRED]
Indicates whether log delivery to the S3 bucket is enabled.
dict
A list of key-value pairs to associate with the DB instance.
(string) --
(string) --
integer
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
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'MODIFYING'|'UPDATING'|'DELETED'|'FAILED'|'UPDATING_DEPLOYMENT_TYPE'|'UPDATING_INSTANCE_TYPE',
'endpoint': 'string',
'port': 123,
'dbInstanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge',
'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
'allocatedStorage': 123,
'deploymentType': 'SINGLE_AZ'|'WITH_MULTIAZ_STANDBY',
'vpcSubnetIds': [
'string',
],
'publiclyAccessible': True|False,
'vpcSecurityGroupIds': [
'string',
],
'dbParameterGroupIdentifier': 'string',
'availabilityZone': 'string',
'secondaryAvailabilityZone': 'string',
'logDeliveryConfiguration': {
's3Configuration': {
'bucketName': 'string',
'enabled': True|False
}
},
'influxAuthParametersSecretArn': 'string'
}
Response Structure
(dict) --
id (string) --
A service-generated unique identifier.
name (string) --
The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
arn (string) --
The Amazon Resource Name (ARN) of the DB instance.
status (string) --
The status of the DB instance.
endpoint (string) --
The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
port (integer) --
The port number on which InfluxDB accepts connections. The default value is 8086.
dbInstanceType (string) --
The Timestream for InfluxDB instance type that InfluxDB runs on.
dbStorageType (string) --
The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
allocatedStorage (integer) --
The amount of storage allocated for your DB storage type (in gibibytes).
deploymentType (string) --
Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
vpcSubnetIds (list) --
A list of VPC subnet IDs associated with the DB instance.
(string) --
publiclyAccessible (boolean) --
Indicates if the DB instance has a public IP to facilitate access.
vpcSecurityGroupIds (list) --
A list of VPC security group IDs associated with the DB instance.
(string) --
dbParameterGroupIdentifier (string) --
The id of the DB parameter group assigned to your DB instance.
availabilityZone (string) --
The Availability Zone in which the DB instance resides.
secondaryAvailabilityZone (string) --
The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
logDeliveryConfiguration (dict) --
Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
s3Configuration (dict) --
Configuration for S3 bucket log delivery.
bucketName (string) --
The name of the S3 bucket to deliver logs to.
enabled (boolean) --
Indicates whether log delivery to the S3 bucket is enabled.
influxAuthParametersSecretArn (string) --
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
{'parameters': {'InfluxDBv2': {'httpIdleTimeout': {'durationType': 'hours | '
'minutes | '
'seconds | '
'milliseconds',
'value': 'long'},
'httpReadHeaderTimeout': {'durationType': 'hours '
'| '
'minutes '
'| '
'seconds '
'| '
'milliseconds',
'value': 'long'},
'httpReadTimeout': {'durationType': 'hours | '
'minutes | '
'seconds | '
'milliseconds',
'value': 'long'},
'httpWriteTimeout': {'durationType': 'hours | '
'minutes | '
'seconds | '
'milliseconds',
'value': 'long'},
'influxqlMaxSelectBuckets': 'long',
'influxqlMaxSelectPoint': 'long',
'influxqlMaxSelectSeries': 'long',
'pprofDisabled': 'boolean',
'queryInitialMemoryBytes': 'long',
'queryMaxMemoryBytes': 'long',
'queryMemoryBytes': 'long',
'sessionLength': 'integer',
'sessionRenewDisabled': 'boolean',
'storageCacheMaxMemorySize': 'long',
'storageCacheSnapshotMemorySize': 'long',
'storageCacheSnapshotWriteColdDuration': {'durationType': 'hours '
'| '
'minutes '
'| '
'seconds '
'| '
'milliseconds',
'value': 'long'},
'storageCompactFullWriteColdDuration': {'durationType': 'hours '
'| '
'minutes '
'| '
'seconds '
'| '
'milliseconds',
'value': 'long'},
'storageCompactThroughputBurst': 'long',
'storageMaxConcurrentCompactions': 'integer',
'storageMaxIndexLogFileSize': 'long',
'storageNoValidateFieldSize': 'boolean',
'storageRetentionCheckInterval': {'durationType': 'hours '
'| '
'minutes '
'| '
'seconds '
'| '
'milliseconds',
'value': 'long'},
'storageSeriesFileMaxConcurrentSnapshotCompactions': 'integer',
'storageSeriesIdSetCacheSize': 'long',
'storageWalMaxConcurrentWrites': 'integer',
'storageWalMaxWriteDelay': {'durationType': 'hours '
'| '
'minutes '
'| '
'seconds '
'| '
'milliseconds',
'value': 'long'},
'uiDisabled': 'boolean'}}}
Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.
See also: AWS API Documentation
Request Syntax
client.create_db_parameter_group(
name='string',
description='string',
parameters={
'InfluxDBv2': {
'fluxLogEnabled': True|False,
'logLevel': 'debug'|'info'|'error',
'noTasks': True|False,
'queryConcurrency': 123,
'queryQueueSize': 123,
'tracingType': 'log'|'jaeger',
'metricsDisabled': True|False,
'httpIdleTimeout': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'httpReadHeaderTimeout': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'httpReadTimeout': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'httpWriteTimeout': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'influxqlMaxSelectBuckets': 123,
'influxqlMaxSelectPoint': 123,
'influxqlMaxSelectSeries': 123,
'pprofDisabled': True|False,
'queryInitialMemoryBytes': 123,
'queryMaxMemoryBytes': 123,
'queryMemoryBytes': 123,
'sessionLength': 123,
'sessionRenewDisabled': True|False,
'storageCacheMaxMemorySize': 123,
'storageCacheSnapshotMemorySize': 123,
'storageCacheSnapshotWriteColdDuration': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'storageCompactFullWriteColdDuration': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'storageCompactThroughputBurst': 123,
'storageMaxConcurrentCompactions': 123,
'storageMaxIndexLogFileSize': 123,
'storageNoValidateFieldSize': True|False,
'storageRetentionCheckInterval': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'storageSeriesFileMaxConcurrentSnapshotCompactions': 123,
'storageSeriesIdSetCacheSize': 123,
'storageWalMaxConcurrentWrites': 123,
'storageWalMaxWriteDelay': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'uiDisabled': True|False
}
},
tags={
'string': 'string'
}
)
string
[REQUIRED]
The name of the DB parameter group. The name must be unique per customer and per region.
string
A description of the DB parameter group.
dict
A list of the parameters that comprise the DB parameter group.
InfluxDBv2 (dict) --
All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.
fluxLogEnabled (boolean) --
Include option to show detailed logs for Flux queries.
Default: false
logLevel (string) --
Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.
Default: info
noTasks (boolean) --
Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.
Default: false
queryConcurrency (integer) --
Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.
Default: 0
queryQueueSize (integer) --
Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.
Default: 0
tracingType (string) --
Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.
metricsDisabled (boolean) --
Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.
Default: false
httpIdleTimeout (dict) --
Maximum duration the server should keep established connections alive while waiting for new requests. Set to 0 for no timeout.
Default: 3 minutes
durationType (string) -- [REQUIRED]
The type of duration for InfluxDB parameters.
value (integer) -- [REQUIRED]
The value of duration for InfluxDB parameters.
httpReadHeaderTimeout (dict) --
Maximum duration the server should try to read HTTP headers for new requests. Set to 0 for no timeout.
Default: 10 seconds
durationType (string) -- [REQUIRED]
The type of duration for InfluxDB parameters.
value (integer) -- [REQUIRED]
The value of duration for InfluxDB parameters.
httpReadTimeout (dict) --
Maximum duration the server should try to read the entirety of new requests. Set to 0 for no timeout.
Default: 0
durationType (string) -- [REQUIRED]
The type of duration for InfluxDB parameters.
value (integer) -- [REQUIRED]
The value of duration for InfluxDB parameters.
httpWriteTimeout (dict) --
Maximum duration the server should spend processing and responding to write requests. Set to 0 for no timeout.
Default: 0
durationType (string) -- [REQUIRED]
The type of duration for InfluxDB parameters.
value (integer) -- [REQUIRED]
The value of duration for InfluxDB parameters.
influxqlMaxSelectBuckets (integer) --
Maximum number of group by time buckets a SELECT statement can create. 0 allows an unlimited number of buckets.
Default: 0
influxqlMaxSelectPoint (integer) --
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 (integer) --
Maximum number of series a SELECT statement can return. 0 allows an unlimited number of series.
Default: 0
pprofDisabled (boolean) --
Disable the /debug/pprof HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging.
Default: false
queryInitialMemoryBytes (integer) --
Initial bytes of memory allocated for a query.
Default: 0
queryMaxMemoryBytes (integer) --
Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.
Default: 0
queryMemoryBytes (integer) --
Maximum bytes of memory allowed for a single query. Must be greater or equal to queryInitialMemoryBytes.
Default: 0
sessionLength (integer) --
Specifies the Time to Live (TTL) in minutes for newly created user sessions.
Default: 60
sessionRenewDisabled (boolean) --
Disables automatically extending a user’s session TTL on each request. By default, every request sets the session’s expiration time to five minutes from now. When disabled, sessions expire after the specified session length and the user is redirected to the login page, even if recently active.
Default: false
storageCacheMaxMemorySize (integer) --
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 (integer) --
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 (dict) --
Duration at which the storage engine will snapshot the cache and write it to a new TSM file if the shard hasn’t received writes or deletes.
Default: 10 minutes
durationType (string) -- [REQUIRED]
The type of duration for InfluxDB parameters.
value (integer) -- [REQUIRED]
The value of duration for InfluxDB parameters.
storageCompactFullWriteColdDuration (dict) --
Duration at which the storage engine will compact all TSM files in a shard if it hasn't received writes or deletes.
Default: 4 hours
durationType (string) -- [REQUIRED]
The type of duration for InfluxDB parameters.
value (integer) -- [REQUIRED]
The value of duration for InfluxDB parameters.
storageCompactThroughputBurst (integer) --
Rate limit (in bytes per second) that TSM compactions can write to disk.
Default: 50331648
storageMaxConcurrentCompactions (integer) --
Maximum number of full and level compactions that can run concurrently. A value of 0 results in 50% of runtime.GOMAXPROCS(0) used at runtime. Any number greater than zero limits compactions to that value. This setting does not apply to cache snapshotting.
Default: 0
storageMaxIndexLogFileSize (integer) --
Size (in bytes) at which an index write-ahead log (WAL) file will compact into an index file. Lower sizes will cause log files to be compacted more quickly and result in lower heap usage at the expense of write throughput.
Default: 1048576
storageNoValidateFieldSize (boolean) --
Skip field size validation on incoming write requests.
Default: false
storageRetentionCheckInterval (dict) --
Interval of retention policy enforcement checks. Must be greater than 0.
Default: 30 minutes
durationType (string) -- [REQUIRED]
The type of duration for InfluxDB parameters.
value (integer) -- [REQUIRED]
The value of duration for InfluxDB parameters.
storageSeriesFileMaxConcurrentSnapshotCompactions (integer) --
Maximum number of snapshot compactions that can run concurrently across all series partitions in a database.
Default: 0
storageSeriesIdSetCacheSize (integer) --
Size of the internal cache used in the TSI index to store previously calculated series results. Cached results are returned quickly rather than needing to be recalculated when a subsequent query with the same tag key/value predicate is executed. Setting this value to 0 will disable the cache and may decrease query performance.
Default: 100
storageWalMaxConcurrentWrites (integer) --
Maximum number writes to the WAL directory to attempt at the same time. Setting this value to 0 results in number of processing units available x2.
Default: 0
storageWalMaxWriteDelay (dict) --
Maximum amount of time a write request to the WAL directory will wait when the maximum number of concurrent active writes to the WAL directory has been met. Set to 0 to disable the timeout.
Default: 10 minutes
durationType (string) -- [REQUIRED]
The type of duration for InfluxDB parameters.
value (integer) -- [REQUIRED]
The value of duration for InfluxDB parameters.
uiDisabled (boolean) --
Disable the InfluxDB user interface (UI). The UI is enabled by default.
Default: false
dict
A list of key-value pairs to associate with the DB parameter group.
(string) --
(string) --
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'description': 'string',
'parameters': {
'InfluxDBv2': {
'fluxLogEnabled': True|False,
'logLevel': 'debug'|'info'|'error',
'noTasks': True|False,
'queryConcurrency': 123,
'queryQueueSize': 123,
'tracingType': 'log'|'jaeger',
'metricsDisabled': True|False,
'httpIdleTimeout': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'httpReadHeaderTimeout': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'httpReadTimeout': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'httpWriteTimeout': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'influxqlMaxSelectBuckets': 123,
'influxqlMaxSelectPoint': 123,
'influxqlMaxSelectSeries': 123,
'pprofDisabled': True|False,
'queryInitialMemoryBytes': 123,
'queryMaxMemoryBytes': 123,
'queryMemoryBytes': 123,
'sessionLength': 123,
'sessionRenewDisabled': True|False,
'storageCacheMaxMemorySize': 123,
'storageCacheSnapshotMemorySize': 123,
'storageCacheSnapshotWriteColdDuration': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'storageCompactFullWriteColdDuration': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'storageCompactThroughputBurst': 123,
'storageMaxConcurrentCompactions': 123,
'storageMaxIndexLogFileSize': 123,
'storageNoValidateFieldSize': True|False,
'storageRetentionCheckInterval': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'storageSeriesFileMaxConcurrentSnapshotCompactions': 123,
'storageSeriesIdSetCacheSize': 123,
'storageWalMaxConcurrentWrites': 123,
'storageWalMaxWriteDelay': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'uiDisabled': True|False
}
}
}
Response Structure
(dict) --
id (string) --
A service-generated unique identifier.
name (string) --
The customer-supplied name that uniquely identifies the DB parameter group when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
arn (string) --
The Amazon Resource Name (ARM) of the DB parameter group.
description (string) --
The description of the DB parameter group.
parameters (dict) --
A list of the parameters that comprise the DB parameter group.
InfluxDBv2 (dict) --
All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.
fluxLogEnabled (boolean) --
Include option to show detailed logs for Flux queries.
Default: false
logLevel (string) --
Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.
Default: info
noTasks (boolean) --
Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.
Default: false
queryConcurrency (integer) --
Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.
Default: 0
queryQueueSize (integer) --
Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.
Default: 0
tracingType (string) --
Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.
metricsDisabled (boolean) --
Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.
Default: false
httpIdleTimeout (dict) --
Maximum duration the server should keep established connections alive while waiting for new requests. Set to 0 for no timeout.
Default: 3 minutes
durationType (string) --
The type of duration for InfluxDB parameters.
value (integer) --
The value of duration for InfluxDB parameters.
httpReadHeaderTimeout (dict) --
Maximum duration the server should try to read HTTP headers for new requests. Set to 0 for no timeout.
Default: 10 seconds
durationType (string) --
The type of duration for InfluxDB parameters.
value (integer) --
The value of duration for InfluxDB parameters.
httpReadTimeout (dict) --
Maximum duration the server should try to read the entirety of new requests. Set to 0 for no timeout.
Default: 0
durationType (string) --
The type of duration for InfluxDB parameters.
value (integer) --
The value of duration for InfluxDB parameters.
httpWriteTimeout (dict) --
Maximum duration the server should spend processing and responding to write requests. Set to 0 for no timeout.
Default: 0
durationType (string) --
The type of duration for InfluxDB parameters.
value (integer) --
The value of duration for InfluxDB parameters.
influxqlMaxSelectBuckets (integer) --
Maximum number of group by time buckets a SELECT statement can create. 0 allows an unlimited number of buckets.
Default: 0
influxqlMaxSelectPoint (integer) --
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 (integer) --
Maximum number of series a SELECT statement can return. 0 allows an unlimited number of series.
Default: 0
pprofDisabled (boolean) --
Disable the /debug/pprof HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging.
Default: false
queryInitialMemoryBytes (integer) --
Initial bytes of memory allocated for a query.
Default: 0
queryMaxMemoryBytes (integer) --
Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.
Default: 0
queryMemoryBytes (integer) --
Maximum bytes of memory allowed for a single query. Must be greater or equal to queryInitialMemoryBytes.
Default: 0
sessionLength (integer) --
Specifies the Time to Live (TTL) in minutes for newly created user sessions.
Default: 60
sessionRenewDisabled (boolean) --
Disables automatically extending a user’s session TTL on each request. By default, every request sets the session’s expiration time to five minutes from now. When disabled, sessions expire after the specified session length and the user is redirected to the login page, even if recently active.
Default: false
storageCacheMaxMemorySize (integer) --
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 (integer) --
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 (dict) --
Duration at which the storage engine will snapshot the cache and write it to a new TSM file if the shard hasn’t received writes or deletes.
Default: 10 minutes
durationType (string) --
The type of duration for InfluxDB parameters.
value (integer) --
The value of duration for InfluxDB parameters.
storageCompactFullWriteColdDuration (dict) --
Duration at which the storage engine will compact all TSM files in a shard if it hasn't received writes or deletes.
Default: 4 hours
durationType (string) --
The type of duration for InfluxDB parameters.
value (integer) --
The value of duration for InfluxDB parameters.
storageCompactThroughputBurst (integer) --
Rate limit (in bytes per second) that TSM compactions can write to disk.
Default: 50331648
storageMaxConcurrentCompactions (integer) --
Maximum number of full and level compactions that can run concurrently. A value of 0 results in 50% of runtime.GOMAXPROCS(0) used at runtime. Any number greater than zero limits compactions to that value. This setting does not apply to cache snapshotting.
Default: 0
storageMaxIndexLogFileSize (integer) --
Size (in bytes) at which an index write-ahead log (WAL) file will compact into an index file. Lower sizes will cause log files to be compacted more quickly and result in lower heap usage at the expense of write throughput.
Default: 1048576
storageNoValidateFieldSize (boolean) --
Skip field size validation on incoming write requests.
Default: false
storageRetentionCheckInterval (dict) --
Interval of retention policy enforcement checks. Must be greater than 0.
Default: 30 minutes
durationType (string) --
The type of duration for InfluxDB parameters.
value (integer) --
The value of duration for InfluxDB parameters.
storageSeriesFileMaxConcurrentSnapshotCompactions (integer) --
Maximum number of snapshot compactions that can run concurrently across all series partitions in a database.
Default: 0
storageSeriesIdSetCacheSize (integer) --
Size of the internal cache used in the TSI index to store previously calculated series results. Cached results are returned quickly rather than needing to be recalculated when a subsequent query with the same tag key/value predicate is executed. Setting this value to 0 will disable the cache and may decrease query performance.
Default: 100
storageWalMaxConcurrentWrites (integer) --
Maximum number writes to the WAL directory to attempt at the same time. Setting this value to 0 results in number of processing units available x2.
Default: 0
storageWalMaxWriteDelay (dict) --
Maximum amount of time a write request to the WAL directory will wait when the maximum number of concurrent active writes to the WAL directory has been met. Set to 0 to disable the timeout.
Default: 10 minutes
durationType (string) --
The type of duration for InfluxDB parameters.
value (integer) --
The value of duration for InfluxDB parameters.
uiDisabled (boolean) --
Disable the InfluxDB user interface (UI). The UI is enabled by default.
Default: false
{'port': 'integer'}
Deletes a Timestream for InfluxDB DB instance.
See also: AWS API Documentation
Request Syntax
client.delete_db_instance(
identifier='string'
)
string
[REQUIRED]
The id of the DB instance.
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'MODIFYING'|'UPDATING'|'DELETED'|'FAILED'|'UPDATING_DEPLOYMENT_TYPE'|'UPDATING_INSTANCE_TYPE',
'endpoint': 'string',
'port': 123,
'dbInstanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge',
'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
'allocatedStorage': 123,
'deploymentType': 'SINGLE_AZ'|'WITH_MULTIAZ_STANDBY',
'vpcSubnetIds': [
'string',
],
'publiclyAccessible': True|False,
'vpcSecurityGroupIds': [
'string',
],
'dbParameterGroupIdentifier': 'string',
'availabilityZone': 'string',
'secondaryAvailabilityZone': 'string',
'logDeliveryConfiguration': {
's3Configuration': {
'bucketName': 'string',
'enabled': True|False
}
},
'influxAuthParametersSecretArn': 'string'
}
Response Structure
(dict) --
id (string) --
A service-generated unique identifier.
name (string) --
The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
arn (string) --
The Amazon Resource Name (ARN) of the DB instance.
status (string) --
The status of the DB instance.
endpoint (string) --
The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
port (integer) --
The port number on which InfluxDB accepts connections.
dbInstanceType (string) --
The Timestream for InfluxDB instance type that InfluxDB runs on.
dbStorageType (string) --
The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
allocatedStorage (integer) --
The amount of storage allocated for your DB storage type (in gibibytes).
deploymentType (string) --
Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
vpcSubnetIds (list) --
A list of VPC subnet IDs associated with the DB instance.
(string) --
publiclyAccessible (boolean) --
Indicates if the DB instance has a public IP to facilitate access.
vpcSecurityGroupIds (list) --
A list of VPC security group IDs associated with the DB instance.
(string) --
dbParameterGroupIdentifier (string) --
The id of the DB parameter group assigned to your DB instance.
availabilityZone (string) --
The Availability Zone in which the DB instance resides.
secondaryAvailabilityZone (string) --
The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
logDeliveryConfiguration (dict) --
Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
s3Configuration (dict) --
Configuration for S3 bucket log delivery.
bucketName (string) --
The name of the S3 bucket to deliver logs to.
enabled (boolean) --
Indicates whether log delivery to the S3 bucket is enabled.
influxAuthParametersSecretArn (string) --
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
{'port': 'integer'}
Returns a Timestream for InfluxDB DB instance.
See also: AWS API Documentation
Request Syntax
client.get_db_instance(
identifier='string'
)
string
[REQUIRED]
The id of the DB instance.
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'MODIFYING'|'UPDATING'|'DELETED'|'FAILED'|'UPDATING_DEPLOYMENT_TYPE'|'UPDATING_INSTANCE_TYPE',
'endpoint': 'string',
'port': 123,
'dbInstanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge',
'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
'allocatedStorage': 123,
'deploymentType': 'SINGLE_AZ'|'WITH_MULTIAZ_STANDBY',
'vpcSubnetIds': [
'string',
],
'publiclyAccessible': True|False,
'vpcSecurityGroupIds': [
'string',
],
'dbParameterGroupIdentifier': 'string',
'availabilityZone': 'string',
'secondaryAvailabilityZone': 'string',
'logDeliveryConfiguration': {
's3Configuration': {
'bucketName': 'string',
'enabled': True|False
}
},
'influxAuthParametersSecretArn': 'string'
}
Response Structure
(dict) --
id (string) --
A service-generated unique identifier.
name (string) --
The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
arn (string) --
The Amazon Resource Name (ARN) of the DB instance.
status (string) --
The status of the DB instance.
endpoint (string) --
The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
port (integer) --
The port number on which InfluxDB accepts connections.
dbInstanceType (string) --
The Timestream for InfluxDB instance type that InfluxDB runs on.
dbStorageType (string) --
The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
allocatedStorage (integer) --
The amount of storage allocated for your DB storage type (in gibibytes).
deploymentType (string) --
Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
vpcSubnetIds (list) --
A list of VPC subnet IDs associated with the DB instance.
(string) --
publiclyAccessible (boolean) --
Indicates if the DB instance has a public IP to facilitate access.
vpcSecurityGroupIds (list) --
A list of VPC security group IDs associated with the DB instance.
(string) --
dbParameterGroupIdentifier (string) --
The id of the DB parameter group assigned to your DB instance.
availabilityZone (string) --
The Availability Zone in which the DB instance resides.
secondaryAvailabilityZone (string) --
The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
logDeliveryConfiguration (dict) --
Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
s3Configuration (dict) --
Configuration for S3 bucket log delivery.
bucketName (string) --
The name of the S3 bucket to deliver logs to.
enabled (boolean) --
Indicates whether log delivery to the S3 bucket is enabled.
influxAuthParametersSecretArn (string) --
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
{'parameters': {'InfluxDBv2': {'httpIdleTimeout': {'durationType': 'hours | '
'minutes | '
'seconds | '
'milliseconds',
'value': 'long'},
'httpReadHeaderTimeout': {'durationType': 'hours '
'| '
'minutes '
'| '
'seconds '
'| '
'milliseconds',
'value': 'long'},
'httpReadTimeout': {'durationType': 'hours | '
'minutes | '
'seconds | '
'milliseconds',
'value': 'long'},
'httpWriteTimeout': {'durationType': 'hours | '
'minutes | '
'seconds | '
'milliseconds',
'value': 'long'},
'influxqlMaxSelectBuckets': 'long',
'influxqlMaxSelectPoint': 'long',
'influxqlMaxSelectSeries': 'long',
'pprofDisabled': 'boolean',
'queryInitialMemoryBytes': 'long',
'queryMaxMemoryBytes': 'long',
'queryMemoryBytes': 'long',
'sessionLength': 'integer',
'sessionRenewDisabled': 'boolean',
'storageCacheMaxMemorySize': 'long',
'storageCacheSnapshotMemorySize': 'long',
'storageCacheSnapshotWriteColdDuration': {'durationType': 'hours '
'| '
'minutes '
'| '
'seconds '
'| '
'milliseconds',
'value': 'long'},
'storageCompactFullWriteColdDuration': {'durationType': 'hours '
'| '
'minutes '
'| '
'seconds '
'| '
'milliseconds',
'value': 'long'},
'storageCompactThroughputBurst': 'long',
'storageMaxConcurrentCompactions': 'integer',
'storageMaxIndexLogFileSize': 'long',
'storageNoValidateFieldSize': 'boolean',
'storageRetentionCheckInterval': {'durationType': 'hours '
'| '
'minutes '
'| '
'seconds '
'| '
'milliseconds',
'value': 'long'},
'storageSeriesFileMaxConcurrentSnapshotCompactions': 'integer',
'storageSeriesIdSetCacheSize': 'long',
'storageWalMaxConcurrentWrites': 'integer',
'storageWalMaxWriteDelay': {'durationType': 'hours '
'| '
'minutes '
'| '
'seconds '
'| '
'milliseconds',
'value': 'long'},
'uiDisabled': 'boolean'}}}
Returns a Timestream for InfluxDB DB parameter group.
See also: AWS API Documentation
Request Syntax
client.get_db_parameter_group(
identifier='string'
)
string
[REQUIRED]
The id of the DB parameter group.
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'description': 'string',
'parameters': {
'InfluxDBv2': {
'fluxLogEnabled': True|False,
'logLevel': 'debug'|'info'|'error',
'noTasks': True|False,
'queryConcurrency': 123,
'queryQueueSize': 123,
'tracingType': 'log'|'jaeger',
'metricsDisabled': True|False,
'httpIdleTimeout': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'httpReadHeaderTimeout': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'httpReadTimeout': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'httpWriteTimeout': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'influxqlMaxSelectBuckets': 123,
'influxqlMaxSelectPoint': 123,
'influxqlMaxSelectSeries': 123,
'pprofDisabled': True|False,
'queryInitialMemoryBytes': 123,
'queryMaxMemoryBytes': 123,
'queryMemoryBytes': 123,
'sessionLength': 123,
'sessionRenewDisabled': True|False,
'storageCacheMaxMemorySize': 123,
'storageCacheSnapshotMemorySize': 123,
'storageCacheSnapshotWriteColdDuration': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'storageCompactFullWriteColdDuration': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'storageCompactThroughputBurst': 123,
'storageMaxConcurrentCompactions': 123,
'storageMaxIndexLogFileSize': 123,
'storageNoValidateFieldSize': True|False,
'storageRetentionCheckInterval': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'storageSeriesFileMaxConcurrentSnapshotCompactions': 123,
'storageSeriesIdSetCacheSize': 123,
'storageWalMaxConcurrentWrites': 123,
'storageWalMaxWriteDelay': {
'durationType': 'hours'|'minutes'|'seconds'|'milliseconds',
'value': 123
},
'uiDisabled': True|False
}
}
}
Response Structure
(dict) --
id (string) --
A service-generated unique identifier.
name (string) --
The customer-supplied name that uniquely identifies the DB parameter group when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
arn (string) --
The Amazon Resource Name (ARN) of the DB parameter group.
description (string) --
A description of the DB parameter group.
parameters (dict) --
The parameters that comprise the DB parameter group.
InfluxDBv2 (dict) --
All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.
fluxLogEnabled (boolean) --
Include option to show detailed logs for Flux queries.
Default: false
logLevel (string) --
Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.
Default: info
noTasks (boolean) --
Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.
Default: false
queryConcurrency (integer) --
Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.
Default: 0
queryQueueSize (integer) --
Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.
Default: 0
tracingType (string) --
Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.
metricsDisabled (boolean) --
Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.
Default: false
httpIdleTimeout (dict) --
Maximum duration the server should keep established connections alive while waiting for new requests. Set to 0 for no timeout.
Default: 3 minutes
durationType (string) --
The type of duration for InfluxDB parameters.
value (integer) --
The value of duration for InfluxDB parameters.
httpReadHeaderTimeout (dict) --
Maximum duration the server should try to read HTTP headers for new requests. Set to 0 for no timeout.
Default: 10 seconds
durationType (string) --
The type of duration for InfluxDB parameters.
value (integer) --
The value of duration for InfluxDB parameters.
httpReadTimeout (dict) --
Maximum duration the server should try to read the entirety of new requests. Set to 0 for no timeout.
Default: 0
durationType (string) --
The type of duration for InfluxDB parameters.
value (integer) --
The value of duration for InfluxDB parameters.
httpWriteTimeout (dict) --
Maximum duration the server should spend processing and responding to write requests. Set to 0 for no timeout.
Default: 0
durationType (string) --
The type of duration for InfluxDB parameters.
value (integer) --
The value of duration for InfluxDB parameters.
influxqlMaxSelectBuckets (integer) --
Maximum number of group by time buckets a SELECT statement can create. 0 allows an unlimited number of buckets.
Default: 0
influxqlMaxSelectPoint (integer) --
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 (integer) --
Maximum number of series a SELECT statement can return. 0 allows an unlimited number of series.
Default: 0
pprofDisabled (boolean) --
Disable the /debug/pprof HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging.
Default: false
queryInitialMemoryBytes (integer) --
Initial bytes of memory allocated for a query.
Default: 0
queryMaxMemoryBytes (integer) --
Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.
Default: 0
queryMemoryBytes (integer) --
Maximum bytes of memory allowed for a single query. Must be greater or equal to queryInitialMemoryBytes.
Default: 0
sessionLength (integer) --
Specifies the Time to Live (TTL) in minutes for newly created user sessions.
Default: 60
sessionRenewDisabled (boolean) --
Disables automatically extending a user’s session TTL on each request. By default, every request sets the session’s expiration time to five minutes from now. When disabled, sessions expire after the specified session length and the user is redirected to the login page, even if recently active.
Default: false
storageCacheMaxMemorySize (integer) --
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 (integer) --
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 (dict) --
Duration at which the storage engine will snapshot the cache and write it to a new TSM file if the shard hasn’t received writes or deletes.
Default: 10 minutes
durationType (string) --
The type of duration for InfluxDB parameters.
value (integer) --
The value of duration for InfluxDB parameters.
storageCompactFullWriteColdDuration (dict) --
Duration at which the storage engine will compact all TSM files in a shard if it hasn't received writes or deletes.
Default: 4 hours
durationType (string) --
The type of duration for InfluxDB parameters.
value (integer) --
The value of duration for InfluxDB parameters.
storageCompactThroughputBurst (integer) --
Rate limit (in bytes per second) that TSM compactions can write to disk.
Default: 50331648
storageMaxConcurrentCompactions (integer) --
Maximum number of full and level compactions that can run concurrently. A value of 0 results in 50% of runtime.GOMAXPROCS(0) used at runtime. Any number greater than zero limits compactions to that value. This setting does not apply to cache snapshotting.
Default: 0
storageMaxIndexLogFileSize (integer) --
Size (in bytes) at which an index write-ahead log (WAL) file will compact into an index file. Lower sizes will cause log files to be compacted more quickly and result in lower heap usage at the expense of write throughput.
Default: 1048576
storageNoValidateFieldSize (boolean) --
Skip field size validation on incoming write requests.
Default: false
storageRetentionCheckInterval (dict) --
Interval of retention policy enforcement checks. Must be greater than 0.
Default: 30 minutes
durationType (string) --
The type of duration for InfluxDB parameters.
value (integer) --
The value of duration for InfluxDB parameters.
storageSeriesFileMaxConcurrentSnapshotCompactions (integer) --
Maximum number of snapshot compactions that can run concurrently across all series partitions in a database.
Default: 0
storageSeriesIdSetCacheSize (integer) --
Size of the internal cache used in the TSI index to store previously calculated series results. Cached results are returned quickly rather than needing to be recalculated when a subsequent query with the same tag key/value predicate is executed. Setting this value to 0 will disable the cache and may decrease query performance.
Default: 100
storageWalMaxConcurrentWrites (integer) --
Maximum number writes to the WAL directory to attempt at the same time. Setting this value to 0 results in number of processing units available x2.
Default: 0
storageWalMaxWriteDelay (dict) --
Maximum amount of time a write request to the WAL directory will wait when the maximum number of concurrent active writes to the WAL directory has been met. Set to 0 to disable the timeout.
Default: 10 minutes
durationType (string) --
The type of duration for InfluxDB parameters.
value (integer) --
The value of duration for InfluxDB parameters.
uiDisabled (boolean) --
Disable the InfluxDB user interface (UI). The UI is enabled by default.
Default: false
{'items': {'port': 'integer'}}
Returns a list of Timestream for InfluxDB DB instances.
See also: AWS API Documentation
Request Syntax
client.list_db_instances(
nextToken='string',
maxResults=123
)
string
The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
integer
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.
dict
Response Syntax
{
'items': [
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'MODIFYING'|'UPDATING'|'DELETED'|'FAILED'|'UPDATING_DEPLOYMENT_TYPE'|'UPDATING_INSTANCE_TYPE',
'endpoint': 'string',
'port': 123,
'dbInstanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge',
'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
'allocatedStorage': 123,
'deploymentType': 'SINGLE_AZ'|'WITH_MULTIAZ_STANDBY'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
A list of Timestream for InfluxDB DB instance summaries.
(dict) --
Contains a summary of a DB instance.
id (string) --
The service-generated unique identifier of the DB instance.
name (string) --
This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands.
arn (string) --
The Amazon Resource Name (ARN) of the DB instance.
status (string) --
The status of the DB instance.
endpoint (string) --
The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
port (integer) --
The port number on which InfluxDB accepts connections.
dbInstanceType (string) --
The Timestream for InfluxDB instance type to run InfluxDB on.
dbStorageType (string) --
The storage type for your DB instance.
allocatedStorage (integer) --
The amount of storage to allocate for your DbStorageType in GiB (gibibytes).
deploymentType (string) --
Single-Instance or with a MultiAZ Standby for High availability.
nextToken (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.
{'port': 'integer'}
Updates a Timestream for InfluxDB DB instance.
See also: AWS API Documentation
Request Syntax
client.update_db_instance(
identifier='string',
logDeliveryConfiguration={
's3Configuration': {
'bucketName': 'string',
'enabled': True|False
}
},
dbParameterGroupIdentifier='string',
port=123,
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',
deploymentType='SINGLE_AZ'|'WITH_MULTIAZ_STANDBY'
)
string
[REQUIRED]
The id of the DB instance.
dict
Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
s3Configuration (dict) -- [REQUIRED]
Configuration for S3 bucket log delivery.
bucketName (string) -- [REQUIRED]
The name of the S3 bucket to deliver logs to.
enabled (boolean) -- [REQUIRED]
Indicates whether log delivery to the S3 bucket is enabled.
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.
integer
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
string
The Timestream for InfluxDB DB instance type to run InfluxDB on.
string
Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'MODIFYING'|'UPDATING'|'DELETED'|'FAILED'|'UPDATING_DEPLOYMENT_TYPE'|'UPDATING_INSTANCE_TYPE',
'endpoint': 'string',
'port': 123,
'dbInstanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge',
'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
'allocatedStorage': 123,
'deploymentType': 'SINGLE_AZ'|'WITH_MULTIAZ_STANDBY',
'vpcSubnetIds': [
'string',
],
'publiclyAccessible': True|False,
'vpcSecurityGroupIds': [
'string',
],
'dbParameterGroupIdentifier': 'string',
'availabilityZone': 'string',
'secondaryAvailabilityZone': 'string',
'logDeliveryConfiguration': {
's3Configuration': {
'bucketName': 'string',
'enabled': True|False
}
},
'influxAuthParametersSecretArn': 'string'
}
Response Structure
(dict) --
id (string) --
A service-generated unique identifier.
name (string) --
This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands.
arn (string) --
The Amazon Resource Name (ARN) of the DB instance.
status (string) --
The status of the DB instance.
endpoint (string) --
The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
port (integer) --
The port number on which InfluxDB accepts connections.
dbInstanceType (string) --
The Timestream for InfluxDB instance type that InfluxDB runs on.
dbStorageType (string) --
The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
allocatedStorage (integer) --
The amount of storage allocated for your DB storage type (in gibibytes).
deploymentType (string) --
Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
vpcSubnetIds (list) --
A list of VPC subnet IDs associated with the DB instance.
(string) --
publiclyAccessible (boolean) --
Indicates if the DB instance has a public IP to facilitate access.
vpcSecurityGroupIds (list) --
A list of VPC security group IDs associated with the DB instance.
(string) --
dbParameterGroupIdentifier (string) --
The id of the DB parameter group assigned to your DB instance.
availabilityZone (string) --
The Availability Zone in which the DB instance resides.
secondaryAvailabilityZone (string) --
The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
logDeliveryConfiguration (dict) --
Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
s3Configuration (dict) --
Configuration for S3 bucket log delivery.
bucketName (string) --
The name of the S3 bucket to deliver logs to.
enabled (boolean) --
Indicates whether log delivery to the S3 bucket is enabled.
influxAuthParametersSecretArn (string) --
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.