All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::POLARDB::AITask

Last Updated:Dec 04, 2025

ALIYUN::POLARDB::AITask is used to enable the PolarDB for AI feature.

Syntax

{
  "Type": "ALIYUN::POLARDB::AITask",
  "Properties": {
    "Username": String,
    "NodeType": String,
    "DBClusterId": String,
    "Password": String
  }
}

Properties

Property

Type

Required

Allow updates

Description

Constraint

Username

String

Yes

No

The username of the database for which you want to enable the PolarDB for AI feature.

None.

NodeType

String

No

No

The node type.

Valid values:

  • DLNode: AI node

  • SearchNode: AI search node

DBClusterId

String

Yes

No

The cluster ID.

None.

Password

String

Yes

No

The password of the database for which you want to enable the PolarDB for AI feature.

None.

Return values

Fn::GetAtt

DBClusterId: the cluster ID.

Examples

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBClusterId:
    Description: The ID of the DB cluster.
    Type: String
  NodeType:
    Default: DLNode
    Type: String
  Password:
    Description: The password of the database account for which to enable the PolarDB for AI feature.
    Type: String
  Username:
    Description: The database account for which to enable the PolarDB for AI feature.
    Type: String
Resources:
  AITask:
    Properties:
      DBClusterId:
        Ref: DBClusterId
      NodeType:
        Ref: NodeType
      Password:
        Ref: Password
      Username:
        Ref: Username
    Type: ALIYUN::POLARDB::AITask
Outputs:
  DBClusterId:
    Description: The ID of the DB cluster.
    Value:
      Fn::GetAtt:
      - AITask
      - DBClusterId
                        
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Username": {
      "Type": "String",
      "Description": "The database account for which to enable the PolarDB for AI feature."
    },
    "NodeType": {
      "Type": "String",
      "Description": "The type of the node. Valid values:\nDLNode: An AI node (default).\nSearchNode: A search AI node.",
      "Default": "DLNode"
    },
    "DBClusterId": {
      "Type": "String",
      "Description": "The ID of the DB cluster."
    },
    "Password": {
      "Type": "String",
      "Description": "The password of the database account for which to enable the PolarDB for AI feature."
    }
  },
  "Resources": {
    "AITask": {
      "Type": "ALIYUN::POLARDB::AITask",
      "Properties": {
        "Username": {
          "Ref": "Username"
        },
        "NodeType": {
          "Ref": "NodeType"
        },
        "DBClusterId": {
          "Ref": "DBClusterId"
        },
        "Password": {
          "Ref": "Password"
        }
      }
    }
  },
  "Outputs": {
    "DBClusterId": {
      "Description": "The ID of the DB cluster.",
      "Value": {
        "Fn::GetAtt": [
          "AITask",
          "DBClusterId"
        ]
      }
    }
  }
}