全部产品
Search
文档中心

资源编排:ALIYUN::RDS::Database

更新时间:Feb 05, 2026

ALIYUN::RDS::Database类型用于在实例下创建数据库。

语法

{
  "Type": "ALIYUN::RDS::Database",
  "Properties": {
    "CharacterSetName": String,
    "DBInstanceId": String,
    "DBDescription": String,
    "DBName": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

CharacterSetName

String

字符集。

取值:

  • MySQL或MariaDB类型:utf8、gbk、latin1、utf8mb4。

  • SQL Server类型:Chinese_PRC_CI_AS、Chinese_PRC_CS_AS、SQL_Latin1_General_CP1_CI_AS、SQL_Latin1_General_CP1_CS_AS、Chinese_PRC_BIN。

  • PostgreSQL类型:KOI8U、UTF8、WIN866、WIN874、WIN1250、WIN1251、WIN1252、WIN1253、WIN1254、WIN1255、WIN1256、WIN1257、WIN1258、EUC_CN、EUC_KR、EUC_TW、EUC_JP、EUC_JIS_2004、KOI8R、MULE_INTERNAL、LATIN1、LATIN2、LATIN3、LATIN4、LATIN5、LATIN6、LATIN7、LATIN8、LATIN9、LATIN10、ISO_8859_5、ISO_8859_6、ISO_8859_7、ISO_8859_8、SQL_ASCII。

DBInstanceId

String

实例ID。

DBDescription

String

数据库描述。

长度为2~256个字符。以英文字母或汉字开头,不能以http://https://开头。可包含英文字母、汉字、数字、下划线(_)和短划线(-)。

DBName

String

数据库名称。

长度为2~64个字符。 以小写英文字母开头,以小写英文字母或数字结尾。可包含小写英文字母、数字、下划线(_)或短划线(-)。

说明

数据库名称在实例中必须唯一。

返回值

Fn::GetAtt

  • DBInstanceId:实例ID。

  • DBName:数据库名称。

示例

场景 1 :为已有RDS实例创建数据库。

快速创建

ROSTemplateFormatVersion: '2015-09-01'
Description:
  zh-cn: 为已有RDS实例创建数据库。
  en: Create a database for an existing RDS instance.
Parameters:
  RDSInstance:
    AssociationProperty: ALIYUN::RDS::Instance::InstanceId
    Type: String
    Label:
      zh-cn: RDS实例ID
      en: RDS ID
  DBName:
    Type: String
    Label:
      zh-cn: 数据库名称
      en: DB Name
    Description:
      zh-cn: 数据库名称,由小写字母、数字及特殊字符(-_)组成,以字母开头,字母或数字结尾,最多64个字符。
      en: Database name, consisting of lowercase letters, Numbers, and special characters (-_), starting with letters, ending with letters or Numbers, up to 64 characters.
    Default: springboot_demo
Outputs: {}
Resources:
  Database:
    Type: ALIYUN::RDS::Database
    Properties:
      CharacterSetName: UTF8
      DBInstanceId:
        Ref: RDSInstance
      DBName:
        Ref: DBName
Metadata: {}
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": {
    "zh-cn": "为已有RDS实例创建数据库。",
    "en": "Create a database for an existing RDS instance."
  },
  "Parameters": {
    "RDSInstance": {
      "AssociationProperty": "ALIYUN::RDS::Instance::InstanceId",
      "Type": "String",
      "Label": {
        "zh-cn": "RDS实例ID",
        "en": "RDS ID"
      }
    },
    "DBName": {
      "Type": "String",
      "Label": {
        "zh-cn": "数据库名称",
        "en": "DB Name"
      },
      "Description": {
        "zh-cn": "数据库名称,由小写字母、数字及特殊字符(-_)组成,以字母开头,字母或数字结尾,最多64个字符。",
        "en": "Database name, consisting of lowercase letters, Numbers, and special characters (-_), starting with letters, ending with letters or Numbers, up to 64 characters."
      },
      "Default": "springboot_demo"
    }
  },
  "Outputs": {
  },
  "Resources": {
    "Database": {
      "Type": "ALIYUN::RDS::Database",
      "Properties": {
        "CharacterSetName": "UTF8",
        "DBInstanceId": {
          "Ref": "RDSInstance"
        },
        "DBName": {
          "Ref": "DBName"
        }
      }
    }
  },
  "Metadata": {
  }
}

场景 2 :新建一台RDS实例并创建数据库。

快速创建

ROSTemplateFormatVersion: '2015-09-01'
Description:
  zh-cn: 创建一台按量付费的RDS Serverless MySQL实例并绑定数据库和数据库账号。
  en: Create a pay-as-you-go RDS Serverless MySQL instance and bind it to a database and a database user.
