AWS AWSCloudFormation documentation change
Summary
Updated documentation for AWS CloudFormation Language Server with expanded IDE support (JetBrains IDEs version 2025.3+, VS Code forks), added 'Extract to parameter' feature, clarified UI differences between VS Code and JetBrains, and streamlined installation/usage instructions.
Security assessment
The changes are documentation updates about IDE integration features, user interface improvements, and expanded IDE support. No evidence of addressing specific security vulnerabilities, weaknesses, or incidents. The documentation mentions existing security features (CloudFormation Guard validation) but doesn't add new security documentation.
Diff
diff --git a/AWSCloudFormation/latest/UserGuide/ide-extension.md b/AWSCloudFormation/latest/UserGuide/ide-extension.md index c6e8cef88..2d41a0d52 100644 --- a//AWSCloudFormation/latest/UserGuide/ide-extension.md +++ b//AWSCloudFormation/latest/UserGuide/ide-extension.md @@ -5 +5 @@ -IDEs integrating with the AWS CloudFormation language serverGetting startedInitializing a CloudFormation project in the IDEOpen sourceNeed help? +IDEs integrating with the AWS CloudFormation Language ServerGetting startedInitializing a CloudFormation project in the IDE (VS Code only)Open sourceNeed help? @@ -7 +7 @@ IDEs integrating with the AWS CloudFormation language serverGetting startedIniti -# AWS CloudFormation language server +# AWS CloudFormation Language Server @@ -9 +9 @@ IDEs integrating with the AWS CloudFormation language serverGetting startedIniti -The AWS CloudFormation language server provides capabilities to accelerate authoring infrastructure-as-code (IaC) and deploying AWS resources safely and with confidence. It follows the [language server protocol](https://microsoft.github.io/language-server-protocol/) (LSP) to provide documentation on hover, auto-completion, diagnostics via static validation, go to definition and code actions. In addition to these traditional language server capabilities, the server adds online features to explore and deploy AWS resources via CloudFormation. This includes the ability to validate and deploy templates using change sets; view stack diffs, events, resources, and outputs; list stacks and browse resources by type; and insert live resource state directly into CloudFormation templates. Developer tooling and integrated development environments (IDE) can leverage the language server capabilities to enhance the experience of IaC developers on CloudFormation. +The AWS CloudFormation Language Server provides capabilities to accelerate authoring infrastructure-as-code (IaC) and deploying AWS resources safely and with confidence. It follows the [language server protocol](https://microsoft.github.io/language-server-protocol/) (LSP) to provide documentation on hover, auto-completion, diagnostics via static validation, go to definition and code actions. In addition to these traditional language server capabilities, the server adds online features to explore and deploy AWS resources via CloudFormation. This includes the ability to validate and deploy templates using change sets; view stack diffs, events, resources, and outputs; list stacks and browse resources by type; and insert live resource state directly into CloudFormation templates. @@ -13 +13 @@ The AWS CloudFormation language server provides capabilities to accelerate autho - * IDEs integrating with the AWS CloudFormation language server + * IDEs integrating with the AWS CloudFormation Language Server @@ -17 +17 @@ The AWS CloudFormation language server provides capabilities to accelerate autho - * Initializing a CloudFormation project in the IDE + * Initializing a CloudFormation project in the IDE (VS Code only) @@ -26 +26 @@ The AWS CloudFormation language server provides capabilities to accelerate autho -## IDEs integrating with the AWS CloudFormation language server +## IDEs integrating with the AWS CloudFormation Language Server @@ -28 +28 @@ The AWS CloudFormation language server provides capabilities to accelerate autho -The [AWS Toolkit](https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguide/welcome.html) extension integrates the CloudFormation language server to enhance the authoring experience. This integration is currently supported in VS Code and JetBrains based IDEs, including: +AWS provides off-the-shelf integration with the CloudFormation Language Server through the AWS Toolkit for the following IDEs: @@ -30 +30 @@ The [AWS Toolkit](https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguid - * [Visual Studio Code](https://code.visualstudio.com/) + * [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=AmazonWebServices.aws-toolkit-vscode) @@ -32 +32,6 @@ The [AWS Toolkit](https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguid - * [JetBrains](https://www.jetbrains.com/ides/#choose-your-ide) + * [JetBrains IDEs](https://plugins.jetbrains.com/plugin/11349-aws-toolkit) (version 2025.3 or later), including IntelliJ IDEA, WebStorm, and PyCharm + + + + +The following IDEs also support the CloudFormation Language Server: @@ -37,0 +43 @@ The [AWS Toolkit](https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguid + * Most VS Code forks and distributions @@ -40,0 +47,3 @@ The [AWS Toolkit](https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguid + +The CloudFormation Language Server adheres to the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) (LSP) and therefore other integrations are configurable. For instructions on integrating the language server with other editors, see the [installation guide](https://github.com/aws-cloudformation/cloudformation-languageserver/blob/main/INSTALLATION.md). + @@ -49 +58 @@ The [AWS Toolkit](https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguid - * Step 2: Access CloudFormation in the AWS Toolkit panel + * Step 2: Access CloudFormation in the AWS Toolkit @@ -64 +73 @@ Before you begin, make sure that: - * You are using a VS Code or IntelliJ based IDE on a supported operating system (macOS, Windows, or Linux). + * You are using a supported IDE on a supported operating system (macOS, Windows, or Linux). @@ -66 +75 @@ Before you begin, make sure that: - * You have installed or upgraded to the latest version of the [AWS Toolkit](https://marketplace.visualstudio.com/items?itemName=AmazonWebServices.aws-toolkit-vscode) for your IDE. + * You have installed or upgraded to the latest version of the AWS Toolkit for your IDE. @@ -71 +80 @@ Before you begin, make sure that: -Some features in the AWS CloudFormation language server require an active AWS account and configured credentials. You must be signed in to your AWS account through the AWS Toolkit using valid credentials. +Some features in the AWS CloudFormation Language Server require an active AWS account and configured credentials. You must be signed in to your AWS account through the AWS Toolkit using valid credentials. @@ -75,12 +84 @@ Some features in the AWS CloudFormation language server require an active AWS ac - * Open your IDE's Extensions or Plugin Manager. - - * Search for AWS Toolkit. - - * Install or update to version 3.85.0 or later of the AWS Toolkit for your IDE. - - * Restart your IDE after installation. - - - - -Note: After installation, the AWS Toolkit automatically enables CloudFormation IDE support. When you first install or upgrade the AWS Toolkit with the AWS CloudFormation language server extension, you're prompted to grant permission for AWS to collect anonymous usage data. This data helps AWS improve the CloudFormation language server and enhances the authoring experience. No sensitive information is collected and AWS does not record or store template content, resource configurations, or any identifiable customer data. You can change your telemetry preferences at any time from the IDE settings. The usage data collected focuses only on feature interactions and performance metrics. These insights help AWS identify and prioritize improvements such as faster validation, enhanced autocomplete, and better error diagnostics. +Install or update to the latest version of the AWS Toolkit from your IDE's extension or plugin manager, then restart your IDE. @@ -88 +86 @@ Note: After installation, the AWS Toolkit automatically enables CloudFormation I -### Step 2: Access CloudFormation in the AWS Toolkit panel +After installation, the AWS Toolkit automatically enables CloudFormation IDE support. When you first install or upgrade the AWS Toolkit with the AWS CloudFormation Language Server, you are prompted to grant permission for AWS to collect anonymous usage data. This data helps AWS improve the CloudFormation Language Server and enhances the authoring experience. No sensitive information is collected and AWS does not record or store template content, resource configurations, or any identifiable customer data. You can change your telemetry preferences at any time from the IDE settings. Restart the IDE for the changes to take effect. The usage data collected focuses only on feature interactions and performance metrics. These insights help AWS identify and prioritize improvements such as faster validation, enhanced autocomplete, and better error diagnostics. @@ -90 +88 @@ Note: After installation, the AWS Toolkit automatically enables CloudFormation I -In your IDE, open the AWS Toolkit panel from the activity bar. Under AWS Toolkit, choose **CLOUDFORMATION**. +### Step 2: Access CloudFormation in the AWS Toolkit @@ -92 +90 @@ In your IDE, open the AWS Toolkit panel from the activity bar. Under AWS Toolkit -Panel sections: +After installing the AWS Toolkit, open the CloudFormation panel in your IDE. In VS Code, open the AWS Toolkit panel from the activity bar and choose **CLOUDFORMATION**. In JetBrains IDEs, open the **AWS Toolkit** tool window from the side bar and select the **CloudFormation** tab. @@ -94 +92 @@ Panel sections: - * **Region** : Displays the current AWS Region. You can change it by selecting the Region name or by using the **AWS CloudFormation: Select Region** command from the command palette. +The CloudFormation panel contains the following sections: @@ -96 +94 @@ Panel sections: - * **Environment** : Indicates the environment you selected during CFN init (for example, dev, test, or prod). This value appears only after completing the environment selection step. + * **Region** : Displays the current AWS Region. In VS Code, you can change it by selecting the Region name or by using the **AWS CloudFormation: Select Region** command from the command palette. In JetBrains IDEs, the Region is configured through the AWS Toolkit connection settings. @@ -98 +96 @@ Panel sections: - * **Stacks** : Displays a paginated list of CloudFormation stacks in your account. + * **Stacks** : Displays a paginated list of CloudFormation stacks in your account. Expand a stack to view its **Change Sets** node, which lists the change sets associated with that stack. Use the View Stack Detail action to open the stack detail view, which displays the stack overview, events, outputs, and resources. @@ -100 +98 @@ Panel sections: - * Click on the refresh icon to update the list of stacks. + * **Resources** : After you add a resource type, the panel displays the AWS resources of that type in your account. You can view, refresh, copy, or import them into your template. @@ -102,19 +99,0 @@ Panel sections: - * Use the **+** icon to deploy a new template as a stack. - - * Each stack entry includes: - - * **Overview** : Displays stack summary and status - - * **Stack ID** - - * **Description** - - * **Created time** and **Updated time** - - * **Status** and **Status reason** - - * **Events** , **Outputs** , and **Resources** - - * **Change set** - - * **Resources** : After you select a resource type, the panel displays the AWS resources of that type in your account. You can view, refresh, copy, or import them into your template. @@ -123,0 +103 @@ Panel sections: +In JetBrains IDEs, the toolbar above the tree provides quick access to common actions including **Validate and Deploy** , **Rerun Validate and Deploy** , **Add Resource Type** , and **Refresh**. Actions are also available through right-click context menus on tree nodes. @@ -127 +107 @@ Panel sections: -As you write your CloudFormation template, the IDE provides intelligent authoring assistance to help you create accurate and compliant infrastructure faster. The CloudFormation language server runs in the background and provides the following authoring features: +As you write your CloudFormation template, the IDE provides intelligent authoring assistance to help you create accurate and compliant infrastructure faster. The CloudFormation Language Server runs in the background and provides the following authoring features: @@ -132,0 +113,2 @@ As you write your CloudFormation template, the IDE provides intelligent authorin + * Extract to parameter: When your cursor is on a literal value in a template (for example, a string like `t2.micro`), the IDE offers a refactoring action to extract the value into the `Parameters` section and replace the literal with a `!Ref` to the new parameter. If the same literal value appears in multiple places, you can choose to extract all occurrences at once. + @@ -138 +120 @@ As you write your CloudFormation template, the IDE provides intelligent authorin - * **Expand the CloudFormation Resources panel** : In the AWS Toolkit side panel, expand **CloudFormation** , then under **Resources** , click the **Add +** icon. + * **Add a resource type** : In the AWS Toolkit CloudFormation panel, under **Resources** , add a resource type to browse. In VS Code, click the **Add +** icon or use the **AWS CloudFormation: Add Resource Types** command from the command palette. In JetBrains, click the **Add Resource Type** button in the toolbar or right-click the **Resources** node. @@ -140 +122 @@ As you write your CloudFormation template, the IDE provides intelligent authorin - * **Search for a resource type** : To find a specific AWS resource type, in the search bar type the specific AWS resource type you want to add. Example: + * **Search for a resource type** : In the search dialog, type the AWS resource type you want to add. Example: @@ -146,3 +128 @@ As you write your CloudFormation template, the IDE provides intelligent authorin -You can select resource type using **AWS CloudFormation: Add Resource Types** in the command palette. - - * **Adding resources to your template** : Under the **Resources** panel, a paginated list of detected AWS resources in your account is displayed. If you have many resources, only first page is shown. Use the navigation controls at the bottom of the panel to move through additional pages and view all available resources. + * **Browse resources** : Under the **Resources** section, a paginated list of detected AWS resources in your account is displayed. If you have many resources, only the first page is shown. Use the navigation controls to move through additional pages and view all available resources. @@ -163 +143 @@ You can select resource type using **AWS CloudFormation: Add Resource Types** in - * You can refresh the **Resources** panel at any time to view the latest list of resources available in your account or Region. + * You can refresh the **Resources** section at any time to view the latest list of resources available in your account or Region. @@ -167,3 +147 @@ You can select resource type using **AWS CloudFormation: Add Resource Types** in - * To confirm if a resource is already managed by CloudFormation, click the **i** (information) icon next to the resource name. - - * Alternatively, you can use the command **AWS CloudFormation: Get Stack Management Info** to check whether a resource belongs to a stack. + * To confirm if a resource is already managed by CloudFormation, use the information action next to the resource. In VS Code, click the **i** icon. In JetBrains IDEs, right-click the resource and choose **Get Stack Management Info**. @@ -176 +154 @@ You can select resource type using **AWS CloudFormation: Add Resource Types** in -You can add related resources to the selected resource by using the command **AWS CloudFormation: Add Related Resources by Type**. Once you select a resource type from the ones already defined in your template, the IDE displays a list of resources that are typically associated with or dependent on that type. For example, if you select an `AWS::EC2::Instance`, the IDE may suggest adding related resources such as `AWS::EC2::SecurityGroup` or `AWS::EC2::Subnet`. This feature helps you quickly build connected infrastructure components without manually searching for compatible resource types. Adding related resources is currently not supported on JetBrains IDEs. +In VS Code, you can add related resources to the selected resource by using the command **AWS CloudFormation: Add Related Resources by Type**. Once you select a resource type from the ones already defined in your template, the IDE displays a list of resources that are typically associated with or dependent on that type. For example, if you select an `AWS::EC2::Instance`, the IDE may suggest adding related resources such as `AWS::EC2::SecurityGroup` or `AWS::EC2::Subnet`. This feature helps you quickly build connected infrastructure components without manually searching for compatible resource types. This feature is currently not supported in JetBrains IDEs. @@ -180 +158 @@ You can add related resources to the selected resource by using the command **AW -The CloudFormation IDE provides built-in static validation powered by [AWS CloudFormation Linter (cfn-lint)](https://aws.amazon.com/blogs/devops/aws-cloudformation-linter-v1/) and [AWS CloudFormation Guard](https://docs.aws.amazon.com/cfn-guard/latest/ug/what-is-guard.html). These validations run behind the scenes as you author templates, helping you identify syntax errors, compliance gaps, and best practice issues before deployment. +The CloudFormation Language Server provides built-in static validation powered by [AWS CloudFormation Linter (cfn-lint)](https://github.com/aws-cloudformation/cfn-lint) and [AWS CloudFormation Guard](https://docs.aws.amazon.com/cfn-guard/latest/ug/what-is-guard.html). These validations run behind the scenes as you author templates, helping you identify syntax errors, compliance gaps, and best practice issues before deployment. @@ -199 +177 @@ The CloudFormation Linter is integrated into the IDE to automatically check your - * **Error highlighting** : Displays red or yellow squiggly lines under issues, representing deployment blockers or warnings. + * **Error highlighting** : Displays inline markers under issues, representing deployment blockers or warnings. @@ -201 +179 @@ The CloudFormation Linter is integrated into the IDE to automatically check your - * **Hover over help** : When you hover over an error, the IDE shows the diagnostic message associated with that issue. If a quick fix is available, it will also be offered in the hover panel. + * **Hover help** : When you hover over an error, the IDE shows the diagnostic message associated with that issue. If a quick fix is available, it is also offered. @@ -208 +186 @@ The CloudFormation Linter is integrated into the IDE to automatically check your -Guard validates your templates against rule sets that define compliance and security policies. The IDE runs Guard validations in real time through the CloudFormation language server, giving you immediate feedback while you author templates. +Guard validates your templates against rule sets that define compliance and security policies. The IDE runs Guard validations in real time through the CloudFormation Language Server, giving you immediate feedback while you author templates. @@ -210 +188 @@ Guard validates your templates against rule sets that define compliance and secu - * **Default rule packs** : The IDE includes a pre-registered set of Guard rules focused on foundational best practices for resource security and configuration hygiene. To learn more link to [the guard rule registry](https://github.com/aws-cloudformation/aws-guard-rules-registry). + * **Default rule packs** : The IDE includes a pre-registered set of Guard rules focused on foundational best practices for resource security and configuration hygiene. To learn more, see [the guard rule registry](https://github.com/aws-cloudformation/aws-guard-rules-registry). @@ -212 +190 @@ Guard validates your templates against rule sets that define compliance and secu - * **Adding rule packs** : To add or modify rule sets, open Settings, Guard and select or upload additional Guard rule packs. + * **Adding rule packs** : To add or modify rule sets, open your IDE settings and navigate to the Guard configuration section to select or upload additional Guard rule packs. @@ -217 +195 @@ Guard validates your templates against rule sets that define compliance and secu -**Tips** : Understanding squiggly line indicators +**Tips** : Understanding diagnostic indicators @@ -219 +197 @@ Guard validates your templates against rule sets that define compliance and secu - * Blue squiggles: Best practice hints or optimization recommendations. + * Blue indicators: Best practice hints or optimization recommendations. @@ -221 +199 @@ Guard validates your templates against rule sets that define compliance and secu - * Yellow squiggles: Warnings for non-blocking issues (for example, missing tags or parameters). + * Yellow indicators: Warnings for non-blocking issues (for example, missing tags or parameters). @@ -223 +201 @@ Guard validates your templates against rule sets that define compliance and secu - * Red squiggles: Deployment blockers such as invalid property names, missing required fields, or schema mismatches. + * Red indicators: Deployment blockers such as invalid property names, missing required fields, or schema mismatches. @@ -230 +208 @@ Guard validates your templates against rule sets that define compliance and secu -When you click on a template file in the **Explorer** , the **Outline** panel automatically displays a structured, hierarchical view of your CloudFormation template. It organizes the template into sections such as `Parameters`, `Resources`, `Outputs`, and `Mappings`, and shows each resource type and logical ID. This makes it easy to quickly locate and navigate to specific resources or parameters within large templates. +The IDE provides a structured, hierarchical view of your CloudFormation template, organized into sections such as `Parameters`, `Resources`, `Outputs`, and `Mappings`, showing each resource type and logical ID. This makes it easy to quickly locate and navigate to specific resources or parameters within large templates. In VS Code, the **Outline** panel in the **Explorer** sidebar displays this structure. In JetBrains IDEs, open the **Structure** tool window to view the template structure for the currently open file. @@ -236 +214,3 @@ You can use **Go to Definition** for intrinsic functions such as `GetAtt` and `R -When you're ready to deploy your CloudFormation template, open the command palette and run **AWS CloudFormation: Validate and Deploy**. The command validates your template, and if no blocking errors are found, it proceeds to the deployment phase. Before confirming, the IDE shows a [drift-aware change set](./drift-aware-change-sets.html) summary and a diff view so you can review all proposed changes. +When you are ready to deploy your CloudFormation template, use the Validate and Deploy feature to create a change set. The IDE validates your template, and if no blocking errors are found, it proceeds to create a [drift-aware change set](./drift-aware-change-sets.html). The IDE then shows a diff view so you can review all proposed changes before executing the change set. + +In VS Code, open the command palette and run **AWS CloudFormation: Validate and Deploy**. The command palette guides you through selecting a template, stack name, parameters, capabilities, and other deployment options step by step. In JetBrains IDEs, use the **Validate and Deploy** toolbar button, right-click a template file in the editor, or right-click a stack in the tree. JetBrains presents a wizard dialog where you configure all deployment options including template selection, stack name, parameters, capabilities, tags, and advanced options. @@ -242 +222 @@ The IDE automatically performs a [validation check before deployment](./validate - * Invalid property syntax or schema mismatches: These issues are typically caught by `cfn-lint` during authoring, but if a user proceeds to deploy without addressing them, CloudFormation's deployment-time validation will surface the same errors before the stack is created or updated. + * Invalid property syntax or schema mismatches: These issues are typically caught by `cfn-lint` during authoring, but if you proceed to deploy without addressing them, CloudFormation's deployment-time validation surfaces the same errors before the stack is created or updated. @@ -251 +231 @@ The IDE automatically performs a [validation check before deployment](./validate -If the validation detects errors, the IDE highlights the issues directly in your template using red or yellow squiggly lines and lists the errors in the **PROBLEMS** panel. Each issue includes the specific property or resource that caused the failure, along with a suggested fix. If there are no blocking errors, you can proceed to the deployment phase. +If the validation detects errors, the IDE highlights the issues directly in your template and lists the errors in the diagnostics panel. Each issue includes the specific property or resource that caused the failure, along with a suggested fix. If there are no blocking errors, you can proceed to the deployment phase. @@ -255 +235 @@ If warnings are found (non-blocking issues), a dialog appears allowing you to ei -The IDE opens a [drift-aware change set](./drift-aware-change-sets.html) that displays any differences between your current template and the deployed stack configuration. This allows you to review, confirm, or cancel the change set before execution. +The IDE opens a [drift-aware change set](./drift-aware-change-sets.html) that displays any differences between your current template and the deployed stack configuration. This allows you to review, confirm, or cancel the change set before execution. Cancelling the deployment deletes the change set. @@ -257 +237 @@ The IDE opens a [drift-aware change set](./drift-aware-change-sets.html) that di -Note: Drift-aware change sets enhance the CloudFormation deployment process by allowing you to handle stack drift safely. Stack drift occurs when the actual state of your resources differs from what's defined in your CloudFormation template, often due to manual changes made through the AWS Management Console, CLI, or SDK. CloudFormation [drift-aware change set](./drift-aware-change-sets.html) compare your processed stack configuration with the live resource state, and the IDE surfaces these differences so you can bring resources back into compliance before deployment. +Drift-aware change sets enhance the CloudFormation deployment process by allowing you to handle stack drift safely. Stack drift occurs when the actual state of your resources differs from what is defined in your CloudFormation template, often due to manual changes made through the AWS Management Console, CLI, or SDK. CloudFormation [drift-aware change sets](./drift-aware-change-sets.html) compare your processed stack configuration with the live resource state, and the IDE surfaces these differences so you can bring resources back into compliance before deployment. @@ -261 +241 @@ Note: Drift-aware change sets enhance the CloudFormation deployment process by a -When the deployment starts, you can navigate to the **CloudFormation** tab in the panel to monitor progress in real time. Under **Stack Events** , you'll see a list of operations performed during the deployment. Each event includes details such as: +When the deployment starts, you can monitor progress in real time from the CloudFormation panel. Under **Stack Events** , you see a list of operations performed during the deployment. Each event includes details such as: @@ -274 +254 @@ When the deployment starts, you can navigate to the **CloudFormation** tab in th -You can also view the stack's **Resources** and **Outputs** from this panel. If you want to open the stack in the AWS Management Console, use the external-link icon next to the stack name. The **Stack Events** view helps you track deployment progress, identify potential issues, and confirm when your stack has completed successfully. +You can also view the stack's **Resources** and **Outputs** from this panel. The **Stack Events** view helps you track deployment progress, identify potential issues, and confirm when your stack has completed successfully. @@ -276 +256 @@ You can also view the stack's **Resources** and **Outputs** from this panel. If -## Initializing a CloudFormation project in the IDE +## Initializing a CloudFormation project in the IDE (VS Code only) @@ -278 +258 @@ You can also view the stack's **Resources** and **Outputs** from this panel. If -Initializing a CloudFormation project in the IDE helps you set up a structured workspace with the correct folders, environment configuration, and AWS credentials so you can validate and deploy your templates reliably. You can initialize a new CloudFormation project directly from the IDE to create this recommended setup. This feature is currently not supported on JetBrains IDEs.