ALIYUN::TSDB::InfluxDBDatabase

Updated at:

ALIYUN::TSDB::InfluxDBDatabase is used to create a Time Series Database (TSDB) database.

Important

Dear Alibaba Cloud user, thank you for your support of Time Series Database (TSDB) for InfluxDB®. We regret to inform you that this product is scheduled to be discontinued due to product updates. Its services will be gradually phased out. For more information, see [Notice] Discontinuation of Time Series Database (TSDB) for InfluxDB® on October 23, 2026.

Syntax

{
  "Type": "ALIYUN::TSDB::InfluxDBDatabase",
  "Properties": {
    "InstanceId": String,
    "DBName": String
  }
}

Properties

Property Name

Type

Required

Allow updates

Description

Constraints

InstanceId

String

Yes

No

The ID of the time series database instance.

None

DBName

String

Yes

No

The time series database name.

The name can be up to 64 characters in length. It can contain lowercase letters, digits, and underscores (_). The name must start with a lowercase letter and end with a lowercase letter or a digit.

Return value

Fn::GetAtt

  • InstanceId: The ID of the Time Series Database (TSDB) for InfluxDB® instance.

  • DBName: The name of the database.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": "The ID of TSDB for InfluxDB.",
      "Default": "ts-wz99vz6u8jg39****"
    },
    "DBName": {
      "Type": "String",
      "Description": "The name of database. The name can at most be 64 characters in length and can contain lowercase letters, digits, and underscores (_). It must start with a letter and end with a letter or digit.",
      "MinLength": 1,
      "MaxLength": 64,
      "Default": "test"
    }
  },
  "Resources": {
    "InfluxDBDatabase": {
      "Type": "ALIYUN::TSDB::InfluxDBDatabase",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        },
        "DBName": {
          "Ref": "DBName"
        }
      }
    }
  },
  "Outputs": {
    "InstanceId": {
      "Description": "The ID of TSDB for InfluxDB.",
      "Value": {
        "Fn::GetAtt": [
          "InfluxDBDatabase",
          "InstanceId"
        ]
      }
    },
    "DBName": {
      "Description": "The name of database.",
      "Value": {
        "Fn::GetAtt": [
          "InfluxDBDatabase",
          "DBName"
        ]
      }
    }
  }
}