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.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- Arn
-
The Amazon Resource Name (ARN) for the extension, in this account and Region.
Conditional: You must specify either
Arn, orTypeNameandType.Type: String
Length Constraints: Maximum length of 1024.
Pattern:
arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:[0-9]{12}:type/.+Required: No
- Type
-
The extension type.
Conditional: You must specify either
Arn, orTypeNameandType.Type: String
Valid Values:
RESOURCE | MODULE | HOOKRequired: No
- TypeName
-
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, orTypeNameandType.Type: String
Length Constraints: Minimum length of 10. Maximum length of 204.
Pattern:
[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}Required: No
Errors
For information about the errors that are common to all actions, see Common Errors.
- CFNRegistry
-
An error occurred during a CloudFormation registry operation.
HTTP Status Code: 400
- TypeNotFound
-
The specified extension doesn't exist in the CloudFormation registry.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
