Class: Aws::CloudFormation::Types::TypeSummary

Inherits:
Struct
  • Object
show all
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

Instance Attribute Details

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

9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
# File 'lib/aws-sdk-cloudformation/types.rb', line 9150

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

#descriptionString

The description of the extension.

Returns:

  • (String)

9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
# File 'lib/aws-sdk-cloudformation/types.rb', line 9150

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_activatedBoolean

Whether or not 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.

Returns:

  • (Boolean)

9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
# File 'lib/aws-sdk-cloudformation/types.rb', line 9150

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_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].

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

Returns:

  • (Time)

9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
# File 'lib/aws-sdk-cloudformation/types.rb', line 9150

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_versionString

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

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

Returns:

  • (String)

9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
# File 'lib/aws-sdk-cloudformation/types.rb', line 9150

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

9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
# File 'lib/aws-sdk-cloudformation/types.rb', line 9150

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_numberString

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

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

Returns:

  • (String)

9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
# File 'lib/aws-sdk-cloudformation/types.rb', line 9150

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_idString

The ID of the extension publisher, if the extension is published by a third party. Extensions published by Amazon do not return a publisher ID.

Returns:

  • (String)

9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
# File 'lib/aws-sdk-cloudformation/types.rb', line 9150

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_identityString

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

Returns:

  • (String)

9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
# File 'lib/aws-sdk-cloudformation/types.rb', line 9150

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_nameString

The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.

Returns:

  • (String)

9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
# File 'lib/aws-sdk-cloudformation/types.rb', line 9150

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

#typeString

The kind of extension.

Returns:

  • (String)

9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
# File 'lib/aws-sdk-cloudformation/types.rb', line 9150

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_arnString

The Amazon Resource Name (ARN) of the extension.

Returns:

  • (String)

9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
# File 'lib/aws-sdk-cloudformation/types.rb', line 9150

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_nameString

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

Returns:

  • (String)

9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
# File 'lib/aws-sdk-cloudformation/types.rb', line 9150

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