Timestream InfluxDB

2024/03/14 - Timestream InfluxDB - 11 new api methods

Changes  This is the initial SDK release for Amazon Timestream for InfluxDB. Amazon Timestream for InfluxDB is a new 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.

TagResource (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)
type resourceArn

string

param resourceArn

[REQUIRED]

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

type tags

dict

param tags

[REQUIRED]

A list of tags used to categorize and track resources.

  • (string) --

    • (string) --

returns

None

DeleteDbInstance (new) Link ¶

Deletes a Timestream for InfluxDB DB instance.

See also: AWS API Documentation

Request Syntax

client.delete_db_instance(
    identifier='string'
)
type identifier

string

param identifier

[REQUIRED]

The id of the DB instance.

rtype

dict

returns

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'arn': 'string',
    'status': 'CREATING'|'AVAILABLE'|'DELETING'|'MODIFYING'|'UPDATING'|'DELETED'|'FAILED',
    'endpoint': 'string',
    'dbInstanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge',
    'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
    'allocatedStorage': 123,
    'deploymentType': 'SINGLE_AZ'|'WITH_MULTIAZ_STANDBY',
    'vpcSubnetIds': [
        'string',
    ],
    'publiclyAccessible': True|False,
    'vpcSecurityGroupIds': [
        'string',
    ],
    'dbParameterGroupIdentifier': 'string',
    'availabilityZone': 'string',
    'secondaryAvailabilityZone': 'string',
    'logDeliveryConfiguration': {
        's3Configuration': {
            'bucketName': 'string',
            'enabled': True|False
        }
    },
    'influxAuthParametersSecretArn': 'string'
}

Response Structure

  • (dict) --

    • id (string) --

      A service-generated unique identifier.

    • name (string) --

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

    • arn (string) --

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

    • status (string) --

      The status of the DB instance.

    • endpoint (string) --

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

    • dbInstanceType (string) --

      The Timestream for InfluxDB instance type that InfluxDB runs on.

    • dbStorageType (string) --

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

    • allocatedStorage (integer) --

      The amount of storage allocated for your DB storage type (in gibibytes).

    • deploymentType (string) --

      Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.

    • vpcSubnetIds (list) --

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

      • (string) --

    • publiclyAccessible (boolean) --

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

    • vpcSecurityGroupIds (list) --

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

      • (string) --

    • dbParameterGroupIdentifier (string) --

      The id of the DB parameter group assigned to your DB instance.

    • availabilityZone (string) --

      The Availability Zone in which the DB instance resides.

    • secondaryAvailabilityZone (string) --

      The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.

    • logDeliveryConfiguration (dict) --

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

      • s3Configuration (dict) --

        Configuration for S3 bucket log delivery.

        • bucketName (string) --

          The name of the S3 bucket to deliver logs to.

        • enabled (boolean) --

          Indicates whether log delivery to the S3 bucket is enabled.

    • influxAuthParametersSecretArn (string) --

      The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.

CreateDbInstance (new) Link ¶

Creates a new Timestream for InfluxDB DB instance.

See also: AWS API Documentation

Request Syntax

client.create_db_instance(
    name='string',
    username='string',
    password='string',
    organization='string',
    bucket='string',
    dbInstanceType='db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge',
    vpcSubnetIds=[
        'string',
    ],
    vpcSecurityGroupIds=[
        'string',
    ],
    publiclyAccessible=True|False,
    dbStorageType='InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
    allocatedStorage=123,
    dbParameterGroupIdentifier='string',
    deploymentType='SINGLE_AZ'|'WITH_MULTIAZ_STANDBY',
    logDeliveryConfiguration={
        's3Configuration': {
            'bucketName': 'string',
            'enabled': True|False
        }
    },
    tags={
        'string': 'string'
    }
)
type name

string

param name

[REQUIRED]

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

type username

string

param username

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.

type password

string

param password

[REQUIRED]

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

type organization

string

param organization

The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.

