您可以使用環境變數來設定 AWS CLI - AWS Command Line Interface

您可以使用環境變數來設定 AWS CLI

環境變數提供另一種方法來指定組態選項和憑證,且適合用來編寫指令碼或暫時將具名描述檔設為預設值。

選項的優先順序

  • 如果您使用本主題中所述的其中一個環境變數來指定選項,它將覆寫從組態檔中描述檔載入的任何數值。

  • 如果您在 AWS CLI 命令列中使用參數來指定選項,它將覆寫來自對應的環境變數或組態檔案中描述檔的任何數值。

如需有關優先順序以及 AWS CLI 如何決定要使用的憑證的詳細資訊,請參閱 組態設定和優先順序

如何設定環境變數

下列範例說明如何為預設使用者設定環境變數。

Linux or macOS
$ export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE $ export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY $ export AWS_DEFAULT_REGION=us-west-2

設定環境變數會變更使用的數值,直到 Shell 工作階段結束或直到您將該變數設為其他數值。您可以在 Shell 的啟動指令碼中設定變數,讓它們跨未來的工作階段持續生效。

Windows Command Prompt

為所有工作階段設定

C:\> setx AWS_ACCESS_KEY_ID AKIAIOSFODNN7EXAMPLE C:\> setx AWS_SECRET_ACCESS_KEY wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY C:\> setx AWS_DEFAULT_REGION us-west-2

使用 setx 設定環境變數時,將會變更在目前命令提示工作階段及您在執行命令後建立的所有命令提示工作階段中使用的數值。不會影響您執行命令當時已執行的其他命令 Shell。您可能需要重新啟動終端機才能載入設定。

僅針對目前工作階段設定

使用 set 設定環境變數會變更使用的數值,直到目前命令提示工作階段結束或直到您將該變數設為其他數值。

C:\> set AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE C:\> set AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY C:\> set AWS_DEFAULT_REGION=us-west-2
PowerShell
PS C:\> $Env:AWS_ACCESS_KEY_ID="AKIAIOSFODNN7EXAMPLE" PS C:\> $Env:AWS_SECRET_ACCESS_KEY="wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" PS C:\> $Env:AWS_DEFAULT_REGION="us-west-2"

如果您在 PowerShell 提示字元中設定環境變數 (如前一個範例所示),它只會在目前的工作階段儲存該數值。若要讓環境變數設定在所有 PowerShell 和命令提示字元工作階段中持續存在,請使用 Control Panel (控制面板) 中的 System (系統) 應用程式。或者,您也可以將變數新增到 PowerShell 設定檔,為所有未來 PowerShell 工作階段設定變數。如需有關存放環境變數或跨工作階段持續存放的詳細資訊,請參閱 PowerShell 文件

AWS CLI 支援的環境變數

AWS CLI 支援下列環境變數。

AWS_ACCESS_KEY_ID

指定與 IAM 使用者或角色相關聯的 AWS 存取金鑰。

如果已定義,此環境變數會覆寫設定檔設定 aws_access_key_id 的數值。您無法使用命令列選項來指定存取金鑰 ID。

AWS_CA_BUNDLE

指定要用於 HTTPS 憑證驗證的憑證套件路徑。

如果已定義,此環境變數會覆寫設定檔設定 ca_bundle 的數值。您可以使用 --ca-bundle 命令列參數來覆寫此環境變數。

AWS_CLI_AUTO_PROMPT

為 AWS CLI 第 2 版啟用自動提示。有兩種設定可以使用:

  • 在您每次嘗試執行 aws 命令時,on 都會使用完整的自動提示模式。這包括在完整的命令或不完整的命令之後按下 ENTER

    AWS_CLI_AUTO_PROMPT=on
  • on-partial 使用部分自動提示模式。如果命令不完整或因用戶端驗證錯誤而無法執行,則會使用自動提示。如果您有預先存在的指令碼、Runbook,或是您只希望系統自動提示您不熟悉的命令 (而非針對每個命令發出提示),這個模式就特別有用。

    AWS_CLI_AUTO_PROMPT=on-partial

如果已定義,此環境變數會覆寫 cli_auto_prompt 設定檔設定的數值。您可以使用 --cli-auto-prompt--no-cli-auto-prompt 命令列參數來覆寫此環境變數。

如需 AWS CLI 第 2 版自動提示功能的相關資訊,請參閱 讓 AWS CLI 提示您輸入命令提示

AWS_CLI_FILE_ENCODING

指定用於文字檔的編碼。預設情況下,編碼會與您的語言環境相符。若要設定與地區設定不同的編碼,請使用 aws_cli_file_encoding 環境變數。例如,如果您使用 Windows 的預設編碼 CP1252,則 aws_cli_file_encoding=UTF-8 設定會將 CLI 設定為使用 UTF-8

AWS_CONFIG_FILE

指定 AWS CLI 用來儲存組態設定檔的檔案位置。預設路徑為 ~/.aws/config

您無法在具名設定檔設定中或使用命令列參數來指定此數值。

AWS_DATA_PATH

載入 AWS CLI 資料時,~/.aws/models 的內建搜索路徑外需要檢查的額外目錄清單。設定此環境變數會指出回復內建搜尋路徑前需要先檢查的額外目錄。多個項目應使用 os.pathsep 字元分隔,在 Linux 或 macOS 上為 :,在 Windows 上則為 ;

AWS_DEFAULT_OUTPUT

指定要使用的輸出格式

如果已定義,此環境變數會覆寫設定檔設定 output 的數值。您可以使用 --output 命令列參數來覆寫此環境變數。

AWS_DEFAULT_REGION

指定請求傳送到的 AWS 區域。

如果已定義,此環境變數會覆寫設定檔設定 region 和 的數值。您可以使用 --region 命令列參數與 AWS SDK 相容 AWS_REGION 環境變數來覆寫此環境變數。

AWS_EC2_METADATA_DISABLED

停用 Amazon EC2 執行個體中繼資料服務 (IMDS)。

如果設定為 true,則不會向 IMDS 要求使用者憑證或組態 (如區域)。

AWS_MAX_ATTEMPTS

指定 AWS CLI 重試處理常式使用的重試次數上限值,其中初始呼叫會計入您提供的數值。如需有關重試的詳細資訊,請參閱 AWS CLI 重試

如果已定義,此環境變數會覆寫設定檔設定 max_attempts 的數值。

AWS_METADATA_SERVICE_NUM_ATTEMPTS

AWS CLI 嘗試在已設定 IAM 角色的 Amazon EC2 執行個體上擷取憑證時,只會在放棄之前從執行個體中繼資料服務嘗試擷取憑證一次。如果您知道自己的程式碼將在 Amazon EC2 執行個體上執行,您可以增加這個值,讓 AWS CLI 在放棄之前多重新嘗試幾次。

AWS_METADATA_SERVICE_TIMEOUT

執行個體中繼資料服務連線逾時前的秒數。嘗試在已設定 IAM 角色的 Amazon EC2 執行個體上擷取憑證時,執行個體中繼資料服務連線預設為 1 秒之後逾時。如果您知道自己在已設定 IAM 角色的 Amazon EC2 執行個體上執行,您可以視需要增加這個值。

AWS_PAGER

指定用於輸出的分頁程式。根據預設,AWS CLI 第 2 版會透過作業系統的預設分頁程式傳回所有輸出。

若要停用所有外部分頁程式,請將變數設定為空字串。

如果已定義,此環境變數會覆寫設定檔設定 cli_pager 的數值。

AWS_PROFILE

指定 AWS CLI 設定檔的名稱,其中包含要使用的憑證和選項。這可以是在 credentialsconfig 檔案中存放的描述檔名稱,或數值 default 以使用預設描述檔。

