serverless_v2_platform_versions

Creates, updates, deletes, gets or lists a serverless_v2_platform_versions resource.

Overview

Name	serverless_v2_platform_versions
Type	Resource
Id	aws.rds.serverless_v2_platform_versions

Fields

The following fields are returned by SELECT queries:

describe_serverless_v2_platform_versions

Name	Datatype	Description
engine	string	The name of the database engine.
is_default	boolean	Indicates whether this platform version is the default version for the engine. The default platform version is the version used for new DB clusters.
serverless_v2_features_support	string	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.
serverless_v2_platform_version	string	The version number of the serverless platform.
serverless_v2_platform_version_description	string	The description of the serverless platform.
status	string	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_serverless_v2_platform_versions	select	region	ServerlessV2PlatformVersion, Engine, Filters, DefaultOnly, IncludeAll, MaxRecords, Marker	Describes the properties of specific platform versions for Aurora Serverless v2.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
DefaultOnly	boolean	Specifies whether to return only the default platform versions for each engine. The default platform version is the version used for new DB clusters.
Engine	string	The database engine to return platform version details for. Valid Values: aurora-mysql aurora-postgresql
Filters	array	This parameter isn't currently supported.
IncludeAll	boolean	Specifies whether to also include platform versions which are no longer in use.
Marker	string	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 MaxRecords.
MaxRecords	integer	The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 20 Constraints: Minimum 1, maximum 200.
ServerlessV2PlatformVersion	string	A specific platform version to return details for. Example: 3

SELECT examples

describe_serverless_v2_platform_versions

Describes the properties of specific platform versions for Aurora Serverless v2.

SELECT
engine,
is_default,
serverless_v2_features_support,
serverless_v2_platform_version,
serverless_v2_platform_version_description,
status
FROM aws.rds.serverless_v2_platform_versions
WHERE region = '{{ region }}' -- required
AND ServerlessV2PlatformVersion = '{{ ServerlessV2PlatformVersion }}'
AND Engine = '{{ Engine }}'
AND Filters = '{{ Filters }}'
AND DefaultOnly = '{{ DefaultOnly }}'
AND IncludeAll = '{{ IncludeAll }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;