type bucket

string

param bucket

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.

type dbInstanceType

string

param dbInstanceType

[REQUIRED]

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

type vpcSubnetIds

list

param vpcSubnetIds

[REQUIRED]

A list of VPC subnet IDs to associate with the DB instance. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.

  • (string) --

type vpcSecurityGroupIds

list

param vpcSecurityGroupIds

[REQUIRED]

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

  • (string) --

type publiclyAccessible

boolean

param publiclyAccessible

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

type dbStorageType

string

param dbStorageType

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

type allocatedStorage

integer

param allocatedStorage

[REQUIRED]

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

type dbParameterGroupIdentifier

string

param dbParameterGroupIdentifier

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.

type deploymentType

string

param deploymentType

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

type logDeliveryConfiguration

dict

param logDeliveryConfiguration

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

  • s3Configuration (dict) -- [REQUIRED]

    Configuration for S3 bucket log delivery.

    • bucketName (string) -- [REQUIRED]

      The name of the S3 bucket to deliver logs to.

    • enabled (boolean) -- [REQUIRED]

      Indicates whether log delivery to the S3 bucket is enabled.

type tags

dict

param tags

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

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'arn': 'string',
    'status': 'CREATING'|'AVAILABLE'|'DELETING'|'MODIFYING'|'UPDATING'|'DELETED'|'FAILED',
    'endpoint': 'string',
    'dbInstanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge',
    'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
    'allocatedStorage': 123,
    'deploymentType': 'SINGLE_AZ'|'WITH_MULTIAZ_STANDBY',
    'vpcSubnetIds': [
        'string',
    ],
    'publiclyAccessible': True|False,
    'vpcSecurityGroupIds': [
        'string',
    ],
    'dbParameterGroupIdentifier': 'string',
    'availabilityZone': 'string',
    'secondaryAvailabilityZone': 'string',
    'logDeliveryConfiguration': {
        's3Configuration': {
            'bucketName': 'string',
            'enabled': True|False
        }
    },
    'influxAuthParametersSecretArn': 'string'
}

Response Structure

  • (dict) --

    • id (string) --

      A service-generated unique identifier.

    • name (string) --

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

    • arn (string) --

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

    • status (string) --

      The status of the DB instance.

    • endpoint (string) --

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

    • dbInstanceType (string) --

      The Timestream for InfluxDB instance type that InfluxDB runs on.

    • dbStorageType (string) --

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

    • allocatedStorage (integer) --

      The amount of storage allocated for your DB storage type (in gibibytes).

    • deploymentType (string) --

      Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.

    • vpcSubnetIds (list) --

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

      • (string) --

    • publiclyAccessible (boolean) --

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

    • vpcSecurityGroupIds (list) --

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

      • (string) --

    • dbParameterGroupIdentifier (string) --

      The id of the DB parameter group assigned to your DB instance.

    • availabilityZone (string) --

      The Availability Zone in which the DB instance resides.

    • secondaryAvailabilityZone (string) --

      The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.

    • logDeliveryConfiguration (dict) --

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

      • s3Configuration (dict) --

        Configuration for S3 bucket log delivery.

        • bucketName (string) --

          The name of the S3 bucket to deliver logs to.

        • enabled (boolean) --

          Indicates whether log delivery to the S3 bucket is enabled.

    • influxAuthParametersSecretArn (string) --

      The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.

UpdateDbInstance (new) Link ¶

Updates a Timestream for InfluxDB DB instance.

See also: AWS API Documentation

Request Syntax

client.update_db_instance(
    identifier='string',
    logDeliveryConfiguration={
        's3Configuration': {
            'bucketName': 'string',
            'enabled': True|False
        }
    },
    dbParameterGroupIdentifier='string'
)
type identifier

string

param identifier

[REQUIRED]

The id of the DB instance.

type logDeliveryConfiguration

dict

