Skip to content

Commit edee83e

Browse files
author
AWS
committed
Amazon Relational Database Service Update: Adds a new DescribeServerlessV2PlatformVersions API to describe platform version properties for Aurora Serverless v2. Also introduces a new valid maintenance action value for serverless platform version updates.
1 parent 9fde1b7 commit edee83e

3 files changed

Lines changed: 109 additions & 1 deletion

File tree

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Relational Database Service",
4+
"contributor": "",
5+
"description": "Adds a new DescribeServerlessV2PlatformVersions API to describe platform version properties for Aurora Serverless v2. Also introduces a new valid maintenance action value for serverless platform version updates."
6+
}

services/rds/src/main/resources/codegen-resources/paginators-1.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,12 @@
228228
"output_token": "Marker",
229229
"result_key": "ReservedDBInstancesOfferings"
230230
},
231+
"DescribeServerlessV2PlatformVersions": {
232+
"input_token": "Marker",
233+
"limit_key": "MaxRecords",
234+
"output_token": "Marker",
235+
"result_key": "ServerlessV2PlatformVersions"
236+
},
231237
"DescribeSourceRegions": {
232238
"input_token": "Marker",
233239
"limit_key": "MaxRecords",

services/rds/src/main/resources/codegen-resources/service-2.json

Lines changed: 97 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1763,6 +1763,20 @@
17631763
],
17641764
"documentation":"<p>Lists available reserved DB instance offerings.</p>"
17651765
},
1766+
"DescribeServerlessV2PlatformVersions":{
1767+
"name":"DescribeServerlessV2PlatformVersions",
1768+
"http":{
1769+
"method":"POST",
1770+
"requestUri":"/"
1771+
},
1772+
"input":{"shape":"DescribeServerlessV2PlatformVersionsMessage"},
1773+
"output":{
1774+
"shape":"ServerlessV2PlatformVersionsMessage",
1775+
"resultWrapper":"DescribeServerlessV2PlatformVersionsResult"
1776+
},
1777+
"errors":[],
1778+
"documentation":"<p>Describes the properties of specific platform versions for Aurora Serverless v2.</p>"
1779+
},
17661780
"DescribeSourceRegions":{
17671781
"name":"DescribeSourceRegions",
17681782
"http":{
@@ -10802,6 +10816,40 @@
1080210816
},
1080310817
"documentation":"<p/>"
1080410818
},
10819+
"DescribeServerlessV2PlatformVersionsMessage":{
10820+
"type":"structure",
10821+
"members":{
10822+
"ServerlessV2PlatformVersion":{
10823+
"shape":"String",
10824+
"documentation":"<p>A specific platform version to return details for.</p> <p>Example: <code>3</code> </p>"
10825+
},
10826+
"Engine":{
10827+
"shape":"String",
10828+
"documentation":"<p>The database engine to return platform version details for.</p> <p>Valid Values:</p> <ul> <li> <p> <code>aurora-mysql</code> </p> </li> <li> <p> <code>aurora-postgresql</code> </p> </li> </ul>"
10829+
},
10830+
"Filters":{
10831+
"shape":"FilterList",
10832+
"documentation":"<p>This parameter isn't currently supported.</p>"
10833+
},
10834+
"DefaultOnly":{
10835+
"shape":"BooleanOptional",
10836+
"documentation":"<p>Specifies whether to return only the default platform versions for each engine. The default platform version is the version used for new DB clusters.</p>"
10837+
},
10838+
"IncludeAll":{
10839+
"shape":"BooleanOptional",
10840+
"documentation":"<p>Specifies whether to also include platform versions which are no longer in use.</p>"
10841+
},
10842+
"MaxRecords":{
10843+
"shape":"IntegerOptional",
10844+
"documentation":"<p>The maximum number of records to include in the response. If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.</p> <p>Default: 20</p> <p>Constraints: Minimum 1, maximum 200.</p>"
10845+
},
10846+
"Marker":{
10847+
"shape":"String",
10848+
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
10849+
}
10850+
},
10851+
"documentation":"<p/>"
10852+
},
1080510853
"DescribeSourceRegionsMessage":{
1080610854
"type":"structure",
1080710855
"members":{
@@ -14397,7 +14445,7 @@
1439714445
"members":{
1439814446
"Action":{
1439914447
"shape":"String",
14400-
"documentation":"<p>The type of pending maintenance action that is available for the resource. </p> <p>For more information about maintenance actions, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html\">Maintaining a DB instance</a>.</p> <p>Valid Values:</p> <ul> <li> <p> <code>ca-certificate-rotation</code> </p> </li> <li> <p> <code>db-upgrade</code> </p> </li> <li> <p> <code>hardware-maintenance</code> </p> </li> <li> <p> <code>os-upgrade</code> </p> </li> <li> <p> <code>system-update</code> </p> </li> </ul> <p>For more information about these actions, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#maintenance-actions-aurora\">Maintenance actions for Amazon Aurora</a> or <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#maintenance-actions-rds\">Maintenance actions for Amazon RDS</a>.</p>"
14448+
"documentation":"<p>The type of pending maintenance action that is available for the resource. </p> <p>For more information about maintenance actions, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html\">Maintaining a DB instance</a>.</p> <p>Valid Values:</p> <ul> <li> <p> <code>ca-certificate-rotation</code> </p> </li> <li> <p> <code>db-upgrade</code> </p> </li> <li> <p> <code>hardware-maintenance</code> </p> </li> <li> <p> <code>os-upgrade</code> </p> </li> <li> <p> <code>serverless-platform-version-update</code> </p> </li> <li> <p> <code>system-update</code> </p> </li> </ul> <p>For more information about these actions, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#maintenance-actions-aurora\">Maintenance actions for Amazon Aurora</a> or <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#maintenance-actions-rds\">Maintenance actions for Amazon RDS</a>.</p>"
1440114449
},
1440214450
"AutoAppliedAfterDate":{
1440314451
"shape":"TStamp",
@@ -16697,6 +16745,54 @@
1669716745
},
1669816746
"documentation":"<p>Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions and platform versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features. </p>"
1669916747
},
16748+
"ServerlessV2PlatformVersionInfo":{
16749+
"type":"structure",
16750+
"members":{
16751+
"ServerlessV2PlatformVersion":{
16752+
"shape":"String",
16753+
"documentation":"<p>The version number of the serverless platform.</p>"
16754+
},
16755+
"ServerlessV2PlatformVersionDescription":{
16756+
"shape":"String",
16757+
"documentation":"<p>The description of the serverless platform.</p>"
16758+
},
16759+
"Engine":{
16760+
"shape":"String",
16761+
"documentation":"<p>The name of the database engine.</p>"
16762+
},
16763+
"ServerlessV2FeaturesSupport":{
16764+
"shape":"ServerlessV2FeaturesSupport",
16765+
"documentation":"<p>Specifies any Aurora Serverless v2 properties or limits that differ between Aurora Serverless v2 platform versions. You can retrieve the platform version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.</p>"
16766+
},
16767+
"Status":{
16768+
"shape":"String",
16769+
"documentation":"<p>The status of the serverless platform. Valid statuses are the following:</p> <ul> <li> <p> <code>enabled</code> - The platform version is in use.</p> </li> <li> <p> <code>disabled</code> - The platform version is not in use.</p> </li> </ul>"
16770+
},
16771+
"IsDefault":{
16772+
"shape":"Boolean",
16773+
"documentation":"<p>Indicates whether this platform version is the default version for the engine. The default platform version is the version used for new DB clusters.</p>"
16774+
}
16775+
},
16776+
"documentation":"<p>This data type is used as a response element in the action <code>DescribeServerlessV2PlatformVersions</code>.</p>"
16777+
},
16778+
"ServerlessV2PlatformVersionList":{
16779+
"type":"list",
16780+
"member":{"shape":"ServerlessV2PlatformVersionInfo"}
16781+
},
16782+
"ServerlessV2PlatformVersionsMessage":{
16783+
"type":"structure",
16784+
"members":{
16785+
"Marker":{
16786+
"shape":"String",
16787+
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
16788+
},
16789+
"ServerlessV2PlatformVersions":{
16790+
"shape":"ServerlessV2PlatformVersionList",
16791+
"documentation":"<p>A list of <code>ServerlessV2PlatformVersionInfo</code> elements.</p>"
16792+
}
16793+
},
16794+
"documentation":"<p>Contains the result of a successful invocation of the <code>DescribeServerlessV2PlatformVersions</code> action.</p>"
16795+
},
1670016796
"ServerlessV2ScalingConfiguration":{
1670116797
"type":"structure",
1670216798
"members":{

0 commit comments

Comments
 (0)