Parameters:
  VpcId:
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    Type: String
    Description:
      zh-cn: 现有虚拟专有网络的实例ID
      en: Please search the ID starting with (vpc-xxx) from console-Virtual Private Cloud
    Label:
      zh-cn: 专有网络VPC实例ID
      en: VPC ID
  RdsAccountName:
    Default: db_root
    Type: String
    Description:
      zh-cn: MySQL 管理员用户名称
      en: Account Name
    Label:
      zh-cn: 用户名称
      en: Account Name
  ZoneId:
    AssociationProperty: ALIYUN::ECS::Instance::ZoneId
    Type: String
    Label:
      zh-cn: 主可用区
      en: Primary Availability Zone
  VSwitch:
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      VpcId: ${VpcId}
      ZoneId: ${ZoneId}
    Type: String
    Description:
      zh-cn: 现有业务网络交换机的实例ID
      en: Instance ID of existing business network switches, console-Virtual Private Cloud-VSwitches under query
    Label:
      zh-cn: 交换机实例ID
      en: VSwitch ID
  DBInstanceClass:
    Default: mysql.n2.serverless.1c
    AssociationProperty: ALIYUN::RDS::Instance::InstanceType
    AssociationPropertyMetadata:
      Engine: MySQL
      EngineVersion: '8.0'
      InstanceChargeType: Serverless
      DBInstanceStorageType: cloud_essd
      ZoneId: ${ZoneId}
    Type: String
    Label:
      zh-cn: 实例规格
      en: Instance Class
  RdsAccountPassword:
    Type: String
    NoEcho: true
    Description:
      zh-cn: |-
        长度为8~32个字符。由大写英文字母、小写英文字母、数字、特殊字符中的任意三种组成。支持的特殊字符如下:
        !@#$&%^*()_+-= 。
      en: |-
        The length is 8 ~ 32 characters. It is composed of uppercase English letters, lowercase English letters, numbers and special characters. The special characters supported are as follows:
        !@#$& amp;%^* ()_+-=  .
    Label:
      zh-cn: 用户密码
      en: DB Account Password
Outputs:
  PublicConnectionString:
    Value:
      Fn::GetAtt:
        - RDSInstance
        - PublicConnectionString
  InnerIPAddress:
    Value:
      Fn::GetAtt:
        - RDSInstance
        - InnerIPAddress
  AccountName:
    Value:
      Fn::GetAtt:
        - RdsAccount
        - AccountName
  PublicIPAddress:
    Value:
      Fn::GetAtt:
        - RDSInstance
        - PublicIPAddress
  DBName:
    Value:
      Fn::GetAtt:
        - Database
        - DBName
  InnerConnectionString:
    Value:
      Fn::GetAtt:
        - RDSInstance
        - InnerConnectionString
Resources:
  RDSInstance:
    Type: ALIYUN::RDS::DBInstance
    Properties:
      Category: serverless_basic
      Engine: MySQL
      DBInstanceStorage: 20
      ServerlessConfig:
        MinCapacity: 0.5
        AutoPause: false
        MaxCapacity: 8
        SwitchForce: false
      DBInstanceStorageType: cloud_essd
      PayType: Serverless
      ZoneId:
        Ref: ZoneId
      VpcId:
        Ref: VpcId
      VSwitchId:
        Ref: VSwitch
      EngineVersion: '8.0'
      DBInstanceClass:
        Ref: DBInstanceClass
      SecurityIPList: 0.0.0.0/0
  RdsAccount:
    Type: ALIYUN::RDS::Account
    Properties:
      DBInstanceId:
        Ref: RDSInstance
      AccountPassword:
        Ref: RdsAccountPassword
      AccountType: Super
      AccountName:
        Ref: RdsAccountName
  Database:
    Type: ALIYUN::RDS::Database
    Properties:
      CharacterSetName: UTF8
      DBInstanceId:
        Ref: RDSInstance
      DBName: springboot_demo
