- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeactivateTypeCommand
Deactivates a public extension that was previously activated in this account and Region.
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.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { CloudFormationClient, DeactivateTypeCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import
// const { CloudFormationClient, DeactivateTypeCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import
const client = new CloudFormationClient(config);
const input = { // DeactivateTypeInput
TypeName: "STRING_VALUE",
Type: "RESOURCE" || "MODULE" || "HOOK",
Arn: "STRING_VALUE",
};
const command = new DeactivateTypeCommand(input);
const response = await client.send(command);
// {};
DeactivateTypeCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
Arn | string | undefined | The Amazon Resource Name (ARN) for the extension, in this account and Region. Conditional: You must specify either |
Type | ThirdPartyType | undefined | The extension type. Conditional: You must specify either |
TypeName | string | undefined | 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 |
DeactivateTypeCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| CFNRegistryException | client | An error occurred during a CloudFormation registry operation. |
| TypeNotFoundException | client | The specified extension doesn't exist in the CloudFormation registry. |
| CloudFormationServiceException | Base exception class for all service exceptions from CloudFormation service. |