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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudformation/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 type.

Returns:

  • (String)


2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2738

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created)
  SENSITIVE = []
  include Aws::Structure
end

#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)


2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2738

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String)


2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2738

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the registered type.

Returns:

  • (String)


2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2738

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created)
  SENSITIVE = []
  include Aws::Structure
end

#documentation_urlString

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

Returns:

  • (String)


2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2738

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created)
  SENSITIVE = []
  include Aws::Structure
end

#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)


2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2738

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created)
  SENSITIVE = []
  include Aws::Structure
end

#is_default_versionBoolean

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

Returns:

  • (Boolean)


2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2738

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created)
  SENSITIVE = []
  include Aws::Structure
end

#last_updatedTime

When the specified type version was registered.

Returns:

  • (Time)


2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2738

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created)
  SENSITIVE = []
  include Aws::Structure
end

#logging_configTypes::LoggingConfig

Contains logging configuration information for a type.



2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2738

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created)
  SENSITIVE = []
  include Aws::Structure
end

#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

Returns:

  • (String)


2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2738

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created)
  SENSITIVE = []
  include Aws::Structure
end

#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)


2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2738

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created)
  SENSITIVE = []
  include Aws::Structure
end

#source_urlString

The URL of the source code for the type.

Returns:

  • (String)


2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2738

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created)
  SENSITIVE = []
  include Aws::Structure
end

#time_createdTime

When the specified type version was registered.

Returns:

  • (Time)


2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2738

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The kind of type.

Currently the only valid value is RESOURCE.

Returns:

  • (String)


2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2738

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created)
  SENSITIVE = []
  include Aws::Structure
end

#type_nameString

The name of the registered type.

Returns:

  • (String)


2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2738

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String)


2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2738

class DescribeTypeOutput < Struct.new(
  :arn,
  :type,
  :type_name,
  :default_version_id,
  :is_default_version,
  :description,
  :schema,
  :provisioning_type,
  :deprecated_status,
  :logging_config,
  :execution_role_arn,
  :visibility,
  :source_url,
  :documentation_url,
  :last_updated,
  :time_created)
  SENSITIVE = []
  include Aws::Structure
end