Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cloudformation ]

register-type

Description

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

  • Validating the resource schema
  • Determining which handlers have been specified for the resource
  • Making the resource type available for use in your account

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

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

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  register-type
[--type <value>]
--type-name <value>
--schema-handler-package <value>
[--logging-config <value>]
[--execution-role-arn <value>]
[--client-request-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--type (string)

The kind of type.

Currently, the only valid value is RESOURCE .

Possible values:

  • RESOURCE

--type-name (string)

The name of the type being registered.

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

Note

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

  • Alexa
  • AMZN
  • Amazon
  • AWS
  • Custom
  • Dev

--schema-handler-package (string)

A url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.

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

Note

As part of registering a resource provider type, CloudFormation must be able to access the S3 bucket which contains the schema handler package for that resource provider. For more information, see IAM Permissions for Registering a Resource Provider in the AWS CloudFormation User Guide .

--logging-config (structure)

Specifies logging configuration information for a type.

Shorthand Syntax:

LogRoleArn=string,LogGroupName=string

JSON Syntax:

{
  "LogRoleArn": "string",
  "LogGroupName": "string"
}

--execution-role-arn (string)

The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type 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. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.

--client-request-token (string)

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 a type from the same registeration request, even if the request is submitted multiple times.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To register a resource type

The following register-type example registers the specified resource type as a private resource type in the user's account.

aws cloudformation register-type \
    --type-name My::Organization::ResourceName \
    --schema-handler-package s3://bucket_name/my-organization-resource_name.zip \
    --type RESOURCE

Output:

{
    "RegistrationToken": "f5525280-104e-4d35-bef5-8f1f1example"
}

For more information, see Registering Resource Providers in the CloudFormation Command Line Interface User Guide for Type Development.

Output

RegistrationToken -> (string)

The identifier for this registration request.

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