Documentation

Contains summary information about the specified CloudFormation extension.

See: newTypeSummary smart constructor.

Create a value of TypeSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:defaultVersionId:TypeSummary', typeSummary_defaultVersionId - 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 .

$sel:description:TypeSummary', typeSummary_description - The description of the extension.

$sel:isActivated:TypeSummary', typeSummary_isActivated - 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.

$sel:lastUpdated:TypeSummary', typeSummary_lastUpdated - 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.

$sel:latestPublicVersion:TypeSummary', typeSummary_latestPublicVersion - 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.

$sel:originalTypeName:TypeSummary', typeSummary_originalTypeName - 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.

$sel:publicVersionNumber:TypeSummary', typeSummary_publicVersionNumber - 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.

$sel:publisherId:TypeSummary', typeSummary_publisherId - 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.

$sel:publisherIdentity:TypeSummary', typeSummary_publisherIdentity - 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.

$sel:publisherName:TypeSummary', typeSummary_publisherName - The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.

$sel:type':TypeSummary', typeSummary_type - The kind of extension.

$sel:typeArn:TypeSummary', typeSummary_typeArn - The Amazon Resource Name (ARN) of the extension.

$sel:typeName:TypeSummary', typeSummary_typeName - 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.

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 .

The description of the extension.

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.

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.

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.

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.

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.

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.

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.

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

The kind of extension.

The Amazon Resource Name (ARN) of the extension.

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.