Resource Orchestration Service (ROS) integration example - ApsaraDB RDS

Vous pouvez utiliser les modèles du service Alibaba Cloud Resource Orchestration Service (ROS) pour définir vos ressources cloud et leurs dépendances. Le moteur d'orchestration ROS crée et configure automatiquement toutes les ressources en fonction du modèle, ce qui permet d'automatiser le déploiement et les opérations. Cette rubrique explique comment utiliser ROS pour interroger les informations relatives à une instance ApsaraDB for RDS.

Ressources prises en charge

ROS simplifie la gestion des ressources cloud. Vous créez des modèles pour définir les ressources Alibaba Cloud, telles que les instances ECS et ApsaraDB for RDS, ainsi que leurs dépendances. Le moteur d'orchestration ROS utilise ensuite le modèle pour créer, configurer et déployer automatiquement les ressources. Pour plus d'informations, consultez la rubrique Qu'est-ce que Resource Orchestration Service ?.

Vous pouvez utiliser ROS pour orchestrer ApsaraDB for RDS. Ces opérations impliquent deux types d'éléments : les ressources et les sources de données.

Ressources :
- ALIYUN::RDS::Account : crée un compte pour gérer une base de données.
- ALIYUN::RDS::AccountPrivilege : accorde des autorisations à un compte pour accéder à une base de données.
- ALIYUN::RDS::ADInfo : configure le service de domaine AD.
- ALIYUN::RDS::Connection : crée un endpoint public.
- ALIYUN::RDS::Database : crée une base de données dans une instance.
- ALIYUN::RDS::DBInstance : crée une instance ApsaraDB for RDS.
- ALIYUN::RDS::DBInstanceParameterGroup : modifie les paramètres d'une instance ApsaraDB for RDS.
- ALIYUN::RDS::DBInstanceSecurityIps : modifie la liste d'autorisation IP d'une instance.
- ALIYUN::RDS::DBInstanceClone : restaure les données à partir d'un point dans le temps vers une nouvelle instance clone.
- ALIYUN::RDS::MigrateTask : restaure un fichier de sauvegarde depuis OSS vers une instance ApsaraDB for RDS for SQL Server, permettant la migration des données vers le cloud.
- ALIYUN::RDS::PostgresExtensions : installe les extensions spécifiées dans la base de données de destination.
- ALIYUN::RDS::PrepayDBInstance : crée une instance de base de données par abonnement.
- ALIYUN::RDS::ReadOnlyDBInstance : crée une instance en lecture seule.
Sources de données :
- DATASOURCE::RDS::Accounts : interroge les informations relatives aux comptes d'une instance.
- DATASOURCE::RDS::DBInstance : interroge les informations relatives à une instance ApsaraDB for RDS.
- DATASOURCE::RDS::Databases : interroge les informations relatives aux bases de données d'une instance ApsaraDB for RDS.
- DATASOURCE::RDS::DBInstances : interroge la liste des instances ApsaraDB for RDS.
- DATASOURCE::RDS::Zones : interroge les ressources ApsaraDB for RDS dans une zone spécifiée.

Configurer les permissions

Pour des raisons de sécurité, n'utilisez pas votre compte Alibaba Cloud pour accéder à ApsaraDB for RDS. Créez plutôt un utilisateur RAM, obtenez sa paire AccessKey et accordez-lui les permissions requises.

Créez un utilisateur RAM :
1. Accédez à la page RAM Users et cliquez sur Create User.
2. Définissez Logon Name sur rds-test-operator et sélectionnez Programmatic Access pour Access Method.
3. Cliquez sur OK pour créer l'utilisateur RAM.
Accordez des permissions à l'utilisateur RAM :
1. Accédez à la page RAM Users. Recherchez l'utilisateur RAM et cliquez sur Add Permissions dans la colonne Actions.
2. Ajoutez les stratégies de permission suivantes à l'utilisateur RAM :
  - AliyunRDSFullAccess : accorde des permissions pour interroger et modifier les instances ApsaraDB for RDS.
    
    Remarque
    Vous pouvez également sélectionner AliyunRDSReadOnlyAccess pour obtenir des permissions en lecture seule sur les instances ApsaraDB for RDS, ou créer une stratégie personnalisée en fonction de vos besoins métier. Pour plus d'informations, consultez la rubrique Créer une stratégie de permission personnalisée.
  - AliyunROSFullAccess : accorde des permissions pour gérer toutes les opérations ROS.
