ALIYUN::MONGODB::Instance - Create or clone MongoDB replica set | ROS - Resource Orchestration Service

Syntaxe

{
  "Type": "ALIYUN::MONGODB::Instance",
  "Properties": {
    "DatabaseNames": String,
    "VpcPasswordFree": Boolean,
    "ReadonlyReplicas": Integer,
    "BusinessInfo": String,
    "AccountPassword": String,
    "VpcId": String,
    "SecurityGroupId": String,
    "AutoRenew": Boolean,
    "ResourceGroupId": String,
    "VSwitchId": String,
    "StorageEngine": String,
    "SrcDBInstanceId": String,
    "ReplicationFactor": Integer,
    "ZoneId": String,
    "EngineVersion": String,
    "RestoreTime": String,
    "DBInstanceStorage": Integer,
    "DBInstanceDescription": String,
    "CouponNo": String,
    "Period": Integer,
    "SecurityIPArray": String,
    "ChargeType": String,
    "BackupId": String,
    "TDEStatus": Boolean,
    "DBInstanceClass": String,
    "Tags": List,
    "SecondaryZoneId": String,
    "HiddenZoneId": String,
    "StorageType": String,
    "PrivateConnections": Map,
    "ClusterId": String,
    "SrcRegion": String,
    "AuditPolicyOptions": Map,
    "DBInstanceReleaseProtection": Boolean,
    "SSLOptions": Map,
    "Encrypted": Boolean,
    "ProvisionedIops": Integer,
    "EncryptionKey": String,
    "RestoreType": Integer,
    "BackupPolicyOptions": Map
  }
}

Propriétés

