AWS amazonq medium security documentation change
Summary
Added documentation for pausing/canceling transformations, expanded Java version options, added security note about validating code and avoiding unvetted artifacts, introduced --trust flag for security vetting
Security assessment
Added explicit security guidance about avoiding unvetted artifacts and validating transformed code. Introduced --trust flag described as enabling security vetting during transformations. These changes directly address security practices for code transformation workflows.
Diff
diff --git a/amazonq/latest/qdeveloper-ug/transform-CLI.md b/amazonq/latest/qdeveloper-ug/transform-CLI.md index 78a2d6595..9e67e244b 100644 --- a//amazonq/latest/qdeveloper-ug/transform-CLI.md +++ b//amazonq/latest/qdeveloper-ug/transform-CLI.md @@ -5 +5 @@ -Building code in your local environmentCommands +Building code in your local environmentCommandsPausing or canceling a transformation @@ -9,3 +8,0 @@ Building code in your local environmentCommands -Transforming code with Amazon Q on the command line is in preview, and is subject to change. ---- - @@ -21,0 +19,2 @@ To get started, install the command line tool and authenticate, and then see the + * Pausing or canceling a transformation + @@ -36,0 +36,4 @@ The build in your local environment helps verify the transformed code by allowin +###### Note + +Amazon Q performs transformations based on your project's requests, descriptions, and content. To maintain security, avoid including external, unvetted artifacts in your project repository and always validate transformed code for both functionality and security. + @@ -46 +49 @@ To configure a transformation and authenticate to Amazon Q Developer Pro, run: -To start a transformation for a Java upgrade, run the following command. For `<your-target-java-version>`, you can enter either `JAVA_17` or `JAVA_21`. +To start a transformation for a Java upgrade, run the following command. For `<your-source-java-version>`, you can enter `JAVA_1.8`, `JAVA_8`, `JAVA_11`, `JAVA_17`, or `JAVA_21`. For `<your-target-java-version>`, you can enter either `JAVA_17` or `JAVA_21`. Both `--source_version` and `--target_version` are optional. The `--trust` flag enables a transformation to run while vetting code to maintain security. @@ -49,0 +53 @@ To start a transformation for a Java upgrade, run the following command. For `<y + --source_version <your-source-java-version> @@ -50,0 +55 @@ To start a transformation for a Java upgrade, run the following command. For `<y + --trust @@ -67,0 +73,17 @@ To get help with transformations, run: +## Pausing or canceling a transformation + +You can choose to pause or cancel your current transformation job. You can pause a transformation job for up to 12 hours before you can resume again. + +###### To pause or cancel a code transformation job + + 1. In your CLI terminal, press **Ctrl+C** on your keyboard. + + 2. Select whether you want to pause or cancel your tranformation. + + * Enter `1` if you want to puase the code transformation job. You can resume the job within 12 hours to continue the code transformation using the following QCT command: ``qct transform --source_folder=≤/Path/Given/Originally/To/QCT>``. + + * Enter `2` if you want to cancel the code tranformation job. + + + +