type_versions

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

Overview

Name	type_versions
Type	Resource
Id	aws.cloudformation.type_versions

Fields

The following fields are returned by SELECT queries:

list_type_versions

Name	Datatype	Description
arn	string	The ARN of the extension version.
description	string	The description of the extension version.
is_default_version	boolean	Whether the specified extension version is set as the default version. This applies only to private extensions you have registered in your account, and extensions published by Amazon. For public third-party extensions, CloudFormation returns null.
public_version_number	string	For public extensions that have been activated for this account and Region, the version of the public extension to be used for CloudFormation operations in this account and Region. For any extensions other than activated third-party extensions, CloudFormation returns null. How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Automatically use new versions of extensions in the CloudFormation User Guide.
time_created	string	When the version was registered.
type	string	The kind of extension.
type_name	string	The name of the extension.
version_id	string	The ID of a specific version of the extension. The version ID is the value at the end of the ARN assigned to the extension version when it's registered.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_type_versions	select	region	Type, TypeName, Arn, MaxResults, NextToken, DeprecatedStatus, PublisherId	Returns summary information about the versions of an extension.

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)
Arn	string	The Amazon Resource Name (ARN) of the extension for which you want version summary information. Conditional: You must specify either TypeName and Type, or Arn.
DeprecatedStatus	string	The deprecation status of the extension versions that you want to get summary information about. Valid values include: LIVE: The extension version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope. DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations. The default is LIVE.
MaxResults	integer	The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
NextToken	string	The token for the next set of items to return. (You received this token from a previous call.)
PublisherId	string	The publisher ID of the extension publisher. Extensions published by Amazon aren't assigned a publisher ID.
Type	string	The kind of the extension. Conditional: You must specify either TypeName and Type, or Arn.
TypeName	string	The name of the extension for which you want version summary information. Conditional: You must specify either TypeName and Type, or Arn.

SELECT examples

list_type_versions

Returns summary information about the versions of an extension.

SELECT
arn,
description,
is_default_version,
public_version_number,
time_created,
type,
type_name,
version_id
FROM aws.cloudformation.type_versions
WHERE region = '{{ region }}' -- required
AND Type = '{{ Type }}'
AND TypeName = '{{ TypeName }}'
AND Arn = '{{ Arn }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DeprecatedStatus = '{{ DeprecatedStatus }}'
AND PublisherId = '{{ PublisherId }}'
;