Nom de la propriété	Type	Obligatoire	Mise à jour autorisée	Description	Contraintes
DBInstanceStorage	Integer	Oui	Oui	La capacité de stockage.	Valeurs valides : 10 à 3 000. La valeur doit être un multiple de 10. Unité : Go.
DBInstanceClass	String	Oui	Oui	Le type d'instance.	Types d'instances.
TDEStatus	Boolean	Non	Oui	Active le chiffrement transparent des données (TDE).	Valeurs valides : true : Active le TDE. Remarque Une fois activé, le TDE ne peut pas être désactivé. false (par défaut) : Désactive le TDE.
SrcDBInstanceId	String	Non	Non	L'ID de l'instance source.	Requis pour le clonage. À utiliser avec BackupId ou RestoreTime.
DBInstanceDescription	String	Non	Non	La description de l'instance.	2 à 256 caractères. Doit commencer par une lettre ou un caractère chinois. Les lettres, chiffres, caractères chinois, traits de soulignement (_) et tirets (-) sont autorisés.
SecurityIPArray	String	Non	Oui	La liste d'autorisation d'adresses IP.	Séparez les adresses par des virgules (,). Chaque adresse doit être unique. Maximum : 1 000. Formats : 0.0.0.0/0, 10,23.XX.XX (adresse IP) ou 10,23.XX.XX/24 (bloc CIDR, longueur du préfixe 1-32). Par défaut : 0.0.0.0/0 (toutes les adresses IP).
ClusterId	String	Non	Non	L'ID du cluster dédié.	Aucune
SrcRegion	String	Non	Non	La région de l'instance source.	Remarque Ce paramètre est requis lorsque RestoreType est défini sur 2 ou 3.
AuditPolicyOptions	Map	Non	Oui	La configuration de la politique d'audit.	Propriétés AuditPolicyOptions.
DBInstanceReleaseProtection	Boolean	Non	Oui	Active la protection contre la suppression.	Valeurs valides : true : Activé. false : Désactivé.
SSLOptions	Map	Non	Oui	La configuration du chiffrement TLS/SSL.	Propriétés SSLOptions.
Encrypted	Boolean	Non	Non	Active le chiffrement des disques.	Aucune
ProvisionedIops	Integer	Non	Non	Les IOPS provisionnés.	Aucune
EncryptionKey	String	Non	Non	La clé KMS pour le chiffrement des disques.	Aucune
RestoreType	Integer	Non	Non	Le type de restauration de l'instance.	Valeurs valides : 0 : Restaure l'instance à partir d'un jeu de sauvegarde spécifié. 1 : Restaure l'instance à un instant précis spécifié. 2 : Restaure une instance supprimée à partir d'un jeu de sauvegarde spécifié. 3 : Restaure l'instance à partir d'un jeu de sauvegarde géo-redondant spécifié.
BackupPolicyOptions	Map	Non	Oui	La configuration de la politique de sauvegarde.	Propriétés BackupPolicyOptions.
ZoneId	String	Non	Non	L'ID de la zone.	Pour plus d'informations, consultez DescribeRegions. Si l'instance se trouve dans un VPC, la valeur de ce paramètre doit correspondre à la zone du vSwitch.
VpcPasswordFree	Boolean	Non	Non	Active l'accès sans mot de passe via un VPC.	Valeurs valides : true : Active l'accès sans mot de passe. false : Désactive l'accès sans mot de passe.
VpcId	String	Non	Non	L'ID du VPC.	Aucune
SecurityGroupId	String	Non	Oui	L'ID du groupe de sécurité.	Aucune
VSwitchId	String	Non	Non	L'ID du vSwitch.	Aucune
BackupId	String	Non	Non	L'ID du jeu de sauvegarde.	Requis pour le clonage. À utiliser avec SrcDBInstanceId.
AccountPassword	String	Non	Oui	Le mot de passe du compte root.	6 à 32 caractères. Lettres, chiffres et ces caractères spéciaux sont autorisés : `!#$%^&*()_+-=`.
EngineVersion	String	Non	Non	La version du moteur de base de données.	Valeurs valides : 3.4 (par défaut) 4.0 4.2 4,4 5,0
StorageEngine	String	Non	Non	Le moteur de stockage.	Versions et moteurs de stockage. Valeurs valides : WiredTiger (par défaut) : Convient à la plupart des scénarios. RocksDB : Adapté aux scénarios comportant de nombreuses écritures et peu de lectures. TerarkDB : Adapté aux scénarios où les lectures sont plus nombreuses que les écritures, ou aux scénarios impliquant des écritures par lots et de nombreuses lectures.
ReplicationFactor	Integer	Non	Oui	Le nombre de nœuds dans l'ensemble de réplicas.	Valeurs valides : 3 (par défaut) 5 7
DatabaseNames	String	Non	Non	Le nom de la base de données.	Aucune
ReadonlyReplicas	Integer	Non	Oui	Le nombre de nœuds en lecture seule.	Valeurs valides : 1 à 5.
BusinessInfo	String	Non	Non	Les informations commerciales.	Il s'agit d'un paramètre supplémentaire.
ResourceGroupId	String	Non	Oui	L'ID du groupe de ressources.	Aucune
AutoRenew	Boolean	Non	Non	Active le renouvellement automatique.	Valeurs valides : true : Active le renouvellement automatique. false (par défaut) : La ressource nécessite un renouvellement manuel.
RestoreTime	String	Non	Non	Le point de restauration pour le clonage.	Format : yyyy-MM-ddTHH:mm:ssZ (UTC). Requis pour le clonage. À utiliser avec SrcDBInstanceId et BackupId. Prend en charge les points de restauration des 7 derniers jours.
CouponNo	String	Non	Non	Le code du coupon.	Par défaut : youhuiquan_promotion_option_id_for_blank.
Period	Integer	Non	Oui	La durée de l'abonnement.	Unité : mois. Valeurs valides : 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24 et 36. La valeur par défaut est 1. S'applique uniquement lorsque ChargeType est PrePaid.
ChargeType	String	Non	Oui	La méthode de facturation.	Valeurs valides : PostPaid : Paiement à l'utilisation. PrePaid : Abonnement.
Tags	List	Non	Oui	Les tags.	Vous pouvez ajouter jusqu'à 20 tags. Propriétés Tags.
SecondaryZoneId	String	Non	Non	La zone où le nœud secondaire est déployé.	Valeurs valides : cn-hangzhou-g : Hangzhou Zone G. cn-hangzhou-h : Hangzhou Zone H. cn-hangzhou-i : Hangzhou Zone I. cn-hongkong-b : Hong Kong (Chine) Zone B. cn-hongkong-c : Hong Kong (Chine) Zone C. cn-hongkong-d : Hong Kong (Chine) Zone D. cn-wulanchabu-a : Ulanqab Zone A. cn-wulanchabu-b : Ulanqab Zone B. cn-wulanchabu-c : Ulanqab Zone C. ap-southeast-1a : Singapour Zone A. ap-southeast-1b : Singapour Zone B. ap-southeast-1c : Singapour Zone C. ap-southeast-5a : Jakarta Zone A. ap-southeast-5b : Jakarta Zone B. ap-southeast-5c : Jakarta Zone C. eu-central-1a : Francfort Zone A. eu-central-1b : Francfort Zone B. eu-central-1c : Francfort Zone C. Remarque Ce paramètre est disponible et requis lorsque EngineVersion est défini sur 4,4 ou 5,0. La valeur de ce paramètre ne peut pas être identique à celle de ZoneId ou HiddenZoneId.
HiddenZoneId	String	Non	Non	La zone où le nœud caché est déployé.	Valeurs valides : cn-hangzhou-g : Hangzhou Zone G. cn-hangzhou-h : Hangzhou Zone H. cn-hangzhou-i : Hangzhou Zone I. cn-hongkong-b : Hong Kong (Chine) Zone B. cn-hongkong-c : Hong Kong (Chine) Zone C. cn-hongkong-d : Hong Kong (Chine) Zone D. cn-wulanchabu-a : Ulanqab Zone A. cn-wulanchabu-b : Ulanqab Zone B. cn-wulanchabu-c : Ulanqab Zone C. ap-southeast-1a : Singapour Zone A. ap-southeast-1b : Singapour Zone B. ap-southeast-1c : Singapour Zone C. ap-southeast-5a : Jakarta Zone A. ap-southeast-5b : Jakarta Zone B. ap-southeast-5c : Jakarta Zone C. eu-central-1a : Francfort Zone A. eu-central-1b : Francfort Zone B. eu-central-1c : Francfort Zone C. Remarque Ce paramètre est disponible et requis lorsque EngineVersion est défini sur 4,4 ou 5,0. La valeur de ce paramètre ne peut pas être identique à celle de ZoneId ou SecondaryZoneId.
StorageType	String	Non	Non	La classe de stockage.	Valeurs valides : cloud_essd1 : PL1 ESSD. cloud_essd2 : PL2 ESSD. cloud_essd3 : PL3 ESSD. local_ssd : SSD local.
PrivateConnections	Map	Non	Oui	Les configurations de la connexion privée.	Propriétés PrivateConnections.