3. Cliquez sur OK pour accorder les permissions.

Procédure

Instructions

Lisez le texte en anglais pour comprendre CE qui doit être communiqué
Rédigez le français À PARTIR DE ZÉRO — oubliez la structure de phrase anglaise
Conservez exactement tout le formatage Markdown, les blocs de code, les liens et les images
Balises xref (<a data-tag="xref" ...>texte</a>) — conservez la balise ENTIÈRE avec tous ses attributs dans l'ordre et la casse d'origine, traduisez UNIQUEMENT le texte visible entre > et
Appliquez strictement toutes les règles linguistiques spécifiques
Appliquez les règles relatives aux mots interdits avec une tolérance zéro
Utilisez le mode impératif dans les étapes numérotées et les listes à puces procédurales
Assurez la cohérence terminologique — un même terme doit avoir la même traduction partout
Variez les débuts de phrase dans les listes et les tableaux — aucun début ne doit être répété plus de 2 fois

Renvoyez UNIQUEMENT le document Markdown en français, sans explication

Connectez-vous à la console Resource Orchestration Service (ROS).
Dans la barre de navigation supérieure, sélectionnez une région.
Dans le volet de navigation de gauche, choisissez Stack. Sur la page qui s'affiche, cliquez sur Create Stack.

Spécifiez un modèle et cliquez sur Next.

Cette rubrique explique comment utiliser un modèle personnalisé pour interroger les informations relatives à une instance ApsaraDB RDS. Pour plus d'informations sur l'utilisation des modèles, consultez la rubrique Créer une pile.

Dans la section Specify Template, sélectionnez Select an Existing Template.
Définissez la valeur du paramètre Template Import Method sur Enter Template Content.

Dans la section Template Content, sélectionnez ROS et saisissez le code du modèle.

Le modèle suivant illustre l'utilisation de la source de données DATASOURCE::RDS::DBInstance pour interroger les informations d'une instance ApsaraDB RDS. Vous pouvez utiliser ce modèle au format JSON ou YAML. Pour plus d'informations, consultez la rubrique DATASOURCE::RDS::DBInstance.

