AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Returns:

  • (String)


2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2969

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

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

Returns:

  • (String)


2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2969

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 extension version.

Valid values include:

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

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

Returns:

  • (String)


2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2969

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

Returns:

  • (String)


2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2969

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

Returns:

  • (String)


2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2969

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 extension. 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 extension with the appropriate credentials.

Returns:

  • (String)


2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2969

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 extension version is set as the default version.

Returns:

  • (Boolean)


2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2969

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 extension version was registered.

Returns:

  • (Time)


2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2969

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 an extension.



2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2969

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 extension. 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 extension includes an update handler to process updates to the extension during stack update operations.

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

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

    • create

    • read

    • delete

Returns:

  • (String)


2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2969

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

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

Returns:

  • (String)


2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2969

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

Returns:

  • (String)


2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2969

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 extension version was registered.

Returns:

  • (Time)


2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2969

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

Returns:

  • (String)


2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2969

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

Returns:

  • (String)


2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2969

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 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. Currently, AWS CloudFormation marks any types you register as PRIVATE.

  • PUBLIC: The extension is publically visible and usable within any Amazon account.

Returns:

  • (String)


2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2969

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