AWS AWSCloudFormation documentation change
Summary
Expanded deregistration documentation with examples, added pre-deregistration checks, and clarified commands for removing extensions by type, version, or ARN.
Security assessment
Changes focus on operational best practices (e.g., checking extension usage before removal) but do not address security vulnerabilities or document new security features.
Diff
diff --git a/AWSCloudFormation/latest/UserGuide/registry-private-deregister-extension.md b/AWSCloudFormation/latest/UserGuide/registry-private-deregister-extension.md index 18878ce35..b0d0d44de 100644 --- a//AWSCloudFormation/latest/UserGuide/registry-private-deregister-extension.md +++ b//AWSCloudFormation/latest/UserGuide/registry-private-deregister-extension.md @@ -5 +5,3 @@ -# Deregister third-party private extensions you previously registered in your account +Example deregister extension commands + +# Remove third-party private extensions from your account @@ -11 +13 @@ You can deregister a specific extension version, or the extension as a whole. To -The following example deregisters an extension. Replace the sample values for `--type` and `--type-name`. +###### Note @@ -12,0 +15 @@ The following example deregisters an extension. Replace the sample values for `- +Before you deregister an extension, it's a good idea to use the [describe-type](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/describe-type.html) command to confirm the extension exists. Then, use the [list-stacks](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/list-stacks.html) and [get-template](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/get-template.html) commands to check if any stacks are using the extension before you deregister it. @@ -14,3 +17,14 @@ The following example deregisters an extension. Replace the sample values for `- - aws cloudformation deregister-type --type MODULE \ - --type-name My::S3::SampleBucket::MODULE \ - --region us-west-2 +## Example deregister extension commands + +This sections provides examples that show the different ways to deregister private extensions. + +###### Deregister by type name + +Use the [deregister-type](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/deregister-type.html) command with `--type` and `--type-name` options to deregister your extension. + + + aws cloudformation deregister-type \ + --type MODULE \ + --type-name My::S3::SampleBucket::MODULE + +###### Deregister by type name and version @@ -19,0 +34,18 @@ To deregister a specific version of your extension, specify the `--version-id` o + + aws cloudformation deregister-type \ + --type MODULE \ + --type-name My::S3::SampleBucket::MODULE \ + --version-id 00000001 + +###### Tip + +To set a different version of the extension as default first, use the [set-type-default-version](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/set-type-default-version.html) command. + +###### Deregister by ARN + +Use the `--arn` option and specify your extension's ARN to deregister it. + + + aws cloudformation deregister-type \ + --arn arn:aws:cloudformation:us-west-2:123456789012:type/resource/Organization-Service-Resource +