Call DATASOURCE::RDS::Zones to list RDS zones - Resource Orchestration Service

Syntax

{
  "Type": "DATASOURCE::RDS::Zones",
  "Properties": {
    "DispenseMode": String,
    "Category": String,
    "EngineVersion": String,
    "ZoneId": String,
    "CommodityCode": String,
    "Engine": String,
    "RefreshOptions": String
  }
}

Properties

Property Name	Type	Required	Update Allowed	Description	Constraints
DispenseMode	String	No	Yes	Whether to return only zones that support single-zone deployment.	Valid values: 1. Back 0: Does not return a value. Note The single-zone deployment feature lets you install a three-node Enterprise Edition instance in a single zone.
Category	String	No	Yes	The instance edition.	Valid values: Basic: Basic Edition. HighAvailability: High-availability Edition. AlwaysOn: Cluster Edition. Finance: Three-node Enterprise Edition.
EngineVersion	String	No	Yes	The database version.	Valid values: MySQL: 5.5, 5.6, 5.7, 8.0 SQL Server: 2008r2, 08r2_ent_ha, 2012, 2012_ent_ha, 2012_std_ha, 2012_web, 2014_std_ha, 2016_ent_ha, 2016_std_ha, 2016_web, 2017_std_ha, 2017_ent, 2019_std_ha, 2019_ent PostgreSQL: 9.4, 10.0, 11.0, 12.0, 13.0, 14.0 MariaDB: 10.3
ZoneId	String	No	Yes	The zone ID.	Multi-zone IDs use a different format from single-zone IDs and include MAZ. Examples: `cn-hangzhou-MAZ6(b,f)` and `cn-hangzhou-MAZ5(b,e,f)`. You can call the DescribeRegions operation to query zone IDs.
CommodityCode	String	No	Yes	The commodity code of the instance.	Valid values: bards_intl: Pay-as-you-go primary instance. rds_intl: Subscription primary instance. rords_intl: Pay-as-you-go read-only instance. rds_rordspre_public_intl: Subscription read-only instance.
Engine	String	Yes	Yes	The database type.	Valid values: MySQL SQLServer PostgreSQL MariaDB
RefreshOptions	String	No	Yes	The refresh policy for data source resources when the stack is updated.	Valid values: Never (default): The data source resource is never refreshed when the stack is updated. Always: The data source resource is always refreshed when the stack is updated.

Return values (Fn::GetAtt)

ZoneIds: The list of RDS zone IDs.
Zones: The list of RDS zone resources.

Property	Type	Description	Constraints
ZoneIds	List	The list of RDS zone IDs.	None
Zones	List	The list of RDS zone resources.	None
ZoneId	String	The zone ID.	None
RegionId	String	The region ID.	None
SupportedEngines	List	The database engine versions available for purchase.	Example: `[ { "SupportedEngineVersions" : [ { "Version" : "8.0", "SupportedCategorys" : [ { "Category" : "HighAvailability", "SupportedStorageTypes" : [ { "StorageType" : "local_ssd" }, { "StorageType" : "cloud_ssd" } ] }, { "Category" : "Basic", "SupportedStorageTypes" : [ { "StorageType" : "cloud_ssd" } ] } ] } ], "Engine" : "MySQL"} ]`

Examples

JSON

{
  "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"
        ]
      }
    }
  }
}

YAML

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