ALIYUN::RDS::ReadOnlyDBInstance - Resource Orchestration Service

La ressource ALIYUN::RDS::ReadOnlyDBInstance permet de créer une instance en lecture seule ApsaraDB RDS.

Syntaxe

{
  "Type": "ALIYUN::RDS::ReadOnlyDBInstance",
  "Properties": {
    "Category": String,
    "VPCId": String,
    "DBInstanceDescription": String,
    "Tags": Map,
    "EngineVersion": String,
    "DBInstanceId": String,
    "PayType": String,
    "ZoneId": String,
    "ResourceGroupId": String,
    "DBInstanceStorage": Integer,
    "VSwitchId": String,
    "DBInstanceStorageType": String,
    "DBInstanceClass": String,
    "PrivateIpAddress": String,
    "PeriodType": String,
    "Period": Integer,
    "AutoRenew": Boolean,
    "TargetDedicatedHostIdForMaster": String,
    "DeletionProtection": Boolean,
    "DedicatedHostGroupId": String
  }
}

Propriétés

Propriété	Type	Obligatoire	Modifiable	Description	Contrainte
Category	String	Non	Non	Édition de l'instance.	Valeurs valides : Basic : Édition de base. HighAvailability (par défaut) : Édition haute disponibilité. AlwaysOn : Édition cluster.
VPCId	String	Non	Non	ID du VPC (Virtual Private Cloud) de l'instance en lecture seule.	Aucune.
DBInstanceDescription	String	Non	Non	Description de l'instance.	La description doit comporter entre 2 et 256 caractères et peut contenir des lettres, des chiffres, des traits de soulignement (_) et des tirets (-). Elle doit commencer par une lettre, mais ne peut pas débuter par `http://` ou `https://`.
Tags	Map	Non	Oui	Tags de l'instance en lecture seule.	Les tags sont au format clé-valeur. Exemple : `{"key1": "value1","key2": "value2", ... "key5": "value5"}` Spécifiez jusqu'à cinq paires clé-valeur. Une clé de tag peut comporter jusqu'à 64 caractères et ne peut pas commencer par `http://` ou `https://`. Une valeur de tag peut comporter jusqu'à 128 caractères et ne peut pas commencer par `aliyun`, `http://` ou `https://`.
EngineVersion	String	Oui	Non	Version du moteur de base de données.	La version du moteur de base de données de l'instance en lecture seule doit être identique à celle de l'instance principale. Valeurs valides lorsque le moteur de base de données est MySQL : 5.6 5.7 8.0 Valeur valide lorsque le moteur de base de données est SQL Server : 2017_ent
DBInstanceId	String	Oui	Non	ID de l'instance principale.	Aucune.
PayType	String	Non	Non	Méthode de facturation de l'instance en lecture seule.	Seule la méthode de facturation à l'utilisation (pay-as-you-go) est prise en charge. Définissez la valeur sur Postpaid.
ZoneId	String	Oui	Non	ID de la zone de l'instance en lecture seule.	Appelez l'opération DescribeRegions pour interroger la liste des zones les plus récentes.
ResourceGroupId	String	Non	Non	ID du groupe de ressources.	Aucune.
DBInstanceStorage	Integer	Oui	Oui	Capacité de stockage de l'instance en lecture seule.	Unité : Go. Valeurs valides : de 5 à 3000. La valeur doit être un multiple de 5. Les plages de valeurs varient selon les versions. Pour plus d'informations, consultez la rubrique Types d'instances principales ApsaraDB RDS.
VSwitchId	String	Non	Non	ID du vSwitch de l'instance en lecture seule.	Aucune.
DBInstanceStorageType	String	Non	Non	Type de stockage de l'instance en lecture seule.	Valeurs valides : local_ssd ou ephemeral_ssd : SSD local cloud_ssd : SSD standard cloud_essd : SSD amélioré (ESSD) Remarque Utilisez uniquement des SSD locaux pour les instances ApsaraDB RDS for MySQL en lecture seule, et uniquement des SSD standards ou des ESSD pour les instances ApsaraDB RDS for SQL Server en lecture seule.
DBInstanceClass	String	Oui	Oui	Type d'instance de l'instance en lecture seule.	Pour plus d'informations, consultez la rubrique Types d'instances principales ApsaraDB RDS. Sélectionnez un type d'instance supérieur ou égal à celui de l'instance principale. Si le type d'instance de l'instance en lecture seule est inférieur à celui de l'instance principale, cette dernière risque de rencontrer des problèmes tels qu'une latence élevée et une charge importante.
PrivateIpAddress	String	Non	Non	Adresse IP privée de l'instance en lecture seule.	L'adresse IP privée doit se situer dans la plage d'adresses IP du vSwitch spécifié. Le système attribue automatiquement une adresse IP privée à l'instance en fonction des valeurs de VPCId et VSwitchId.
PeriodType	String	Non	Non	Unité de durée d'abonnement de l'instance en lecture seule.	Valeurs valides : Year (Année) Month (Mois)
Period	Integer	Non	Non	Durée d'abonnement de l'instance en lecture seule.	Valeurs valides lorsque PeriodType est défini sur Year : de 1 à 3. Valeurs valides lorsque PeriodType est défini sur Month : de 1 à 9.
AutoRenew	Boolean	Non	Non	Indique s'il faut activer le renouvellement automatique pour l'instance en lecture seule.	Cette propriété prend effet uniquement lorsque l'instance en lecture seule utilise la méthode de facturation par abonnement. Valeurs valides : true false (par défaut) Remarque Si vous définissez PeriodType sur Month, le cycle de renouvellement automatique est d'un mois. Si vous définissez PeriodType sur Year, le cycle de renouvellement automatique est d'un an.
TargetDedicatedHostIdForMaster	String	Non	Non	ID de l'hôte sur lequel réside l'instance principale. Cette propriété prend effet lors de la création de l'instance en lecture seule dans un cluster dédié.	Aucune.
DeletionProtection	Boolean	Non	Non	Indique s'il faut activer la fonctionnalité de protection contre la suppression pour l'instance en lecture seule.	Valeurs valides : true : false (par défaut) Remarque Activez la fonctionnalité de protection contre la suppression pour les instances facturées à l'utilisation (pay-as-you-go).
DedicatedHostGroupId	String	Non	Non	ID du cluster dédié auquel appartient l'instance en lecture seule. Cette propriété est valide lors de la création de l'instance en lecture seule dans un cluster dédié.	Aucune.

