deactivate_type¶
Operation¶
deactivate_type
¶
deactivate_type(request: DeactivateTypeInput | DeactivateTypeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeactivateTypeInputDict]) -> DeactivateTypeOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeactivateTypeInput | DeactivateTypeInputDict | 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[DeactivateTypeInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeactivateTypeOutput
|
An instance of |
deactivate_type
async
¶
deactivate_type(request: DeactivateTypeInput | DeactivateTypeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeactivateTypeInputDict]) -> DeactivateTypeOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeactivateTypeInput | DeactivateTypeInputDict | 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[DeactivateTypeInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeactivateTypeOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DeactivateTypeInputDict
¶
Bases: TypedDict
Dictionary form of DeactivateTypeInput.
Attributes¶
arn
instance-attribute
¶
arn: str | None
The Amazon Resource Name (ARN) for the extension in this account and Region.
Conditional: You must specify either Arn, or TypeName and Type.
DeactivateTypeInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeactivateTypeInput structure.
Attributes¶
arn
class-attribute
instance-attribute
¶
arn: str | None = ...
The Amazon Resource Name (ARN) for the extension in this account and Region.
Conditional: You must specify either Arn, or TypeName and Type.
Output¶
DeactivateTypeOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeactivateTypeOutput structure.