Smaws_Client_TimestreamInfluxDB.Typestype nonrec vpc_subnet_id_list = vpc_subnet_id listtype nonrec vpc_security_group_id_list = vpc_security_group_id listtype nonrec validation_exception = {reason : validation_exception_reason;The reason that validation failed.
*)message : Smaws_Lib.Smithy_api.Types.string_;}The input fails to satisfy the constraints specified by Timestream for InfluxDB.
type nonrec s3_configuration = {enabled : Smaws_Lib.Smithy_api.Types.boolean_;Indicates whether log delivery to the S3 bucket is enabled.
*)bucket_name : Smaws_Lib.Smithy_api.Types.string_;The name of the S3 bucket to deliver logs to.
*)}Configuration for S3 bucket log delivery.
type nonrec log_delivery_configuration = {s3_configuration : s3_configuration;Configuration for S3 bucket log delivery.
*)}Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
type nonrec instance_mode_list = instance_mode listtype nonrec maintenance_schedule = {preferred_maintenance_window : maintenance_window;The preferred maintenance window in the format ddd:HH:MM-ddd:HH:MM (UTC). Day must be one of: Mon, Tue, Wed, Thu, Fri, Sat, Sun. For example, Sun:02:00-Sun:06:00. Provide an empty string to let the system choose a window.
*)timezone : iana_timezone;The IANA timezone identifier for the maintenance window. Format: Region/City or UTC. For example, America/New_York or UTC.
*)}Specifies the maintenance schedule for a DB instance or cluster, defining when maintenance operations such as patching can be performed.
type nonrec update_db_instance_output = {next_maintenance_time : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of the next scheduled maintenance operation on the DB instance.
*)last_maintenance_time : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of the last completed maintenance operation on the DB instance.
*)maintenance_schedule : maintenance_schedule option;The maintenance schedule for the DB instance.
*)instance_modes : instance_mode_list option;Specifies the DbInstance's roles in the cluster.
*)instance_mode : instance_mode option;Specifies the DbInstance's role in the cluster.
*)db_cluster_id : db_cluster_id option;Specifies the DbCluster to which this DbInstance belongs to.
*)influx_auth_parameters_secret_arn : Smaws_Lib.Smithy_api.Types.string_ option;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.
*)log_delivery_configuration : log_delivery_configuration option;Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
*)secondary_availability_zone : Smaws_Lib.Smithy_api.Types.string_ option;The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
*)availability_zone : Smaws_Lib.Smithy_api.Types.string_ option;The Availability Zone in which the DB instance resides.
*)db_parameter_group_identifier : db_parameter_group_identifier option;The id of the DB parameter group assigned to your DB instance.
*)vpc_security_group_ids : vpc_security_group_id_list option;A list of VPC security group IDs associated with the DB instance.
*)publicly_accessible : Smaws_Lib.Smithy_api.Types.boolean_ option;Indicates if the DB instance has a public IP to facilitate access.
*)vpc_subnet_ids : vpc_subnet_id_list;A list of VPC subnet IDs associated with the DB instance.
*)deployment_type : deployment_type option;Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
*)allocated_storage : allocated_storage option;The amount of storage allocated for your DB storage type (in gibibytes).
*)db_storage_type : db_storage_type option;The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
*)db_instance_type : db_instance_type option;The Timestream for InfluxDB instance type that InfluxDB runs on.
*)network_type : network_type option;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 : port option;The port number on which InfluxDB accepts connections.
*)endpoint : Smaws_Lib.Smithy_api.Types.string_ option;The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
*)status : status option;The status of the DB instance.
*)arn : arn;The Amazon Resource Name (ARN) of the DB instance.
*)name : db_instance_name;This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
*)id : db_instance_id;A service-generated unique identifier.
*)}type nonrec update_db_instance_input = {maintenance_schedule : maintenance_schedule option;Specifies the maintenance schedule for the DB instance, including the preferred maintenance window and timezone.
*)allocated_storage : allocated_storage option;The amount of storage to allocate for your DB storage type (in gibibytes).
*)db_storage_type : db_storage_type option;The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
*)deployment_type : deployment_type option;Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
*)db_instance_type : db_instance_type option;The Timestream for InfluxDB DB instance type to run InfluxDB on.
*)port : port option;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
*)db_parameter_group_identifier : db_parameter_group_identifier option;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.
*)log_delivery_configuration : log_delivery_configuration option;Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
*)identifier : db_instance_identifier;The id of the DB instance.
*)}type nonrec throttling_exception = {retry_after_seconds : Smaws_Lib.Smithy_api.Types.integer option;The number of seconds the caller should wait before retrying.
*)message : Smaws_Lib.Smithy_api.Types.string_;}The request was denied due to request throttling.
type nonrec resource_not_found_exception = {resource_type : Smaws_Lib.Smithy_api.Types.string_;The type of Timestream for InfluxDB resource associated with the request.
*)resource_id : Smaws_Lib.Smithy_api.Types.string_;The identifier for the Timestream for InfluxDB resource associated with the request.
*)message : Smaws_Lib.Smithy_api.Types.string_;}The requested resource was not found or does not exist.
The request processing has failed because of an unknown error, exception or failure.
type nonrec conflict_exception = {resource_type : Smaws_Lib.Smithy_api.Types.string_;The type of Timestream for InfluxDB resource associated with the request.
*)resource_id : Smaws_Lib.Smithy_api.Types.string_;The identifier for the Timestream for InfluxDB resource associated with the request.
*)message : Smaws_Lib.Smithy_api.Types.string_;}The request conflicts with an existing resource in Timestream for InfluxDB.
You do not have sufficient access to perform this action.
type nonrec update_db_cluster_output = {db_cluster_status : cluster_status option;The status of the DB cluster.
*)}type nonrec update_db_cluster_input = {maintenance_schedule : maintenance_schedule option;Specifies the maintenance schedule for the DB cluster, including the preferred maintenance window and timezone.
*)failover_mode : failover_mode option;Update the DB cluster's failover behavior.
*)db_instance_type : db_instance_type option;Update the DB cluster to use the specified DB instance Type.
*)port : port option;Update the DB cluster to use the specified port.
*)db_parameter_group_identifier : db_parameter_group_identifier option;Update the DB cluster to use the specified DB parameter group.
*)log_delivery_configuration : log_delivery_configuration option;The log delivery configuration to apply to the DB cluster.
*)db_cluster_id : db_cluster_id;Service-generated unique identifier of the DB cluster to update.
*)}type nonrec tag_keys = tag_key listtype nonrec tag_resource_request = {resource_arn : arn;The Amazon Resource Name (ARN) of the tagged resource.
*)}The request exceeds the service quota.
type nonrec reboot_db_instance_output = {next_maintenance_time : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of the next scheduled maintenance operation on the DB instance.
*)last_maintenance_time : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of the last completed maintenance operation on the DB instance.
*)maintenance_schedule : maintenance_schedule option;The maintenance schedule for the DB instance.
*)instance_modes : instance_mode_list option;Specifies the DbInstance's roles in the cluster.
*)instance_mode : instance_mode option;Specifies the DbInstance's role in the cluster.
*)db_cluster_id : db_cluster_id option;Specifies the DbCluster to which this DbInstance belongs to.
*)influx_auth_parameters_secret_arn : Smaws_Lib.Smithy_api.Types.string_ option;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.
*)log_delivery_configuration : log_delivery_configuration option;Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
*)secondary_availability_zone : Smaws_Lib.Smithy_api.Types.string_ option;The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
*)availability_zone : Smaws_Lib.Smithy_api.Types.string_ option;The Availability Zone in which the DB instance resides.
*)db_parameter_group_identifier : db_parameter_group_identifier option;The id of the DB parameter group assigned to your DB instance.
*)vpc_security_group_ids : vpc_security_group_id_list option;A list of VPC security group IDs associated with the DB instance.
*)publicly_accessible : Smaws_Lib.Smithy_api.Types.boolean_ option;Indicates if the DB instance has a public IP to facilitate access.
*)vpc_subnet_ids : vpc_subnet_id_list;A list of VPC subnet IDs associated with the DB instance.
*)deployment_type : deployment_type option;Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
*)allocated_storage : allocated_storage option;The amount of storage allocated for your DB storage type (in gibibytes).
*)db_storage_type : db_storage_type option;The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
*)db_instance_type : db_instance_type option;The Timestream for InfluxDB instance type that InfluxDB runs on.
*)network_type : network_type option;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 : port option;The port number on which InfluxDB accepts connections.
*)endpoint : Smaws_Lib.Smithy_api.Types.string_ option;The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
*)status : status option;The status of the DB instance.
*)arn : arn;The Amazon Resource Name (ARN) of the DB instance.
*)name : db_instance_name;The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
*)id : db_instance_id;A service-generated unique identifier.
*)}type nonrec reboot_db_instance_input = {identifier : db_instance_identifier;The id of the DB instance to reboot.
*)}type nonrec reboot_db_cluster_output = {db_cluster_status : cluster_status option;The status of the DB Cluster.
*)}type nonrec db_instance_id_list = db_instance_id listtype nonrec reboot_db_cluster_input = {instance_ids : db_instance_id_list option;A list of service-generated unique DB Instance Ids belonging to the DB Cluster to reboot.
*)db_cluster_id : db_cluster_id;Service-generated unique identifier of the DB cluster to reboot.
*)}type nonrec percent_or_absolute_long = | Absolute of Smaws_Lib.Smithy_api.Types.longAbsolute long for InfluxDB parameters.
*)| Percent of Smaws_Lib.Smithy_api.Types.string_Percent for InfluxDB parameters.
*)Percent or Absolute Long for InfluxDB parameters
type nonrec duration = {value : Smaws_Lib.Smithy_api.Types.long;The value of duration for InfluxDB parameters.
*)duration_type : duration_type;The type of duration for InfluxDB parameters.
*)}Duration for InfluxDB parameters in Timestream for InfluxDB.
type nonrec influx_d_bv2_parameters = {ui_disabled : Smaws_Lib.Smithy_api.Types.boolean_ option;Disable the InfluxDB user interface (UI). The UI is enabled by default.
Default: false
*)storage_wal_max_write_delay : duration option;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
*)storage_wal_max_concurrent_writes : Smaws_Lib.Smithy_api.Types.integer option;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
*)storage_series_id_set_cache_size : Smaws_Lib.Smithy_api.Types.long option;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
*)storage_series_file_max_concurrent_snapshot_compactions : Smaws_Lib.Smithy_api.Types.integer
option;Maximum number of snapshot compactions that can run concurrently across all series partitions in a database.
Default: 0
*)storage_retention_check_interval : duration option;Interval of retention policy enforcement checks. Must be greater than 0.
Default: 30 minutes
*)storage_no_validate_field_size : Smaws_Lib.Smithy_api.Types.boolean_ option;Skip field size validation on incoming write requests.
Default: false
*)storage_max_index_log_file_size : Smaws_Lib.Smithy_api.Types.long option;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
*)storage_max_concurrent_compactions : Smaws_Lib.Smithy_api.Types.integer option;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
*)storage_compact_throughput_burst : Smaws_Lib.Smithy_api.Types.long option;Rate limit (in bytes per second) that TSM compactions can write to disk.
Default: 50331648
*)storage_compact_full_write_cold_duration : duration option;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
*)storage_cache_snapshot_write_cold_duration : duration option;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
*)storage_cache_snapshot_memory_size : Smaws_Lib.Smithy_api.Types.long option;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
*)storage_cache_max_memory_size : Smaws_Lib.Smithy_api.Types.long option;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
*)session_renew_disabled : Smaws_Lib.Smithy_api.Types.boolean_ option;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
*)session_length : Smaws_Lib.Smithy_api.Types.integer option;Specifies the Time to Live (TTL) in minutes for newly created user sessions.
Default: 60
*)query_memory_bytes : Smaws_Lib.Smithy_api.Types.long option;Maximum bytes of memory allowed for a single query. Must be greater or equal to queryInitialMemoryBytes.
Default: 0
*)query_max_memory_bytes : Smaws_Lib.Smithy_api.Types.long option;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
*)query_initial_memory_bytes : Smaws_Lib.Smithy_api.Types.long option;Initial bytes of memory allocated for a query.
Default: 0
*)pprof_disabled : Smaws_Lib.Smithy_api.Types.boolean_ option;Disable the /debug/pprof HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging.
Default: true
*)influxql_max_select_series : Smaws_Lib.Smithy_api.Types.long option;Maximum number of series a SELECT statement can return. 0 allows an unlimited number of series.
Default: 0
*)influxql_max_select_point : Smaws_Lib.Smithy_api.Types.long option;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
*)influxql_max_select_buckets : Smaws_Lib.Smithy_api.Types.long option;Maximum number of group by time buckets a SELECT statement can create. 0 allows an unlimited number of buckets.
Default: 0
*)http_write_timeout : duration option;Maximum duration the server should spend processing and responding to write requests. Set to 0 for no timeout.
Default: 0
*)http_read_timeout : duration option;Maximum duration the server should try to read the entirety of new requests. Set to 0 for no timeout.
Default: 0
*)http_read_header_timeout : duration option;Maximum duration the server should try to read HTTP headers for new requests. Set to 0 for no timeout.
Default: 10 seconds
*)http_idle_timeout : duration option;Maximum duration the server should keep established connections alive while waiting for new requests. Set to 0 for no timeout.
Default: 3 minutes
*)metrics_disabled : Smaws_Lib.Smithy_api.Types.boolean_ option;tracing_type : tracing_type option;Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.
*)query_queue_size : Smaws_Lib.Smithy_api.Types.integer option;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
*)query_concurrency : Smaws_Lib.Smithy_api.Types.integer option;Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.
Default: 0
*)no_tasks : Smaws_Lib.Smithy_api.Types.boolean_ option;Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.
Default: false
*)log_level : log_level option;Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.
Default: info
*)flux_log_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;Include option to show detailed logs for Flux queries.
Default: false
*)}All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.
type nonrec influx_d_bv3_core_parameters = {hard_delete_default_duration : duration option;Sets the default duration for hard deletion of data.
Default: 90d
*)delete_grace_period : duration option;Specifies the grace period before permanently deleting data.
Default: 24h
*)retention_check_interval : duration option;The interval at which retention policies are checked and enforced. Enter as a human-readable time–for example: 30m or 1h.
Default: 30m
*)gen1_lookback_duration : duration option;Specifies how far back to look when creating generation 1 Parquet files.
Default: 24h
*)table_index_cache_concurrency_limit : Smaws_Lib.Smithy_api.Types.integer option;Limits the concurrency level for table index cache operations.
Default: 8
*)table_index_cache_max_entries : Smaws_Lib.Smithy_api.Types.integer option;Specifies the maximum number of entries in the table index cache.
Default: 1000
*)wal_replay_concurrency_limit : Smaws_Lib.Smithy_api.Types.integer option;Concurrency limit during WAL replay. Setting this number too high can lead to OOM. The default is dynamically determined.
Default: max(num_cpus, 10)
*)wal_replay_fail_on_error : Smaws_Lib.Smithy_api.Types.boolean_ option;Determines whether WAL replay should fail when encountering errors.
Default: false
*)parquet_mem_cache_size : percent_or_absolute_long option;Specifies the size of the in-memory Parquet cache in megabytes or percentage of total available memory.
Default: 20%
*)exec_mem_pool_bytes : percent_or_absolute_long option;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%
*)gen1_duration : duration option;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
*)distinct_cache_eviction_interval : duration option;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
*)last_cache_eviction_interval : duration option;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
*)parquet_mem_cache_query_path_duration : duration option;Specifies the time window for caching recent Parquet files in memory.
Default: 5h
*)disable_parquet_mem_cache : Smaws_Lib.Smithy_api.Types.boolean_ option;Disables the in-memory Parquet cache. By default, the cache is enabled.
*)parquet_mem_cache_prune_interval : duration option;Sets the interval to check if the in-memory Parquet cache needs to be pruned.
Default: 1s
*)parquet_mem_cache_prune_percentage : Smaws_Lib.Smithy_api.Types.float_ option;Specifies the percentage of entries to prune during a prune operation on the in-memory Parquet cache.
Default: 0.1
*)preemptive_cache_age : duration option;Specifies the interval to prefetch into the Parquet cache during compaction.
Default: 3d
*)snapshotted_wal_files_to_keep : Smaws_Lib.Smithy_api.Types.integer option;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
*)wal_max_write_buffer_size : Smaws_Lib.Smithy_api.Types.integer option;Specifies the maximum number of write requests that can be buffered before a flush must be executed and succeed.
Default: 100000
*)wal_snapshot_size : Smaws_Lib.Smithy_api.Types.integer option;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
*)force_snapshot_mem_threshold : percent_or_absolute_long option;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%
*)max_http_request_size : Smaws_Lib.Smithy_api.Types.long option;Specifies the maximum size of HTTP requests.
Default: 10485760
*)data_fusion_config : Smaws_Lib.Smithy_api.Types.string_ option;Provides custom configuration to DataFusion as a comma-separated list of key:value pairs.
*)data_fusion_use_cached_parquet_loader : Smaws_Lib.Smithy_api.Types.boolean_
option;Uses a cached parquet loader when reading parquet files from the object store.
*)data_fusion_max_parquet_fanout : Smaws_Lib.Smithy_api.Types.integer option;When multiple parquet files are required in a sorted way (deduplication for example), specifies the maximum fanout.
Default: 1000
*)data_fusion_runtime_thread_priority : Smaws_Lib.Smithy_api.Types.integer option;Sets the thread priority for tokio DataFusion runtime workers.
Default: 10
*)data_fusion_runtime_thread_keep_alive : duration option;Sets a custom timeout for a thread in the blocking pool of the tokio DataFusion runtime.
*)data_fusion_runtime_max_io_events_per_tick : Smaws_Lib.Smithy_api.Types.integer
option;Configures the maximum number of events processed per tick by the tokio DataFusion runtime.
*)data_fusion_runtime_max_blocking_threads : Smaws_Lib.Smithy_api.Types.integer
option;Specifies the limit for additional threads spawned by the DataFusion runtime.
*)data_fusion_runtime_global_queue_interval : Smaws_Lib.Smithy_api.Types.integer
option;Sets the number of scheduler ticks after which the scheduler of the DataFusion runtime polls the global task queue.
*)data_fusion_runtime_event_interval : Smaws_Lib.Smithy_api.Types.integer option;Sets the number of scheduler ticks after which the scheduler of the DataFusion tokio runtime polls for external events–for example: timers, I/O.
*)data_fusion_runtime_disable_lifo_slot : Smaws_Lib.Smithy_api.Types.boolean_
option;Disables the LIFO slot of the DataFusion runtime.
*)data_fusion_runtime_type : data_fusion_runtime_type option;Specifies the DataFusion tokio runtime type.
Default: multi-thread
*)data_fusion_num_threads : Smaws_Lib.Smithy_api.Types.integer option;Sets the maximum number of DataFusion runtime threads to use.
*)log_format : log_formats option;Defines the message format for logs.
Default: full
*)log_filter : Smaws_Lib.Smithy_api.Types.string_ option;Sets the filter directive for logs.
*)query_log_size : Smaws_Lib.Smithy_api.Types.integer option;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
*)query_file_limit : Smaws_Lib.Smithy_api.Types.integer option;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
*)}All the customer-modifiable InfluxDB v3 Core parameters in Timestream for InfluxDB.
type nonrec influx_d_bv3_enterprise_parameters = {catalog_sync_interval : duration option;Defines how often the catalog synchronizes across cluster nodes.
Default: 10s
*)replication_interval : duration option;Specifies the interval at which data replication occurs between cluster nodes.
Default: 250ms
*)distinct_value_cache_disable_from_history : Smaws_Lib.Smithy_api.Types.boolean_
option;Disables populating the distinct value cache from historical data. If disabled, the cache is still populated with data from the write-ahead log (WAL).
*)last_value_cache_disable_from_history : Smaws_Lib.Smithy_api.Types.boolean_
option;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).
*)compaction_check_interval : duration option;Specifies how often the compactor checks for new compaction work to perform.
Default: 10s
*)compaction_cleanup_wait : duration option;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
*)compaction_multipliers : Smaws_Lib.Smithy_api.Types.string_ option;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
*)compaction_gen2_duration : duration option;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
*)compaction_max_num_files_per_plan : Smaws_Lib.Smithy_api.Types.integer option;Sets the maximum number of files included in any compaction plan.
Default: 500
*)compaction_row_limit : Smaws_Lib.Smithy_api.Types.integer option;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
*)dedicated_compactor : Smaws_Lib.Smithy_api.Types.boolean_;Specifies if the compactor instance should be a standalone instance or not.
*)query_only_instances : Smaws_Lib.Smithy_api.Types.integer;Specifies number of instances in the DbCluster which can only query.
*)ingest_query_instances : Smaws_Lib.Smithy_api.Types.integer;Specifies number of instances in the DbCluster which can both ingest and query.
*)hard_delete_default_duration : duration option;Sets the default duration for hard deletion of data.
Default: 90d
*)delete_grace_period : duration option;Specifies the grace period before permanently deleting data.
Default: 24h
*)retention_check_interval : duration option;The interval at which retention policies are checked and enforced. Enter as a human-readable time–for example: 30m or 1h.
Default: 30m
*)gen1_lookback_duration : duration option;Specifies how far back to look when creating generation 1 Parquet files.
Default: 24h
*)table_index_cache_concurrency_limit : Smaws_Lib.Smithy_api.Types.integer option;Limits the concurrency level for table index cache operations.
Default: 8
*)table_index_cache_max_entries : Smaws_Lib.Smithy_api.Types.integer option;Specifies the maximum number of entries in the table index cache.
Default: 1000
*)wal_replay_concurrency_limit : Smaws_Lib.Smithy_api.Types.integer option;Concurrency limit during WAL replay. Setting this number too high can lead to OOM. The default is dynamically determined.
Default: max(num_cpus, 10)
*)wal_replay_fail_on_error : Smaws_Lib.Smithy_api.Types.boolean_ option;Determines whether WAL replay should fail when encountering errors.
Default: false
*)parquet_mem_cache_size : percent_or_absolute_long option;Specifies the size of the in-memory Parquet cache in megabytes or percentage of total available memory.
Default: 20%
*)exec_mem_pool_bytes : percent_or_absolute_long option;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%
*)gen1_duration : duration option;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
*)distinct_cache_eviction_interval : duration option;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
*)last_cache_eviction_interval : duration option;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
*)parquet_mem_cache_query_path_duration : duration option;Specifies the time window for caching recent Parquet files in memory.
Default: 5h
*)disable_parquet_mem_cache : Smaws_Lib.Smithy_api.Types.boolean_ option;Disables the in-memory Parquet cache. By default, the cache is enabled.
*)parquet_mem_cache_prune_interval : duration option;Sets the interval to check if the in-memory Parquet cache needs to be pruned.
Default: 1s
*)parquet_mem_cache_prune_percentage : Smaws_Lib.Smithy_api.Types.float_ option;Specifies the percentage of entries to prune during a prune operation on the in-memory Parquet cache.
Default: 0.1
*)preemptive_cache_age : duration option;Specifies the interval to prefetch into the Parquet cache during compaction.
Default: 3d
*)snapshotted_wal_files_to_keep : Smaws_Lib.Smithy_api.Types.integer option;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
*)wal_max_write_buffer_size : Smaws_Lib.Smithy_api.Types.integer option;Specifies the maximum number of write requests that can be buffered before a flush must be executed and succeed.
Default: 100000
*)wal_snapshot_size : Smaws_Lib.Smithy_api.Types.integer option;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
*)force_snapshot_mem_threshold : percent_or_absolute_long option;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%
*)max_http_request_size : Smaws_Lib.Smithy_api.Types.long option;Specifies the maximum size of HTTP requests.
Default: 10485760
*)data_fusion_config : Smaws_Lib.Smithy_api.Types.string_ option;Provides custom configuration to DataFusion as a comma-separated list of key:value pairs.
*)data_fusion_use_cached_parquet_loader : Smaws_Lib.Smithy_api.Types.boolean_
option;Uses a cached parquet loader when reading parquet files from the object store.
*)data_fusion_max_parquet_fanout : Smaws_Lib.Smithy_api.Types.integer option;When multiple parquet files are required in a sorted way (deduplication for example), specifies the maximum fanout.
Default: 1000
*)data_fusion_runtime_thread_priority : Smaws_Lib.Smithy_api.Types.integer option;Sets the thread priority for tokio DataFusion runtime workers.
Default: 10
*)data_fusion_runtime_thread_keep_alive : duration option;Sets a custom timeout for a thread in the blocking pool of the tokio DataFusion runtime.
*)data_fusion_runtime_max_io_events_per_tick : Smaws_Lib.Smithy_api.Types.integer
option;Configures the maximum number of events processed per tick by the tokio DataFusion runtime.
*)data_fusion_runtime_max_blocking_threads : Smaws_Lib.Smithy_api.Types.integer
option;Specifies the limit for additional threads spawned by the DataFusion runtime.
*)data_fusion_runtime_global_queue_interval : Smaws_Lib.Smithy_api.Types.integer
option;Sets the number of scheduler ticks after which the scheduler of the DataFusion runtime polls the global task queue.
*)data_fusion_runtime_event_interval : Smaws_Lib.Smithy_api.Types.integer option;Sets the number of scheduler ticks after which the scheduler of the DataFusion tokio runtime polls for external events–for example: timers, I/O.
*)data_fusion_runtime_disable_lifo_slot : Smaws_Lib.Smithy_api.Types.boolean_
option;Disables the LIFO slot of the DataFusion runtime.
*)data_fusion_runtime_type : data_fusion_runtime_type option;Specifies the DataFusion tokio runtime type.
Default: multi-thread
*)data_fusion_num_threads : Smaws_Lib.Smithy_api.Types.integer option;Sets the maximum number of DataFusion runtime threads to use.
*)log_format : log_formats option;Defines the message format for logs.
Default: full
*)log_filter : Smaws_Lib.Smithy_api.Types.string_ option;Sets the filter directive for logs.
*)query_log_size : Smaws_Lib.Smithy_api.Types.integer option;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
*)query_file_limit : Smaws_Lib.Smithy_api.Types.integer option;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
*)}All the customer-modifiable InfluxDB v3 Enterprise parameters in Timestream for InfluxDB.
type nonrec parameters = | InfluxDBv3Enterprise of influx_d_bv3_enterprise_parametersAll the customer-modifiable InfluxDB v3 Enterprise parameters in Timestream for InfluxDB.
*)| InfluxDBv3Core of influx_d_bv3_core_parametersAll the customer-modifiable InfluxDB v3 Core parameters in Timestream for InfluxDB.
*)| InfluxDBv2 of influx_d_bv2_parametersAll the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.
*)The parameters that comprise the parameter group.
type nonrec db_parameter_group_summary = {description : Smaws_Lib.Smithy_api.Types.string_ option;A description of the DB parameter group.
*)arn : arn;The Amazon Resource Name (ARN) of the DB parameter group.
*)name : db_parameter_group_name;This customer-supplied name uniquely identifies the parameter group.
*)id : db_parameter_group_id;A service-generated unique identifier.
*)}Contains a summary of a DB parameter group.
type nonrec db_parameter_group_summary_list = db_parameter_group_summary listtype nonrec list_db_parameter_groups_output = {next_token : next_token option;Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off.
*)items : db_parameter_group_summary_list;A list of Timestream for InfluxDB DB parameter group summaries.
*)}type nonrec list_db_parameter_groups_input = {max_results : max_results option;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.
*)next_token : next_token option;The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
*)}type nonrec db_instance_summary = {deployment_type : deployment_type option;Single-Instance or with a MultiAZ Standby for High availability.
*)allocated_storage : allocated_storage option;The amount of storage to allocate for your DbStorageType in GiB (gibibytes).
*)db_storage_type : db_storage_type option;The storage type for your DB instance.
*)db_instance_type : db_instance_type option;The Timestream for InfluxDB instance type to run InfluxDB on.
*)network_type : network_type option;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 : port option;The port number on which InfluxDB accepts connections.
*)endpoint : Smaws_Lib.Smithy_api.Types.string_ option;The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
*)status : status option;The status of the DB instance.
*)arn : arn;The Amazon Resource Name (ARN) of the DB instance.
*)name : db_instance_name;This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
*)id : db_instance_id;The service-generated unique identifier of the DB instance.
*)}Contains a summary of a DB instance.
type nonrec db_instance_summary_list = db_instance_summary listtype nonrec list_db_instances_output = {next_token : next_token option;Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off.
*)items : db_instance_summary_list;A list of Timestream for InfluxDB DB instance summaries.
*)}type nonrec list_db_instances_input = {max_results : max_results option;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.
*)next_token : next_token option;The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
*)}type nonrec db_instance_for_cluster_summary = {instance_modes : instance_mode_list option;Specifies the DB instance's roles in the cluster.
*)instance_mode : instance_mode option;Specifies the DB instance's role in the cluster.
*)deployment_type : deployment_type option;Specifies the deployment type if applicable.
*)allocated_storage : allocated_storage option;The amount of storage allocated for your DB storage type in GiB (gibibytes).
*)db_storage_type : db_storage_type option;The storage type for your DB instance.
*)db_instance_type : db_instance_type option;The Timestream for InfluxDB instance type to run InfluxDB on.
*)network_type : network_type option;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 : port option;The port number on which InfluxDB accepts connections.
*)endpoint : Smaws_Lib.Smithy_api.Types.string_ option;The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
*)status : status option;The status of the DB instance.
*)arn : arn;The Amazon Resource Name (ARN) of the DB instance.
*)name : db_instance_name;A service-generated name for the DB instance based on the customer-supplied name for the DB cluster.
*)id : db_instance_id;The service-generated unique identifier of the DB instance.
*)}Contains a summary of a DB instance belonging to a DB cluster.
type nonrec db_instance_for_cluster_summary_list =
db_instance_for_cluster_summary listtype nonrec list_db_instances_for_cluster_output = {next_token : next_token option;Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off.
*)items : db_instance_for_cluster_summary_list;A list of Timestream for InfluxDB instance summaries belonging to the cluster.
*)}type nonrec list_db_instances_for_cluster_input = {max_results : max_results option;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.
*)next_token : next_token option;The pagination token. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.
*)db_cluster_id : db_cluster_id;Service-generated unique identifier of the DB cluster.
*)}type nonrec db_cluster_summary = {engine_type : engine_type option;The engine type of your DB cluster.
*)allocated_storage : allocated_storage option;The amount of storage allocated for your DB storage type (in gibibytes).
*)db_storage_type : db_storage_type option;The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
*)network_type : network_type option;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.
*)db_instance_type : db_instance_type option;The Timestream for InfluxDB DB instance type that InfluxDB runs on.
*)deployment_type : cluster_deployment_type option;Deployment type of the DB cluster
*)port : port option;The port number on which InfluxDB accepts connections.
*)reader_endpoint : Smaws_Lib.Smithy_api.Types.string_ option;The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
*)endpoint : Smaws_Lib.Smithy_api.Types.string_ option;The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.
*)status : cluster_status option;The status of the DB cluster.
*)arn : arn;The Amazon Resource Name (ARN) of the DB cluster.
*)name : db_cluster_name;Customer supplied name of the Timestream for InfluxDB cluster.
*)id : db_cluster_id;Service-generated unique identifier of the DB cluster to retrieve.
*)}Describes a summary of a Timestream for InfluxDB cluster.
type nonrec db_cluster_summary_list = db_cluster_summary listtype nonrec list_db_clusters_output = {next_token : next_token option;Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off.
*)items : db_cluster_summary_list;A list of Timestream for InfluxDB cluster summaries.
*)}type nonrec list_db_clusters_input = {max_results : max_results option;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.
*)next_token : next_token option;The pagination token. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.
*)}type nonrec get_db_parameter_group_output = {parameters : parameters option;The parameters that comprise the DB parameter group.
*)description : Smaws_Lib.Smithy_api.Types.string_ option;A description of the DB parameter group.
*)arn : arn;The Amazon Resource Name (ARN) of the DB parameter group.
*)name : db_parameter_group_name;The customer-supplied name that uniquely identifies the DB parameter group when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
*)id : db_parameter_group_id;A service-generated unique identifier.
*)}type nonrec get_db_parameter_group_input = {identifier : db_parameter_group_identifier;The id of the DB parameter group.
*)}type nonrec get_db_instance_output = {next_maintenance_time : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of the next scheduled maintenance operation on the DB instance.
*)last_maintenance_time : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of the last completed maintenance operation on the DB instance.
*)maintenance_schedule : maintenance_schedule option;The maintenance schedule for the DB instance.
*)instance_modes : instance_mode_list option;Specifies the DbInstance's roles in the cluster.
*)instance_mode : instance_mode option;Specifies the DbInstance's role in the cluster.
*)db_cluster_id : db_cluster_id option;Specifies the DbCluster to which this DbInstance belongs to.
*)influx_auth_parameters_secret_arn : Smaws_Lib.Smithy_api.Types.string_ option;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.
*)log_delivery_configuration : log_delivery_configuration option;Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
*)secondary_availability_zone : Smaws_Lib.Smithy_api.Types.string_ option;The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
*)availability_zone : Smaws_Lib.Smithy_api.Types.string_ option;The Availability Zone in which the DB instance resides.
*)db_parameter_group_identifier : db_parameter_group_identifier option;The id of the DB parameter group assigned to your DB instance.
*)vpc_security_group_ids : vpc_security_group_id_list option;A list of VPC security group IDs associated with the DB instance.
*)publicly_accessible : Smaws_Lib.Smithy_api.Types.boolean_ option;Indicates if the DB instance has a public IP to facilitate access.
*)vpc_subnet_ids : vpc_subnet_id_list;A list of VPC subnet IDs associated with the DB instance.
*)deployment_type : deployment_type option;Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
*)allocated_storage : allocated_storage option;The amount of storage allocated for your DB storage type (in gibibytes).
*)db_storage_type : db_storage_type option;The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
*)db_instance_type : db_instance_type option;The Timestream for InfluxDB instance type that InfluxDB runs on.
*)network_type : network_type option;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 : port option;The port number on which InfluxDB accepts connections.
*)endpoint : Smaws_Lib.Smithy_api.Types.string_ option;The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
*)status : status option;The status of the DB instance.
*)arn : arn;The Amazon Resource Name (ARN) of the DB instance.
*)name : db_instance_name;The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
*)id : db_instance_id;A service-generated unique identifier.
*)}type nonrec get_db_instance_input = {identifier : db_instance_identifier;The id of the DB instance.
*)}type nonrec cluster_configuration = {dedicated_compactor : Smaws_Lib.Smithy_api.Types.boolean_ option;Indicates if the compactor instance is a standalone instance or not.
*)query_only_instances : Smaws_Lib.Smithy_api.Types.integer option;The number of instances in the DbCluster which can only query.
*)ingest_query_instances : Smaws_Lib.Smithy_api.Types.integer option;The number of instances in the DbCluster which can both ingest and query.
*)}Configuration for node modes in the DbCluster.
type nonrec get_db_cluster_output = {cluster_configuration : cluster_configuration option;Configuration for node modes in the DbCluster.
*)failover_mode : failover_mode option;The configured failover mode for the DB cluster.
*)vpc_security_group_ids : vpc_security_group_id_list option;A list of VPC security group IDs associated with the DB cluster.
*)vpc_subnet_ids : vpc_subnet_id_list option;A list of VPC subnet IDs associated with the DB cluster.
*)influx_auth_parameters_secret_arn : Smaws_Lib.Smithy_api.Types.string_ option;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.
*)next_maintenance_time : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of the next scheduled maintenance operation on the DB cluster.
*)last_maintenance_time : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of the last completed maintenance operation on the DB cluster.
*)maintenance_schedule : maintenance_schedule option;The maintenance schedule for the DB cluster.
*)log_delivery_configuration : log_delivery_configuration option;Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
*)db_parameter_group_identifier : db_parameter_group_identifier option;The ID of the DB parameter group assigned to your DB cluster.
*)publicly_accessible : Smaws_Lib.Smithy_api.Types.boolean_ option;Indicates if the DB cluster has a public IP to facilitate access from outside the VPC.
*)engine_type : engine_type option;The engine type of your DB cluster.
*)allocated_storage : allocated_storage option;The amount of storage allocated for your DB storage type (in gibibytes).
*)db_storage_type : db_storage_type option;The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
*)network_type : network_type option;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.
*)db_instance_type : db_instance_type option;The Timestream for InfluxDB instance type that InfluxDB runs on.
*)deployment_type : cluster_deployment_type option;Deployment type of the DB cluster.
*)port : port option;The port number on which InfluxDB accepts connections.
*)reader_endpoint : Smaws_Lib.Smithy_api.Types.string_ option;The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
*)endpoint : Smaws_Lib.Smithy_api.Types.string_ option;The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.
*)status : cluster_status option;The status of the DB cluster.
*)arn : arn;The Amazon Resource Name (ARN) of the DB cluster.
*)name : db_cluster_name;Customer-supplied name of the Timestream for InfluxDB cluster.
*)id : db_cluster_id;Service-generated unique identifier of the DB cluster to retrieve.
*)}type nonrec get_db_cluster_input = {db_cluster_id : db_cluster_id;Service-generated unique identifier of the DB cluster to retrieve.
*)}type nonrec delete_db_instance_output = {next_maintenance_time : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of the next scheduled maintenance operation on the DB instance.
*)last_maintenance_time : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of the last completed maintenance operation on the DB instance.
*)maintenance_schedule : maintenance_schedule option;The maintenance schedule for the DB instance.
*)instance_modes : instance_mode_list option;Specifies the DbInstance's roles in the cluster.
*)instance_mode : instance_mode option;Specifies the DbInstance's role in the cluster.
*)db_cluster_id : db_cluster_id option;Specifies the DbCluster to which this DbInstance belongs to.
*)influx_auth_parameters_secret_arn : Smaws_Lib.Smithy_api.Types.string_ option;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.
*)log_delivery_configuration : log_delivery_configuration option;Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
*)secondary_availability_zone : Smaws_Lib.Smithy_api.Types.string_ option;The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
*)availability_zone : Smaws_Lib.Smithy_api.Types.string_ option;The Availability Zone in which the DB instance resides.
*)db_parameter_group_identifier : db_parameter_group_identifier option;The id of the DB parameter group assigned to your DB instance.
*)vpc_security_group_ids : vpc_security_group_id_list option;A list of VPC security group IDs associated with the DB instance.
*)publicly_accessible : Smaws_Lib.Smithy_api.Types.boolean_ option;Indicates if the DB instance has a public IP to facilitate access.
*)vpc_subnet_ids : vpc_subnet_id_list;A list of VPC subnet IDs associated with the DB instance.
*)deployment_type : deployment_type option;Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
*)allocated_storage : allocated_storage option;The amount of storage allocated for your DB storage type (in gibibytes).
*)db_storage_type : db_storage_type option;The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
*)db_instance_type : db_instance_type option;The Timestream for InfluxDB instance type that InfluxDB runs on.
*)network_type : network_type option;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 : port option;The port number on which InfluxDB accepts connections.
*)endpoint : Smaws_Lib.Smithy_api.Types.string_ option;The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
*)status : status option;The status of the DB instance.
*)arn : arn;The Amazon Resource Name (ARN) of the DB instance.
*)name : db_instance_name;The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
*)id : db_instance_id;A service-generated unique identifier.
*)}type nonrec delete_db_instance_input = {identifier : db_instance_identifier;The id of the DB instance.
*)}type nonrec delete_db_cluster_output = {db_cluster_status : cluster_status option;The status of the DB cluster.
*)}type nonrec delete_db_cluster_input = {db_cluster_id : db_cluster_id;Service-generated unique identifier of the DB cluster.
*)}type nonrec db_parameter_group_resource = Smaws_Lib.CoreTypes.Resource.ttype nonrec db_instance_resource = Smaws_Lib.CoreTypes.Resource.ttype nonrec db_cluster_resource = Smaws_Lib.CoreTypes.Resource.ttype nonrec create_db_parameter_group_output = {parameters : parameters option;A list of the parameters that comprise the DB parameter group.
*)description : Smaws_Lib.Smithy_api.Types.string_ option;The description of the DB parameter group.
*)arn : arn;The Amazon Resource Name (ARM) of the DB parameter group.
*)name : db_parameter_group_name;The customer-supplied name that uniquely identifies the DB parameter group when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
*)id : db_parameter_group_id;A service-generated unique identifier.
*)}type nonrec create_db_parameter_group_input = {parameters : parameters option;A list of the parameters that comprise the DB parameter group.
*)description : Smaws_Lib.Smithy_api.Types.string_ option;A description of the DB parameter group.
*)name : db_parameter_group_name;The name of the DB parameter group. The name must be unique per customer and per region.
*)}type nonrec create_db_instance_output = {next_maintenance_time : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of the next scheduled maintenance operation on the DB instance.
*)last_maintenance_time : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp of the last completed maintenance operation on the DB instance.
*)maintenance_schedule : maintenance_schedule option;The maintenance schedule for the DB instance.
*)instance_modes : instance_mode_list option;Specifies the DbInstance's roles in the cluster.
*)instance_mode : instance_mode option;Specifies the DbInstance's role in the cluster.
*)db_cluster_id : db_cluster_id option;Specifies the DbCluster to which this DbInstance belongs to.
*)influx_auth_parameters_secret_arn : Smaws_Lib.Smithy_api.Types.string_ option;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.
*)log_delivery_configuration : log_delivery_configuration option;Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
*)secondary_availability_zone : Smaws_Lib.Smithy_api.Types.string_ option;The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
*)availability_zone : Smaws_Lib.Smithy_api.Types.string_ option;The Availability Zone in which the DB instance resides.
*)db_parameter_group_identifier : db_parameter_group_identifier option;The id of the DB parameter group assigned to your DB instance.
*)vpc_security_group_ids : vpc_security_group_id_list option;A list of VPC security group IDs associated with the DB instance.
*)publicly_accessible : Smaws_Lib.Smithy_api.Types.boolean_ option;Indicates if the DB instance has a public IP to facilitate access.
*)vpc_subnet_ids : vpc_subnet_id_list;A list of VPC subnet IDs associated with the DB instance.
*)deployment_type : deployment_type option;Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
*)allocated_storage : allocated_storage option;The amount of storage allocated for your DB storage type (in gibibytes).
*)db_storage_type : db_storage_type option;The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
*)db_instance_type : db_instance_type option;The Timestream for InfluxDB instance type that InfluxDB runs on.
*)network_type : network_type option;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 : port option;The port number on which InfluxDB accepts connections. The default value is 8086.
*)endpoint : Smaws_Lib.Smithy_api.Types.string_ option;The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
*)status : status option;The status of the DB instance.
*)arn : arn;The Amazon Resource Name (ARN) of the DB instance.
*)name : db_instance_name;The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
*)id : db_instance_id;A service-generated unique identifier.
*)}type nonrec create_db_instance_input = {network_type : network_type option;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 : port option;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
*)maintenance_schedule : maintenance_schedule option;Specifies the maintenance schedule for the DB instance, including the preferred maintenance window and timezone.
*)log_delivery_configuration : log_delivery_configuration option;Configuration for sending InfluxDB engine logs to a specified S3 bucket.
*)deployment_type : deployment_type option;Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
*)db_parameter_group_identifier : db_parameter_group_identifier option;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.
*)allocated_storage : allocated_storage;The amount of storage to allocate for your DB storage type in GiB (gibibytes).
*)db_storage_type : db_storage_type option;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:
publicly_accessible : Smaws_Lib.Smithy_api.Types.boolean_ option;Configures the DB instance with a public IP to facilitate access.
*)vpc_security_group_ids : vpc_security_group_id_list;A list of VPC security group IDs to associate with the DB instance.
*)vpc_subnet_ids : vpc_subnet_id_list;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.
*)db_instance_type : db_instance_type;The Timestream for InfluxDB DB instance type to run InfluxDB on.
*)bucket : bucket option;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.
*)organization : organization option;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 : password;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.
*)username : username option;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.
*)name : db_instance_name;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.
*)}type nonrec create_db_cluster_output = {db_cluster_status : cluster_status option;The status of the DB cluster.
*)db_cluster_id : db_cluster_id option;A service-generated unique identifier.
*)}type nonrec create_db_cluster_input = {maintenance_schedule : maintenance_schedule option;Specifies the maintenance schedule for the DB cluster, including the preferred maintenance window and timezone.
*)log_delivery_configuration : log_delivery_configuration option;Configuration for sending InfluxDB engine logs to a specified S3 bucket.
*)failover_mode : failover_mode option;Specifies the behavior of failure recovery when the primary node of the cluster fails.
*)deployment_type : cluster_deployment_type option;Specifies the type of cluster to create.
*)vpc_security_group_ids : vpc_security_group_id_list;A list of VPC security group IDs to associate with the Timestream for InfluxDB cluster.
*)vpc_subnet_ids : vpc_subnet_id_list;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.
*)publicly_accessible : Smaws_Lib.Smithy_api.Types.boolean_ option;Configures the Timestream for InfluxDB cluster with a public IP to facilitate access from outside the VPC.
*)network_type : network_type option;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.
*)allocated_storage : allocated_storage option;The amount of storage to allocate for your DB storage type in GiB (gibibytes).
*)db_storage_type : db_storage_type option;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:
db_instance_type : db_instance_type;The Timestream for InfluxDB DB instance type to run InfluxDB on.
*)db_parameter_group_identifier : db_parameter_group_identifier option;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.
*)port : port option;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
*)bucket : bucket option;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.
*)organization : organization option;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 : password option;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.
*)username : username option;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.
*)name : db_cluster_name;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.
*)}