Skip to content

Register Type

cloudformation_register_type R Documentation

Registers an extension with the CloudFormation service

Description

Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services 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 about how to develop extensions and ready them for registration, 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 deregister_type to deregister specific extension versions if necessary.

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

Once you have registered a private extension in your account and Region, use set_type_configuration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

Usage

cloudformation_register_type(Type, TypeName, SchemaHandlerPackage,
  LoggingConfig, ExecutionRoleArn, ClientRequestToken)

Arguments

Type

The kind of extension.

TypeName

[required] The name of the extension being registered.

We suggest that extension names adhere to the following patterns:

  • For resource types, company_or_organization::service::type.

  • For modules, company_or_organization::service::type::MODULE.

  • For hooks, MyCompany::Testing::MyTestHook.

The following organization namespaces are reserved and can't be used in your extension names:

  • Alexa

  • AMZN

  • Amazon

  • AWS

  • Custom

  • Dev

SchemaHandlerPackage

[required] A URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register.

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

The user registering the extension must be able to access the package in the S3 bucket. That's, 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 Identity and Access Management User Guide.

LoggingConfig

Specifies logging configuration information for an extension.

ExecutionRoleArn

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principal (resources.cloudformation.amazonaws.com). For more information about adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

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 registration request, even if the request is submitted multiple times.

Value

A list with the following syntax: 

list(
  RegistrationToken = "string"
)

Request syntax

svc$register_type(
  Type = "RESOURCE"|"MODULE"|"HOOK",
  TypeName = "string",
  SchemaHandlerPackage = "string",
  LoggingConfig = list(
    LogRoleArn = "string",
    LogGroupName = "string"
  ),
  ExecutionRoleArn = "string",
  ClientRequestToken = "string"
)