AWS AWSCloudFormation documentation change
Summary
Added hyperlinks to AWS CLI command references and improved command descriptions across multiple entries
Security assessment
The changes improve documentation clarity by adding official command references and streamlining explanations, but do not introduce or modify security-related content. No evidence of addressing vulnerabilities or adding security features.
Diff
diff --git a/AWSCloudFormation/latest/UserGuide/service_code_examples.md b/AWSCloudFormation/latest/UserGuide/service_code_examples.md index 84a229edc..cbd1d66bc 100644 --- a//AWSCloudFormation/latest/UserGuide/service_code_examples.md +++ b//AWSCloudFormation/latest/UserGuide/service_code_examples.md @@ -48 +48 @@ The examples in this guide use the convention of a backslash (\\) to indicate th -Use the `cancel-update-stack` command to cancel a stack update. For more information, see [Cancel a stack update](./using-cfn-stack-update-cancel.html). +Use the [cancel-update-stack](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/cancel-update-stack.html) command command to cancel a stack update. For more information, see [Cancel a stack update](./using-cfn-stack-update-cancel.html). @@ -88 +88 @@ PowerShell -Use the `continue-update-rollback` command to continue rolling back an update. For more information, see [Continue rolling back an update](./using-cfn-updating-stacks-continueupdaterollback.html). +Use the [continue-update-rollback](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/continue-update-rollback.html) command to continue rolling back an update. For more information, see [Continue rolling back an update](./using-cfn-updating-stacks-continueupdaterollback.html). @@ -131 +131 @@ PowerShell -Use the `create-stack` command to create a stack. You must provide the stack name, the location of a valid template, and any input parameters. The parameter key names are case sensitive. If you mistype a parameter key name, CloudFormation doesn't create the stack and reports that the template doesn't contain that parameter. +Use the [create-stack](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/create-stack.html) command to create a stack. You must provide the stack name, the location of a valid template, and any input parameters. The parameter key names are case sensitive. If you mistype a parameter key name, CloudFormation doesn't create the stack and reports that the template doesn't contain that parameter. @@ -260,3 +260 @@ Output: -Use the `deploy` command to create a stack that includes transforms. - -To create a stack from a template that includes transforms, you must use a change set. Instead of creating a change set and then initiating it, use the `deploy` command to combine these steps into a single command. +Use the [deploy](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/deploy/) command to create a stack that includes transforms. When you create a stack from a template that includes transforms, you must use a change set. The `deploy` command combines two steps (creating a change set and executing it) into a single command. @@ -276 +274 @@ The following `deploy` command creates a stack with the specified name, template -Use the `delete-stack` command to delete a stack. For more information, see [Delete a stack from the CloudFormation console](./cfn-console-delete-stack.html). +Use the [delete-stack](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/delete-stack.html) command to delete a stack. For more information, see [Delete a stack](./cfn-console-delete-stack.html). @@ -341 +339 @@ After using `FORCE_DELETE_STACK`, you can use the `list-stack-resources` command -Use the `describe-stack-events` command to describe stack events. For more information, see [Monitor stack progress](./monitor-stack-progress.html). +Use the [describe-stack-events](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/describe-stack-events.html) command to describe stack events. For more information, see [Monitor stack progress](./monitor-stack-progress.html). @@ -831 +829 @@ PowerShell -Use the `list-stacks` command to list stacks. To list only stacks with the specified status codes, include the `--stack-status-filter` option. You can specify one or more stack status codes for the `--stack-status-filter` option. For more information, see [Stack status codes](./view-stack-events.html#cfn-console-view-stack-data-resources-status-codes). +Use the [list-stacks](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/list-stacks.html) command to list stacks. To list only stacks with the specified status codes, include the `--stack-status-filter` option. You can specify one or more stack status codes for the `--stack-status-filter` option. For more information, see [Stack status codes](./view-stack-events.html#cfn-console-view-stack-data-resources-status-codes). @@ -897 +895 @@ PowerShell -Use the `update-stack` command to directly update a stack. You specify the stack, and parameter values and capabilities that you want to update, and, if you want use an updated template, the name of the template. For more information, see [Update stacks directly](./using-cfn-updating-stacks-direct.html). +Use the [update-stack](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/update-stack.html) command to directly update a stack. You specify the stack, and parameter values and capabilities that you want to update, and, if you want use an updated template, the name of the template. For more information, see [Update stacks directly](./using-cfn-updating-stacks-direct.html). @@ -988 +986 @@ To remove all notifications, specify for `[]` for the `--notification-arns` opti -Use the `validate-template` command to check your template file for syntax errors. +Use the [validate-template](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/validate-template.html) command to check your template file for syntax errors.