Valeurs de retour

Fn::GetAtt

ConnectionString : point de terminaison interne de l'instance en lecture seule.
DBInstanceId : ID de l'instance en lecture seule.
Port : port interne de l'instance en lecture seule.

Exemples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBInstanceId:
    Type: String
    Description: The ID of the master instance.
  ZoneId:
    Type: String
    Description: Create an Availability Zone for an instance to ensure that the Availability Zone supports the creation of rds resource specifications.
    AssociationProperty: ALIYUN::ECS::Instance::ZoneId
    Label: Zone ID
  VPC:
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    Type: String
    Description: Please search the ID starts with (vpc-xxx)from console-Virtual Private Cloud
    Label: Existing VPC Instance ID
  VSwitch:
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    Type: String
    Description: Please search the business VSwitch ID starts with(vsw-xxx)from console-Virtual Private Cloud-VSwitches
    Label: Existing VSwitch ID
    AssociationPropertyMetadata:
      VpcId: VPC
      ZoneId: ZoneId
  EngineVersion:
    Type: String
    Description: 'MySQL: 5.5, 5.6, 5.7, 5.8, SQLServer: 2008r2, PostgreSQL: 9.4'
    Default: '5.6'
  DBInstanceClass:
    Type: String
    Description: Instance Class
    Default: rds.mysql.s2.large
  DBInstanceStorage:
    Type: Number
    Description: MySQL: 5-1000, SQLServer: 10-1000, others: 5-2000
    Default: 40
