CloudFormation / Client / deactivate_type

deactivate_type

CloudFormation.Client.deactivate_type(**kwargs)

Deactivates a public third-party extension, such as a resource or module, or a CloudFormation Hook when you no longer use it.

Deactivating an extension deletes the configuration details that are associated with it. To temporarily disable a CloudFormation Hook instead, you can use SetTypeConfiguration.

Once deactivated, an extension can’t be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions aren’t automatically updated if a new version of the extension is released.

To see which extensions are currently activated, use ListTypes.

See also: AWS API Documentation

Request Syntax

response = client.deactivate_type(
    TypeName='string',
    Type='RESOURCE'|'MODULE'|'HOOK',
    Arn='string'
)
Parameters:

  • TypeName (string) –

    The type name of the extension in this account and Region. If you specified a type name alias when enabling the extension, use the type name alias.

    Conditional: You must specify either Arn, or TypeName and Type.

  • Type (string) –

    The extension type.

    Conditional: You must specify either Arn, or TypeName and Type.

  • Arn (string) –

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

    Conditional: You must specify either Arn, or TypeName and Type.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • CloudFormation.Client.exceptions.CFNRegistryException

  • CloudFormation.Client.exceptions.TypeNotFoundException