You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudFormation::Types::DescribeTypeOutput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the type.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the type.

#default_version_idString

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.

Returns:

  • (String)

    The ID of the default version of the type.

#deprecated_statusString

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.

    Possible values:

    • LIVE
    • DEPRECATED

Returns:

  • (String)

    The deprecation status of the type.

#descriptionString

The description of the registered type.

Returns:

  • (String)

    The description of the registered type.

#documentation_urlString

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

Returns:

  • (String)

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

#execution_role_arnString

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.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the IAM execution role used to register the type.

#last_updatedTime

When the specified type version was registered.

Returns:

  • (Time)

    When the specified type version was registered.

#logging_configTypes::LoggingConfig

Contains logging configuration information for a type.

Returns:

#provisioning_typeString

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

      Possible values:

      • NON_PROVISIONABLE
      • IMMUTABLE
      • FULLY_MUTABLE

Returns:

  • (String)

    The provisioning behavior of the type.

#schemaString

The schema that defines the type.

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

Returns:

  • (String)

    The schema that defines the type.

#source_urlString

The URL of the source code for the type.

Returns:

  • (String)

    The URL of the source code for the type.

#time_createdTime

When the specified type version was registered.

Returns:

  • (Time)

    When the specified type version was registered.

#typeString

The kind of type.

Currently the only valid value is RESOURCE.

Possible values:

  • RESOURCE

Returns:

  • (String)

    The kind of type.

#type_nameString

The name of the registered type.

Returns:

  • (String)

    The name of the registered type.

#visibilityString

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.

    Possible values:

    • PUBLIC
    • PRIVATE

Returns:

  • (String)

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