class Aws::CloudFormation::Types::DescribeTypeOutput

@!attribute [rw] arn

The Amazon Resource Name (ARN) of the extension.
@return [String]

@!attribute [rw] type

The kind of extension.
@return [String]

@!attribute [rw] type_name

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][1].

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
@return [String]

@!attribute [rw] default_version_id

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 Amazon and
published by third parties, CloudFormation returns `null`. For more
information, see [RegisterType][1].

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

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
@return [String]

@!attribute [rw] is_default_version

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 Amazon. For public third-party
extensions, whether or not they are activated in your account,
CloudFormation returns `null`.
@return [Boolean]

@!attribute [rw] type_tests_status

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 or not they are activated in your account.

* `PASSED`\: The extension has passed all its contract tests.

  An extension must have a test status of `PASSED` before it can be
  published. For more information, see [Publishing extensions to
  make them available for public use][1] in the *CloudFormation
  Command Line Interface User Guide*.

* `FAILED`\: The extension has failed one or more contract tests.

* `IN_PROGRESS`\: Contract tests are currently being performed on
  the extension.

* `NOT_TESTED`\: Contract tests haven't been performed on the
  extension.

[1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html
@return [String]

@!attribute [rw] type_tests_status_description

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 or not they are activated in your account.
@return [String]

@!attribute [rw] description

The description of the extension.
@return [String]

@!attribute [rw] schema

The schema that defines the extension.

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

[1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html
@return [String]

@!attribute [rw] provisioning_type

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:

* `FULLY_MUTABLE`\: The resource type includes an update handler to
  process updates to the type during stack update operations.

* `IMMUTABLE`\: The resource type doesn't include an update
  handler, so the type can't be updated and must instead be
  replaced during stack update operations.

* `NON_PROVISIONABLE`\: The resource type doesn't include all the
  following handlers, and therefore can't actually be provisioned.

  * create

  * read

  * delete
@return [String]

@!attribute [rw] deprecated_status

The deprecation status of the extension version.

Valid values include:

* `LIVE`\: The extension is activated or registered and can be used
  in CloudFormation operations, dependent on its provisioning
  behavior and visibility scope.

* `DEPRECATED`\: The extension has been deactivated or deregistered
  and can no longer be used in CloudFormation operations.

For public third-party extensions, CloudFormation returns `null`.
@return [String]

@!attribute [rw] logging_config

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 Amazon and
published by third parties, CloudFormation returns `null`. For more
information, see [RegisterType][1].

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
@return [Types::LoggingConfig]

@!attribute [rw] required_activated_types

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.
@return [Array<Types::RequiredActivatedType>]

@!attribute [rw] execution_role_arn

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][1].

If the registered extension calls any Amazon Web Services APIs, you
must create an <i> <a
href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM
execution role</a> </i> that includes the necessary permissions to
call those Amazon Web Services APIs, and provision that execution
role in your account. CloudFormation then assumes that execution
role to provide your extension with the appropriate credentials.

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
@return [String]

@!attribute [rw] 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. CloudFormation marks any
  extensions you register as `PRIVATE`.

* `PUBLIC`\: The extension is publicly visible and usable within any
  Amazon account.
@return [String]

@!attribute [rw] source_url

The URL of the source code for the extension.
@return [String]

@!attribute [rw] documentation_url

The URL of a page providing detailed documentation for this
extension.
@return [String]

@!attribute [rw] last_updated

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

* Private extensions you have registered in your account. For more
  information, see [RegisterType][1].

* Public extensions you have activated in your account with
  auto-update specified. For more information, see
  [ActivateType][2].

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
[2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
@return [Time]

@!attribute [rw] time_created

When the specified private extension version was registered or
activated in your account.
@return [Time]

@!attribute [rw] configuration_schema

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][1]. For more information, see [Configuring
extensions at the account level][2] in the *CloudFormation User
Guide*.

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html
[2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
@return [String]

@!attribute [rw] publisher_id

The publisher ID of the extension publisher.

This applies only to public third-party extensions. For private
registered extensions, and extensions provided by Amazon Web
Services, CloudFormation returns `null`.
@return [String]

@!attribute [rw] original_type_name

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 [Specifying
aliases to refer to extensions][1] in the *CloudFormation User
Guide*.

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias
@return [String]

@!attribute [rw] original_type_arn

For public extensions that have been activated for this account and
region, the Amazon Resource Name (ARN) of the public extension.
@return [String]

@!attribute [rw] public_version_number

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`.
@return [String]

@!attribute [rw] latest_public_version

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`.
@return [String]

@!attribute [rw] is_activated

Whether or not the extension is activated in the account and region.

This only applies to public third-party extensions. For all other
extensions, CloudFormation returns `null`.
@return [Boolean]

@!attribute [rw] auto_update

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 [Activating public
extensions for use in your
account](AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable)
in the *CloudFormation User Guide*.
@return [Boolean]

@see docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeTypeOutput AWS API Documentation

Constants

SENSITIVE