ServerlessV2PlatformVersionInfo
Contains details about a specific Amazon DocumentDB Serverless platform version, including its version number, status, engine, and supported features.
Contents
Note
In the following list, the required parameters are described first.
- Engine
-
The name of the database engine.
Type: String
Required: No
- IsDefault
-
Specifies whether this platform version is the default version for the engine. The default platform version is the version used for new DB clusters.
Type: Boolean
Required: No
- ServerlessV2FeaturesSupport
-
Specifies any Amazon DocumentDB Serverless v2 properties or limits that differ between platform versions. You can retrieve the platform version of an existing cluster and check whether it supports specific features before you use them.
Type: ServerlessV2FeaturesSupport object
Required: No
- ServerlessV2PlatformVersion
-
The version number of the serverless platform.
Type: String
Required: No
- ServerlessV2PlatformVersionDescription
-
The description of the serverless platform.
Type: String
Required: No
- Status
-
The status of the serverless platform. Valid statuses are the following:
-
enabled- The platform version is in use. -
disabled- The platform version is not in use.
Type: String
Required: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: