Skip to content

ActivateTypeInput

Source code in docs_src/capo_cloudformation/types/activate_type_input.py
class ActivateTypeInput(TypedDict, closed=True):
    type: NotRequired["capo_cloudformation.types.third_party_type.ThirdPartyType"]
    """<p>The extension type.</p> <p>Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>, <code>Type</code>, and <code>PublisherId</code>.</p>"""
    public_type_arn: NotRequired[
        "capo_cloudformation.types.third_party_type_arn.ThirdPartyTypeArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the public extension.</p> <p>Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>, <code>Type</code>, and <code>PublisherId</code>.</p>"""
    publisher_id: NotRequired["capo_cloudformation.types.publisher_id.PublisherId"]
    """<p>The ID of the extension publisher.</p> <p>Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>, <code>Type</code>, and <code>PublisherId</code>.</p>"""
    type_name: NotRequired["capo_cloudformation.types.type_name.TypeName"]
    """<p>The name of the extension.</p> <p>Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>, <code>Type</code>, and <code>PublisherId</code>.</p>"""
    type_name_alias: NotRequired["capo_cloudformation.types.type_name.TypeName"]
    """<p>An alias to assign 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> <p>An extension alias must be unique within a given account and Region. You can activate the same public resource multiple times in the same account and Region, using different type name aliases.</p>"""
    auto_update: NotRequired["capo_cloudformation.types.auto_update.AutoUpdate"]
    """<p>Whether to automatically update the extension in this account and Region when a new <i>minor</i> version is published by the extension publisher. Major versions released by the publisher must be manually updated.</p> <p>The default is <code>true</code>.</p>"""
    logging_config: NotRequired[
        "capo_cloudformation.types.logging_config.LoggingConfig"
    ]
    """<p>Contains logging configuration information for an extension.</p>"""
    execution_role_arn: NotRequired["capo_cloudformation.types.role_arn2.RoleARN2"]
    """<p>The name of the IAM execution role to use to activate the extension.</p>"""
    version_bump: NotRequired["capo_cloudformation.types.version_bump.VersionBump"]
    """<p>Manually updates a previously-activated type to a new major or minor version, if available. You can also use this parameter to update the value of <code>AutoUpdate</code>.</p> <ul> <li> <p> <code>MAJOR</code>: CloudFormation updates the extension to the newest major version, if one is available.</p> </li> <li> <p> <code>MINOR</code>: CloudFormation updates the extension to the newest minor version, if one is available.</p> </li> </ul>"""
    major_version: NotRequired["capo_cloudformation.types.major_version.MajorVersion"]
    """<p>The major version of this extension you want to activate, if multiple major versions are available. The default is the latest major version. CloudFormation uses the latest available <i>minor</i> version of the major version selected.</p> <p>You can specify <code>MajorVersion</code> or <code>VersionBump</code>, but not both.</p>"""

auto_update instance-attribute

auto_update: NotRequired[AutoUpdate]

Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.

The default is true.

execution_role_arn instance-attribute

execution_role_arn: NotRequired[RoleARN2]

The name of the IAM execution role to use to activate the extension.

logging_config instance-attribute

logging_config: NotRequired[LoggingConfig]

Contains logging configuration information for an extension.

major_version instance-attribute

major_version: NotRequired[MajorVersion]

The major version of this extension you want to activate, if multiple major versions are available. The default is the latest major version. CloudFormation uses the latest available minor version of the major version selected.

You can specify MajorVersion or VersionBump, but not both.

public_type_arn instance-attribute

public_type_arn: NotRequired[ThirdPartyTypeArn]

The Amazon Resource Name (ARN) of the public extension.

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

publisher_id instance-attribute

publisher_id: NotRequired[PublisherId]

The ID of the extension publisher.

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

type instance-attribute

type: NotRequired[ThirdPartyType]

The extension type.

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

type_name instance-attribute

type_name: NotRequired[TypeName]

The name of the extension.

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

type_name_alias instance-attribute

type_name_alias: NotRequired[TypeName]

An alias to assign 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.

An extension alias must be unique within a given account and Region. You can activate the same public resource multiple times in the same account and Region, using different type name aliases.

version_bump instance-attribute

version_bump: NotRequired[VersionBump]

Manually updates a previously-activated type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdate.

  • MAJOR: CloudFormation updates the extension to the newest major version, if one is available.

  • MINOR: CloudFormation updates the extension to the newest minor version, if one is available.