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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10525

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.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10525

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.

Returns:

• (Boolean)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10525

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

Returns:

• (Time)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10525

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-party 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 [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)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10525

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 [Use 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)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10525

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

# File 'lib/aws-sdk-cloudformation/types.rb', line 10525

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.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10525

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 [Publishing extensions to make them available for public use] in the *CloudFormation Command Line Interface (CLI) User Guide*.

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10525

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.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10525

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.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10525

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.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10525

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 call the

ActivateType][1

API operation 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)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10525

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