DescribeType

The Amazon Resource Name (ARN) of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+

Required: No

The version number of a public third-party extension.

Type: String

Length Constraints: Minimum length of 5.

Pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(.*)$

Required: No

The publisher ID of the extension publisher.

Extensions provided by AWS are not assigned a publisher ID.

Type: String

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

Pattern: [0-9a-zA-Z]{12,40}

Required: No

The kind of extension.

Conditional: You must specify either TypeName and Type, or Arn.

Type: String

Valid Values: RESOURCE | MODULE | HOOK

Required: No

The name of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

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: No

The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.

Type: String

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

Pattern: [A-Za-z0-9-]+

Required: No

The Amazon Resource Name (ARN) of the extension.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+

Whether CloudFormation automatically updates the extension in this account and Region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. For more information, see Automatically use new versions of extensions in the AWS CloudFormation User Guide.

Type: Boolean

A JSON string that represent the current configuration data for the extension in this account and Region.

To set the configuration data for an extension, use SetTypeConfiguration. For more information, see Edit configuration data for extensions in your account in the AWS CloudFormation User Guide.

Type: String

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

Pattern: [\s\S]+

The ID of the default version of the extension. The default version is used when the extension version isn't specified.

This applies only to private extensions you have registered in your account. For public extensions, both those provided by AWS and published by third parties, CloudFormation returns null. For more information, see RegisterType.

To set the default version of an extension, use SetTypeDefaultVersion.

Type: String

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

Pattern: [A-Za-z0-9-]+

The deprecation status of the extension version.

Valid values include:

For public third-party extensions, CloudFormation returns null.

Type: String

Valid Values: LIVE | DEPRECATED

The description of the extension.

Type: String

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

The URL of a page providing detailed documentation for this extension.

Type: String

Length Constraints: Maximum length of 4096.

The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to private extensions you have registered in your account. For more information, see RegisterType.

If the registered extension calls any AWS APIs, 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 extension with the appropriate credentials.

Type: String

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

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

Whether the extension is activated in the account and Region.

This only applies to public third-party extensions. For all other extensions, CloudFormation returns null.

Type: Boolean

Whether the specified extension version is set as the default version.

This applies only to private extensions you have registered in your account, and extensions published by AWS. For public third-party extensions, whether they are activated in your account, CloudFormation returns null.

Type: Boolean

When the specified extension version was registered. This applies only to:

Type: Timestamp

The latest version of a public extension that is available for use.

This only applies if you specify a public extension, and you don't specify a version. For all other requests, CloudFormation returns null.

Type: String

Length Constraints: Minimum length of 5.

Pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(.*)$

Contains logging configuration information for private extensions. This applies only to private extensions you have registered in your account. For public extensions, both those provided by AWS and published by third parties, CloudFormation returns null. For more information, see RegisterType.

Type: LoggingConfig object

For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of the public extension.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+

For public extensions that have been activated for this account and Region, the type name of the public extension.

If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Use aliases to refer to extensions in the AWS CloudFormation User Guide.

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}

For resource type extensions, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

Type: String

Valid Values: NON_PROVISIONABLE | IMMUTABLE | FULLY_MUTABLE

The version number of a public third-party extension.

This applies only if you specify a public extension you have activated in your account, or specify a public extension without specifying a version. For all other extensions, CloudFormation returns null.

Type: String

Length Constraints: Minimum length of 5.

Pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(.*)$

The publisher ID of the extension publisher.

This applies only to public third-party extensions. For private registered extensions, and extensions provided by AWS, CloudFormation returns null.

Type: String

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

Pattern: [0-9a-zA-Z]{12,40}

For extensions that are modules, the public third-party extensions that must be activated in your account in order for the module itself to be activated.

Type: Array of RequiredActivatedType objects

The schema that defines the extension.

For more information about extension schemas, see Resource type schema in the AWS CloudFormation Command Line Interface (CLI) User Guide.

Type: String

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

The URL of the source code for the extension.

Type: String

Length Constraints: Maximum length of 4096.

When the specified private extension version was registered or activated in your account.

Type: Timestamp

The kind of extension.

Type: String

Valid Values: RESOURCE | MODULE | HOOK

The name of the extension.

If the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the type name alias. For more information, see ActivateType.

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}

The contract test status of the registered extension version. To return the extension test status of a specific extension version, you must specify VersionId.

This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.

Type: String

Valid Values: PASSED | FAILED | IN_PROGRESS | NOT_TESTED

The description of the test status. To return the extension test status of a specific extension version, you must specify VersionId.

This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.

Type: String

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

Pattern: [\s\S]+

The scope at which the extension is visible and usable in CloudFormation operations.

Valid values include:

Type: String

Valid Values: PUBLIC | PRIVATE

An error occurred during a CloudFormation registry operation.

HTTP Status Code: 400

The specified extension doesn't exist in the CloudFormation registry.

HTTP Status Code: 404