RegisterType - AWS CloudFormation

RegisterType

Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your AWS account, and includes:

  • Validating the extension schema

  • Determining which handlers, if any, have been specified for the extension

  • Making the extension available for use in your account

For more information on how to develop extensions and ready them for registeration, see Creating Resource Providers in the CloudFormation CLI User Guide.

You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per region. Use DeregisterType to deregister specific extension versions if necessary.

Once you have initiated a registration request using RegisterType , you can use DescribeTypeRegistration to monitor the progress of the registration request.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ClientRequestToken

A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of an extension from the same registeration request, even if the request is submitted multiple times.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9][-a-zA-Z0-9]*

Required: No

ExecutionRoleArn

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension. If your extension calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the extension handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the extension handler, thereby supplying your extension with the appropriate credentials.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: arn:.+:iam::[0-9]{12}:role/.+

Required: No

LoggingConfig

Specifies logging configuration information for an extension.

Type: LoggingConfig object

Required: No

SchemaHandlerPackage

A url to the S3 bucket containing the extension project package that contains the neccessary files for the extension you want to register.

For information on generating a schema handler package for the extension you want to register, see submit in the CloudFormation CLI User Guide.

Note

The user registering the extension must be able to access the package in the S3 bucket. That is, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the AWS Identity and Access Management User Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Required: Yes

Type

The kind of extension.

Type: String

Valid Values: RESOURCE | MODULE

Required: No

TypeName

The name of the extension being registered.

We recommend that extension names adhere to the following pattern: company_or_organization::service::type.

Note

The following organization namespaces are reserved and cannot be used in your extension names:

  • Alexa

  • AMZN

  • Amazon

  • AWS

  • Custom

  • Dev

Type: String

Length Constraints: Minimum length of 10. Maximum length of 204.

Pattern: [A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}

Required: Yes

Response Elements

The following element is returned by the service.

RegistrationToken

The identifier for this registration request.

Use this registration token when calling DescribeTypeRegistration , which returns information about the status and IDs of the extension registration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9][-a-zA-Z0-9]*

Errors

For information about the errors that are common to all actions, see Common Errors.

CFNRegistry

An error occurred during a CloudFormation registry operation.

HTTP Status Code: 400

Examples

RegisterType

This example illustrates one usage of RegisterType.

Sample Request

https://cloudformation.us-east-1.amazonaws.com/ ?Action=RegisterType &Version=2010-05-15 &TypeName=My::Resource::Example &SchemaHandlerPackage=[s3 url] &Type=RESOURCE &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=[Access key ID and scope] &X-Amz-Date=20171211T230005Z &X-Amz-SignedHeaders=content-type;host &X-Amz-Signature=[Signature]

Sample Response

<RegisterTypeResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/"> <RegisterTypeResult> <RegistrationToken>f5525280-104e-4d35-bef5-8f1f1example</RegistrationToken> </RegisterTypeResult> <ResponseMetadata> <RequestId>4d121847-1d2b-4ebe-8ca5-499405example</RequestId> </ResponseMetadata> </RegisterTypeResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: