AWS transform documentation change
Summary
Added native Windows support documentation with PowerShell instructions, updated environment variable handling for Windows, and clarified configuration file paths across operating systems
Security assessment
Changes focus on expanding platform support and improving configuration instructions. While environment variable handling is mentioned, there is no evidence of addressing a specific security vulnerability or weakness. The updates are operational rather than security-focused.
Diff
diff --git a/transform/latest/userguide/custom-get-started.md b/transform/latest/userguide/custom-get-started.md index 9376f678b..21f941416 100644 --- a//transform/latest/userguide/custom-get-started.md +++ b//transform/latest/userguide/custom-get-started.md @@ -25,2 +25 @@ AWS Transform custom supports the following operating systems: - * **Windows Subsystem for Linux (WSL)** \- Supported when running under WSL - + * **Windows** \- Full support for native Windows using Windows Terminal and PowerShell (The `atx ct` commands are not yet supported on Windows) @@ -27,0 +27 @@ AWS Transform custom supports the following operating systems: + * **Windows Subsystem for Linux (WSL)** \- Supported when running under WSL @@ -30 +29,0 @@ AWS Transform custom supports the following operating systems: -###### Important @@ -32 +30,0 @@ AWS Transform custom supports the following operating systems: -Windows native execution is not supported. AWS Transform custom will detect native Windows environments and exit with an error message. For Windows users, install and use Windows Subsystem for Linux (WSL). @@ -60 +58 @@ If you are working in an internet-restricted environment, update firewall rules -The recommended installation method is using the installation script. +The recommended installation method is using the installation script. Choose the tab for your operating system. @@ -65,0 +64,3 @@ The recommended installation method is using the installation script. +Linux and macOS + + @@ -67,0 +69,7 @@ The recommended installation method is using the installation script. +Windows (PowerShell) + + +On native Windows, run the installation script from Windows Terminal using PowerShell. + + irm https://transform-cli.awsstatic.com/install.ps1 | iex + @@ -83 +91,4 @@ AWS Transform custom requires AWS credentials to authenticate with the service. -Set the following environment variables: +Set the following environment variables. + +Linux and macOS + @@ -90 +101,12 @@ Set the following environment variables: -You can also specify a profile using the `AWS_PROFILE` environment variable: +Windows (PowerShell) + + + + $env:AWS_ACCESS_KEY_ID="your_access_key" + $env:AWS_SECRET_ACCESS_KEY="your_secret_key" + $env:AWS_SESSION_TOKEN="your_session_token" + +You can also specify a profile using the `AWS_PROFILE` environment variable. + +Linux and macOS + @@ -94,0 +117,10 @@ You can also specify a profile using the `AWS_PROFILE` environment variable: +Windows (PowerShell) + + + + $env:AWS_PROFILE="your_profile_name" + +###### Note + +Environment variables set with `$env:` in PowerShell apply to the current session only. To persist them across sessions, set them through **System Properties** > **Environment Variables** , or use `[System.Environment]::SetEnvironmentVariable()`. + @@ -97 +129 @@ You can also specify a profile using the `AWS_PROFILE` environment variable: -Configure credentials in `~/.aws/credentials`: +Configure credentials in the AWS credentials file, located at `~/.aws/credentials` on Linux and macOS, or `%USERPROFILE%\.aws\credentials` on Windows: @@ -163 +195 @@ The CLI checks these sources in priority order to determine which region to use: - 3. Selected profile in `~/.aws/config` (via `AWS_PROFILE` environment variable) + 3. Selected profile in the AWS config file (via `AWS_PROFILE` environment variable) @@ -165 +197 @@ The CLI checks these sources in priority order to determine which region to use: - 4. Default profile in `~/.aws/config` + 4. Default profile in the AWS config file @@ -171,0 +204,4 @@ The CLI checks these sources in priority order to determine which region to use: +###### Note + +The AWS config file is located at `~/.aws/config` on Linux and macOS, or `%USERPROFILE%\.aws\config` on Windows. + @@ -181,0 +218,3 @@ Choose one of these methods to configure your region: +Linux and macOS + + @@ -184,0 +224,6 @@ Choose one of these methods to configure your region: +Windows (PowerShell) + + + + $env:AWS_REGION="<your-region>" + @@ -191,0 +237,3 @@ Choose one of these methods to configure your region: +Linux and macOS + + @@ -195,0 +244,7 @@ Choose one of these methods to configure your region: +Windows (PowerShell) + + + + aws configure set region <your-region> --profile your_profile_name + $env:AWS_PROFILE="your_profile_name" + @@ -198 +253 @@ Choose one of these methods to configure your region: -Edit `~/.aws/config` directly: +Edit the AWS config file directly (`~/.aws/config` on Linux and macOS, or `%USERPROFILE%\.aws\config` on Windows): @@ -217,0 +273,3 @@ To check which region AWS Transform custom will use: +Linux and macOS + + @@ -222,0 +281,8 @@ To check which region AWS Transform custom will use: +Windows (PowerShell) + + + + echo "AWS_REGION: $env:AWS_REGION" + echo "AWS_DEFAULT_REGION: $env:AWS_DEFAULT_REGION" + echo "AWS_PROFILE: $env:AWS_PROFILE" + @@ -224,0 +291,3 @@ To check which region AWS Transform custom will use: +Linux and macOS + + @@ -227,0 +297,6 @@ To check which region AWS Transform custom will use: +Windows (PowerShell) + + + + Get-Content "$env:USERPROFILE\.aws\atx\logs\debug.log" -Wait -Tail 10 +