Syntaxe Tags

"Tags": [
  {
    "Key": String,
    "Value": String
  }
]

Propriétés Tags

Nom de la propriété	Type	Obligatoire	Mise à jour autorisée	Description	Contraintes
Key	String	Oui	Non	La clé du tag.	La clé doit comporter entre 1 et 128 caractères. Elle ne peut pas commencer par `aliyun` ou `acs:` et ne peut pas contenir `http://` ou `https://`.
Value	String	Non	Non	La valeur du tag.	La valeur doit comporter entre 0 et 128 caractères. Elle ne peut pas commencer par `aliyun` ou `acs:` et ne peut pas contenir `http://` ou `https://`.

Syntaxe PrivateConnections

"PrivateConnections": 
  {
    "ReplicaConnections": List
  }

Propriétés PrivateConnections

Nom de la propriété

Type

Obligatoire

Mise à jour autorisée

Description

Contraintes

ReplicaConnections

List

Oui

Les informations de connexion des nœuds de réplica.

Longueur : 1 à 6.

Remarque

Vous pouvez créer ou modifier les informations de connexion d'un nœud uniquement dans le même ordre que celui renvoyé par l'opération DescribeDBInstanceAttribute.

Propriétés ReplicaConnections.

Syntaxe AuditPolicyOptions

