type_registrations

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

Overview

Name	type_registrations
Type	Resource
Id	aws.cloudformation.type_registrations

Fields

The following fields are returned by SELECT queries:

describe_type_registration

Name	Datatype	Description
line_items	array

list_type_registrations

Name	Datatype	Description
registration_token	string	A list of extension registration tokens. Use DescribeTypeRegistration to return detailed information about a type registration request.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_type_registration	select	RegistrationToken, region		Returns information about an extension's registration, including its current status and type and version identifiers. When you initiate a registration request using RegisterType, you can then use DescribeTypeRegistration to monitor the progress of that registration request. Once the registration request has completed, use DescribeType to return detailed information about an extension.
list_type_registrations	select	region	Type, TypeName, TypeArn, RegistrationStatusFilter, MaxResults, NextToken	Returns a list of registration tokens for the specified extension(s).

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
RegistrationToken	string	The identifier for this registration request. This registration token is generated by CloudFormation when you initiate a registration request using RegisterType.
region	string	AWS region (default: us-east-1)
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.)
RegistrationStatusFilter	string	The current status of the extension registration request. The default is IN_PROGRESS.
Type	string	The kind of extension. Conditional: You must specify either TypeName and Type, or Arn.
TypeArn	string	The Amazon Resource Name (ARN) of the extension. Conditional: You must specify either TypeName and Type, or Arn.
TypeName	string	The name of the extension. Conditional: You must specify either TypeName and Type, or Arn.

SELECT examples

describe_type_registration

Returns information about an extension's registration, including its current status and type and version identifiers. When you initiate a registration request using RegisterType, you can then use DescribeTypeRegistration to monitor the progress of that registration request. Once the registration request has completed, use DescribeType to return detailed information about an extension.

SELECT
line_items
FROM aws.cloudformation.type_registrations
WHERE RegistrationToken = '{{ RegistrationToken }}' -- required
AND region = '{{ region }}' -- required
;

list_type_registrations

Returns a list of registration tokens for the specified extension(s).

SELECT
registration_token
FROM aws.cloudformation.type_registrations
WHERE region = '{{ region }}' -- required
AND Type = '{{ Type }}'
AND TypeName = '{{ TypeName }}'
AND TypeArn = '{{ TypeArn }}'
AND RegistrationStatusFilter = '{{ RegistrationStatusFilter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;