Skip to content

activate_type

Operation

activate_type

activate_type(request: ActivateTypeInput | ActivateTypeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ActivateTypeInputDict]) -> ActivateTypeOutput

Activates a public third-party extension, such as a resource or module, to make it available for use in stack templates in your current account and Region. It can also create CloudFormation Hooks, which allow you to evaluate resource configurations before CloudFormation provisions them. Hooks integrate with both CloudFormation and Cloud Control API operations.

After you activate an extension, you can use SetTypeConfiguration to set specific properties for the extension.

To see which extensions have been activated, use ListTypes. To see configuration details for an extension, use DescribeType.

For more information, see Activate a third-party public extension in your account in the CloudFormation User Guide. For information about creating Hooks, see the CloudFormation Hooks User Guide.

Parameters:

Name Type Description Default
request ActivateTypeInput | ActivateTypeInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ActivateTypeInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ActivateTypeOutput

An instance of ActivateTypeOutput.

activate_type async

activate_type(request: ActivateTypeInput | ActivateTypeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ActivateTypeInputDict]) -> ActivateTypeOutput

Activates a public third-party extension, such as a resource or module, to make it available for use in stack templates in your current account and Region. It can also create CloudFormation Hooks, which allow you to evaluate resource configurations before CloudFormation provisions them. Hooks integrate with both CloudFormation and Cloud Control API operations.

After you activate an extension, you can use SetTypeConfiguration to set specific properties for the extension.

To see which extensions have been activated, use ListTypes. To see configuration details for an extension, use DescribeType.

For more information, see Activate a third-party public extension in your account in the CloudFormation User Guide. For information about creating Hooks, see the CloudFormation Hooks User Guide.

Parameters:

Name Type Description Default
request ActivateTypeInput | ActivateTypeInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ActivateTypeInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ActivateTypeOutput

An instance of ActivateTypeOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ActivateTypeInputDict

Bases: TypedDict

Dictionary form of ActivateTypeInput.

Attributes

auto_update instance-attribute
auto_update: bool | None

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: str | None

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

logging_config instance-attribute
logging_config: LoggingConfig | LoggingConfigDict | None

Contains logging configuration information for an extension.

major_version instance-attribute
major_version: int | None

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: str | None

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: str | None

The ID of the extension publisher.

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

type instance-attribute
type: str | None

The extension type.

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

type_name instance-attribute
type_name: str | None

The name of the extension.

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

type_name_alias instance-attribute
type_name_alias: str | None

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: str | None

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.

ActivateTypeInput dataclass

Bases: _SerdeShape

Dataclass for ActivateTypeInput structure.

Attributes

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

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 class-attribute instance-attribute
execution_role_arn: str | None = ...

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

logging_config class-attribute instance-attribute
logging_config: LoggingConfig | None = ...

Contains logging configuration information for an extension.

major_version class-attribute instance-attribute
major_version: int | None = ...

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 class-attribute instance-attribute
public_type_arn: str | None = ...

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

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

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

The ID of the extension publisher.

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

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

The extension type.

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

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

The name of the extension.

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

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

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 class-attribute instance-attribute
version_bump: str | None = ...

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.

Output

ActivateTypeOutput dataclass

Bases: _SerdeShape

Dataclass for ActivateTypeOutput structure.

Attributes

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

The Amazon Resource Name (ARN) of the activated extension in this account and Region.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.