Skip to content

register_type

Operation

register_type

register_type(request: RegisterTypeInput | RegisterTypeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RegisterTypeInputDict]) -> RegisterTypeOutput

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 types using the CloudFormation CLI in the CloudFormation Command Line Interface (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.

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

Parameters:

Name Type Description Default
request RegisterTypeInput | RegisterTypeInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[RegisterTypeInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
RegisterTypeOutput

An instance of RegisterTypeOutput.

register_type async

register_type(request: RegisterTypeInput | RegisterTypeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RegisterTypeInputDict]) -> RegisterTypeOutput

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 types using the CloudFormation CLI in the CloudFormation Command Line Interface (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.

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

Parameters:

Name Type Description Default
request RegisterTypeInput | RegisterTypeInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[RegisterTypeInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
RegisterTypeOutput

An instance of RegisterTypeOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

RegisterTypeInputDict

Bases: TypedDict

Dictionary form of RegisterTypeInput.

Attributes

client_request_token instance-attribute
client_request_token: str | None

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.

execution_role_arn instance-attribute
execution_role_arn: str | None

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.

logging_config instance-attribute
logging_config: LoggingConfig | LoggingConfigDict | None

Specifies logging configuration information for an extension.

schema_handler_package instance-attribute
schema_handler_package: Required[str]

A URL to the S3 bucket that contains 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 Command Line Interface (CLI) User Guide.

Note

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.

type instance-attribute
type: str | None

The kind of extension.

type_name instance-attribute
type_name: Required[str]

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.

Note

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

  • Alexa

  • AMZN

  • Amazon

  • AWS

  • Custom

  • Dev

RegisterTypeInput dataclass

Bases: _SerdeShape

Dataclass for RegisterTypeInput structure.

Attributes

client_request_token class-attribute instance-attribute
client_request_token: str | None = ...

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.

execution_role_arn class-attribute instance-attribute
execution_role_arn: str | None = ...

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.

logging_config class-attribute instance-attribute
logging_config: LoggingConfig | None = ...

Specifies logging configuration information for an extension.

schema_handler_package class-attribute instance-attribute
schema_handler_package: str | None = ...

A URL to the S3 bucket that contains 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 Command Line Interface (CLI) User Guide.

Note

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.

type class-attribute instance-attribute
type: str | None = ...

The kind of extension.

type_name class-attribute instance-attribute
type_name: str | None = ...

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.

Note

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

  • Alexa

  • AMZN

  • Amazon

  • AWS

  • Custom

  • Dev

Output

RegisterTypeOutput dataclass

Bases: _SerdeShape

Dataclass for RegisterTypeOutput structure.

Attributes

registration_token class-attribute instance-attribute
registration_token: str | None = ...

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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.