Format JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBInstanceId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the instance."
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::RDS::DBInstance",
      "Properties": {
        "DBInstanceId": {
          "Ref": "DBInstanceId"
        }
      }
    }
  },
  "Outputs": {
    "DBInstanceMemory": {
      "Description": "The memory capacity of the instance. Unit: MB.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceMemory"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The resource group ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "IncrementSourceDBInstanceId": {
      "Description": "The ID of the instance from which incremental data comes. The incremental data of a disaster recovery instance or read-only instance comes from its primary instance. If this parameter is not returned, the instance is a primary instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IncrementSourceDBInstanceId"
        ]
      }
    },
    "MasterZone": {
      "Description": "The zone ID of the primary instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MasterZone"
        ]
      }
    },
    "Port": {
      "Description": "The port that is used to connect to the instance over an internal network.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Port"
        ]
      }
    },
    "LatestKernelVersion": {
      "Description": "The latest minor engine version that is supported by the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LatestKernelVersion"
        ]
      }
    },
    "ConsoleVersion": {
      "Description": "The type of the proxy that is used by the instance. Valid values:\n1: shared proxy\n2: dedicated proxy",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ConsoleVersion"
        ]
      }
    },
    "DBInstanceType": {
      "Description": "The type of the instance. Valid values:\nPrimary: primary instance\nReadonly: read-only instance\nGuard: disaster recovery instance\nTemp: temporary instance",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceType"
        ]
      }
    },
    "GeneralGroupName": {
      "Description": "The name of the dedicated cluster to which the instance belongs. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GeneralGroupName"
        ]
      }
    },
    "InstanceNetworkType": {
      "Description": "The network type of the instance. Valid values:\nClassic\nVPC",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceNetworkType"
        ]
      }
    },
    "DBInstanceClassType": {
      "Description": "The instance family to which the instance belongs. Valid values:\ns: shared instance family\nx: general-purpose instance family\nd: dedicated instance family\nh: dedicated host instance family",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceClassType"
        ]
      }
    },
    "AutoUpgradeMinorVersion": {
      "Description": "The method that is used to update the minor engine version of the instance. Valid values:\nAuto: automatic update.\nManual: manual update. The minor engine version of the instance is forcefully updated only when the minor engine version in use is phased out.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AutoUpgradeMinorVersion"
        ]
      }
    },
    "DBInstanceId": {
      "Description": "The instance ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceId"
        ]
      }
    },
    "DBInstanceStorage": {
      "Description": "The storage capacity of the instance. Unit: GB.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceStorage"
        ]
      }
    },
    "PGBouncerEnabled": {
      "Description": "Indicates whether PgBouncer is enabled.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PGBouncerEnabled"
        ]
      }
    },
    "InstructionSetArch": {
      "Description": "The architecture type of the instance. Valid values:\nx86\narm",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstructionSetArch"
        ]
      }
    },
    "LockReason": {
      "Description": "The reason why the instance was locked.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LockReason"
        ]
      }
    },
    "AvailabilityValue": {
      "Description": "The availability of the instance as a percentage.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AvailabilityValue"
        ]
      }
    },
    "Engine": {
      "Description": "The database engine of the instance. Valid values:\nMySQL\nPostgreSQL\nSQLServer\nMariaDB",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Engine"
        ]
      }
    },
    "DBInstanceDescription": {
      "Description": "The description of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceDescription"
        ]
      }
    },
    "IPType": {
      "Description": "The type of the IP address. Only IPv4 addresses are supported.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IPType"
        ]
      }
    },
    "MaxIOMBPS": {
      "Description": "The maximum I/O throughput. Unit: MB/s.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MaxIOMBPS"
        ]
      }
    },
    "DBInstanceDiskUsed": {
      "Description": "The disk usage of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceDiskUsed"
        ]
      }
    },
    "EngineVersion": {
      "Description": "The database engine version.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EngineVersion"
        ]
      }
    },
    "MaxConnections": {
      "Description": "The maximum number of concurrent connections.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MaxConnections"
        ]
      }
    },
    "DBInstanceStatus": {
      "Description": "The status of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceStatus"
        ]
      }
    },
    "DBInstanceClass": {
      "Description": "The instance type of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceClass"
        ]
      }
    },
    "AccountMaxQuantity": {
      "Description": "The maximum number of accounts that can be created on the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AccountMaxQuantity"
        ]
      }
    },
    "VSwitchId": {
      "Description": "The vSwitch ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VSwitchId"
        ]
      }
    },
    "TipsLevel": {
      "Description": "The severity level of the exception that is detected on the instance. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition. Valid values:\n1: The instance is normal.\n2: The specifications of the read-only instances do not match the specifications of the primary instance. You must adjust the specifications of these instances based on your business requirements.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TipsLevel"
        ]
      }
    },
    "LockMode": {
      "Description": "The lock mode of the instance. Valid values:\nUnlock: The instance is not locked.\nManualLock: The instance is manually locked.\nLockByExpiration: The instance is automatically locked due to instance expiration.\nLockByRestoration: The instance is automatically locked due to instance restoration.\nLockByDiskQuota: The instance is automatically locked due to exhausted storage space.\nLockReadInstanceByDiskQuota: The read-only instance is automatically locked due to exhausted storage.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LockMode"
        ]
      }
    },
    "DeletionProtection": {
      "Description": "Indicates whether the release protection feature is enabled. Valid values:\ntrue\nfalse",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DeletionProtection"
        ]
      }
    },
    "PayType": {
      "Description": "The billing method of the instance. Valid values:\nPostpaid: pay-as-you-go\nPrepaid: subscription",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PayType"
        ]
      }
    },
    "GuardDBInstanceId": {
      "Description": "The ID of the disaster recovery instance that is attached to the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GuardDBInstanceId"
        ]
      }
    },
    "DBClusterNodes": {
      "Description": "The information about the node in the cluster.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBClusterNodes"
        ]
      }
    },
    "TimeZone": {
      "Description": "The time zone of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TimeZone"
        ]
      }
    },
    "VpcId": {
      "Description": "The virtual private cloud (VPC) ID of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcId"
        ]
      }
    },
    "MasterInstanceId": {
      "Description": "The ID of the primary instance.\nNote: If this parameter is not returned, the instance is the primary instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MasterInstanceId"
        ]
      }
    },
    "CurrentKernelVersion": {
      "Description": "The minor engine version of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CurrentKernelVersion"
        ]
      }
    },
    "CreationTime": {
      "Description": "The creation time. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreationTime"
        ]
      }
    },
    "ConnectionMode": {
      "Description": "The connection mode of the instance. Valid values:\nStandard: standard mode\nSafe: database proxy mode",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ConnectionMode"
        ]
      }
    },
    "VpcCloudInstanceId": {
      "Description": "The virtual private cloud (VPC) ID of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcCloudInstanceId"
        ]
      }
    },
    "ReadonlyInstanceSQLDelayedTime": {
      "Description": "The data replication latency from the primary instance to read-only instances, in seconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReadonlyInstanceSQLDelayedTime"
        ]
      }
    },
    "ProxyType": {
      "Description": "The type of the proxy that is supported by the instance. Valid values:\n0: The instance does not support database proxies.\n1: The instance supports shared proxies, with which the instance runs in multi-tenant mode.\n2: The instance supports dedicated proxies, with which the instance runs in single-tenant mode.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ProxyType"
        ]
      }
    },
    "ConnectionString": {
      "Description": "The internal endpoint of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ConnectionString"
        ]
      }
    },
    "ExpireTime": {
      "Description": "The expiration time. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.\nNote: Pay-as-you-go instances never expire.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExpireTime"
        ]
      }
    },
    "AdvancedFeatures": {
      "Description": "The advanced features that are enabled for the instance. If multiple advanced features are enabled, the advanced features are separated by commas (,). This parameter is available only to instances that run SQL Server. Valid values:\nLinkedServer\nDistributeTransaction",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AdvancedFeatures"
        ]
      }
    },
    "DBMaxQuantity": {
      "Description": "The maximum number of databases that can be created on the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBMaxQuantity"
        ]
      }
    },
    "Category": {
      "Description": "The RDS edition of the instance. Valid values:\nBasic: RDS Basic Edition\nHighAvailability: RDS High-availability Edition\ncluster: RDS Cluster Edition for ApsaraDB RDS for MySQL\nAlwaysOn: RDS Cluster Edition for ApsaraDB RDS for SQL Server\nFinance: RDS Enterprise Edition\nServerless_basic: RDS Basic Edition for serverless instances",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Category"
        ]
      }
    },
    "SuperPermissionMode": {
      "Description": "Indicates whether the instance supports superuser accounts, such as the system administrator (SA) account, the Active Directory (AD) account, and the host account.\nEnable\nDisabled",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SuperPermissionMode"
        ]
      }
    },
    "DBInstanceNetType": {
      "Description": "The type of the network over which the instance is connected. Valid values:\nInternet: Internet\nIntranet: internal network",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceNetType"
        ]
      }
    },
    "DedicatedHostGroupId": {
      "Description": "The ID of the dedicated cluster.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DedicatedHostGroupId"
        ]
      }
    },
    "TempDBInstanceId": {
      "Description": "The ID of the temporary instance that is attached to the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TempDBInstanceId"
        ]
      }
    },
    "DBInstanceCPU": {
      "Description": "The number of CPU cores.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceCPU"
        ]
      }
    },
    "SecurityIPList": {
      "Description": "The IP addresses in the IP address whitelist.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecurityIPList"
        ]
      }
    },
    "ReadOnlyDBInstanceIds": {
      "Description": "The IDs of the read-only instances that are attached to the primary instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReadOnlyDBInstanceIds"
        ]
      }
    },
    "SecurityIPMode": {
      "Description": "The whitelist mode of the instance. Valid values:\nnormal: standard whitelist mode\nsafety: enhanced whitelist mode",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecurityIPMode"
        ]
      }
    },
    "MaintainTime": {
      "Description": "The maintenance window of the instance. The time is displayed in UTC. Note: The maintenance window on the ApsaraDB RDS console is this value plus eight hours.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MaintainTime"
        ]
      }
    },
    "ZoneId": {
      "Description": "The zone ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneId"
        ]
      }
    },
    "Collation": {
      "Description": "The character set collation of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Collation"
        ]
      }
    },
    "DBInstanceStorageType": {
      "Description": "The storage type of the instance. Valid values:\nlocal_ssd and ephemeral_ssd: local SSD\ncloud_ssd: standard SSD\ncloud_essd: enhanced SSD (ESSD)",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceStorageType"
        ]
      }
    },
    "MaxIOPS": {
      "Description": "The maximum number of I/O requests per second.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MaxIOPS"
        ]
      }
    },
    "SlaveZones": {
      "Description": "Information about the secondary instance's zone.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SlaveZones"
        ]
      }
    },
    "Extra": {
      "Description": "The extended information of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Extra"
        ]
      }
    },
    "ServerlessConfig": {
      "Description": "The settings of the serverless instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ServerlessConfig"
        ]
      }
    },
    "BabelfishConfig": {
      "Description": "The configuration of the Babelfish feature for the ApsaraDB RDS for PostgreSQL instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BabelfishConfig"
        ]
      }
    },
    "Tips": {
      "Description": "Information about exceptions detected on the instance. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tips"
        ]
      }
    }
  }
}

