Class: Aws::CloudFormation::Types::TypeSummary
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudFormation::Types::TypeSummary
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-cloudformation/types.rb
Overview
Contains summary information about the specified CloudFormation extension.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#default_version_id ⇒ String
The ID of the default version of the extension.
-
#description ⇒ String
The description of the extension.
-
#is_activated ⇒ Boolean
Whether the extension is activated for this account and region.
-
#last_updated ⇒ Time
When the specified extension version was registered.
-
#latest_public_version ⇒ String
For public extensions that have been activated for this account and region, the latest version of the public extension *that is available*.
-
#original_type_name ⇒ String
For public extensions that have been activated for this account and region, the type name of the public extension.
-
#public_version_number ⇒ String
For public extensions that have been activated for this account and region, the version of the public extension to be used for CloudFormation operations in this account and Region.
-
#publisher_id ⇒ String
The ID of the extension publisher, if the extension is published by a third party.
-
#publisher_identity ⇒ String
The service used to verify the publisher identity.
-
#publisher_name ⇒ String
The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.
-
#type ⇒ String
The kind of extension.
-
#type_arn ⇒ String
The Amazon Resource Name (ARN) of the extension.
-
#type_name ⇒ String
The name of the extension.
Instance Attribute Details
#default_version_id ⇒ String
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].
To set the default version of an extension, use ` SetTypeDefaultVersion `.
[1]: docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 8695 class TypeSummary < Struct.new( :type, :type_name, :default_version_id, :type_arn, :last_updated, :description, :publisher_id, :original_type_name, :public_version_number, :latest_public_version, :publisher_identity, :publisher_name, :is_activated) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The description of the extension.
8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 8695 class TypeSummary < Struct.new( :type, :type_name, :default_version_id, :type_arn, :last_updated, :description, :publisher_id, :original_type_name, :public_version_number, :latest_public_version, :publisher_identity, :publisher_name, :is_activated) SENSITIVE = [] include Aws::Structure end |
#is_activated ⇒ Boolean
Whether the extension is activated for this account and region.
This applies only to third-party public extensions. Extensions published by Amazon are activated by default.
8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 8695 class TypeSummary < Struct.new( :type, :type_name, :default_version_id, :type_arn, :last_updated, :description, :publisher_id, :original_type_name, :public_version_number, :latest_public_version, :publisher_identity, :publisher_name, :is_activated) SENSITIVE = [] include Aws::Structure end |
#last_updated ⇒ Time
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].
For all other extension types, CloudFormation returns `null`.
[1]: docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html [2]: docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 8695 class TypeSummary < Struct.new( :type, :type_name, :default_version_id, :type_arn, :last_updated, :description, :publisher_id, :original_type_name, :public_version_number, :latest_public_version, :publisher_identity, :publisher_name, :is_activated) SENSITIVE = [] include Aws::Structure end |
#latest_public_version ⇒ String
For public extensions that have been activated for this account and region, the latest version of the public extension *that is available*. For any extensions other than activated third-arty extensions, CloudFormation returns `null`.
How you specified `AutoUpdate` when enabling the extension affects whether CloudFormation automatically updates the extension in this account and region when a new version is released. For more information, see [Setting CloudFormation to automatically use new versions of extensions] in the *CloudFormation User Guide*.
8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 8695 class TypeSummary < Struct.new( :type, :type_name, :default_version_id, :type_arn, :last_updated, :description, :publisher_id, :original_type_name, :public_version_number, :latest_public_version, :publisher_identity, :publisher_name, :is_activated) SENSITIVE = [] include Aws::Structure end |
#original_type_name ⇒ String
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*.
8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 8695 class TypeSummary < Struct.new( :type, :type_name, :default_version_id, :type_arn, :last_updated, :description, :publisher_id, :original_type_name, :public_version_number, :latest_public_version, :publisher_identity, :publisher_name, :is_activated) SENSITIVE = [] include Aws::Structure end |
#public_version_number ⇒ String
For public extensions that have been activated for this account and region, the version of the public extension to be used for CloudFormation operations in this account and Region.
How you specified `AutoUpdate` when enabling the extension affects whether CloudFormation automatically updates the extension in this account and region when a new version is released. For more information, see [Setting CloudFormation to automatically use new versions of extensions] in the *CloudFormation User Guide*.
8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 8695 class TypeSummary < Struct.new( :type, :type_name, :default_version_id, :type_arn, :last_updated, :description, :publisher_id, :original_type_name, :public_version_number, :latest_public_version, :publisher_identity, :publisher_name, :is_activated) SENSITIVE = [] include Aws::Structure end |
#publisher_id ⇒ String
The ID of the extension publisher, if the extension is published by a third party. Extensions published by Amazon don't return a publisher ID.
8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 8695 class TypeSummary < Struct.new( :type, :type_name, :default_version_id, :type_arn, :last_updated, :description, :publisher_id, :original_type_name, :public_version_number, :latest_public_version, :publisher_identity, :publisher_name, :is_activated) SENSITIVE = [] include Aws::Structure end |
#publisher_identity ⇒ String
The service used to verify the publisher identity.
For more information, see [Registering your account to publish CloudFormation extensions] in the CFN-CLI User Guide for Extension Development.
[1]: docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html
8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 8695 class TypeSummary < Struct.new( :type, :type_name, :default_version_id, :type_arn, :last_updated, :description, :publisher_id, :original_type_name, :public_version_number, :latest_public_version, :publisher_identity, :publisher_name, :is_activated) SENSITIVE = [] include Aws::Structure end |
#publisher_name ⇒ String
The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.
8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 8695 class TypeSummary < Struct.new( :type, :type_name, :default_version_id, :type_arn, :last_updated, :description, :publisher_id, :original_type_name, :public_version_number, :latest_public_version, :publisher_identity, :publisher_name, :is_activated) SENSITIVE = [] include Aws::Structure end |
#type ⇒ String
The kind of extension.
8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 8695 class TypeSummary < Struct.new( :type, :type_name, :default_version_id, :type_arn, :last_updated, :description, :publisher_id, :original_type_name, :public_version_number, :latest_public_version, :publisher_identity, :publisher_name, :is_activated) SENSITIVE = [] include Aws::Structure end |
#type_arn ⇒ String
The Amazon Resource Name (ARN) of the extension.
8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 8695 class TypeSummary < Struct.new( :type, :type_name, :default_version_id, :type_arn, :last_updated, :description, :publisher_id, :original_type_name, :public_version_number, :latest_public_version, :publisher_identity, :publisher_name, :is_activated) SENSITIVE = [] include Aws::Structure end |
#type_name ⇒ String
The name of the extension.
If you specified a `TypeNameAlias` when you [activate this extension] in your account and region, CloudFormation considers that alias as the type name.
[1]: docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 8695 class TypeSummary < Struct.new( :type, :type_name, :default_version_id, :type_arn, :last_updated, :description, :publisher_id, :original_type_name, :public_version_number, :latest_public_version, :publisher_identity, :publisher_name, :is_activated) SENSITIVE = [] include Aws::Structure end |