param logDeliveryConfiguration

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

  • s3Configuration (dict) -- [REQUIRED]

    Configuration for S3 bucket log delivery.

    • bucketName (string) -- [REQUIRED]

      The name of the S3 bucket to deliver logs to.

    • enabled (boolean) -- [REQUIRED]

      Indicates whether log delivery to the S3 bucket is enabled.

type dbParameterGroupIdentifier

string

param dbParameterGroupIdentifier

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.

rtype

dict

returns

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'arn': 'string',
    'status': 'CREATING'|'AVAILABLE'|'DELETING'|'MODIFYING'|'UPDATING'|'DELETED'|'FAILED',
    'endpoint': 'string',
    'dbInstanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge',
    'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
    'allocatedStorage': 123,
    'deploymentType': 'SINGLE_AZ'|'WITH_MULTIAZ_STANDBY',
    'vpcSubnetIds': [
        'string',
    ],
    'publiclyAccessible': True|False,
    'vpcSecurityGroupIds': [
        'string',
    ],
    'dbParameterGroupIdentifier': 'string',
    'availabilityZone': 'string',
    'secondaryAvailabilityZone': 'string',
    'logDeliveryConfiguration': {
        's3Configuration': {
            'bucketName': 'string',
            'enabled': True|False
        }
    },
    'influxAuthParametersSecretArn': 'string'
}

Response Structure

  • (dict) --

    • id (string) --

      A service-generated unique identifier.

    • name (string) --

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

    • arn (string) --

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

    • status (string) --

      The status of the DB instance.

    • endpoint (string) --

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

    • dbInstanceType (string) --

      The Timestream for InfluxDB instance type that InfluxDB runs on.

    • dbStorageType (string) --

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

    • allocatedStorage (integer) --

      The amount of storage allocated for your DB storage type (in gibibytes).

    • deploymentType (string) --

      Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.

    • vpcSubnetIds (list) --

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

      • (string) --

    • publiclyAccessible (boolean) --

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

    • vpcSecurityGroupIds (list) --

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

      • (string) --

    • dbParameterGroupIdentifier (string) --

      The id of the DB parameter group assigned to your DB instance.

    • availabilityZone (string) --

      The Availability Zone in which the DB instance resides.

    • secondaryAvailabilityZone (string) --

      The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.

    • logDeliveryConfiguration (dict) --

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

      • s3Configuration (dict) --

        Configuration for S3 bucket log delivery.

        • bucketName (string) --

          The name of the S3 bucket to deliver logs to.

        • enabled (boolean) --

          Indicates whether log delivery to the S3 bucket is enabled.

    • influxAuthParametersSecretArn (string) --

      The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.

ListDbParameterGroups (new) Link ¶

Returns a list of Timestream for InfluxDB DB parameter groups.

See also: AWS API Documentation

Request Syntax

client.list_db_parameter_groups(
    nextToken='string',
    maxResults=123
)
type nextToken

string

param nextToken

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

type maxResults

integer

param maxResults

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.

rtype

dict

returns

Response Syntax