"AuditPolicyOptions": 
  {
    "StoragePeriod": Integer,
    "AuditStatus": String,
    "AuditLogSwitchSource": String,
    "ServiceType": String
  }

Propriétés AuditPolicyOptions

Nom de la propriété	Type	Obligatoire	Mise à jour autorisée	Description	Contraintes
AuditStatus	String	Oui	Oui	Le statut du journal d'audit.	Valeurs valides : enable : Active le journal d'audit. disabled : Désactive le journal d'audit.
StoragePeriod	Integer	Non	Oui	La période de rétention des journaux d'audit.	Valeurs valides : 1 à 365. La valeur par défaut est 30. Unité : jours.
AuditLogSwitchSource	String	Non	Oui	La source de la demande de journal d'audit.	La valeur est Console.
ServiceType	String	Non	Oui	La version du journal d'audit.	Valeurs valides : Trial : Version d'essai gratuite. Standard : Version officielle. Remarque Par défaut : Trial. Depuis le 6 janvier 2022, l'édition officielle est disponible dans diverses régions et l'essai gratuit n'est plus proposé. Définissez cette valeur sur Standard.

Syntaxe SSLOptions

"SSLOptions": 
  {
    "ForceEncryption": Integer,
    "SwitchMode": Integer,
    "SSLAction": String
  }

Propriétés SSLOptions

Nom de la propriété	Type	Obligatoire	Mise à jour autorisée	Description	Contraintes
SSLAction	String	Oui	Oui	L'opération à effectuer sur la fonctionnalité SSL.	Valeurs valides : Open : Active le chiffrement SSL. Close : Désactive le chiffrement SSL. Update : Met à jour le certificat SSL.
ForceEncryption	Integer	Non	Oui	Active le chiffrement SSL forcé pour les connexions.	Valeurs valides : 1 : Force le chiffrement SSL. 0 : Ne force pas le chiffrement SSL.
SwitchMode	Integer	Non	Oui	Le moment d'application des modifications de configuration SSL.	Valeurs valides : 0 : Appliquer immédiatement. 1 : Appliquer pendant la fenêtre de maintenance.

Syntaxe BackupPolicyOptions

"SSLOptions": 
  {
    "CrossBackupType": String,
    "BackupInterval": Integer,
    "BackupRetentionPolicyOnClusterDeletion": Integer,
    "HighFrequencyBackupRetention": Integer,
    "BackupRetentionPeriod": Integer,
    "InstanceType": String,
    "LogBackupRetentionPeriod": Integer,
    "CrossRetentionValue": Integer,
    "CrossBackupPeriod": String,
    "PreferredBackupTime": String,
    "DestRegion": String,
    "CrossRetentionType": String,
    "EnableCrossLogBackup": Integer,
    "PreferredBackupPeriod": String,
    "PreserveOneEachHour": Boolean,
    "SnapshotBackupType": String,
    "CrossLogRetentionType": String,
    "CrossLogRetentionValue": Integer,
    "EnableBackupLog": Integer,
    "SrcRegion": String
  }

Propriétés BackupPolicyOptions

