La ressource ALIYUN::RDS::PrepayDBInstance permet de créer des instances ApsaraDB RDS en mode abonnement.
Syntaxe
{
"Type": "ALIYUN::RDS::PrepayDBInstance",
"Properties": {
"DBMappings": List,
"CouponCode": String,
"MasterUsername": String,
"PeriodType": String,
"DBInstanceNetType": String,
"MasterUserType": String,
"AutoRenew": Boolean,
"PreferredBackupTime": String,
"PrivateIpAddress": String,
"Engine": String,
"MultiAZ": Boolean,
"VpcId": String,
"ConnectionMode": String,
"ResourceGroupId": String,
"VSwitchId": String,
"BackupRetentionPeriod": Number,
"Quantity": Number,
"CommodityCode": String,
"ZoneId": String,
"AutoPay": Boolean,
"Port": Integer,
"ConnectionStringPrefix": String,
"SubscriptionDeletionForce": Boolean,
"ConnectionStringType": String,
"EngineVersion": String,
"DBInstanceClass": String,
"PreferredBackupPeriod": List,
"DBInstanceStorage": Integer,
"DBInstanceDescription": String,
"Tags": Map,
"Period": Number,
"MasterUserPassword": String,
"AllocatePublicConnection": Boolean,
"SlaveZoneIds": List,
"TargetDedicatedHostIdForMaster": String,
"RoleARN": String,
"DBInstanceStorageType": String,
"Category": String,
"DBParamGroupId": String,
"EncryptionKey": String,
"DBIsIgnoreCase": Integer,
"SecurityGroupId": String,
"TargetDedicatedHostIdForLog": String,
"DBTimeZone": String,
"DedicatedHostGroupId": String,
"TargetDedicatedHostIdForSlave": String,
"MaintainTime": String,
"SQLCollectorStatus": String,
"SSLSetting": String,
"ArchiveBackupRetentionPeriod": Integer,
"LogBackupRetentionPeriod": Integer,
"EnableBackupLog": Boolean,
"LogBackupLocalRetentionNumber": Integer,
"ArchiveBackupKeepPolicy": String,
"LocalLogRetentionHours": Integer,
"HighSpaceUsageProtection": String,
"CompressType": Integer,
"LogBackupFrequency": String,
"BackupPolicyMode": String,
"ArchiveBackupKeepCount": Integer,
"LocalLogRetentionSpace": Integer,
"ReleasedKeepPolicy": String,
"BackUpCategory": String,
"ServerlessConfig": Map,
"InstanceNetworkType": String,
"StorageAutoScale": String,
"StorageUpperBound": Number,
"StorageThreshold": Number,
"IoAccelerationEnabled": String,
"ColdDataEnabled": Boolean,
"BurstingEnabled": Boolean,
"DeletionProtection": Boolean
}
}
Propriétés
Propriété | Type | Obligatoire | Modifiable | Description | Contrainte |
ResourceGroupId | String | Non | Oui | ID du groupe de ressources. | Aucune. |
DBMappings | List | Non | Non | Bases de données à créer sur l'instance. | Pour plus d'informations, consultez la section Propriétés DBMappings. |
CouponCode | String | Non | Non | Code du coupon. | Aucune. |
MasterUsername | String | Non | Oui | Nom du compte de base de données de l'instance. | Le nom doit être globalement unique. Il doit comporter entre 2 et 16 caractères. Il doit commencer par une lettre et se terminer par une lettre ou un chiffre. Il peut contenir des lettres, des chiffres et des traits de soulignement (_). |
PeriodType | String | Oui | Non | Unité de durée de l'abonnement. | Valeurs valides :
|
AutoUpgradeMinorVersion | String | Non | Oui | Méthode de mise à niveau de la version mineure de l'instance. | Valeurs valides :
|
DBInstanceNetType | String | Non | Non | Type de connexion réseau de l'instance. | Valeurs valides :
|
MasterUserType | String | Non | Non | Type de compte de base de données. | Valeurs valides :
|
Port | Integer | Non | Oui | Port de l'instance. | Aucune. |
ConnectionStringPrefix | String | Non | Oui | Préfixe de l'endpoint. | Le préfixe doit comporter entre 8 et 64 caractères et peut contenir des lettres, des chiffres et des traits d'union (-). |
ConnectionStringType | String | Non | Oui | Type d'endpoint. | Valeurs valides :
|
PreferredBackupTime | String | Non | Oui | Heure de sauvegarde. | Spécifiez l'heure au format HH:mmZ-HH:mmZ. Valeurs valides : 00:00Z-01:00Z, 01:00Z-02:00Z, 02:00Z-03:00Z, 03:00Z-04:00Z, 04:00Z-05:00Z, 05:00Z-06:00Z, 06:00Z-07:00Z, 07:00Z-08:00Z, 08:00Z-09:00Z, 09:00Z-10:00Z, 10:00Z-11:00Z, 11:00Z-12:00Z, 12:00Z-13:00Z, 13:00Z-14:00Z, 14:00Z-15:00Z, 15:00Z-16:00Z, 16:00Z-17:00Z, 17:00Z-18:00Z, 18:00Z-19:00Z, 19:00Z-20:00Z, 20:00Z-21:00Z, 21:00Z-22:00Z, 22:00Z-23:00Z et 23:00Z-24:00Z. |
PrivateIpAddress | String | Non | Non | Adresse IP privée correspondant au vSwitch. | Si vous ne spécifiez pas cette propriété, le système attribue automatiquement une adresse IP privée. |
Engine | String | Oui | Non | Type de moteur de base de données. | Valeurs valides :
|
MultiAZ | Boolean | Non | Non | Indique si l'instance est déployée sur plusieurs zones. | Valeurs valides :
|
VpcId | String | Non | Non | ID du cloud privé virtuel (VPC). | Aucune. |
ConnectionMode | String | Non | Non | Mode de connexion de la base de données. | Valeurs valides :
Si vous ne spécifiez pas cette propriété, le système attribue un mode de connexion par défaut. |
AutoRenew | Boolean | Non | Non | Indique si le renouvellement automatique est activé pour l'instance. | Valeurs valides :
|
VSwitchId | String | Non | Non | ID du vSwitch. | Aucune. |
BackupRetentionPeriod | Number | Non | Oui | Nombre de jours de conservation des données de sauvegarde. | Aucune. |
Quantity | Number | Non | Non | Nombre d'instances à créer. | Valeurs valides : 1 à 99. Valeur par défaut : 1. |
CommodityCode | String | Oui | Non | Code de produit. | Valeurs valides :
|
SubscriptionDeletionForce | Boolean | Non | Non | Cette propriété s'applique uniquement aux instances en abonnement. Si vous définissez cette propriété sur true pour une instance en abonnement, l'instance est convertie en instance à la demande avant sa suppression forcée. Si vous définissez cette propriété sur false pour une instance en abonnement, l'instance n'est pas supprimée de force. Cette propriété entraîne des frais supplémentaires. Soyez prudent lors de la spécification de cette propriété. | Aucune. |
ZoneId | String | Non | Non | ID de la zone. | Aucune. |
EngineVersion | String | Oui | Non | Version du moteur de base de données. | Valeurs valides :
|
DBInstanceClass | String | Oui | Oui | Type d'instance. | Exemples : rds.mys2.large, rds.mss1.large et rds.pg.s1.small. |
PreferredBackupPeriod | List | Non | Oui | Jour de la semaine pour la sauvegarde des données. | Valeurs valides :
|
DBInstanceStorage | Integer | Oui | Oui | Capacité de stockage de l'instance. | Valeurs valides :
Unité : Go. Remarque La valeur de DBInstanceStorage doit être un multiple de 5 Go. |
DBInstanceDescription | String | Non | Oui | Description de l'instance. | La description doit comporter entre 2 et 256 caractères. Elle doit commencer par une lettre et ne peut pas commencer par |
Tags | Map | Non | Oui | Tags. | Aucune. |
Period | Number | Oui | Non | Durée de l'abonnement. | Valeurs valides :
|
MasterUserPassword | String | Non | Oui | Mot de passe du compte de base de données de l'instance. | Le mot de passe doit comporter entre 8 et 32 caractères. Il doit contenir au moins trois des types de caractères suivants : lettres majuscules, lettres minuscules, chiffres et caractères spéciaux. Les caractères spéciaux suivants sont pris en charge : |
AllocatePublicConnection | Boolean | Non | Non | Indique si un endpoint public est demandé pour l'instance. | Valeurs valides :
|
AutoPay | Boolean | Non | Non | Indique si le paiement automatique est activé. | Valeurs valides :
|
SlaveZoneIds | List | Non | Non | IDs des zones secondaires pour les instances Haute disponibilité ou Édition Entreprise. | Vous pouvez spécifier jusqu'à deux zones secondaires. Par exemple, vous pouvez définir cette propriété sur Vous devez spécifier un vSwitch pour chaque zone principale ou secondaire. Par exemple, si vous définissez ZoneId sur Si vous souhaitez que le système sélectionne automatiquement une zone secondaire, vous devez définir SlaveZoneIds sur |
TargetDedicatedHostIdForMaster | String | Non | Non | ID de l'hôte de l'instance principale à créer dans un cluster dédié. | Aucune. |
RoleARN | String | Non | Non | Alibaba Cloud Resource Name (ARN) du rôle. Vous pouvez accéder à Key Management Service (KMS) depuis ApsaraDB RDS en utilisant ce rôle. | Aucune. |
DBInstanceStorageType | String | Non | Oui | Type de stockage de l'instance. | Valeurs valides :
|
Category | String | Non | Oui | Édition de l'instance. | Valeurs valides :
|
DBParamGroupId | String | Non | Non | ID du modèle de paramètres. | Aucune. |
EncryptionKey | String | Non | Non | ID de la clé utilisée pour le chiffrement des disques dans la région où réside l'instance. | Vous pouvez obtenir l'ID de la clé depuis la console KMS. Vous pouvez également créer une clé. |
DBIsIgnoreCase | Integer | Non | Non | Indique si les noms de table sont sensibles à la casse. | Valeurs valides :
|
SecurityGroupId | String | Non | Oui | ID du groupe de sécurité. | Vous pouvez associer l'instance à un maximum de trois groupes de sécurité. Séparez les IDs des groupes de sécurité par des virgules (,). Si vous souhaitez dissocier l'instance de tous les groupes de sécurité, laissez cette propriété vide. |
TargetDedicatedHostIdForLog | String | Non | Non | ID de l'hôte de l'instance logger à créer dans un cluster dédié. | Aucune. |
DBTimeZone | String | Non | Non | Fuseau horaire UTC. | Valeurs valides : -12:59 à +13:00. Par défaut, si vous ne spécifiez pas cette propriété, le système utilise le fuseau horaire par défaut de la région où réside l'instance. Si vous créez une instance avec des SSD locaux attachés, vous pouvez nommer le fuseau horaire. |
DedicatedHostGroupId | String | Non | Non | ID du cluster dédié dans lequel vous souhaitez créer l'instance. | Aucune. |
TargetDedicatedHostIdForSlave | String | Non | Non | ID de l'hôte de l'instance secondaire à créer dans un cluster dédié. | Aucune. |
MaintainTime | String | Non | Non | Fenêtre de maintenance de l'instance. | Spécifiez la fenêtre de maintenance au format HH:mmZ-HH:mmZ. |
SQLCollectorStatus | String | Non | Oui | Indique si SQL Explorer et Audit sont activés. | Valeurs valides :
|
SSLSetting | String | Non | Non | Paramètres de connexion SSL de l'instance. | Valeurs valides :
|
ArchiveBackupRetentionPeriod | Integer | Non | Oui | Nombre de jours de conservation des sauvegardes archivées. | Aucune. |
LogBackupRetentionPeriod | Integer | Non | Oui | Nombre de jours de conservation des sauvegardes de journaux. | Aucune. |
EnableBackupLog | Boolean | Non | Oui | Indique si la sauvegarde des journaux est activée. | Valeurs valides :
|
LogBackupLocalRetentionNumber | Integer | Non | Oui | Nombre de journaux binaires locaux à conserver. | Aucune. |
ArchiveBackupKeepPolicy | String | Non | Oui | Cycle de conservation des sauvegardes archivées. | Valeurs valides :
ArchiveBackupKeepCount détermine le nombre de sauvegardes pouvant être conservées au cours du cycle. Le nombre par défaut est 0. Remarque Cette propriété prend effet lorsque BackupPolicyMode est défini sur DataBackupPolicy. |
LocalLogRetentionHours | Integer | Non | Oui | Nombre d'heures de conservation des sauvegardes de journaux locaux. | Aucune. |
HighSpaceUsageProtection | String | Non | Oui | Indique si les journaux binaires sont supprimés de force lorsque l'utilisation de la capacité de l'instance dépasse 80 % ou que la capacité restante est inférieure à 5 Go. | Valeurs valides :
|
CompressType | Integer | Non | Oui | La méthode de compression des données de sauvegarde. | Valeurs valides :
|
LogBackupFrequency | String | Non | Oui | La fréquence de sauvegarde des journaux. | Cette propriété est disponible lorsque Engine est défini sur SQLServer. Définissez la valeur sur LogInterval. La valeur LogInterval indique que le système effectue une sauvegarde des journaux toutes les 30 minutes. Remarque La valeur par défaut de LogBackupFrequency est identique à celle de PreferredBackupPeriod. |
BackupPolicyMode | String | Non | Oui | Le type de sauvegarde. | Valeurs valides :
|
ArchiveBackupKeepCount | Integer | Non | Oui | Le nombre de sauvegardes archivées à conserver. | Aucun. |
LocalLogRetentionSpace | Integer | Non | Oui | L'utilisation maximale de la capacité pour les journaux locaux sur l'instance. | Aucun. |
ReleasedKeepPolicy | String | Non | Oui | La politique de conservation des sauvegardes archivées en cas de libération de l'instance. | Valeurs valides :
|
BackUpCategory | String | Non | Oui | L'édition de l'instance de sauvegarde. | Valeurs valides :
|
ServerlessConfig | Map | Non | Non | Les paramètres de l'instance serverless. | Pour plus d'informations, consultez Propriétés ServerlessConfig. |
InstanceNetworkType | String | Non | Non | Le type de réseau de l'instance. | Valeurs valides :
Remarque Pour l'instance qui exécute MySQL et utilise des disques cloud, vous devez définir cette propriété sur VPC. Pour l'instance qui exécute PostgreSQL ou MariaDB, vous devez définir cette propriété sur VPC. Pour l'instance qui exécute SQL Server Basic ou SQL Server Web, vous pouvez définir cette propriété sur VPC ou Classic. Pour les autres types d'instances, vous devez définir cette propriété sur VPC. |
StorageAutoScale | String | Non | Non | Indique si l'extension automatique du stockage est activée. | Cette propriété est prise en charge uniquement lorsque Engine est défini sur MySQL ou PostgreSQL. Valeurs valides :
Remarque Vous pouvez également appeler l'opération ModifyDasInstanceConfig pour ajuster les paramètres d'extension automatique du stockage d'une instance après sa création. Pour plus d'informations, consultez Configurer l'extension automatique du stockage pour une instance ApsaraDB RDS for MySQL. |
StorageUpperBound | Number | Non | Non | La capacité de stockage maximale autorisée pour l'extension automatique du stockage. | L'extension automatique du stockage n'entraîne pas un dépassement de la capacité de stockage de l'instance au-delà de la valeur de cette propriété. Unité : Go. Remarque La valeur doit être supérieure ou égale à 0. Vous devez spécifier cette propriété lorsque StorageAutoScale est défini sur Enable. |
StorageThreshold | Number | Non | Non | Le seuil de déclenchement de l'extension automatique du stockage. Unité : %. | Valeurs valides :
Remarque Vous devez spécifier cette propriété lorsque StorageAutoScale est défini sur Enable. |
IoAccelerationEnabled | String | Non | Non | Indique si l'accélération des E/S est activée. | Valeurs valides :
|
ColdDataEnabled | Boolean | Non | Non | Cette propriété est réservée. | Aucun. |
BurstingEnabled | Boolean | Non | Non | Indique si le burst des E/S est activé. | Valeurs valides :
|
DeletionProtection | Boolean | Non | Oui | Indique si la fonctionnalité de protection contre la suppression est activée. | Valeurs valides :
|
Syntaxe de ServerlessConfig
"ServerlessConfig": {
"SwitchForce": Boolean,
"MaxCapacity": Number,
"MinCapacity": Number,
"AutoPause": Boolean
}
Propriétés de ServerlessConfig
Propriété | Type | Obligatoire | Modifiable | Description | Contrainte |
SwitchForce | Boolean | Non | Non | Indique si la mise à l'échelle forcée est activée pour l'instance serverless. | Valeurs valides :
Remarque
|
MaxCapacity | Number | Oui | Non | La valeur maximale de mise à l'échelle des RCU pour l'instance. | Valeurs valides : 0,5 à 8. Remarque La valeur de cette propriété doit être supérieure ou égale à la valeur de MinCapacity. |
MinCapacity | Number | Oui | Non | La valeur minimale de mise à l'échelle des RCU pour l'instance. | Valeurs valides : 0,5 à 8. Remarque La valeur de cette propriété doit être inférieure ou égale à la valeur de MaxCapacity. |
AutoPause | Boolean | Non | Non | Indique si la fonctionnalité de démarrage et de suspension automatiques est activée pour l'instance serverless. | Valeurs valides :
Remarque Une fois la fonctionnalité activée, l'instance est suspendue si aucune connexion n'est établie dans les 10 minutes, et elle reprend son activité dès qu'une connexion est détectée. |
Syntaxe de DBMappings
"DBMappings": [
{
"DBDescription": String,
"CharacterSetName": String,
"DBName": String
}
]
Propriétés de DBMappings
Propriété | Type | Obligatoire | Modifiable | Description | Contrainte |
DBDescription | String | Non | Non | La description de la base de données. | La description doit comporter entre 2 et 256 caractères. Elle doit commencer par une lettre et ne peut pas commencer par |
CharacterSetName | String | Oui | Non | Le jeu de caractères. | Valeurs valides :
|
DBName | String | Oui | Non | Le nom de la base de données. | Le nom doit être globalement unique. Il peut contenir jusqu'à 64 caractères, y compris des lettres minuscules, des chiffres et des traits de soulignement (_). Il doit commencer par une lettre minuscule. |
Valeurs de retour
Fn::GetAtt
InnerPort : le port privé de l'instance.
OrderId : l'ID de la commande.
PublicConnectionString : le endpoint public de l'instance.
InnerIPAddress : l'adresse IP privée de l'instance.
DBInstanceId : l'ID de l'instance.
PublicIPAddress : l'adresse IP publique de l'instance.
PublicPort : le port public de l'instance.
InnerConnectionString : le endpoint privé de l'instance.
Exemples
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
AllocatePublicConnection:
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Description: If true, allocate public connection automate.
Type: Boolean
ArchiveBackupKeepCount:
Description: "The number of archived backups that can be retained. Default value:\
\ 1. Valid values: \nThe value of this parameter ranges from 1 to 31 when the\
\ ArchiveBackupKeepPolicy \n parameter is set to ByMonth. \nThe value of this\
\ parameter ranges from 1 to 7 when the ArchiveBackupKeepPolicy \n parameter\
\ is set to ByWeek. \nNote You do not need to specify this parameter when the\
\ ArchiveBackupKeepPolicy \nparameter is set to KeepAll."
MaxValue: 31
MinValue: 1
Type: Number
ArchiveBackupKeepPolicy:
AllowedValues:
- ByMonth
- ByWeek
- KeepAll
Description: "The period for which to retain archived backups. The number of archived\
\ backups that can \n be retained within the specified period is determined\
\ by the ArchiveBackupKeepCount parameter. \n Default value: 0. Valid values:\
\ \nByMonth \n ByWeek \n KeepAll"
Type: String
ArchiveBackupRetentionPeriod:
Description: "The number of days for which to retain archived backups. \n The\
\ default value 0 specifies not to enable the backup archiving function. Valid\
\ values: 30 to 1095."
MaxValue: 1095
MinValue: 30
Type: Number
AutoPay:
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Default: true
Description: Automatic Payment. Default is true.
Type: Boolean
AutoRenew:
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Default: false
Description: Auto renew the prepay instance. If the period type is by year, it
will renew by year, else it will renew by month.
Type: Boolean
BackUpCategory:
AllowedValues:
- Flash
- Standard
Description: "Specifies whether to enable the second-level backup function. This\
\ function allows a backup \nto be completed within seconds. Valid values: \n\
Flash: specifies to enable the second-level backup function. \n Standard: specifies\
\ to disable the second-level backup function."
Type: String
BackupPolicyMode:
AllowedValues:
- DataBackupPolicy
- LogBackupPolicy
Description: "Backup type, \nDataBackupPolicy: data backup \nLogBackupPolicy:\
\ log backup"
Type: String
BackupRetentionPeriod:
Default: 7
Description: 'The retention period of the data backup. Value range: 7 to 730.
The default value is the original value. Note When the BackupPolicyMode parameter
is set to LogBackupPolicy, this parameter is required.'
Type: Number
Category:
AllowedValues:
- Basic
- HighAvailability
- AlwaysOn
- Finance
Description: 'The edition of the instance. Valid values:
Basic: specifies to use the Basic Edition.
HighAvailability: specifies to use the High-availability Edition.
AlwaysOn: specifies to use the Cluster Edition.
Finance: specifies to use the Enterprise Edition.'
Type: String
CommodityCode:
AllowedValues:
- rds
- bards
- rords
Default: rds
Description: The CommodityCode of the order.
Type: String
CompressType:
Description: "The format used to compress backups. Valid values: \n 1: The zlib\
\ tool is used to compress backups into .tar.gz files. \n 4: The QuickLZ tool\
\ is used to compress backups into .xb.gz files. \nThis compression format is\
\ supported only when the instance runs MySQL 5.6 or 5.7. \nIt can be used to\
\ restore individual databases and tables. \n 8: The QuickLZ tool is used to\
\ compress backups into .xb.gz files. \n This compression format is supported\
\ only when the instance runs MySQL 8.0. \nIt cannot be used to restore individual\
\ databases or tables."
Type: Number
ConnectionMode:
Description: 'Connection Mode for database instance,support ''Standard'' and ''Safe''
mode. Default is RDS system assigns. '
Type: String
ConnectionStringPrefix:
AllowedPattern: '[a-zA-Z0-9-]{8,64}'
Description: "The prefix of the endpoint. \nOnly the prefix of the CurrentConnectionString\
\ parameter value can be modified.\nThe prefix must be 8 to 64 characters in\
\ length and can contain letters, digits, and hyphens (-). "
Type: String
ConnectionStringType:
AllowedValues:
- Inner
- Public
Default: Inner
Description: 'The endpoint type of the instance, allow values: Inner, Public'
Type: String
CouponCode:
Description: The coupon code of the order.
Type: String
DBInstanceClass:
Description: Database instance type. Refer the RDS database instance type reference,
such as 'rds.mys2.large', 'rds.mss1.large', 'rds.pg.s1.small' etc
Type: String
DBInstanceDescription:
Description: Description of created database instance.
Type: String
DBInstanceNetType:
AllowedValues:
- Internet
- Intranet
Default: Intranet
Description: Database instance net type, default is Intranet.Internet for public
access, Intranet for private access.
Type: String
DBInstanceStorage:
Description: Database instance storage size. mysql is [5,1000]. sql server 2008r2
is [10,1000], sql server 2012/2012_web/2016-web is [20,1000]. PostgreSQL and
PPAS is [5,2000]. Increased every 5 GB, Unit in GB
Type: Number
DBInstanceStorageType:
Description: 'The storage type of the instance. Valid values:
local_ssd: specifies to use local SSDs. This is the recommended storage type.
cloud_ssd: specifies to use standard SSDs.
cloud_essd: specifies to use enhanced SSDs.'
Type: String
DBIsIgnoreCase:
Description: 'Specifies whether table names are case-sensitive. Valid values:
1: Table names are not case-sensitive. This is the default value.
0: Table names are case-sensitive.'
Type: Number
DBMappings:
Description: Database mappings to attach to db instance.
Type: Json
DBParamGroupId:
Description: The ID of the parameter template used by the instance.
Type: String
DBTimeZone:
Description: 'The UTC time zone of the instance. Valid values: -12:00 to +12:00.
The time zone must be an integer value such as +08:00. Values such as +08:30
are not allowed.'
Type: String
DedicatedHostGroupId:
Description: The ID of the host group to which the instance belongs if you create
an instance in a host group.
Type: String
EnableBackupLog:
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Description: "Specifies whether to enable the log backup function. Valid values:\
\ \nTrue: specifies to enable the log backup function. \nFalse: specifies to\
\ disable the log backup function. \nNote You must specify this parameter when\
\ the BackupPolicyMode parameter is set to LogBackupPolicy."
Type: Boolean
EncryptionKey:
Description: The ID of the encryption key that is used to encrypt data on SSDs
in the region. You can view the encryption key ID in the Key Management Service
(KMS) console. You can also create an encryption key.
Type: String
Engine:
AllowedValues:
- MySQL
- SQLServer
- PostgreSQL
- PPAS
- MariaDB
Description: Database instance engine type. Support MySQL/SQLServer/PostgreSQL/PPAS/MariaDB
now.
Type: String
EngineVersion:
Description: 'Database instance version of the relative engine type.Support MySQL:
5.5/5.6/5.7/8.0;
SQLServer: 2008r2/2012/2012_ent_ha/2012_std_ha/2012_web/2016_ent_ha/2016_std_ha/2016_web/2017_std_ha/2017_ent;
PostgreSQL: 9.4/10.0/11.0/12.0;
PPAS: 9.3/10.0;
MariaDB: 10.3.'
Type: String
HighSpaceUsageProtection:
AllowedValues:
- Enable
- Disable
Description: "Specifies whether to forcibly delete log backup files when the space\
\ usage of the \n instance exceeds 80% or the remaining space is less than 5\
\ GB. Valid values: \n Enable and Disable. You can retain the default value.\
\ Note You must specify \n this parameter when the BackupPolicyMode parameter\
\ is set to LogBackupPolicy."
Type: String
LocalLogRetentionHours:
Description: "The number of hours for which to retain log backup files on the\
\ instance. \nValid values: 0 to 168. The value 0 specifies not to retain log\
\ backup files on the instance. \nYou can retain the default value. Note You\
\ must specify this parameter when the BackupPolicyMode \nparameter is set to\
\ LogBackupPolicy."
MaxValue: 168
MinValue: 0
Type: Number
LocalLogRetentionSpace:
Description: "The maximum percentage of space that is allowed to store log backup\
\ files on the instance. \n If the space usage for log backup files exceeds\
\ this percentage, the system deletes earlier \n log backup files until the\
\ space usage falls below this percentage. Valid values:0 to 50. \n You can\
\ retain the default value. Note You must specify this parameter when the \n\
\ BackupPolicyMode parameter is set to LogBackupPolicy."
MaxValue: 50
MinValue: 0
Type: Number
LogBackupFrequency:
Description: "The frequency at which to back up logs. Valid values: \nThe value\
\ LogInterval specifies to back up logs every 30 minutes. \n The default value\
\ of this parameter is the same as the data backup frequency. \nNote The value\
\ LogInterval is supported only when the instance runs SQL Server."
Type: String
LogBackupLocalRetentionNumber:
Description: "The number of log backup files that can be retained on the instance.\
\ \nDefault value: 60. Valid values: 6 to 100."
MaxValue: 100
MinValue: 6
Type: Number
LogBackupRetentionPeriod:
Description: "The number of days for which to retain log backup files. Valid values:\
\ 7 to 730. The log backup \n retention period cannot be longer than the data\
\ backup retention period.Note If you enable the log \n backup function, you\
\ can specify the log backup retention period. This applies only when the \n\
\ instance runs MySQL, PostgreSQL, or PPAS."
MaxValue: 730
MinValue: 7
Type: Number
MaintainTime:
Description: The period during which the maintenance performs. The format is HH:mmZ-HH:mmZ.
Type: String
MasterUserPassword:
Description: 'The master password for the database instance. '
MaxLength: 32
MinLength: 8
Type: String
MasterUserType:
AllowedValues:
- Normal
- Super
- Sysadmin
Default: Normal
Description: "Privilege type of account.\n Normal: Common privilege. \n Super:\
\ High privilege. \nSysadmin: Super privileges (SA) (only supported by SQL Server)\n\
The default value is Normal."
Type: String
MasterUsername:
Description: 'The master user name for the database instance. '
Type: String
MultiAZ:
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Default: false
Description: 'Specifies if the database instance is a multiple Availability Zone
deployment. '
Type: Boolean
Period:
Default: 1
Description: Prepaid time period. While choose by pay by month, it could be from
1 to 9. While choose pay by year, it could be from 1 to 3.
MaxValue: 9
MinValue: 1
Type: Number
PeriodType:
AllowedValues:
- Month
- Year
Default: Month
Description: Charge period for created instances.
Type: String
Port:
Description: The port of the database service.
MaxValue: 65535
MinValue: 1
Type: Number
PreferredBackupPeriod:
Description: The backup period. Separate multiple values with commas (,). The
default value is the original value. Valid values:Monday Tuesday Wednesday Thursday
Friday Saturday Sunday Note When the BackupPolicyMode parameter is set to DataBackupPolicy,
this parameter is required.
Type: CommaDelimitedList
PreferredBackupTime:
Description: 'The time when the backup task is performed. Format: yyyy-MM-ddZ-HH:mm:ssZ.Note
When the BackupPolicyMode parameter is set to DataBackupPolicy, this parameter
is required.'
Type: String
PrivateIpAddress:
Description: The private ip for created instance.
Type: String
Quantity:
Default: 1
Description: The number of instance to be created, default is 1, max number is
99
MaxValue: 99
MinValue: 1
Type: Number
ReleasedKeepPolicy:
AllowedValues:
- Lastest
- All
Description: "The policy used to retain archived backups if the instance is released.\
\ Default value: None. \n Valid values: \nLastest: Only the last archived backup\
\ is retained. \n All: All of the archived backups are retained."
Type: String
ResourceGroupId:
Description: Resource group id.
Type: String
RoleARN:
Description: The Alibaba Cloud Resource Name (ARN) provided to the service account
of the instance by your Alibaba Cloud account to connect to KMS. You can copy
the ARN from the RAM console.
Type: String
SQLCollectorStatus:
AllowedValues:
- Enable
- Disabled
Description: "Specifies whether to enable or disable the SQL Explorer (SQL audit)\
\ feature. \nValid values:Enable | Disabled."
Type: String
SSLSetting:
AllowedValues:
- Disabled
- EnabledForPublicConnection
- EnabledForInnerConnection
Default: Disabled
Description: 'Secure Sockets Layer (SSL) link setting of the instance. Valid values:
Disabled: Disable SSL
EnabledForPublicConnection: Public connection address will be protected by the
SSL certificate. It requires AllocatePublicConnection is true.
EnabledForInnerConnection: Private connection address will be protected by the
SSL certificate.
Default value is Disabled.'
Type: String
SecurityGroupId:
Description: "The ID of the ECS security groups. \nEach RDS instance can be associated\
\ with up to three ECS security groups. \nYou must separate them with commas\
\ (,). \nTo delete an ECS Security group, leave this parameter empty. \n"
Type: String
SlaveZoneIds:
Description: List of slave zone ids can specify slave zone ids when creating the
high-availability or enterprise edition instance. Meanwhile, VSwitchId needs
to pass in the corresponding vswitch id to the slave zone by order. For example,
ZoneId = "zone-a" and SlaveZoneIds = ["zone-c", "zone-b"], then the VSwitchId
must be "vsw-zone-a,vsw-zone-c,vsw-zone-b". Of course, you can also choose automatic
allocation, for example, ZoneId = "zone-a" and SlaveZoneIds = ["Auto", "Auto"],
then the VSwitchId must be "vsw-zone-a,Auto,Auto". The list contains up to 2
slave zone ids, separated by commas.
MaxLength: 2
Type: Json
Tags:
Description: 'The tags of an instance.
You should input the information of the tag with the format of the Key-Value,
such as {"key1":"value1","key2":"value2", ... "key5":"value5"}.
At most 5 tags can be specified.
Key
It can be up to 64 characters in length.
Cannot begin with aliyun.
Cannot begin with http:// or https://.
Cannot be a null string.
Value
It can be up to 128 characters in length.
Cannot begin with aliyun.
Cannot begin with http:// or https://.
Can be a null string.'
Type: Json
TargetDedicatedHostIdForLog:
Description: The ID of the host to which the instance belongs if you create a
log instance in a host group.
Type: String
TargetDedicatedHostIdForMaster:
Description: The ID of the host to which the instance belongs if you create a
primary instance in a host group.
Type: String
TargetDedicatedHostIdForSlave:
Description: The ID of the host to which the instance belongs if you create a
secondary instance in a host group.
Type: String
VSwitchId:
Description: The vSwitch id of created instance. For VPC network, the property
is required.
Type: String
VpcId:
Description: The VPC id of created database instance. For VPC network, the property
is required.
Type: String
ZoneId:
Description: selected zone to create database instance. You cannot set the ZoneId
parameter if the MultiAZ parameter is set to true.
Type: String
Resources:
PrepayDBInstance:
Properties:
AllocatePublicConnection:
Ref: AllocatePublicConnection
ArchiveBackupKeepCount:
Ref: ArchiveBackupKeepCount
ArchiveBackupKeepPolicy:
Ref: ArchiveBackupKeepPolicy
ArchiveBackupRetentionPeriod:
Ref: ArchiveBackupRetentionPeriod
AutoPay:
Ref: AutoPay
AutoRenew:
Ref: AutoRenew
BackUpCategory:
Ref: BackUpCategory
BackupPolicyMode:
Ref: BackupPolicyMode
BackupRetentionPeriod:
Ref: BackupRetentionPeriod
Category:
Ref: Category
CommodityCode:
Ref: CommodityCode
CompressType:
Ref: CompressType
ConnectionMode:
Ref: ConnectionMode
ConnectionStringPrefix:
Ref: ConnectionStringPrefix
ConnectionStringType:
Ref: ConnectionStringType
CouponCode:
Ref: CouponCode
DBInstanceClass:
Ref: DBInstanceClass
DBInstanceDescription:
Ref: DBInstanceDescription
DBInstanceNetType:
Ref: DBInstanceNetType
DBInstanceStorage:
Ref: DBInstanceStorage
DBInstanceStorageType:
Ref: DBInstanceStorageType
DBIsIgnoreCase:
Ref: DBIsIgnoreCase
DBMappings:
Ref: DBMappings
DBParamGroupId:
Ref: DBParamGroupId
DBTimeZone:
Ref: DBTimeZone
DedicatedHostGroupId:
Ref: DedicatedHostGroupId
EnableBackupLog:
Ref: EnableBackupLog
EncryptionKey:
Ref: EncryptionKey
Engine:
Ref: Engine
EngineVersion:
Ref: EngineVersion
HighSpaceUsageProtection:
Ref: HighSpaceUsageProtection
LocalLogRetentionHours:
Ref: LocalLogRetentionHours
LocalLogRetentionSpace:
Ref: LocalLogRetentionSpace
LogBackupFrequency:
Ref: LogBackupFrequency
LogBackupLocalRetentionNumber:
Ref: LogBackupLocalRetentionNumber
LogBackupRetentionPeriod:
Ref: LogBackupRetentionPeriod
MaintainTime:
Ref: MaintainTime
MasterUserPassword:
Ref: MasterUserPassword
MasterUserType:
Ref: MasterUserType
MasterUsername:
Ref: MasterUsername
MultiAZ:
Ref: MultiAZ
Period:
Ref: Period
PeriodType:
Ref: PeriodType
Port:
Ref: Port
PreferredBackupPeriod:
Ref: PreferredBackupPeriod
PreferredBackupTime:
Ref: PreferredBackupTime
PrivateIpAddress:
Ref: PrivateIpAddress
Quantity:
Ref: Quantity
ReleasedKeepPolicy:
Ref: ReleasedKeepPolicy
ResourceGroupId:
Ref: ResourceGroupId
RoleARN:
Ref: RoleARN
SQLCollectorStatus:
Ref: SQLCollectorStatus
SSLSetting:
Ref: SSLSetting
SecurityGroupId:
Ref: SecurityGroupId
SlaveZoneIds:
Ref: SlaveZoneIds
Tags:
Ref: Tags
TargetDedicatedHostIdForLog:
Ref: TargetDedicatedHostIdForLog
TargetDedicatedHostIdForMaster:
Ref: TargetDedicatedHostIdForMaster
TargetDedicatedHostIdForSlave:
Ref: TargetDedicatedHostIdForSlave
VSwitchId:
Ref: VSwitchId
VpcId:
Ref: VpcId
ZoneId:
Ref: ZoneId
Type: ALIYUN::RDS::PrepayDBInstance
Outputs:
DBInstanceId:
Description: The instance id of created database instance.
Value:
Fn::GetAtt:
- PrepayDBInstance
- DBInstanceId
InnerConnectionString:
Description: DB instance connection url by Intranet.
Value:
Fn::GetAtt:
- PrepayDBInstance
- InnerConnectionString
InnerIPAddress:
Description: IP Address for created DB instance of Intranet.
Value:
Fn::GetAtt:
- PrepayDBInstance
- InnerIPAddress
InnerPort:
Description: Intranet port of created DB instance.
Value:
Fn::GetAtt:
- PrepayDBInstance
- InnerPort
OrderId:
Description: The order id list of created instance.
Value:
Fn::GetAtt:
- PrepayDBInstance
- OrderId
PublicConnectionString:
Description: DB instance connection url by Internet.
Value:
Fn::GetAtt:
- PrepayDBInstance
- PublicConnectionString
PublicIPAddress:
Description: IP Address for created DB instance of Internet.
Value:
Fn::GetAtt:
- PrepayDBInstance
- PublicIPAddress
PublicPort:
Description: Internet port of created DB instance.
Value:
Fn::GetAtt:
- PrepayDBInstance
- PublicPort{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"PeriodType": {
"Type": "String",
"Description": "Charge period for created instances.",
"AllowedValues": [
"Month",
"Year"
],
"Default": "Month"
},
"ResourceGroupId": {
"Type": "String",
"Description": "Resource group id."
},
"ArchiveBackupRetentionPeriod": {
"Type": "Number",
"Description": "The number of days for which to retain archived backups. \n The default value 0 specifies not to enable the backup archiving function. Valid values: 30 to 1095.",
"MinValue": 30,
"MaxValue": 1095
},
"DBTimeZone": {
"Type": "String",
"Description": "The UTC time zone of the instance. Valid values: -12:00 to +12:00. The time zone must be an integer value such as +08:00. Values such as +08:30 are not allowed."
},
"Port": {
"Type": "Number",
"Description": "The port of the database service.",
"MinValue": 1,
"MaxValue": 65535
},
"ArchiveBackupKeepCount": {
"Type": "Number",
"Description": "The number of archived backups that can be retained. Default value: 1. Valid values: \nThe value of this parameter ranges from 1 to 31 when the ArchiveBackupKeepPolicy \n parameter is set to ByMonth. \nThe value of this parameter ranges from 1 to 7 when the ArchiveBackupKeepPolicy \n parameter is set to ByWeek. \nNote You do not need to specify this parameter when the ArchiveBackupKeepPolicy \nparameter is set to KeepAll.",
"MinValue": 1,
"MaxValue": 31
},
"LogBackupRetentionPeriod": {
"Type": "Number",
"Description": "The number of days for which to retain log backup files. Valid values: 7 to 730. The log backup \n retention period cannot be longer than the data backup retention period.Note If you enable the log \n backup function, you can specify the log backup retention period. This applies only when the \n instance runs MySQL, PostgreSQL, or PPAS.",
"MinValue": 7,
"MaxValue": 730
},
"DBInstanceStorage": {
"Type": "Number",
"Description": "Database instance storage size. mysql is [5,1000]. sql server 2008r2 is [10,1000], sql server 2012/2012_web/2016-web is [20,1000]. PostgreSQL and PPAS is [5,2000]. Increased every 5 GB, Unit in GB"
},
"DBMappings": {
"Type": "Json",
"Description": "Database mappings to attach to db instance."
},
"ConnectionStringPrefix": {
"Type": "String",
"Description": "The prefix of the endpoint. \nOnly the prefix of the CurrentConnectionString parameter value can be modified.\nThe prefix must be 8 to 64 characters in length and can contain letters, digits, and hyphens (-). ",
"AllowedPattern": "[a-zA-Z0-9-]{8,64}"
},
"MultiAZ": {
"Type": "Boolean",
"Description": "Specifies if the database instance is a multiple Availability Zone deployment. ",
"AllowedValues": [
"True",
"true",
"False",
"false"
],
"Default": false
},
"Engine": {
"Type": "String",
"Description": "Database instance engine type. Support MySQL/SQLServer/PostgreSQL/PPAS/MariaDB now.",
"AllowedValues": [
"MySQL",
"SQLServer",
"PostgreSQL",
"PPAS",
"MariaDB"
]
},
"Tags": {
"Type": "Json",
"Description": "The tags of an instance.\nYou should input the information of the tag with the format of the Key-Value, such as {\"key1\":\"value1\",\"key2\":\"value2\", ... \"key5\":\"value5\"}.\nAt most 5 tags can be specified.\nKey\nIt can be up to 64 characters in length.\nCannot begin with aliyun.\nCannot begin with http:// or https://.\nCannot be a null string.\nValue\nIt can be up to 128 characters in length.\nCannot begin with aliyun.\nCannot begin with http:// or https://.\nCan be a null string."
},
"DBInstanceDescription": {
"Type": "String",
"Description": "Description of created database instance."
},
"TargetDedicatedHostIdForMaster": {
"Type": "String",
"Description": "The ID of the host to which the instance belongs if you create a primary instance in a host group."
},
"EngineVersion": {
"Type": "String",
"Description": "Database instance version of the relative engine type.Support MySQL: 5.5/5.6/5.7/8.0;\nSQLServer: 2008r2/2012/2012_ent_ha/2012_std_ha/2012_web/2016_ent_ha/2016_std_ha/2016_web/2017_std_ha/2017_ent;\nPostgreSQL: 9.4/10.0/11.0/12.0;\nPPAS: 9.3/10.0;\nMariaDB: 10.3."
},
"DBInstanceClass": {
"Type": "String",
"Description": "Database instance type. Refer the RDS database instance type reference, such as 'rds.mys2.large', 'rds.mss1.large', 'rds.pg.s1.small' etc"
},
"ArchiveBackupKeepPolicy": {
"Type": "String",
"Description": "The period for which to retain archived backups. The number of archived backups that can \n be retained within the specified period is determined by the ArchiveBackupKeepCount parameter. \n Default value: 0. Valid values: \nByMonth \n ByWeek \n KeepAll",
"AllowedValues": [
"ByMonth",
"ByWeek",
"KeepAll"
]
},
"VSwitchId": {
"Type": "String",
"Description": "The vSwitch id of created instance. For VPC network, the property is required."
},
"BackupPolicyMode": {
"Type": "String",
"Description": "Backup type, \nDataBackupPolicy: data backup \nLogBackupPolicy: log backup",
"AllowedValues": [
"DataBackupPolicy",
"LogBackupPolicy"
]
},
"Period": {
"Type": "Number",
"Description": "Prepaid time period. While choose by pay by month, it could be from 1 to 9. While choose pay by year, it could be from 1 to 3.",
"MinValue": 1,
"MaxValue": 9,
"Default": 1
},
"LocalLogRetentionHours": {
"Type": "Number",
"Description": "The number of hours for which to retain log backup files on the instance. \nValid values: 0 to 168. The value 0 specifies not to retain log backup files on the instance. \nYou can retain the default value. Note You must specify this parameter when the BackupPolicyMode \nparameter is set to LogBackupPolicy.",
"MinValue": 0,
"MaxValue": 168
},
"HighSpaceUsageProtection": {
"Type": "String",
"Description": "Specifies whether to forcibly delete log backup files when the space usage of the \n instance exceeds 80% or the remaining space is less than 5 GB. Valid values: \n Enable and Disable. You can retain the default value. Note You must specify \n this parameter when the BackupPolicyMode parameter is set to LogBackupPolicy.",
"AllowedValues": [
"Enable",
"Disable"
]
},
"RoleARN": {
"Type": "String",
"Description": "The Alibaba Cloud Resource Name (ARN) provided to the service account of the instance by your Alibaba Cloud account to connect to KMS. You can copy the ARN from the RAM console."
},
"MasterUserPassword": {
"Type": "String",
"Description": "The master password for the database instance. ",
"MinLength": 8,
"MaxLength": 32
},
"VpcId": {
"Type": "String",
"Description": "The VPC id of created database instance. For VPC network, the property is required."
},
"SSLSetting": {
"Type": "String",
"Description": "Secure Sockets Layer (SSL) link setting of the instance. Valid values:\nDisabled: Disable SSL\nEnabledForPublicConnection: Public connection address will be protected by the SSL certificate. It requires AllocatePublicConnection is true.\nEnabledForInnerConnection: Private connection address will be protected by the SSL certificate.\nDefault value is Disabled.",
"AllowedValues": [
"Disabled",
"EnabledForPublicConnection",
"EnabledForInnerConnection"
],
"Default": "Disabled"
},
"MasterUsername": {
"Type": "String",
"Description": "The master user name for the database instance. "
},
"ConnectionMode": {
"Type": "String",
"Description": "Connection Mode for database instance,support 'Standard' and 'Safe' mode. Default is RDS system assigns. "
},
"LocalLogRetentionSpace": {
"Type": "Number",
"Description": "The maximum percentage of space that is allowed to store log backup files on the instance. \n If the space usage for log backup files exceeds this percentage, the system deletes earlier \n log backup files until the space usage falls below this percentage. Valid values:0 to 50. \n You can retain the default value. Note You must specify this parameter when the \n BackupPolicyMode parameter is set to LogBackupPolicy.",
"MinValue": 0,
"MaxValue": 50
},
"Category": {
"Type": "String",
"Description": "The edition of the instance. Valid values:\nBasic: specifies to use the Basic Edition.\nHighAvailability: specifies to use the High-availability Edition.\nAlwaysOn: specifies to use the Cluster Edition.\nFinance: specifies to use the Enterprise Edition.",
"AllowedValues": [
"Basic",
"HighAvailability",
"AlwaysOn",
"Finance"
]
},
"PrivateIpAddress": {
"Type": "String",
"Description": "The private ip for created instance."
},
"TargetDedicatedHostIdForSlave": {
"Type": "String",
"Description": "The ID of the host to which the instance belongs if you create a secondary instance in a host group."
},
"DBInstanceNetType": {
"Type": "String",
"Description": "Database instance net type, default is Intranet.Internet for public access, Intranet for private access.",
"AllowedValues": [
"Internet",
"Intranet"
],
"Default": "Intranet"
},
"ReleasedKeepPolicy": {
"Type": "String",
"Description": "The policy used to retain archived backups if the instance is released. Default value: None. \n Valid values: \nLastest: Only the last archived backup is retained. \n All: All of the archived backups are retained.",
"AllowedValues": [
"Lastest",
"All"
]
},
"DedicatedHostGroupId": {
"Type": "String",
"Description": "The ID of the host group to which the instance belongs if you create an instance in a host group."
},
"AutoRenew": {
"Type": "Boolean",
"Description": "Auto renew the prepay instance. If the period type is by year, it will renew by year, else it will renew by month.",
"AllowedValues": [
"True",
"true",
"False",
"false"
],
"Default": false
},
"EncryptionKey": {
"Type": "String",
"Description": "The ID of the encryption key that is used to encrypt data on SSDs in the region. You can view the encryption key ID in the Key Management Service (KMS) console. You can also create an encryption key."
},
"PreferredBackupPeriod": {
"Type": "CommaDelimitedList",
"Description": "The backup period. Separate multiple values with commas (,). The default value is the original value. Valid values:Monday Tuesday Wednesday Thursday Friday Saturday Sunday Note When the BackupPolicyMode parameter is set to DataBackupPolicy, this parameter is required."
},
"LogBackupLocalRetentionNumber": {
"Type": "Number",
"Description": "The number of log backup files that can be retained on the instance. \nDefault value: 60. Valid values: 6 to 100.",
"MinValue": 6,
"MaxValue": 100
},
"SlaveZoneIds": {
"Type": "Json",
"Description": "List of slave zone ids can specify slave zone ids when creating the high-availability or enterprise edition instance. Meanwhile, VSwitchId needs to pass in the corresponding vswitch id to the slave zone by order. For example, ZoneId = \"zone-a\" and SlaveZoneIds = [\"zone-c\", \"zone-b\"], then the VSwitchId must be \"vsw-zone-a,vsw-zone-c,vsw-zone-b\". Of course, you can also choose automatic allocation, for example, ZoneId = \"zone-a\" and SlaveZoneIds = [\"Auto\", \"Auto\"], then the VSwitchId must be \"vsw-zone-a,Auto,Auto\". The list contains up to 2 slave zone ids, separated by commas.",
"MaxLength": 2
},
"DBIsIgnoreCase": {
"Type": "Number",
"Description": "Specifies whether table names are case-sensitive. Valid values:\n1: Table names are not case-sensitive. This is the default value.\n0: Table names are case-sensitive."
},
"CommodityCode": {
"Type": "String",
"Description": "The CommodityCode of the order.",
"AllowedValues": [
"rds",
"bards",
"rords"
],
"Default": "rds"
},
"MaintainTime": {
"Type": "String",
"Description": "The period during which the maintenance performs. The format is HH:mmZ-HH:mmZ."
},
"DBParamGroupId": {
"Type": "String",
"Description": "The ID of the parameter template used by the instance."
},
"ZoneId": {
"Type": "String",
"Description": "selected zone to create database instance. You cannot set the ZoneId parameter if the MultiAZ parameter is set to true."
},
"TargetDedicatedHostIdForLog": {
"Type": "String",
"Description": "The ID of the host to which the instance belongs if you create a log instance in a host group."
},
"AllocatePublicConnection": {
"Type": "Boolean",
"Description": "If true, allocate public connection automate.",
"AllowedValues": [
"True",
"true",
"False",
"false"
]
},
"PreferredBackupTime": {
"Type": "String",
"Description": "The time when the backup task is performed. Format: yyyy-MM-ddZ-HH:mm:ssZ.Note When the BackupPolicyMode parameter is set to DataBackupPolicy, this parameter is required."
},
"SecurityGroupId": {
"Type": "String",
"Description": "The ID of the ECS security groups. \nEach RDS instance can be associated with up to three ECS security groups. \nYou must separate them with commas (,). \nTo delete an ECS Security group, leave this parameter empty. \n"
},
"Quantity": {
"Type": "Number",
"Description": "The number of instance to be created, default is 1, max number is 99",
"MinValue": 1,
"MaxValue": 99,
"Default": 1
},
"AutoPay": {
"Type": "Boolean",
"Description": "Automatic Payment. Default is false.",
"AllowedValues": [
"True",
"true",
"False",
"false"
],
"Default": true
},
"DBInstanceStorageType": {
"Type": "String",
"Description": "The storage type of the instance. Valid values:\nlocal_ssd: specifies to use local SSDs. This is the recommended storage type.\ncloud_ssd: specifies to use standard SSDs.\ncloud_essd: specifies to use enhanced SSDs."
},
"BackUpCategory": {
"Type": "String",
"Description": "Specifies whether to enable the second-level backup function. This function allows a backup \nto be completed within seconds. Valid values: \nFlash: specifies to enable the second-level backup function. \n Standard: specifies to disable the second-level backup function.",
"AllowedValues": [
"Flash",
"Standard"
]
},
"CompressType": {
"Type": "Number",
"Description": "The format used to compress backups. Valid values: \n 1: The zlib tool is used to compress backups into .tar.gz files. \n 4: The QuickLZ tool is used to compress backups into .xb.gz files. \nThis compression format is supported only when the instance runs MySQL 5.6 or 5.7. \nIt can be used to restore individual databases and tables. \n 8: The QuickLZ tool is used to compress backups into .xb.gz files. \n This compression format is supported only when the instance runs MySQL 8.0. \nIt cannot be used to restore individual databases or tables."
},
"LogBackupFrequency": {
"Type": "String",
"Description": "The frequency at which to back up logs. Valid values: \nThe value LogInterval specifies to back up logs every 30 minutes. \n The default value of this parameter is the same as the data backup frequency. \nNote The value LogInterval is supported only when the instance runs SQL Server."
},
"ConnectionStringType": {
"Type": "String",
"Description": "The endpoint type of the instance, allow values: Inner, Public",
"AllowedValues": [
"Inner",
"Public"
],
"Default": "Inner"
},
"CouponCode": {
"Type": "String",
"Description": "The coupon code of the order."
},
"MasterUserType": {
"Type": "String",
"Description": "Privilege type of account.\n Normal: Common privilege. \n Super: High privilege. \nSysadmin: Super privileges (SA) (only supported by SQL Server)\nThe default value is Normal.",
"AllowedValues": [
"Normal",
"Super",
"Sysadmin"
],
"Default": "Normal"
},
"EnableBackupLog": {
"Type": "Boolean",
"Description": "Specifies whether to enable the log backup function. Valid values: \nTrue: specifies to enable the log backup function. \nFalse: specifies to disable the log backup function. \nNote You must specify this parameter when the BackupPolicyMode parameter is set to LogBackupPolicy.",
"AllowedValues": [
"True",
"true",
"False",
"false"
]
},
"SQLCollectorStatus": {
"Type": "String",
"Description": "Specifies whether to enable or disable the SQL Explorer (SQL audit) feature. \nValid values:Enable | Disabled.",
"AllowedValues": [
"Enable",
"Disabled"
]
},
"BackupRetentionPeriod": {
"Type": "Number",
"Description": "The retention period of the data backup. Value range: 7 to 730. The default value is the original value. Note When the BackupPolicyMode parameter is set to LogBackupPolicy, this parameter is required.",
"Default": 7
}
},
"Resources": {
"PrepayDBInstance": {
"Type": "ALIYUN::RDS::PrepayDBInstance",
"Properties": {
"PeriodType": {
"Ref": "PeriodType"
},
"ResourceGroupId": {
"Ref": "ResourceGroupId"
},
"ArchiveBackupRetentionPeriod": {
"Ref": "ArchiveBackupRetentionPeriod"
},
"DBTimeZone": {
"Ref": "DBTimeZone"
},
"Port": {
"Ref": "Port"
},
"ArchiveBackupKeepCount": {
"Ref": "ArchiveBackupKeepCount"
},
"LogBackupRetentionPeriod": {
"Ref": "LogBackupRetentionPeriod"
},
"DBInstanceStorage": {
"Ref": "DBInstanceStorage"
},
"DBMappings": {
"Ref": "DBMappings"
},
"ConnectionStringPrefix": {
"Ref": "ConnectionStringPrefix"
},
"MultiAZ": {
"Ref": "MultiAZ"
},
"Engine": {
"Ref": "Engine"
},
"Tags": {
"Ref": "Tags"
},
"DBInstanceDescription": {
"Ref": "DBInstanceDescription"
},
"TargetDedicatedHostIdForMaster": {
"Ref": "TargetDedicatedHostIdForMaster"
},
"EngineVersion": {
"Ref": "EngineVersion"
},
"DBInstanceClass": {
"Ref": "DBInstanceClass"
},
"ArchiveBackupKeepPolicy": {
"Ref": "ArchiveBackupKeepPolicy"
},
"VSwitchId": {
"Ref": "VSwitchId"
},
"BackupPolicyMode": {
"Ref": "BackupPolicyMode"
},
"Period": {
"Ref": "Period"
},
"LocalLogRetentionHours": {
"Ref": "LocalLogRetentionHours"
},
"HighSpaceUsageProtection": {
"Ref": "HighSpaceUsageProtection"
},
"RoleARN": {
"Ref": "RoleARN"
},
"MasterUserPassword": {
"Ref": "MasterUserPassword"
},
"VpcId": {
"Ref": "VpcId"
},
"SSLSetting": {
"Ref": "SSLSetting"
},
"MasterUsername": {
"Ref": "MasterUsername"
},
"ConnectionMode": {
"Ref": "ConnectionMode"
},
"LocalLogRetentionSpace": {
"Ref": "LocalLogRetentionSpace"
},
"Category": {
"Ref": "Category"
},
"PrivateIpAddress": {
"Ref": "PrivateIpAddress"
},
"TargetDedicatedHostIdForSlave": {
"Ref": "TargetDedicatedHostIdForSlave"
},
"DBInstanceNetType": {
"Ref": "DBInstanceNetType"
},
"ReleasedKeepPolicy": {
"Ref": "ReleasedKeepPolicy"
},
"DedicatedHostGroupId": {
"Ref": "DedicatedHostGroupId"
},
"AutoRenew": {
"Ref": "AutoRenew"
},
"EncryptionKey": {
"Ref": "EncryptionKey"
},
"PreferredBackupPeriod": {
"Ref": "PreferredBackupPeriod"
},
"LogBackupLocalRetentionNumber": {
"Ref": "LogBackupLocalRetentionNumber"
},
"SlaveZoneIds": {
"Ref": "SlaveZoneIds"
},
"DBIsIgnoreCase": {
"Ref": "DBIsIgnoreCase"
},
"CommodityCode": {
"Ref": "CommodityCode"
},
"MaintainTime": {
"Ref": "MaintainTime"
},
"DBParamGroupId": {
"Ref": "DBParamGroupId"
},
"ZoneId": {
"Ref": "ZoneId"
},
"TargetDedicatedHostIdForLog": {
"Ref": "TargetDedicatedHostIdForLog"
},
"AllocatePublicConnection": {
"Ref": "AllocatePublicConnection"
},
"PreferredBackupTime": {
"Ref": "PreferredBackupTime"
},
"SecurityGroupId": {
"Ref": "SecurityGroupId"
},
"Quantity": {
"Ref": "Quantity"
},
"AutoPay": {
"Ref": "AutoPay"
},
"DBInstanceStorageType": {
"Ref": "DBInstanceStorageType"
},
"BackUpCategory": {
"Ref": "BackUpCategory"
},
"CompressType": {
"Ref": "CompressType"
},
"LogBackupFrequency": {
"Ref": "LogBackupFrequency"
},
"ConnectionStringType": {
"Ref": "ConnectionStringType"
},
"CouponCode": {
"Ref": "CouponCode"
},
"MasterUserType": {
"Ref": "MasterUserType"
},
"EnableBackupLog": {
"Ref": "EnableBackupLog"
},
"SQLCollectorStatus": {
"Ref": "SQLCollectorStatus"
},
"BackupRetentionPeriod": {
"Ref": "BackupRetentionPeriod"
}
}
}
},
"Outputs": {
"InnerConnectionString": {
"Description": "DB instance connection url by Intranet.",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"InnerConnectionString"
]
}
},
"DBInstanceId": {
"Description": "The instance id of created database instance.",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"DBInstanceId"
]
}
},
"InnerIPAddress": {
"Description": "IP Address for created DB instance of Intranet.",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"InnerIPAddress"
]
}
},
"PublicConnectionString": {
"Description": "DB instance connection url by Internet.",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"PublicConnectionString"
]
}
},
"PublicIPAddress": {
"Description": "IP Address for created DB instance of Internet.",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"PublicIPAddress"
]
}
},
"OrderId": {
"Description": "The order id list of created instance.",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"OrderId"
]
}
},
"PublicPort": {
"Description": "Internet port of created DB instance.",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"PublicPort"
]
}
},
"InnerPort": {
"Description": "Intranet port of created DB instance.",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"InnerPort"
]
}
}
}
}