Resources:
  ReadOnlyDBInstance:
    Type: ALIYUN::RDS::ReadOnlyDBInstance
    DependsOn: RDSInstance
    Properties:
      VPCId:
        Ref: VPC
      DBInstanceId:
        Ref: DBInstanceId
      ZoneId:
        Ref: ZoneId
      DBInstanceStorage:
        Ref: DBInstanceStorage
      VSwitchId:
        Ref: VSwitch
      EngineVersion:
        Ref: EngineVersion
      DBInstanceClass:
        Ref: DBInstanceClass
Outputs:
  DBInstanceId:
    Description: The instance id of created database instance.
    Value:
      Fn::GetAtt:
        - ReadOnlyDBInstance
        - DBInstanceId
  Port:
    Description: Intranet port of created DB instance.
    Value:
      Fn::GetAtt:
        - ReadOnlyDBInstance
        - Port
  ConnectionString:
    Description: DB instance connection url by Intranet.
    Value:
      Fn::GetAtt:
        - ReadOnlyDBInstance
        - ConnectionString

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBInstanceId": {
      "Type": "String",
      "Description": "The ID of the master instance."
    },
    "ZoneId": {
      "Type": "String",
      "Description": "Create an Availability Zone for an instance to ensure that the Availability Zone supports the creation of rds resource specifications.",
      "AssociationProperty": "ALIYUN::ECS::Instance::ZoneId",
      "Label": "Zone ID"
    },
    "VPC": {
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Type": "String",
      "Description": "Please search the ID starts with (vpc-xxx)from console-Virtual Private Cloud",
      "Label": "Existing VPC Instance ID"
    },
    "VSwitch": {
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "Type": "String",
      "Description": "Please search the business VSwitch ID starts with(vsw-xxx)from console-Virtual Private Cloud-VSwitches",
      "Label": "Existing VSwitch ID",
      "AssociationPropertyMetadata": {
        "VpcId": "VPC",
        "ZoneId": "ZoneId"
      }
    },
    "EngineVersion": {
      "Type": "String",
      "Description": "MySQL: 5.5, 5.6, 5.7, 5.8, SQLServer: 2008r2, PostgreSQL: 9.4",
      "Default": "5.6"
    },
    "DBInstanceClass": {
      "Type": "String",
      "Description": "Instance Class",
      "Default": "rds.mysql.s2.large"
    },
    "DBInstanceStorage": {
      "Type": "Number",
      "Description": "MySQL:5-1000, SQLServer: 10-1000, others: 5-2000",
      "Default": 40
    }
  },
  "Resources": {
    "ReadOnlyDBInstance": {
      "Type": "ALIYUN::RDS::ReadOnlyDBInstance",
      "DependsOn": "RDSInstance",
      "Properties": {
        "VPCId": {
          "Ref": "VPC"
        },
        "DBInstanceId": {
          "Ref": "DBInstanceId"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "DBInstanceStorage": {
          "Ref": "DBInstanceStorage"
        },
        "VSwitchId": {
          "Ref": "VSwitch"
        },
        "EngineVersion": {
          "Ref": "EngineVersion"
        },
        "DBInstanceClass": {
          "Ref": "DBInstanceClass"
        }
      }
    }
  },
  "Outputs": {
    "DBInstanceId": {
      "Description": "The instance id of created database instance.",
      "Value": {
        "Fn::GetAtt": [
          "ReadOnlyDBInstance",
          "DBInstanceId"
        ]
      }
    },
    "Port": {
      "Description": "Intranet port of created DB instance.",
      "Value": {
        "Fn::GetAtt": [
          "ReadOnlyDBInstance",
          "Port"
        ]
      }
    },
    "ConnectionString": {
      "Description": "DB instance connection url by Intranet.",
      "Value": {
        "Fn::GetAtt": [
          "ReadOnlyDBInstance",
          "ConnectionString"
        ]
      }
    }
  }
}