Nom de la propriété	Type	Obligatoire	Mise à jour autorisée	Description	Contraintes
CrossBackupType	String	Non	Oui	La politique de redondance géographique.	Valeurs valides : update : Modifie la politique de redondance géographique. delete : Supprime la politique de redondance géographique.
BackupInterval	Integer	Non	Oui	La fréquence des sauvegardes haute fréquence.	Valeurs valides : -1 : Désactive la sauvegarde haute fréquence. 30 : Toutes les 30 minutes. 60 : Toutes les heures. 120 : Toutes les 2 heures. 180 : Toutes les 3 heures. 240 : Toutes les 4 heures. 360 : Toutes les 6 heures. 480 : Toutes les 8 heures. 720 : Toutes les 12 heures.
BackupRetentionPolicyOnClusterDeletion	Integer	Non	Oui	Politique de rétention des sauvegardes.	Valeurs valides : 0 : Supprime immédiatement tous les jeux de sauvegarde de l'instance lors de sa suppression. 1 : Crée automatiquement une sauvegarde lors de la suppression de l'instance et conserve le jeu de sauvegarde à long terme. 2 : Crée automatiquement une sauvegarde lors de la suppression de l'instance et conserve tous les jeux de sauvegarde du cluster à long terme. Sauvegardes conservées à long terme.
HighFrequencyBackupRetention	Integer	Non	Oui	La période de rétention des sauvegardes haute fréquence.	Avant d'utiliser ce paramètre, assurez-vous que le paramètre BackupInterval est spécifié. La période de rétention par défaut est d'un jour. Unité : jours.
BackupRetentionPeriod	Integer	Non	Oui	La période de rétention des sauvegardes complètes.	Remarque Pour les utilisateurs ayant créé leur compte avant le 10 septembre 2021, la période de rétention par défaut est de 7 jours. Si votre instance est créée après le 10 septembre 2021, les sauvegardes sont conservées par défaut pendant 30 jours.
InstanceType	String	Non	Oui	Le type d'instance.	Valeurs valides : replicate sharding Remarque Ce paramètre est requis lors de la restauration d'une instance supprimée. Ce paramètre est requis lors du clonage d'une instance à partir d'une sauvegarde géo-redondante.
LogBackupRetentionPeriod	Integer	Non	Oui	La période de rétention des sauvegardes de journaux.	La valeur par défaut est 7. Valeurs valides : 7 à 730. Unité : jours.
CrossRetentionValue	Integer	Non	Oui	La période de rétention des sauvegardes géo-redondantes.	Valeurs valides : 3 à 1 825. Unité : jours. Remarque Ce paramètre est requis pour les sauvegardes géo-redondantes. Ce paramètre est requis et prend effet uniquement lorsque CrossRetentionType est défini sur delay.
CrossBackupPeriod	String	Non	Oui	Période de rétention de la redondance géographique	Valeurs valides : Lundi Mardi Mercredi Jeudi Vendredi Samedi Dimanche Remarque Ce paramètre est requis pour les sauvegardes géo-redondantes. Séparez plusieurs valeurs par des virgules (,). Si vous configurez une politique de sauvegarde régulière, les jours spécifiés pour ce paramètre doivent être un sous-ensemble des jours spécifiés pour le paramètre PreferredBackupPeriod.
PreferredBackupTime	String	Non	Oui	L'heure d'exécution de la sauvegarde.	Spécifiez l'heure au format HH:mmZ-HH:mmZ. L'heure doit être en UTC. Remarque La plage horaire doit être d'une heure.
DestRegion	String	Non	Oui	La région où la sauvegarde est stockée.	Remarque Ce paramètre est requis pour les sauvegardes géo-redondantes.
CrossRetentionType	String	Non	Oui	La politique de rétention des sauvegardes géo-redondantes.	Remarque delay : Conserve pendant une période donnée. never : N'expire jamais.
EnableCrossLogBackup	Integer	Non	Oui	Active la sauvegarde des journaux inter-régions.	Remarque Ce paramètre est requis pour les sauvegardes géo-redondantes. 1 : Activer. Cette valeur est requise pour les instances de cluster fragmenté. Pour les instances d'ensemble de réplicas, cette valeur est requise si vous souhaitez activer la récupération à un instant précis entre les régions. 0 : Désactiver.
PreferredBackupPeriod	String	Non	Oui	Le cycle de sauvegarde.	Valeurs valides : Lundi. Mardi Mercredi Jeudi Vendredi : Vendredi. Samedi. Dimanche Remarque Séparez plusieurs valeurs par des virgules (,).
PreserveOneEachHour	Boolean	Non	Oui	Active la sauvegarde clairsemée horaire.	Valeurs valides : true : Si la fréquence de sauvegarde est mesurée en minutes, tous les instantanés créés au cours de la dernière heure sont conservés. Pour les instantanés créés il y a plus d'une heure mais au cours des dernières 24 heures, seul le premier instantané créé après l'heure pleine est conservé. false : Tous les instantanés sont conservés pendant la période de rétention des sauvegardes haute fréquence.
SnapshotBackupType	String	Non	Oui	Le type de sauvegarde par instantané.	Valeurs valides : Flash : Sauvegarde en quelques secondes. Standard : Sauvegarde régulière (par défaut).
CrossLogRetentionType	String	Non	Oui	La politique de rétention des sauvegardes de journaux inter-régions.	Valeurs valides : delay : Conserve pendant une période donnée. never : N'expire jamais.
CrossLogRetentionValue	Integer	Non	Oui	La période de rétention des sauvegardes de journaux inter-régions.	Valeurs valides : 3 à 1 825. La valeur doit être inférieure ou égale à la valeur de CrossRetentionValue. Unité : jours.
EnableBackupLog	Integer	Non	Oui	Active la sauvegarde des journaux.	Valeurs valides : 0 : Désactiver (par défaut). 1 : Activer.
SrcRegion	String	Non	Oui	La région de l'instance.	Remarque Ce paramètre est requis pour restaurer une instance supprimée. Ce paramètre est requis pour les sauvegardes géo-redondantes.

