Update AWS::RDS::DBCluster schema to reflect support for Multi-AZ mysql & postgres clusters

[4naesthetic]

PR #163 implemented support for non-Aurora multi-AZ DB clusters, which can now be created through CloudFormation by setting the Engine to either mysql or postgres, however the schema and public CloudFormation documentation page hasn't been updated to reflect this. Although the new attributes required for Multi-AZ clusters are present in the schema, the descriptions for existing attributes (such as Engine) still indicate that only Aurora clusters are supported.

If this support for Multi-AZ DB clusters is official and supported, can the schema and docs be updated?

[khebul]

Hey,

There has been an official announcement: https://aws.amazon.com/about-aws/whats-new/2022/11/aws-cloudformation-supports-amazon-rds-multi-az-deployments-readable-standbys/

I can also see that the documentation includes the relevant properties, as well as an example of CFN template: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#aws-resource-rds-dbcluster--examples--Creating_a_Multi-AZ_DB_cluster

I can also see that the relevant properties are supported in the schema at least in us-east-1 and eu-west-1: https://schema.cloudformation.us-east-1.amazonaws.com/aws-rds-dbcluster.json
https://schema.cloudformation.eu-west-1.amazonaws.com/aws-rds-dbcluster.json

Could you elaborate which region are you looking at?

[4naesthetic]

Hi,

My apologies, I don't think I was clear enough. This is a docs-only issue.

Today, the Engine property has the following description in the schema and on the CloudFormation docs page:

The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

This description isn't correct, as since adding Multi-AZ cluster support there are additional valid engines: mysql and postgres. CloudFormation doesn't perform validation on the engine as the schema uses a string type for this field so it doesn't block use of this feature.

Also, the top-level description in the aws-rds-dbcluster.json for the resource type only mentions that this resource type can be used to create Aurora clusters (although this appears to have been expanded on the CloudFormation docs page).

CloudFormation Docs

[khebul]

Got it,

You are correct - the documentation needs to be updated.

[sleepwithcoffee]

I think this one can be closed @khebul @4naesthetic

[4naesthetic]

I've taken a look at the links from my earlier comment and I don't believe that the documentation has been updated yet, so unless it's been changed elsewhere then from my perspective this issue is still open.

[sleepwithcoffee]

looking at the CloudFormation doc, it seems that it has been updated

nevertheless, I am creating a PR #524 to update the doc in this repo

[zrfr]

The primary source of documentation is the CFN user guide. Since the CFN docs have now been updated, I am closing this issue.

The documentation in the JSON schema files within this repository is provided as a convenience. When the schema files are uploaded to CFN (accessible here or by using the CFN DescribeType API), all of the documentation is automatically replaced with extracts from the CFN docs. We're aware that the documentation strings here have diverged from the official docs, but we'll address them separately from this issue as this affects more than just the Engine property.