DescribeType - AWS CloudFormation

DescribeType

Returns detailed information about an extension that has been registered.

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

Request Parameters

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

Arn

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

Type

The kind of extension.

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

Type: String

Valid Values: RESOURCE | MODULE

Required: No

TypeName

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

VersionId

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

Response Elements

The following elements are returned by the service.

Arn

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/.+

DefaultVersionId

The ID of the default version of the extension. The default version is used when the extension version is not specified.

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-]+

DeprecatedStatus

The deprecation status of the extension version.

Valid values include:

  • LIVE: The extension is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.

  • DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.

Type: String

Valid Values: LIVE | DEPRECATED

Description

The description of the registered extension.

Type: String

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

DocumentationUrl

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

Type: String

Length Constraints: Maximum length of 4096.

ExecutionRoleArn

The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. 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 extension with the appropriate credentials.

Type: String

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

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

IsDefaultVersion

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

Type: Boolean

LastUpdated

When the specified extension version was registered.

Type: Timestamp

LoggingConfig

Contains logging configuration information for an extension.

Type: LoggingConfig object

ProvisioningType

The provisioning behavior of the extension. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

  • FULLY_MUTABLE: The extension includes an update handler to process updates to the extension during stack update operations.

  • IMMUTABLE: The extension does not include an update handler, so the extension cannot be updated and must instead be replaced during stack update operations.

  • NON_PROVISIONABLE: The extension does not include all of the following handlers, and therefore cannot actually be provisioned.

    • create

    • read

    • delete

Type: String

Valid Values: NON_PROVISIONABLE | IMMUTABLE | FULLY_MUTABLE

Schema

The schema that defines the extension.

For more information on extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.

Type: String

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

SourceUrl

The URL of the source code for the extension.

Type: String

Length Constraints: Maximum length of 4096.

TimeCreated

When the specified extension version was registered.

Type: Timestamp

Type

The kind of extension.

Type: String

Valid Values: RESOURCE | MODULE

TypeName

The name of the registered extension.

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}

Visibility

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

Valid values include:

  • PRIVATE: The extension is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.

  • PUBLIC: The extension is publically visible and usable within any Amazon account.

Type: String

Valid Values: PUBLIC | PRIVATE

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

TypeNotFound

The specified type does not exist in the CloudFormation registry.

HTTP Status Code: 404

Examples

DescribeType

This example illustrates one usage of DescribeType.

Sample Request

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

Sample Response

<DescribeTypeResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/"> <DescribeTypeResult> <Schema>{ [details omitted] } </Schema> <Visibility>PRIVATE</Visibility> <DeprecatedStatus>LIVE</DeprecatedStatus> <TypeName>My::Resource::Example</TypeName> <Description>Resource schema for My::Resource::Example</Description> <Type>RESOURCE</Type> <SourceUrl>https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git</SourceUrl> <LastUpdated>2019-12-03T23:29:33.321Z</LastUpdated> <ProvisioningType>FULLY_MUTABLE</ProvisioningType> <TimeCreated>2019-12-03T23:29:33.321Z</TimeCreated> <Arn>arn:aws:cloudformation:us-east-1:012345678910:type/resource/My-Resource-Example/00000002</Arn> </DescribeTypeResult> <ResponseMetadata> <RequestId>8d2dd588-b16f-4096-8516-ee941example</RequestId> </ResponseMetadata> </DescribeTypeResponse>

See Also

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