TimestreamInfluxDBClient

Suggest an Edit

Amazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on Amazon Web Services for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.

Installation

NPM
npm install @aws-sdk/client-timestream-influxdb
Yarn
yarn add @aws-sdk/client-timestream-influxdb
pnpm
pnpm add @aws-sdk/client-timestream-influxdb

TimestreamInfluxDBClient Operations

Command
Summary
CreateDbClusterCommand

Creates a new Timestream for InfluxDB cluster.

CreateDbInstanceCommand

Creates a new Timestream for InfluxDB DB instance.

CreateDbParameterGroupCommand

Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.

DeleteDbClusterCommand

Deletes a Timestream for InfluxDB cluster.

DeleteDbInstanceCommand

Deletes a Timestream for InfluxDB DB instance.

GetDbClusterCommand

Retrieves information about a Timestream for InfluxDB cluster.

GetDbInstanceCommand

Returns a Timestream for InfluxDB DB instance.

GetDbParameterGroupCommand

Returns a Timestream for InfluxDB DB parameter group.

ListDbClustersCommand

Returns a list of Timestream for InfluxDB DB clusters.

ListDbInstancesCommand

Returns a list of Timestream for InfluxDB DB instances.

ListDbInstancesForClusterCommand

Returns a list of Timestream for InfluxDB clusters.

ListDbParameterGroupsCommand

Returns a list of Timestream for InfluxDB DB parameter groups.

ListTagsForResourceCommand

A list of tags applied to the resource.

TagResourceCommand

Tags are composed of a Key/Value pairs. You can use tags to categorize and track your Timestream for InfluxDB resources.

UntagResourceCommand

Removes the tag from the specified resource.

UpdateDbClusterCommand

Updates a Timestream for InfluxDB cluster.

UpdateDbInstanceCommand

Updates a Timestream for InfluxDB DB instance.

TimestreamInfluxDBClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: TimestreamInfluxDBClientConfig