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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudformation/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the extension.

Returns:

  • (String)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#auto_updateBoolean

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*.

Returns:

  • (Boolean)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_schemaString

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 [Configuring extensions at the account level] in the *CloudFormation User Guide*.

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

Returns:

  • (String)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#default_version_idString

The ID of the default version of the extension. The default version is used when the extension version is not 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].

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

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html

Returns:

  • (String)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#deprecated_statusString

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`.

Returns:

  • (String)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the extension.

Returns:

  • (String)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#documentation_urlString

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

Returns:

  • (String)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_arnString

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 Amazon Web Services APIs, you must create an <a href=“https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html”>IAM execution role</a> 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]: docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html

Returns:

  • (String)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#is_activatedBoolean

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`.

Returns:

  • (Boolean)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#is_default_versionBoolean

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`.

Returns:

  • (Boolean)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#last_updatedTime

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

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

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

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

Returns:

  • (Time)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#latest_public_versionString

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

This only applies if you specify a public extension, and you do not specify a version. For all other requests, CloudFormation returns `null`.

Returns:

  • (String)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#logging_configTypes::LoggingConfig

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]: docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html


3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#original_type_arnString

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

Returns:

  • (String)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#original_type_nameString

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] in the *CloudFormation User Guide*.

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

Returns:

  • (String)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#provisioning_typeString

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 does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.

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

    • create

    • read

    • delete

Returns:

  • (String)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#public_version_numberString

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`.

Returns:

  • (String)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#publisher_idString

The publisher ID of the extension publisher.

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

Returns:

  • (String)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#required_activated_typesArray<Types::RequiredActivatedType>

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.

Returns:


3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#schemaString

The schema that defines the extension.

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

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

Returns:

  • (String)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#source_urlString

The URL of the source code for the extension.

Returns:

  • (String)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#time_createdTime

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

Returns:

  • (Time)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The kind of extension.

Returns:

  • (String)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#type_nameString

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]: docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html

Returns:

  • (String)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#type_tests_statusString

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

This applies only to registered private extension versions. CloudFormation does not 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] 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 have not been performed on the extension.

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

Returns:

  • (String)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#type_tests_status_descriptionString

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

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

Returns:

  • (String)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end

#visibilityString

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 publically visible and usable within any Amazon account.

Returns:

  • (String)

3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
# File 'lib/aws-sdk-cloudformation/types.rb', line 3466

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :type_tests_status,
  :type_tests_status_description,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :required_activated_types,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created,
  :configuration_schema,
  :publisher_id,
  :original_type_name,
  :original_type_arn,
  :public_version_number,
  :latest_public_version,
  :is_activated,
  :auto_update)
  SENSITIVE = []
  include Aws::Structure
end