Skip to content

RequiredActivatedType

Source code in docs_src/capo_cloudformation/types/required_activated_type.py
class RequiredActivatedType(TypedDict, closed=True):
    type_name_alias: NotRequired["capo_cloudformation.types.type_name.TypeName"]
    """<p>An alias assigned to the public extension, in this account and Region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.</p>"""
    original_type_name: NotRequired["capo_cloudformation.types.type_name.TypeName"]
    """<p>The type name of the public extension.</p> <p>If you specified a <code>TypeNameAlias</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias">Use aliases to refer to extensions</a> in the <i>CloudFormation User Guide</i>.</p>"""
    publisher_id: NotRequired["capo_cloudformation.types.publisher_id.PublisherId"]
    """<p>The publisher ID of the extension publisher.</p>"""
    supported_major_versions: NotRequired[
        "capo_cloudformation.types.supported_major_versions.SupportedMajorVersions"
    ]
    """<p>A list of the major versions of the extension type that the macro supports.</p>"""

original_type_name instance-attribute

original_type_name: NotRequired[TypeName]

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.

publisher_id instance-attribute

publisher_id: NotRequired[PublisherId]

The publisher ID of the extension publisher.

supported_major_versions instance-attribute

supported_major_versions: NotRequired[SupportedMajorVersions]

A list of the major versions of the extension type that the macro supports.

type_name_alias instance-attribute

type_name_alias: NotRequired[TypeName]

An alias assigned to the public extension, in this account and Region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.