Metadata:
  ALIYUN::ROS::Interface:
    ParameterGroups:
      - Parameters:
          - VpcId
          - ZoneId
          - VSwitch
        Label:
          default:
            zh-cn: 网络配置
            en: Network Configuration
      - Parameters:
          - DBInstanceClass
          - RdsAccountName
          - RdsAccountPassword
        Label:
          default:
            zh-cn: RDS配置
            en: RDS Configuration
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": {
    "zh-cn": "创建一台按量付费的RDS Serverless MySQL实例并绑定数据库和数据库账号。",
    "en": "Create a pay-as-you-go RDS Serverless MySQL instance and bind it to a database and a database user."
  },
  "Parameters": {
    "VpcId": {
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Type": "String",
      "Description": {
        "zh-cn": "现有虚拟专有网络的实例ID",
        "en": "Please search the ID starting with (vpc-xxx) from console-Virtual Private Cloud"
      },
      "Label": {
        "zh-cn": "专有网络VPC实例ID",
        "en": "VPC ID"
      }
    },
    "RdsAccountName": {
      "Default": "db_root",
      "Type": "String",
      "Description": {
        "zh-cn": "MySQL 管理员用户名称",
        "en": "Account Name"
      },
      "Label": {
        "zh-cn": "用户名称",
        "en": "Account Name"
      }
    },
    "ZoneId": {
      "AssociationProperty": "ALIYUN::ECS::Instance::ZoneId",
      "Type": "String",
      "Label": {
        "zh-cn": "主可用区",
        "en": "Primary Availability Zone"
      }
    },
    "VSwitch": {
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "VpcId": "${VpcId}",
        "ZoneId": "${ZoneId}"
      },
      "Type": "String",
      "Description": {
        "zh-cn": "现有业务网络交换机的实例ID",
        "en": "Instance ID of existing business network switches, console-Virtual Private Cloud-VSwitches under query"
      },
      "Label": {
        "zh-cn": "交换机实例ID",
        "en": "VSwitch ID"
      }
    },
    "DBInstanceClass": {
      "Default": "mysql.n2.serverless.1c",
      "AssociationProperty": "ALIYUN::RDS::Instance::InstanceType",
      "AssociationPropertyMetadata": {
        "Engine": "MySQL",
        "EngineVersion": "8.0",
        "InstanceChargeType": "Serverless",
        "DBInstanceStorageType": "cloud_essd",
        "ZoneId": "${ZoneId}"
      },
      "Type": "String",
      "Label": {
        "zh-cn": "实例规格",
        "en": "Instance Class"
      }
    },
    "RdsAccountPassword": {
      "Type": "String",
      "NoEcho": true,
      "Description": {
        "zh-cn": "长度为8~32个字符。由大写英文字母、小写英文字母、数字、特殊字符中的任意三种组成。支持的特殊字符如下:\n!@#$&%^*()_+-= 。",
        "en": "The length is 8 ~ 32 characters. It is composed of uppercase English letters, lowercase English letters, numbers and special characters. The special characters supported are as follows:\n!@#$& amp;%^* ()_+-=  ."
      },
      "Label": {
        "zh-cn": "用户密码",
        "en": "DB Account Password"
      }
    }
  },
  "Outputs": {
    "PublicConnectionString": {
      "Value": {
        "Fn::GetAtt": [
          "RDSInstance",
          "PublicConnectionString"
        ]
      }
    },
    "InnerIPAddress": {
      "Value": {
        "Fn::GetAtt": [
          "RDSInstance",
          "InnerIPAddress"
        ]
      }
    },
    "AccountName": {
      "Value": {
        "Fn::GetAtt": [
          "RdsAccount",
          "AccountName"
        ]
      }
    },
    "PublicIPAddress": {
      "Value": {
        "Fn::GetAtt": [
          "RDSInstance",
          "PublicIPAddress"
        ]
      }
    },
    "DBName": {
      "Value": {
        "Fn::GetAtt": [
          "Database",
          "DBName"
        ]
      }
    },
    "InnerConnectionString": {
      "Value": {
        "Fn::GetAtt": [
          "RDSInstance",
          "InnerConnectionString"
        ]
      }
    }
  },
  "Resources": {
    "RDSInstance": {
      "Type": "ALIYUN::RDS::DBInstance",
      "Properties": {
        "Category": "serverless_basic",
        "Engine": "MySQL",
        "DBInstanceStorage": 20,
        "ServerlessConfig": {
          "MinCapacity": 0.5,
          "AutoPause": false,
          "MaxCapacity": 8,
          "SwitchForce": false
        },
        "DBInstanceStorageType": "cloud_essd",
        "PayType": "Serverless",
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "VpcId": {
          "Ref": "VpcId"
        },
        "VSwitchId": {
          "Ref": "VSwitch"
        },
        "EngineVersion": "8.0",
        "DBInstanceClass": {
          "Ref": "DBInstanceClass"
        },
        "SecurityIPList": "0.0.0.0/0"
      }
    },
    "RdsAccount": {
      "Type": "ALIYUN::RDS::Account",
      "Properties": {
        "DBInstanceId": {
          "Ref": "RDSInstance"
        },
        "AccountPassword": {
          "Ref": "RdsAccountPassword"
        },
        "AccountType": "Super",
        "AccountName": {
          "Ref": "RdsAccountName"
        }
      }
    },
    "Database": {
      "Type": "ALIYUN::RDS::Database",
      "Properties": {
        "CharacterSetName": "UTF8",
        "DBInstanceId": {
          "Ref": "RDSInstance"
        },
        "DBName": "springboot_demo"
      }
    }
  },
  "Metadata": {
    "ALIYUN::ROS::Interface": {
      "ParameterGroups": [
        {
          "Parameters": [
            "VpcId",
            "ZoneId",
            "VSwitch"
          ],
          "Label": {
            "default": {
              "zh-cn": "网络配置",
              "en": "Network Configuration"
            }
          }
        },
        {
          "Parameters": [
            "DBInstanceClass",
            "RdsAccountName",
            "RdsAccountPassword"
          ],
          "Label": {
            "default": {
              "zh-cn": "RDS配置",
              "en": "RDS Configuration"
            }
          }
        }
      ]
    }
  }
}

更多示例,请参考包含此资源的公共模板。