describe-type¶

Description¶

Returns detailed information about a type that has been registered.

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

Synopsis¶

  describe-type
[--type <value>]
[--type-name <value>]
[--arn <value>]
[--version-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--type (string)

The kind of type.

Currently the only valid value is RESOURCE .

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

Possible values:

RESOURCE

MODULE

--type-name (string)

The name of the type.

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

--arn (string)

The Amazon Resource Name (ARN) of the type.

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

--version-id (string)

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

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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 display type information

The following describe-type example displays information for the specified type.

aws cloudformation describe-type \
    --type-name My::Logs::LogGroup \
    --type RESOURCE

Output:

{
    "SourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git",
    "Description": "Customized resource derived from AWS::Logs::LogGroup",
    "TimeCreated": "2019-12-03T23:29:33.321Z",
    "Visibility": "PRIVATE",
    "TypeName": "My::Logs::LogGroup",
    "LastUpdated": "2019-12-03T23:29:33.321Z",
    "DeprecatedStatus": "LIVE",
    "ProvisioningType": "FULLY_MUTABLE",
    "Type": "RESOURCE",
    "Arn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Logs-LogGroup/00000001",
    "Schema": "[details omitted]"
}

For more information, see Using the CloudFormation Registry in the AWS CloudFormation Users Guide.

Output¶

Arn -> (string)

The Amazon Resource Name (ARN) of the type.

Type -> (string)

The kind of type.

Currently the only valid value is RESOURCE .

TypeName -> (string)

The name of the registered type.

DefaultVersionId -> (string)

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

To set the default version of a type, use `` SetTypeDefaultVersion `` .

IsDefaultVersion -> (boolean)

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

Description -> (string)

The description of the registered type.

Schema -> (string)

The schema that defines the type.

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

ProvisioningType -> (string)

The provisioning behavior of the type. 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 type includes an update handler to process updates to the type during stack update operations.

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

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

create

read

delete

DeprecatedStatus -> (string)

The deprecation status of the type.

Valid values include:

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

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

LoggingConfig -> (structure)

Contains logging configuration information for a type.

LogRoleArn -> (string)

The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.

LogGroupName -> (string)

The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type’s handlers.

ExecutionRoleArn -> (string)

The Amazon Resource Name (ARN) of the IAM execution role used 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.

Visibility -> (string)

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

Valid values include:

PRIVATE : The type 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 type is publically visible and usable within any Amazon account.

SourceUrl -> (string)

The URL of the source code for the type.

DocumentationUrl -> (string)

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

LastUpdated -> (timestamp)

When the specified type version was registered.

TimeCreated -> (timestamp)