DATASOURCE::RDS::Zones is used to query the zones that are available to an ApsaraDB RDS instance.
Syntax
{
"Type": "DATASOURCE::RDS::Zones",
"Properties": {
"DispenseMode": String,
"Category": String,
"EngineVersion": String,
"ZoneId": String,
"CommodityCode": String,
"Engine": String
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
---|---|---|---|---|---|
DispenseMode | String | No | Yes | Specifies whether to return the zones in which the single-zone deployment method is supported. | Valid values:
Note The single-zone deployment method allows you to deploy an Enterprise Edition instance
in a single zone.
|
Category | String | No | Yes | The edition of the instance. | Valid values:
|
EngineVersion | String | No | Yes | The version of the database engine that is run by the instance. | Valid values:
|
ZoneId | String | No | Yes | The ID of the zone in which the instance is deployed. | If the instance is deployed in multiple zones, the value of this property contains
an MAZ part, such as cn-hangzhou-MAZ6(b,f) or cn-hangzhou-MAZ5(b,e,f) . You can query the zone ID when you call the DescribeRegions operation. For more
information, see Query regions.
|
CommodityCode | String | No | Yes | The commodity code of the instance. | Valid values:
|
Engine | String | Yes | Yes | The database engine that is run by the instance. | Valid values:
|
Response parameters (Fn::GetAtt)
- ZoneIds: the zone IDs of the instance.
- Zones: details of the zones of the instance.
Parameter | Type | Description | Constraint |
---|---|---|---|
ZoneIds | List | The zone IDs of the instance. | None. |
Zones | List | Details of the zones of the instance. | None. |
ZoneId | String | The zone ID of the instance. | None. |
RegionId | String | The region ID of the instance. | None. |
SupportedEngines | List | The database engine versions that are available in the zones. | Example:
|
Examples
-
JSON
format{ "ROSTemplateFormatVersion": "2015-09-01", "Parameters": { "Engine": { "Type": "String", "Description": "The database engine that is run by the instance.", "AllowedValues": [ "MySQL", "SQLServer", "PostgreSQL", "MariaDB" ] } }, "Resources": { "ExtensionDataSource": { "Type": "DATASOURCE::RDS::Zones", "Properties": { "Engine": { "Ref": "Engine" } } } }, "Outputs": { "ZoneIds": { "Description": "The list of zone IDs.", "Value": { "Fn::GetAtt": [ "ExtensionDataSource", "ZoneIds" ] } }, "Zones": { "Description": "The list of The Zones.", "Value": { "Fn::GetAtt": [ "ExtensionDataSource", "Zones" ] } } } }