{
    'items': [
        {
            'id': 'string',
            'name': 'string',
            'arn': 'string',
            'description': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      A list of Timestream for InfluxDB DB parameter group summaries.

      • (dict) --

        Contains a summary of a DB parameter group.

        • id (string) --

          A service-generated unique identifier.

        • name (string) --

          This customer-supplied name uniquely identifies the parameter group.

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

ListTagsForResource (new) Link ¶

A list of tags applied to the resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)
type resourceArn

string

param resourceArn

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • tags (dict) --

      A list of tags used to categorize and track resources.

      • (string) --

        • (string) --

ListDbInstances (new) Link ¶

Returns a list of Timestream for InfluxDB DB instances.

See also: AWS API Documentation

Request Syntax

client.list_db_instances(
    nextToken='string',
    maxResults=123
)
type nextToken

string

param nextToken

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

type maxResults

integer

param maxResults

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.

rtype

dict

returns

Response Syntax

{
    'items': [
        {
            'id': 'string',
            'name': 'string',
            'arn': 'string',
            'status': 'CREATING'|'AVAILABLE'|'DELETING'|'MODIFYING'|'UPDATING'|'DELETED'|'FAILED',
            'endpoint': 'string',
            'dbInstanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge',
            'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
            'allocatedStorage': 123,
            'deploymentType': 'SINGLE_AZ'|'WITH_MULTIAZ_STANDBY'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      A list of Timestream for InfluxDB DB instance summaries.

      • (dict) --

        Contains a summary of a DB instance.

        • id (string) --

          The service-generated unique identifier of the DB instance.

        • name (string) --

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

        • arn (string) --

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

        • status (string) --

          The status of the DB instance.

        • endpoint (string) --

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

        • dbInstanceType (string) --

          The Timestream for InfluxDB instance type to run InfluxDB on.

        • dbStorageType (string) --

          The storage type for your DB instance.

        • allocatedStorage (integer) --

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

        • deploymentType (string) --

          Single-Instance or with a MultiAZ Standby for High availability.

    • nextToken (string) --

      Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off.

UntagResource (new) Link ¶

Removes the tag from the specified resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
type resourceArn

string

param resourceArn

[REQUIRED]

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

type tagKeys

list

param tagKeys

[REQUIRED]

The keys used to identify the tags.

  • (string) --

returns

None

GetDbParameterGroup (new) Link ¶

Returns a Timestream for InfluxDB DB parameter group.

See also: AWS API Documentation

Request Syntax

client.get_db_parameter_group(
    identifier='string'
)
type identifier

string

param identifier

[REQUIRED]

The id of the DB parameter group.

rtype

dict

returns

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'arn': 'string',
    'description': 'string',
    'parameters': {
        'InfluxDBv2': {
            'fluxLogEnabled': True|False,
            'logLevel': 'debug'|'info'|'error',
            'noTasks': True|False,
            'queryConcurrency': 123,
            'queryQueueSize': 123,
            'tracingType': 'log'|'jaeger',
            'metricsDisabled': True|False
        }
    }
}

Response Structure

  • (dict) --

    • id (string) --

      A service-generated unique identifier.

    • name (string) --

      The customer-supplied name that uniquely identifies the DB parameter group when interacting with the Amazon Timestream for InfluxDB API and CLI commands.

    • arn (string) --

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

    • description (string) --

      A description of the DB parameter group.

    • parameters (dict) --

      The parameters that comprise the DB parameter group.

      • InfluxDBv2 (dict) --

        All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.

        • fluxLogEnabled (boolean) --

          Include option to show detailed logs for Flux queries.

          Default: false

        • logLevel (string) --

          Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.

          Default: info

        • noTasks (boolean) --

          Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.

          Default: false

        • queryConcurrency (integer) --

          Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.

          Default: 0

        • queryQueueSize (integer) --

          Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.

          Default: 0

        • tracingType (string) --

          Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.

        • metricsDisabled (boolean) --

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

          Default: false

CreateDbParameterGroup (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.create_db_parameter_group(
    name='string',
    description='string',
    parameters={
        'InfluxDBv2': {
            'fluxLogEnabled': True|False,
            'logLevel': 'debug'|'info'|'error',
            'noTasks': True|False,
            'queryConcurrency': 123,
            'queryQueueSize': 123,
            'tracingType': 'log'|'jaeger',
            'metricsDisabled': True|False
        }
    },
    tags={
        'string': 'string'
    }
)
type name

string

param name

[REQUIRED]

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

type description

string

param description

A description of the DB parameter group.

type parameters

dict

param parameters

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

  • InfluxDBv2 (dict) --

    All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.

    • fluxLogEnabled (boolean) --

      Include option to show detailed logs for Flux queries.

      Default: false

    • logLevel (string) --

      Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.

      Default: info

    • noTasks (boolean) --

      Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.

      Default: false

    • queryConcurrency (integer) --

      Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.

      Default: 0

    • queryQueueSize (integer) --

      Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.

      Default: 0

    • tracingType (string) --

      Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.

    • metricsDisabled (boolean) --

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

      Default: false

type tags

dict

param tags

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

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'arn': 'string',
    'description': 'string',
    'parameters': {
        'InfluxDBv2': {
            'fluxLogEnabled': True|False,
            'logLevel': 'debug'|'info'|'error',
            'noTasks': True|False,
            'queryConcurrency': 123,
            'queryQueueSize': 123,
            'tracingType': 'log'|'jaeger',
            'metricsDisabled': True|False
        }
    }
}

Response Structure

  • (dict) --

    • id (string) --

      A service-generated unique identifier.

    • name (string) --

      The customer-supplied name that uniquely identifies the DB parameter group when interacting with the Amazon Timestream for InfluxDB API and CLI commands.

    • arn (string) --

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

    • description (string) --

      The description of the DB parameter group.

    • parameters (dict) --

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

      • InfluxDBv2 (dict) --

        All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.

        • fluxLogEnabled (boolean) --

          Include option to show detailed logs for Flux queries.

          Default: false

        • logLevel (string) --

          Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.

          Default: info

        • noTasks (boolean) --

          Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.

          Default: false

        • queryConcurrency (integer) --

          Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.

          Default: 0

        • queryQueueSize (integer) --

          Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.

          Default: 0

        • tracingType (string) --

          Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.

        • metricsDisabled (boolean) --

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

          Default: false

GetDbInstance (new) Link ¶

Returns a Timestream for InfluxDB DB instance.

See also: AWS API Documentation

Request Syntax

client.get_db_instance(
    identifier='string'
)
type identifier

string

param identifier

[REQUIRED]

The id of the DB instance.

rtype

dict

returns

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'arn': 'string',
    'status': 'CREATING'|'AVAILABLE'|'DELETING'|'MODIFYING'|'UPDATING'|'DELETED'|'FAILED',
    'endpoint': 'string',
    'dbInstanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge',
    'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
    'allocatedStorage': 123,
    'deploymentType': 'SINGLE_AZ'|'WITH_MULTIAZ_STANDBY',
    'vpcSubnetIds': [
        'string',
    ],
    'publiclyAccessible': True|False,
    'vpcSecurityGroupIds': [
        'string',
    ],
    'dbParameterGroupIdentifier': 'string',
    'availabilityZone': 'string',
    'secondaryAvailabilityZone': 'string',
    'logDeliveryConfiguration': {
        's3Configuration': {
            'bucketName': 'string',
            'enabled': True|False
        }
    },
    'influxAuthParametersSecretArn': 'string'
}

Response Structure

  • (dict) --

    • id (string) --

      A service-generated unique identifier.

    • name (string) --

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

    • arn (string) --

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

    • status (string) --

      The status of the DB instance.

    • endpoint (string) --

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

    • dbInstanceType (string) --

      The Timestream for InfluxDB instance type that InfluxDB runs on.

    • dbStorageType (string) --

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

    • allocatedStorage (integer) --

      The amount of storage allocated for your DB storage type (in gibibytes).

    • deploymentType (string) --

      Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.

    • vpcSubnetIds (list) --

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

      • (string) --

    • publiclyAccessible (boolean) --

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

    • vpcSecurityGroupIds (list) --

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

      • (string) --

    • dbParameterGroupIdentifier (string) --

      The id of the DB parameter group assigned to your DB instance.

    • availabilityZone (string) --

      The Availability Zone in which the DB instance resides.

    • secondaryAvailabilityZone (string) --

      The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.

    • logDeliveryConfiguration (dict) --

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

      • s3Configuration (dict) --

        Configuration for S3 bucket log delivery.

        • bucketName (string) --

          The name of the S3 bucket to deliver logs to.

        • enabled (boolean) --

          Indicates whether log delivery to the S3 bucket is enabled.

    • influxAuthParametersSecretArn (string) --

      The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.