AWS AWSCloudFormation documentation change
Summary
Updated documentation for quick-create links with expanded URL format details, S3 URL examples, and a new step-by-step stack creation guide. Added security-related configuration options like IAM roles, stack policies, and termination protection.
Security assessment
The changes add documentation about security features (IAM capabilities, stack policies, termination protection) but do not address a specific security vulnerability. The URL-encoding note for S3 URLs is a best practice to prevent access issues, but not evidence of a resolved security flaw.
Diff
diff --git a/AWSCloudFormation/latest/UserGuide/cfn-console-create-stacks-quick-create-links.md b/AWSCloudFormation/latest/UserGuide/cfn-console-create-stacks-quick-create-links.md index 156b9f82f..151ad2db2 100644 --- a//AWSCloudFormation/latest/UserGuide/cfn-console-create-stacks-quick-create-links.md +++ b//AWSCloudFormation/latest/UserGuide/cfn-console-create-stacks-quick-create-links.md @@ -3 +3 @@ -Supported parametersExample +URL formatExampleCreating a stack using a quick-create link @@ -5 +5 @@ Supported parametersExample -# Create quick-create links for stacks +# Use quick-create links to create CloudFormation stacks @@ -7 +7 @@ Supported parametersExample -Use quick-create links to get stacks up and running quickly from the CloudFormation console. You can specify the template URL, stack name, and template parameters in URL query parameters to prepopulate a single **Create Stack Wizard** page. This simplifies the process of creating stacks by reducing the number of wizard pages and the amount of user input that's required. It also optimizes template reuse because you can create multiple URLs that specify different values for the same template. +Quick-create links provide a streamlined method to launch CloudFormation stacks directly from URLs in the CloudFormation console. By specifying the template URL, stack name, and template parameters as URL query parameters, you can prepopulate a single **Create stack** page and expedite stack creation. This simplifies the process of creating stacks by reducing both the number of wizard pages and the amount of required user input. It also optimizes template reuse, as you can create multiple URLs that specify different values for the same template. @@ -9 +9,9 @@ Use quick-create links to get stacks up and running quickly from the CloudFormat -## Supported parameters +## URL format + +The quick-create link follows this URL format: + + + https://region-code.console.aws.amazon.com/cloudformation/home?region=region-code#/stacks/create/review + ?templateURL=TemplateURL + &stackName=StackName + ¶m_parameterName=parameterValue @@ -13 +21,10 @@ CloudFormation supports the following URL query parameters: -`templateURL` +Template URL + + +Required. The `templateURL` parameter specifies the URL of the stack template located in an Amazon S3 bucket. To avoid access issues with a presigned S3 URL, make sure that you URL-encode the URL. + +Supported S3 URL formats: + + * `https://s3.`region-code`.amazonaws.com/`bucket-name`/`template-name`` + + * `https://`bucket-name`.s3.`region-code`.amazonaws.com/`template-name`` @@ -14,0 +32 @@ CloudFormation supports the following URL query parameters: + * `https://s3-`region-code`.amazonaws.com/`bucket-name`/`template-name`` (legacy format) @@ -16 +33,0 @@ CloudFormation supports the following URL query parameters: -Required. Specifies the URL of the stack template. To avoid access issues, make sure to URL-encode a presigned S3 URL. @@ -18 +34,0 @@ Required. Specifies the URL of the stack template. To avoid access issues, make -`stackName` @@ -21 +37 @@ Required. Specifies the URL of the stack template. To avoid access issues, make -Optional. Specifies the stack name. A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters. +Stack name @@ -23 +38,0 @@ Optional. Specifies the stack name. A stack name can contain only alphanumeric c -Any parameter in the stack template that isn't a `NoEcho` parameter type @@ -24,0 +40 @@ Any parameter in the stack template that isn't a `NoEcho` parameter type +Optional. Use the `stackName` parameter to specify the name of the CloudFormation stack to be created. A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters. @@ -26 +42,4 @@ Any parameter in the stack template that isn't a `NoEcho` parameter type -Optional. Use the format `param_`parameterName`` to specify template parameters in the URL query string. The URL parameter must include the `param_` prefix, and the parameter name segment must exactly match the parameter name in the template. For example: `param_DBName`. +Template parameters + + +Optional. For parameters in the stack template that aren't a `NoEcho` parameter type, use the format `param_`parameterName`` in the URL query string. The URL parameter must include the `param_` prefix, and the parameter name segment must exactly match the parameter name in the template. For example: `param_DBName`. @@ -40 +59 @@ All query parameter names are case sensitive. Users can overwrite these values i -The following example is based on the [ WordPress basic single instance](https://s3.eu-central-1.amazonaws.com/cloudformation-templates-eu-central-1/WordPress_Single_Instance.template) sample template. The query string includes the required `templateURL` parameter and the `stackName`, `DBName`, `InstanceType`, and `KeyName` parameters. +The following example is based on the [WordPress basic single instance](https://s3.us-east-2.amazonaws.com/cloudformation-templates-us-east-2/WordPress_Single_Instance.template) sample template. The query string includes the required `templateURL` parameter and the `stackName`, `DBName`, `InstanceType`, and `KeyName` parameters. @@ -45,2 +64,2 @@ The following URL has line breaks added for clarity. - https://eu-central-1.console.aws.amazon.com/cloudformation/home?region=eu-central-1#/stacks/create/review - ?templateURL=https://s3.eu-central-1.amazonaws.com/cloudformation-templates-eu-central-1/WordPress_Single_Instance.template + https://us-east-2.console.aws.amazon.com/cloudformation/home?region=us-east-2#/stacks/create/review + ?templateURL=https://s3.us-east-2.amazonaws.com/cloudformation-templates-us-east-2/WordPress_Single_Instance.template @@ -54 +73,38 @@ The following URL includes the same parameters as the previous example, but the - https://eu-central-1.console.aws.amazon.com/cloudformation/home?region=eu-central-1#/stacks/create/review?templateURL=https://s3.eu-central-1.amazonaws.com/cloudformation-templates-eu-central-1/WordPress_Single_Instance.template&stackName=MyWPBlog¶m_DBName=mywpblog¶m_InstanceType=t2.medium + https://us-east-2.console.aws.amazon.com/cloudformation/home?region=us-east-2#/stacks/create/review?templateURL=https://s3.us-east-2.amazonaws.com/cloudformation-templates-us-east-2/WordPress_Single_Instance.template&stackName=MyWPBlog¶m_DBName=mywpblog¶m_InstanceType=t2.medium + +## Creating a stack using a quick-create link + +When you open a quick-create link, you are directed to the CloudFormation console. The console opens directly to the **Quick create stack** page, with the supplied values automatically used for the parameters. + +###### To create a stack using a quick-create link (console) + + 1. On the **Quick create stack** page, for **Template** , **Template URL** , confirm the template URL is correct. + + 2. For **Stack name** , verify the prepopulated stack name. + + 3. Review the **Parameters** section. Verify that the prepopulated parameter values are correct. Fill in any required parameters that weren't specified in the URL. Modify any prepopulated values if needed. + + 4. Next, you can configure the following settings: + + * **Tags** — Organize resources with key-value pairs. + + * **Permissions** — Choose the IAM service role for stack operations. + + * **Stack failure options** — Choose to roll back (default) or preserve resources. + + * **Stack policy** — Control resource update permissions. + + * **Rollback configuration** — Configure CloudWatch alarm-based rollback. + + * **Notification options** — Set up Amazon SNS notifications for stack events. + + * **Stack creation options** — Define maximum stack creation time and enable termination protection to prevent accidental deletions. + +For more information, see [Configure stack options](./cfn-console-create-stack.html#configure-stack-options). + + 5. For **Capabilities** , complete any required acknowledgements. For example, if your template contains IAM resources, select **I acknowledge that this template may create IAM resources** to specify that you want to use IAM resources in the template. For more information, see [Acknowledging IAM resources in CloudFormation templates](./control-access-with-iam.html#using-iam-capabilities). + + 6. (Optional) You can create a change set to preview the configuration of the stack before creating it. Choose **Create change set** and follow the directions. For more information, see [Preview the configuration of your stack](./cfn-console-create-stack.html#cfn-console-create-stacks-changesets). + + 7. When you're ready, choose **Create stack** to launch the stack and then monitor the stack creation progress in the **Events** tab. For more information, see [Monitor stack progress](./monitor-stack-progress.html). + @@ -56 +111,0 @@ The following URL includes the same parameters as the previous example, but the -The example URL opens the **Create stack** wizard in the console, with the supplied values automatically used for the parameters. @@ -58 +112,0 @@ The example URL opens the **Create stack** wizard in the console, with the suppl -