Skip to content

TypeSummary

Structure Class

TypeSummary dataclass

Bases: _SerdeShape

Contains summary information about the specified CloudFormation extension.

Attributes

default_version_id class-attribute instance-attribute
default_version_id: str | None = ...

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.

description class-attribute instance-attribute
description: str | None = ...

The description of the extension.

is_activated class-attribute instance-attribute
is_activated: bool | None = ...

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.

last_updated class-attribute instance-attribute
last_updated: datetime | None = ...

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.

latest_public_version class-attribute instance-attribute
latest_public_version: str | None = ...

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.

original_type_name class-attribute instance-attribute
original_type_name: str | None = ...

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.

public_version_number class-attribute instance-attribute
public_version_number: str | None = ...

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.

publisher_id class-attribute instance-attribute
publisher_id: str | None = ...

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.

publisher_identity class-attribute instance-attribute
publisher_identity: str | None = ...

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.

publisher_name class-attribute instance-attribute
publisher_name: str | None = ...

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

type class-attribute instance-attribute
type: str | None = ...

The kind of extension.

type_arn class-attribute instance-attribute
type_arn: str | None = ...

The ARN of the extension.

type_name class-attribute instance-attribute
type_name: str | None = ...

The name of the extension.

If you specified a TypeNameAlias when you call the ActivateType API operation in your account and Region, CloudFormation considers that alias as the type name.