We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.TimestreamInfluxDB

Inherits:
AWS.Service show all
Identifier:
timestreaminfluxdb
API Version:
2023-01-27
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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 AWS 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.

Sending a Request Using TimestreamInfluxDB

var timestreaminfluxdb = new AWS.TimestreamInfluxDB();
timestreaminfluxdb.createDbInstance(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the TimestreamInfluxDB object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var timestreaminfluxdb = new AWS.TimestreamInfluxDB({apiVersion: '2023-01-27'});

You can also set the API version globally in AWS.config.apiVersions using the timestreaminfluxdb service identifier:

AWS.config.apiVersions = {
  timestreaminfluxdb: '2023-01-27',
  // other service API versions
};

var timestreaminfluxdb = new AWS.TimestreamInfluxDB();

Version:

  • 2023-01-27

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.TimestreamInfluxDB(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a TimestreamInfluxDB object

var timestreaminfluxdb = new AWS.TimestreamInfluxDB({apiVersion: '2023-01-27'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.TimestreamInfluxDB.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.TimestreamInfluxDB.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.TimestreamInfluxDB.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean) —

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean) —

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createDbInstance(params = {}, callback) ⇒ AWS.Request

Creates a new Timestream for InfluxDB DB instance.

Service Reference:

Examples:

Calling the createDbInstance operation

var params = {
  allocatedStorage: 'NUMBER_VALUE', /* required */
  dbInstanceType: db.influx.medium | db.influx.large | db.influx.xlarge | db.influx.2xlarge | db.influx.4xlarge | db.influx.8xlarge | db.influx.12xlarge | db.influx.16xlarge, /* required */
  name: 'STRING_VALUE', /* required */
  password: 'STRING_VALUE', /* required */
  vpcSecurityGroupIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  vpcSubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  bucket: 'STRING_VALUE',
  dbParameterGroupIdentifier: 'STRING_VALUE',
  dbStorageType: InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3,
  deploymentType: SINGLE_AZ | WITH_MULTIAZ_STANDBY,
  logDeliveryConfiguration: {
    s3Configuration: { /* required */
      bucketName: 'STRING_VALUE', /* required */
      enabled: true || false /* required */
    }
  },
  organization: 'STRING_VALUE',
  publiclyAccessible: true || false,
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  username: 'STRING_VALUE'
};
timestreaminfluxdb.createDbInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • name — (String)

      The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. DB instance names must be unique per customer and per region.

    • username — (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.

    • password — (String)

      The password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in AWS SecretManager in your account.

    • organization — (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.

    • bucket — (String)

      The name of the initial InfluxDB bucket. All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization.

    • dbInstanceType — (String)

      The Timestream for InfluxDB DB instance type to run InfluxDB on.

      Possible values include:
      • "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 — (Array<String>)

      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.

    • vpcSecurityGroupIds — (Array<String>)

      A list of VPC security group IDs to associate with the DB instance.

    • publiclyAccessible — (Boolean)

      Configures the DB instance with a public IP to facilitate access.

    • dbStorageType — (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

      Possible values include:
      • "InfluxIOIncludedT1"
      • "InfluxIOIncludedT2"
      • "InfluxIOIncludedT3"
    • allocatedStorage — (Integer)

      The amount of storage to allocate for your DB storage type in GiB (gibibytes).

    • dbParameterGroupIdentifier — (String)

      The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.

    • deploymentType — (String)

      Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.

      Possible values include:
      • "SINGLE_AZ"
      • "WITH_MULTIAZ_STANDBY"
    • logDeliveryConfiguration — (map)

      Configuration for sending InfluxDB engine logs to a specified S3 bucket.

      • s3Configuration — required — (map)

        Configuration for S3 bucket log delivery.

        • bucketName — required — (String)

          The name of the S3 bucket to deliver logs to.

        • enabled — required — (Boolean)

          Indicates whether log delivery to the S3 bucket is enabled.

    • tags — (map<String>)

      A list of key-value pairs to associate with the DB instance.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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.

        Possible values include:
        • "CREATING"
        • "AVAILABLE"
        • "DELETING"
        • "MODIFYING"
        • "UPDATING"
        • "DELETED"
        • "FAILED"
        • "UPDATING_DEPLOYMENT_TYPE"
        • "UPDATING_INSTANCE_TYPE"
      • endpoint — (String)

        The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

      • dbInstanceType — (String)

        The Timestream for InfluxDB instance type that InfluxDB runs on.

        Possible values include:
        • "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 — (String)

        The Timestream for InfluxDB DB storage type that InfluxDB stores data on.

        Possible values include:
        • "InfluxIOIncludedT1"
        • "InfluxIOIncludedT2"
        • "InfluxIOIncludedT3"
      • 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.

        Possible values include:
        • "SINGLE_AZ"
        • "WITH_MULTIAZ_STANDBY"
      • vpcSubnetIds — (Array<String>)

        A list of VPC subnet IDs associated with the DB instance.

      • publiclyAccessible — (Boolean)

        Indicates if the DB instance has a public IP to facilitate access.

      • vpcSecurityGroupIds — (Array<String>)

        A list of VPC security group IDs associated with the DB instance.

      • 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 — (map)

        Configuration for sending InfluxDB engine logs to send to specified S3 bucket.

        • s3Configuration — required — (map)

          Configuration for S3 bucket log delivery.

          • bucketName — required — (String)

            The name of the S3 bucket to deliver logs to.

          • enabled — required — (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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createDbParameterGroup(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the createDbParameterGroup operation

var params = {
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  parameters: {
    InfluxDBv2: {
      fluxLogEnabled: true || false,
      logLevel: debug | info | error,
      metricsDisabled: true || false,
      noTasks: true || false,
      queryConcurrency: 'NUMBER_VALUE',
      queryQueueSize: 'NUMBER_VALUE',
      tracingType: log | jaeger
    }
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
timestreaminfluxdb.createDbParameterGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • name — (String)

      The name of the DB parameter group. The name must be unique per customer and per region.

    • description — (String)

      A description of the DB parameter group.

    • parameters — (map)

      A list of the parameters that comprise the DB parameter group.

      • InfluxDBv2 — (map)

        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

          Possible values include:
          • "debug"
          • "info"
          • "error"
        • 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.

          Possible values include:
          • "log"
          • "jaeger"
        • metricsDisabled — (Boolean)

          Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.

          Default: false

    • tags — (map<String>)

      A list of key-value pairs to associate with the DB parameter group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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 — (map)

        A list of the parameters that comprise the DB parameter group.

        • InfluxDBv2 — (map)

          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

            Possible values include:
            • "debug"
            • "info"
            • "error"
          • 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.

            Possible values include:
            • "log"
            • "jaeger"
          • metricsDisabled — (Boolean)

            Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.

            Default: false

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteDbInstance(params = {}, callback) ⇒ AWS.Request

Deletes a Timestream for InfluxDB DB instance.

Service Reference:

Examples:

Calling the deleteDbInstance operation

var params = {
  identifier: 'STRING_VALUE' /* required */
};
timestreaminfluxdb.deleteDbInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • identifier — (String)

      The id of the DB instance.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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.

        Possible values include:
        • "CREATING"
        • "AVAILABLE"
        • "DELETING"
        • "MODIFYING"
        • "UPDATING"
        • "DELETED"
        • "FAILED"
        • "UPDATING_DEPLOYMENT_TYPE"
        • "UPDATING_INSTANCE_TYPE"
      • endpoint — (String)

        The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

      • dbInstanceType — (String)

        The Timestream for InfluxDB instance type that InfluxDB runs on.

        Possible values include:
        • "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 — (String)

        The Timestream for InfluxDB DB storage type that InfluxDB stores data on.

        Possible values include:
        • "InfluxIOIncludedT1"
        • "InfluxIOIncludedT2"
        • "InfluxIOIncludedT3"
      • 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.

        Possible values include:
        • "SINGLE_AZ"
        • "WITH_MULTIAZ_STANDBY"
      • vpcSubnetIds — (Array<String>)

        A list of VPC subnet IDs associated with the DB instance.

      • publiclyAccessible — (Boolean)

        Indicates if the DB instance has a public IP to facilitate access.

      • vpcSecurityGroupIds — (Array<String>)

        A list of VPC security group IDs associated with the DB instance.

      • 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 — (map)

        Configuration for sending InfluxDB engine logs to send to specified S3 bucket.

        • s3Configuration — required — (map)

          Configuration for S3 bucket log delivery.

          • bucketName — required — (String)

            The name of the S3 bucket to deliver logs to.

          • enabled — required — (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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getDbInstance(params = {}, callback) ⇒ AWS.Request

Returns a Timestream for InfluxDB DB instance.

Service Reference:

Examples:

Calling the getDbInstance operation

var params = {
  identifier: 'STRING_VALUE' /* required */
};
timestreaminfluxdb.getDbInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • identifier — (String)

      The id of the DB instance.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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.

        Possible values include:
        • "CREATING"
        • "AVAILABLE"
        • "DELETING"
        • "MODIFYING"
        • "UPDATING"
        • "DELETED"
        • "FAILED"
        • "UPDATING_DEPLOYMENT_TYPE"
        • "UPDATING_INSTANCE_TYPE"
      • endpoint — (String)

        The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

      • dbInstanceType — (String)

        The Timestream for InfluxDB instance type that InfluxDB runs on.

        Possible values include:
        • "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 — (String)

        The Timestream for InfluxDB DB storage type that InfluxDB stores data on.

        Possible values include:
        • "InfluxIOIncludedT1"
        • "InfluxIOIncludedT2"
        • "InfluxIOIncludedT3"
      • 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.

        Possible values include:
        • "SINGLE_AZ"
        • "WITH_MULTIAZ_STANDBY"
      • vpcSubnetIds — (Array<String>)

        A list of VPC subnet IDs associated with the DB instance.

      • publiclyAccessible — (Boolean)

        Indicates if the DB instance has a public IP to facilitate access.

      • vpcSecurityGroupIds — (Array<String>)

        A list of VPC security group IDs associated with the DB instance.

      • 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 — (map)

        Configuration for sending InfluxDB engine logs to send to specified S3 bucket.

        • s3Configuration — required — (map)

          Configuration for S3 bucket log delivery.

          • bucketName — required — (String)

            The name of the S3 bucket to deliver logs to.

          • enabled — required — (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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getDbParameterGroup(params = {}, callback) ⇒ AWS.Request

Returns a Timestream for InfluxDB DB parameter group.

Service Reference:

Examples:

Calling the getDbParameterGroup operation

var params = {
  identifier: 'STRING_VALUE' /* required */
};
timestreaminfluxdb.getDbParameterGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • identifier — (String)

      The id of the DB parameter group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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 — (map)

        The parameters that comprise the DB parameter group.

        • InfluxDBv2 — (map)

          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

            Possible values include:
            • "debug"
            • "info"
            • "error"
          • 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.

            Possible values include:
            • "log"
            • "jaeger"
          • metricsDisabled — (Boolean)

            Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.

            Default: false

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listDbInstances(params = {}, callback) ⇒ AWS.Request

Returns a list of Timestream for InfluxDB DB instances.

Service Reference:

Examples:

Calling the listDbInstances operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
timestreaminfluxdb.listDbInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • nextToken — (String)

      The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

    • maxResults — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • items — (Array<map>)

        A list of Timestream for InfluxDB DB instance summaries.

        • id — required — (String)

          The service-generated unique identifier of the DB instance.

        • name — required — (String)

          This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands.

        • arn — required — (String)

          The Amazon Resource Name (ARN) of the DB instance.

        • status — (String)

          The status of the DB instance.

          Possible values include:
          • "CREATING"
          • "AVAILABLE"
          • "DELETING"
          • "MODIFYING"
          • "UPDATING"
          • "DELETED"
          • "FAILED"
          • "UPDATING_DEPLOYMENT_TYPE"
          • "UPDATING_INSTANCE_TYPE"
        • endpoint — (String)

          The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

        • dbInstanceType — (String)

          The Timestream for InfluxDB instance type to run InfluxDB on.

          Possible values include:
          • "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 — (String)

          The storage type for your DB instance.

          Possible values include:
          • "InfluxIOIncludedT1"
          • "InfluxIOIncludedT2"
          • "InfluxIOIncludedT3"
        • 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.

          Possible values include:
          • "SINGLE_AZ"
          • "WITH_MULTIAZ_STANDBY"
      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listDbParameterGroups(params = {}, callback) ⇒ AWS.Request

Returns a list of Timestream for InfluxDB DB parameter groups.

Service Reference:

Examples:

Calling the listDbParameterGroups operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
timestreaminfluxdb.listDbParameterGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • nextToken — (String)

      The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

    • maxResults — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • items — (Array<map>)

        A list of Timestream for InfluxDB DB parameter group summaries.

        • id — required — (String)

          A service-generated unique identifier.

        • name — required — (String)

          This customer-supplied name uniquely identifies the parameter group.

        • arn — required — (String)

          The Amazon Resource Name (ARN) of the DB parameter group.

        • description — (String)

          A description of the DB parameter group.

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

A list of tags applied to the resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
timestreaminfluxdb.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the tagged resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (map<String>)

        A list of tags used to categorize and track resources.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
timestreaminfluxdb.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the tagged resource.

    • tags — (map<String>)

      A list of tags used to categorize and track resources.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes the tag from the specified resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
timestreaminfluxdb.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the tagged resource.

    • tagKeys — (Array<String>)

      The keys used to identify the tags.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateDbInstance(params = {}, callback) ⇒ AWS.Request

Updates a Timestream for InfluxDB DB instance.

Service Reference:

Examples:

Calling the updateDbInstance operation

var params = {
  identifier: 'STRING_VALUE', /* required */
  dbInstanceType: db.influx.medium | db.influx.large | db.influx.xlarge | db.influx.2xlarge | db.influx.4xlarge | db.influx.8xlarge | db.influx.12xlarge | db.influx.16xlarge,
  dbParameterGroupIdentifier: 'STRING_VALUE',
  deploymentType: SINGLE_AZ | WITH_MULTIAZ_STANDBY,
  logDeliveryConfiguration: {
    s3Configuration: { /* required */
      bucketName: 'STRING_VALUE', /* required */
      enabled: true || false /* required */
    }
  }
};
timestreaminfluxdb.updateDbInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • identifier — (String)

      The id of the DB instance.

    • logDeliveryConfiguration — (map)

      Configuration for sending InfluxDB engine logs to send to specified S3 bucket.

      • s3Configuration — required — (map)

        Configuration for S3 bucket log delivery.

        • bucketName — required — (String)

          The name of the S3 bucket to deliver logs to.

        • enabled — required — (Boolean)

          Indicates whether log delivery to the S3 bucket is enabled.

    • dbParameterGroupIdentifier — (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.

    • dbInstanceType — (String)

      The Timestream for InfluxDB DB instance type to run InfluxDB on.

      Possible values include:
      • "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 — (String)

      Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.

      Possible values include:
      • "SINGLE_AZ"
      • "WITH_MULTIAZ_STANDBY"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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.

        Possible values include:
        • "CREATING"
        • "AVAILABLE"
        • "DELETING"
        • "MODIFYING"
        • "UPDATING"
        • "DELETED"
        • "FAILED"
        • "UPDATING_DEPLOYMENT_TYPE"
        • "UPDATING_INSTANCE_TYPE"
      • endpoint — (String)

        The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

      • dbInstanceType — (String)

        The Timestream for InfluxDB instance type that InfluxDB runs on.

        Possible values include:
        • "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 — (String)

        The Timestream for InfluxDB DB storage type that InfluxDB stores data on.

        Possible values include:
        • "InfluxIOIncludedT1"
        • "InfluxIOIncludedT2"
        • "InfluxIOIncludedT3"
      • 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.

        Possible values include:
        • "SINGLE_AZ"
        • "WITH_MULTIAZ_STANDBY"
      • vpcSubnetIds — (Array<String>)

        A list of VPC subnet IDs associated with the DB instance.

      • publiclyAccessible — (Boolean)

        Indicates if the DB instance has a public IP to facilitate access.

      • vpcSecurityGroupIds — (Array<String>)

        A list of VPC security group IDs associated with the DB instance.

      • 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 — (map)

        Configuration for sending InfluxDB engine logs to send to specified S3 bucket.

        • s3Configuration — required — (map)

          Configuration for S3 bucket log delivery.

          • bucketName — required — (String)

            The name of the S3 bucket to deliver logs to.

          • enabled — required — (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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.