Syntaxe ReplicaConnections

{
  "PrivateConnections": {
    "ReplicaConnections": [
      {
        "ConnectionString": String,
        "ConnectionPort": Integer
      }
    ]
  }
}

Propriétés ReplicaConnections

Nom de la propriété	Type	Obligatoire	Mise à jour autorisée	Description	Contraintes
ConnectionString	String	Oui	Oui	Le préfixe de l'adresse de connexion	Le préfixe doit commencer par une lettre minuscule et se terminer par une lettre minuscule ou un chiffre. Il doit être composé de lettres minuscules, de chiffres et de tirets (-). Sa longueur doit être comprise entre 8 et 63 caractères. Remarque Spécifiez uniquement le préfixe du point de terminaison. Le reste du point de terminaison ne peut pas être modifié. Vous pouvez modifier les points de terminaison des nœuds primaires, secondaires et en lecture seule pour les instances utilisant des SSD locaux ou des ESSD.
ConnectionPort	Integer	Non	Oui	Le port de connexion.	Valeurs valides : 1 000 à 65 535. Remarque Vous pouvez modifier le port uniquement pour une instance exécutant MongoDB 4.2 ou version ultérieure et utilisant des ESSD.

Valeurs de retour

Fn::GetAtt

OrderId : L'ID de la commande utilisée pour créer l'instance MongoDB.
DBInstanceId : L'ID de l'instance MongoDB. L'ID est globalement unique.
DBInstanceStatus : Le statut de l'instance MongoDB.
ConnectionURI : L'URI de connexion.
ReplicaSetName : Le nom de l'ensemble de réplicas.
Arn : Le nom de ressource Alibaba Cloud (ARN) de l'instance.

Exemples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Description: Test MONGODB Instance
Parameters:
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
  ZoneId:
    Type: String
    AssociationProperty: ALIYUN::ECS::ZoneId
  VSwitchId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      ZoneId: ${ZoneId}
      VpcId: ${VpcId}
Resources:
  MongoDB:
    Type: ALIYUN::MONGODB::Instance
    Properties:
      DBInstanceClass: dds.mongo.mid
      DBInstanceStorage: 10
      ZoneId:
        Ref: ZoneId
      VpcId:
        Ref: VpcId
      VSwitchId:
        Ref: VSwitchId
Outputs: {}

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": "Test MONGODB Instance",
  "Parameters": {
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
    },
    "ZoneId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::ZoneId"
    },
    "VSwitchId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "ZoneId": "${ZoneId}",
        "VpcId": "${VpcId}"
      }
    }
  },
  "Resources": {
    "MongoDB": {
      "Type": "ALIYUN::MONGODB::Instance",
      "Properties": {
        "DBInstanceClass": "dds.mongo.mid",
        "DBInstanceStorage": 10,
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "VpcId": {
          "Ref": "VpcId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        }
      }
    }
  },
  "Outputs": {
  }
}

Exemple YAML sur GitHub.