如果您定義此環境變數,它將覆寫使用組態檔中名為 [default] 之描述檔的行為。您可以使用 --profile 命令列參數來覆寫此環境變數。

AWS_REGION

指定要傳送請求區域 AWS 的 AWS SDK 相容環境變數。

如果已定義,此環境變數會覆寫環境變數 AWS_DEFAULT_REGION 及設定檔設定 region 的數值。您可以使用 --region 命令列參數來覆寫此環境變數。

AWS_RETRY_MODE

指定 AWS CLI 使用的重試模式。有三種可用的重試模式:傳統 (預設)、標準和自適應。如需有關重試的詳細資訊,請參閱 AWS CLI 重試

如果已定義,此環境變數會覆寫設定檔設定 retry_mode 的數值。

AWS_ROLE_ARN

利用您要用來執行 AWS CLI 命令的 Web 身分提供者,指定 IAM 角色的 Amazon 資源名稱 (ARN)。

AWS_WEB_IDENTITY_TOKEN_FILEAWS_ROLE_SESSION_NAME 環境變數搭配使用。

如果已定義,此環境變數會覆寫設定檔設定 role_arn 的數值。您無法將角色工作階段名稱指定為命令列參數。

注意

此環境變數目前僅適用於具有 Web 身分提供者的擔任角色,並不適用一般擔任角色提供者組態。

如需使用 Web 身分的詳細資訊,請參閱 擔任具有 Web 身分的角色

AWS_ROLE_SESSION_NAME

指定要連接到角色工作階段的名稱。此數值會在 RoleSessionName 呼叫 AWS CLI 操作時提供給 AssumeRole 參數,並成為所擔任角色使用者 ARN 的一部分: arn:aws:sts::123456789012:assumed-role/role_name/role_session_name。這是選擇性的參數。若您未提供此數值,將會自動產生工作階段名稱。此名稱會出現在與此工作階段相關聯之項目的 AWS CloudTrail 日誌中。

如果已定義,此環境變數會覆寫設定檔設定 role_session_name 的數值。

AWS_ROLE_ARNAWS_WEB_IDENTITY_TOKEN_FILE 環境變數搭配使用。

如需使用 Web 身分的詳細資訊,請參閱 擔任具有 Web 身分的角色

注意

此環境變數目前僅適用於具有 Web 身分提供者的擔任角色,並不適用一般擔任角色提供者組態。

AWS_SECRET_ACCESS_KEY

指定與存取金鑰相關聯的私密金鑰。這基本上是存取金鑰的「密碼」。

如果已定義,此環境變數會覆寫設定檔設定 aws_secret_access_key 的數值。您不能將私密存取金鑰 ID 指定為命令列選項。

AWS_SESSION_TOKEN

指定當您直接從 AWS STS 作業擷取的暫時安全憑證時需要的工作階段字符值。如需詳細資訊,請參閱AWS CLI 命令參考中的擔任角色命令的輸出部分

如果已定義,此環境變數會覆寫設定檔設定 aws_session_token 的數值。

AWS_SHARED_CREDENTIALS_FILE

指定 AWS CLI 用來儲存存取金鑰的檔案位置。預設路徑為 ~/.aws/credentials

您無法在具名設定檔設定中或使用命令列參數來指定此數值。

AWS_WEB_IDENTITY_TOKEN_FILE

指定檔案的路徑,其包含由身分提供者提供的 OAuth 2.0 存取字符或 OpenID Connect ID 字符。AWS CLI 會載入此檔案的內容,並將其作為 WebIdentityToken 引數傳遞至 AssumeRoleWithWebIdentity 操作。

AWS_ROLE_ARNAWS_ROLE_SESSION_NAME 環境變數搭配使用。

如果已定義,此環境變數會覆寫設定檔設定 web_identity_token_file 的數值。

如需使用 Web 身分的詳細資訊,請參閱 擔任具有 Web 身分的角色

注意

此環境變數目前僅適用於具有 Web 身分提供者的擔任角色,並不適用一般擔任角色提供者組態。