Format YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBInstanceId:
    Description:
      en: The ID of the instance.
    Required: false
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      DBInstanceId:
        Ref: DBInstanceId
    Type: DATASOURCE::RDS::DBInstance
Outputs:
  AccountMaxQuantity:
    Description: The maximum number of accounts that can be created on the instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - AccountMaxQuantity
  AdvancedFeatures:
    Description: 'The advanced features that are enabled for the instance. If multiple
      advanced features are enabled, the advanced features are separated by commas
      (,). This parameter is available only to instances that run SQL Server. Valid
      values:
      LinkedServer
      DistributeTransaction'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - AdvancedFeatures
  AutoUpgradeMinorVersion:
    Description: 'The method that is used to update the minor engine version of the
      instance. Valid values:
      Auto: automatic update.
      Manual: manual update. The minor engine version of the instance is forcefully
      updated only when the minor engine version in use is phased out.'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - AutoUpgradeMinorVersion
  AvailabilityValue:
    Description: The availability of the instance as a percentage.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - AvailabilityValue
  BabelfishConfig:
    Description: The configuration of the Babelfish feature for the ApsaraDB RDS for
      PostgreSQL instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - BabelfishConfig
  Category:
    Description: 'The RDS edition of the instance. Valid values:
      Basic: RDS Basic Edition
      HighAvailability: RDS High-availability Edition
      cluster: RDS Cluster Edition for ApsaraDB RDS for MySQL
      AlwaysOn: RDS Cluster Edition for ApsaraDB RDS for SQL Server
      Finance: RDS Enterprise Edition
      Serverless_basic: RDS Basic Edition for serverless instances'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Category
  Collation:
    Description: The character set collation of the instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Collation
  ConnectionMode:
    Description: 'The connection mode of the instance. Valid values:
      Standard: standard mode
      Safe: database proxy mode'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ConnectionMode
  ConnectionString:
    Description: The internal endpoint of the instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ConnectionString
  ConsoleVersion:
    Description: 'The type of the proxy that is used by the instance. Valid values:
      1: shared proxy
      2: dedicated proxy'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ConsoleVersion
  CreationTime:
    Description: The creation time. The time follows the ISO 8601 standard in the
      yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CreationTime
  CurrentKernelVersion:
    Description: The minor engine version of the instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CurrentKernelVersion
  DBClusterNodes:
    Description: The information about the node in the cluster.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBClusterNodes
  DBInstanceCPU:
    Description: The number of CPU cores.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBInstanceCPU
  DBInstanceClass:
    Description: The instance type of the instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBInstanceClass
  DBInstanceClassType:
    Description: 'The instance family to which the instance belongs. Valid values:
      s: shared instance family
      x: general-purpose instance family
      d: dedicated instance family
      h: dedicated host instance family'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBInstanceClassType
  DBInstanceDescription:
    Description: The description of the instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBInstanceDescription
  DBInstanceDiskUsed:
    Description: The disk usage of the instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBInstanceDiskUsed
  DBInstanceId:
    Description: The instance ID.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBInstanceId
  DBInstanceMemory:
    Description: 'The memory capacity of the instance. Unit: MB.'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBInstanceMemory
  DBInstanceNetType:
    Description: 'The type of the network over which the instance is connected. Valid
      values:
      Internet: Internet
      Intranet: internal network'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBInstanceNetType
  DBInstanceStatus:
    Description: The status of the instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBInstanceStatus
  DBInstanceStorage:
    Description: 'The storage capacity of the instance. Unit: GB.'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBInstanceStorage
  DBInstanceStorageType:
    Description: 'The storage type of the instance. Valid values:
      local_ssd and ephemeral_ssd: local SSD
      cloud_ssd: standard SSD
      cloud_essd: enhanced SSD (ESSD)'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBInstanceStorageType
  DBInstanceType:
    Description: 'The type of the instance. Valid values:
      Primary: primary instance
      Readonly: read-only instance
      Guard: disaster recovery instance
      Temp: temporary instance'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBInstanceType
  DBMaxQuantity:
    Description: The maximum number of databases that can be created on the instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBMaxQuantity
  DedicatedHostGroupId:
    Description: The ID of the dedicated cluster.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DedicatedHostGroupId
  DeletionProtection:
    Description: 'Indicates whether the release protection feature is enabled. Valid
      values:
      true
      false'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DeletionProtection
  Engine:
    Description: 'The database engine of the instance. Valid values:
      MySQL
      PostgreSQL
      SQLServer
      MariaDB'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Engine
  EngineVersion:
    Description: The database engine version.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - EngineVersion
  ExpireTime:
    Description: 'The expiration time. The time follows the ISO 8601 standard in the
      yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
      Note: Pay-as-you-go instances never expire.'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ExpireTime
  Extra:
    Description: The extended information of the instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Extra
  GeneralGroupName:
    Description: The name of the dedicated cluster to which the instance belongs.
      This parameter is returned only when the instance is created in an ApsaraDB
      MyBase cluster that runs MySQL on Standard Edition.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - GeneralGroupName
  GuardDBInstanceId:
    Description: The ID of the disaster recovery instance that is attached to the
      instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - GuardDBInstanceId
  IPType:
    Description: The type of the IP address. Only IPv4 addresses are supported.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - IPType
  IncrementSourceDBInstanceId:
    Description: The ID of the instance from which incremental data comes. The incremental
      data of a disaster recovery instance or read-only instance comes from its primary
      instance. If this parameter is not returned, the instance is a primary instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - IncrementSourceDBInstanceId
  InstanceNetworkType:
    Description: 'The network type of the instance. Valid values:
      Classic
      VPC'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceNetworkType
  InstructionSetArch:
    Description: 'The architecture type of the instance. Valid values:
      x86
      arm'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstructionSetArch
  LatestKernelVersion:
    Description: The latest minor engine version that is supported by the instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - LatestKernelVersion
  LockMode:
    Description: 'The lock mode of the instance. Valid values:
      Unlock: The instance is not locked.
      ManualLock: The instance is manually locked.
      LockByExpiration: The instance is automatically locked due to instance expiration.
      LockByRestoration: The instance is automatically locked due to instance restoration.
      LockByDiskQuota: The instance is automatically locked due to exhausted storage
      space.
      LockReadInstanceByDiskQuota: The read-only instance is automatically
      locked due to exhausted storage.'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - LockMode
  LockReason:
    Description: The reason why the instance was locked.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - LockReason
  MaintainTime:
    Description: 'The maintenance window of the instance. The time is displayed in
      UTC. Note: The maintenance window on the ApsaraDB RDS console is this value
      plus eight hours.'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - MaintainTime
  MasterInstanceId:
    Description: 'The ID of the primary instance.
      Note: If this parameter is not returned, the instance is the primary instance.'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - MasterInstanceId
  MasterZone:
    Description: The zone ID of the primary instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - MasterZone
  MaxConnections:
    Description: The maximum number of concurrent connections.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - MaxConnections
  MaxIOMBPS:
    Description: 'The maximum I/O throughput. Unit: MB/s.'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - MaxIOMBPS
  MaxIOPS:
    Description: The maximum number of I/O requests per second.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - MaxIOPS
  PGBouncerEnabled:
    Description: Indicates whether PgBouncer is enabled.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PGBouncerEnabled
  PayType:
    Description: 'The billing method of the instance. Valid values:
      Postpaid: pay-as-you-go
      Prepaid: subscription'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PayType
  Port:
    Description: The port that is used to connect to the instance over an internal
      network.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Port
  ProxyType:
    Description: 'The type of the proxy that is supported by the instance. Valid values:
      0: The instance does not support database proxies.
      1: The instance supports shared proxies, with which the instance runs in multi-tenant
      mode.
      2: The instance supports dedicated proxies, with which the instance runs in
      single-tenant mode.'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ProxyType
  ReadOnlyDBInstanceIds:
    Description: The IDs of the read-only instances that are attached to the primary
      instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ReadOnlyDBInstanceIds
  ReadonlyInstanceSQLDelayedTime:
    Description: The data replication latency from the primary instance to read-only
      instances, in seconds.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ReadonlyInstanceSQLDelayedTime
  ResourceGroupId:
    Description: The resource group ID.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ResourceGroupId
  SecurityIPList:
    Description: The IP addresses in the IP address whitelist.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SecurityIPList
  SecurityIPMode:
    Description: 'The whitelist mode of the instance. Valid values:
      normal: standard whitelist mode
      safety: enhanced whitelist mode'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SecurityIPMode
  ServerlessConfig:
    Description: The settings of the serverless instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ServerlessConfig
  SlaveZones:
    Description: Information about the secondary instance's zone.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SlaveZones
  SuperPermissionMode:
    Description: 'Indicates whether the instance supports superuser accounts, such
      as the system administrator (SA) account, the Active Directory (AD) account,
      and the host account.
      Enable
      Disabled'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SuperPermissionMode
  TempDBInstanceId:
    Description: The ID of the temporary instance that is attached to the instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - TempDBInstanceId
  TimeZone:
    Description: The time zone of the instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - TimeZone
  Tips:
    Description: Information about exceptions detected on the instance.
      This parameter is returned only when the instance is created in an ApsaraDB
      MyBase cluster that runs MySQL on Standard Edition.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Tips
  TipsLevel:
    Description: 'The severity level of the exception that is detected on the instance.
      This parameter is returned only when the instance is created in an ApsaraDB
      MyBase cluster that runs MySQL on Standard Edition. Valid values:
      1: The instance is normal.
      2: The specifications of the read-only instances do not match the specifications
      of the primary instance. You must adjust the specifications of these instances
      based on your business requirements.'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - TipsLevel
  VSwitchId:
    Description: The vSwitch ID.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - VSwitchId
  VpcCloudInstanceId:
    Description: The virtual private cloud (VPC) ID of the instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - VpcCloudInstanceId
  VpcId:
    Description: The virtual private cloud (VPC) ID of the instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - VpcId
  ZoneId:
    Description: The zone ID.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ZoneId

Configurez les paramètres.

Paramètre

Obligatoire

Description

Exemple

Stack Name

Oui

Nom de la pile.

Rds_Test

DBInstanceId

Oui

ID de l'instance ApsaraDB for RDS.

rm-bp1tuz16pa5x8****

Configure Stack Settings

Non

Paramètres de configuration de la pile.

Voir Configurer les paramètres de la pile.

Cliquez sur Create.

Une fois la pile créée, cliquez sur l'onglet Output pour consulter les informations relatives à l'instance.