ALIYUN::POLARDB::AITask - Resource Orchestration Service

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	Editable	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

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBClusterId:
    Description: The ID of the DB cluster.
    Type: String
  NodeType:
    Default: DLNode
    Type: String
    Default: DLNode
  Password:
    Description: The password of the database account that enables the PolarDB for AI function
        is required.
    Type: String
  Username:
    Description: The database account that enables the PolarDB for AI function is required.
    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

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Username": {
      "Type": "String",
      "Description": "The database account that enables the PolarDB for AI function is required."
    },
    "NodeType": {
      "Type": "String",
      "Description": "The type of the node. Valid values:\nDLNode: AI node(default).\nSearchNode: 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 that enables the PolarDB for AI function is required."
    }
  },
  "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"
        ]
      }
    }
  }
}