AWS Command Line Interface
ユーザーガイド

設定ファイルと認証情報ファイルの設定

頻繁に利用される構成設定および認証情報を AWS CLI が維持するファイルに保存することができます。ファイルは名前で参照できるセクションに分類されます。これらは「プロファイル」と呼ばれます。特に指定しない限り、CLI は default という名前のプロファイルにある設定を使用します。替わりの設定を使用するには、追加のプロファイルを作成して参照できます。また、サポートされた環境変数のいずれかの設定を使用するか、あるいはコマンドラインパラメータを使用して、個別の設定を上書きすることもできます。

構成設定はどこに保存されていますか。

AWS CLI は aws configure で指定された認証情報を、ホームディレクトリの .aws という名前のフォルダにある credentials という名前のローカルファイルに保存します。aws configure で指定されたもう 1 つの設定オプションは、config という名前のローカルファイルに保存されるだけでなく、ホームディレクトリの .aws フォルダにも保存されます。ホームディレクトリの場所はオペレーティングシステムによって異なりますが、環境変数 %UserProfile% (Windows の場合) および $HOME またはチルド ~ (Unix ベースのシステムの場合) を使用して参照されます。

たとえば、次のコマンドは .aws フォルダの内容を一覧表示します。

Linux, macOS, or Unix

$ ls ~/.aws

Windows

C:\> dir "%UserProfile%\.aws"

AWS CLI では 2 つのファイルを使用して、機密性の高い認証情報 (~/.aws/credentials 内) と機密性の低い設定オプション (~/.aws/config 内) を区別して保存します。

AWS_CONFIG_FILE 環境変数を別のローカルパスに設定することで、config ファイルの場所をデフォルト以外の場所に指定できます。詳細については、「環境変数」を参照してください。

認証情報を設定ファイルに保存する

また、AWS CLI は config ファイルから認証情報を読み取ることができます。すべてのプロファイル設定を 1 つのファイルに保管することもできます。両方の場所にプロファイルの認証情報がある場合 (たとえば、プロファイルのキーを更新するために aws configure を使用した場合など)、認証情報ファイルのキーが優先されます。

また、これらのファイルはさまざまな言語ソフトウェア開発キット (SDK) によっても使用されます。AWS CLI に加えていずれかの SDK を使用するとき、認証情報が独自のファイルに保存されていない場合は追加の警告が示される場合があります。

前のセクションで設定されたプロファイルのために CLI で生成されたファイルは次のようになります。

~/.aws/credentials

[default] aws_access_key_id=AKIAIOSFODNN7EXAMPLE aws_secret_access_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

~/.aws/config

[default] region=us-west-2 output=json

注記

前述の例では、1 つのデフォルトプロファイルを含むファイルを示しています。複数の名前付きプロファイルを含むファイルの例については、「名前付きプロファイル」を参照してください。

IAM ロールを指定する共有プロファイルを使用すると、AWS CLI は、AWS STS AssumeRole オペレーションを呼び出して一時的な認証情報を取得します。その後、これらの認証情報は ~/.aws/cli/cache に保存されます。それ以降の AWS CLI コマンドは、このキャッシュされた一時的な認証情報を有効期限が切れるまで使用します。有効期限が切れると、そこで AWS CLI によって自動的に認証情報が更新されます。

サポートされる config ファイル設定

config ファイルでは、以下の設定がサポートされます。同名の環境変数があること、または同名のコマンドラインオプションによって上書きされる場合を除き、指定された (またはデフォルトの) プロファイルにリストされる値が使用されます。

この設定は、config ファイルをテキストエディタで直接編集するか、aws configure set コマンドを使用して構成できます。--profile 設定で変更するプロファイルを指定します。たとえば、次のコマンドは integ という名前のプロファイル内の region 設定を構成します。

aws configure set region us-west-2 --profile integ

また、get サブコマンドを使用して、任意の設定の値を取得することもできます。

$ aws configure get region --profile default us-west-2

出力が空の場合にはその設定は明示的に構成されず、デフォルトの値が使用されます。

グローバル設定

api_versions

一部の AWS サービスでは、下位互換性をサポートするために複数の API バージョンを維持します。デフォルトでは、CLI コマンドは最新の API バージョンを使用します。config ファイル内の api_versions 設定に含むプロファイルに使用する API ファイルを指定することができます。

これは、それぞれが使用する AWS サービスと使用する API バージョンを識別する 1 つ以上のインデントされた行に適用される「ネストされた」設定です。どの API バージョンが利用可能を判断するには、各サービスのドキュメントを参照してください。

次の例は、2 つの AWS サービスに API バージョンを指定する方法を示しています。これらの API バージョンは、この設定を含むプロファイルで実行するコマンドにのみ使用されます。

api_versions = ec2 = 2015-03-01 cloudfront = 2015-09-017

この設定には、環境変数やコマンドラインパラメータに相当するものはありません。

aws_access_key_id

コマンドリクエストを認証するための認証情報の一部として使用する AWS アクセスキーを指定します。これを config ファイルに保存することもできますが、credentials ファイルに保存することが推奨されます。

AWS_ACCESS_KEY_ID 環境変数で上書きすることができます。アクセスキー ID をコマンドラインオプションとして指定することはできません。

aws_access_key_id = 123456789012
aws_secret_access_key

コマンドリクエストを認証するための認証情報の一部として使用する AWS シークレットキーを指定します。これを config ファイルに保存することもできますが、credentials ファイルに保存することが推奨されます。

AWS_SECRET_ACCESS_KEY 環境変数で上書きすることができます。シークレットアクセスキーをコマンドラインオプションとして指定することはできません。

aws_secret_access_key = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
aws_session_token

AWS セッショントークンを指定します。セッショントークンは、一時的なセキュリティ認証情報を手動で指定する場合にのみ必要です。これを config ファイルに保存することもできますが、credentials ファイルに保存することが推奨されます。

AWS_SESSION_TOKEN 環境変数で上書きすることができます。セッショントークンをコマンドラインオプションとして指定することはできません。

aws_session_token = AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/LTo6UDdyJwOOvEVPvLXCrrrUtdnniCEXAMPLE/IvU1dYUg2RVAJBanLiHb4IgRmpRV3zrkuWJOgQs8IZZaIv2BXIa2R4Olgk
ca_bundle

SSL 証明書を検証するために使用される CA 証明書バンドル (.pem 拡張子があるファイル) を指定します。

AWS_CA_BUNDLE 環境変数あるいは --ca-bundle コマンドラインオプションで上書きできます。

ca_bundle = dev/apps/ca-certs/cabundle-2019mar05.pem
cli_follow_urlparam

CLI が http:// あるいは https:// で始まるコマンドラインパラメータの URL リンクに従うことを試行するかどうかを指定します。これを有効にすると、取得されたコンテンツは URL の代わりにパラメータ値として使用されます。

  • true: これはデフォルト値です。設定すると、http:// あるいは https:// で始まるすべての文字列パラメータが取得され、ダウンロードされたすべてのコンテンツはコマンドのパラメータ値として使用されます。

  • false: CLI は http:// あるいは https:// で始まるパラメータ文字列を他の文字列と区別して扱いません。

このエントリには同等の環境変数あるいはコマンドラインオプションがありません。

cli_follow_urlparam = false
cli_timestamp_format

出力に含まれるタイムスタンプの形式を指定します。次の値のいずれかを指定できます。

  • iso8601: これは AWS CLI バージョン 2 のデフォルト値です。AWS CLI は、ISO 8601 に従ってすべてのタイムスタンプ を再フォーマットします。

  • wire: これは AWS CLI バージョン 1 のデフォルト値です。AWS CLI は、HTTP クエリレスポンスで受信したとおりにすべてのタイムスタンプ値を表示します。

このエントリには同等の環境変数あるいはコマンドラインオプションがありません。

cli_timestamp_format = iso8601
credential_process

このコマンドで使用するための認証情報を生成あるいは取得する目的で CLI が実行する外部のコマンドを指定します。このコマンドは、特定の形式で認証情報を返す必要があります。この設定を使用する方法の詳細については、「外部プロセスを使用した認証情報の調達」を参照してください。

このエントリには同等の環境変数あるいはコマンドラインオプションがありません。

credential_process = /opt/bin/awscreds-retriever --username susan
credential_source

EC2 インスタンスまたは EC2 コンテナ内で使用され、role_arn パラメータで指定したロールを引き受けるために使用する認証情報を AWS CLI が見つけられる場所を指定します。source_profilecredential_source の両方を同じプロファイルで指定することはできません。

このパラメータには、次の 3 つの値のいずれかを指定できます。

  • Environment: 環境変数からソース認証情報を取得します。

  • Ec2InstanceMetadata: EC2 インスタンスプロファイルにアタッチされた IAM ロールをソース認証情報として使用します。

  • EcsContainer: ECS IAM コンテナにアタッチされたロールをソース認証情報として使用します。

credential_source = Ec2InstanceMetadata
duration_seconds

ロールセッションの最大期間を秒単位で指定します。この値は 900 秒 (15 分) からロールの最大セッション期間設定 (上限は 43200) までの範囲を指定できます。これはオプションのパラメータであり、デフォルトでは 3600 秒に設定されています。

external_id

お客様のアカウントでサードパーティーがロールを引き受けるために使用される独自の識別子。これは ExternalId オペレーションの AssumeRole パラメータにマップします。ExternalId が特定の値でなければならないとロールの信頼ポリシーで指定されている場合を除き、このパラメータはオプションです。

mfa_serial

ロールを引き受けるときに使用する MFA デバイスの ID 番号。これは、引き受けるロールの信頼ポリシーに MFA 認証を必要とする条件が含まれている場合にのみ必須です。値には、ハードウェアデバイスのシリアルナンバー (GAHT12345678 など) または仮想 MFA デバイスの Amazon リソースネーム (ARN) (arn:aws:iam::123456789012:mfa/user など)のいずれかを指定できます。

出力

このプロファイルを使用してリクエストするコマンドのデフォルトの出力形式を指定します。次の値のいずれかを指定できます。

  • json: これは、デフォルト値です。出力は、JSON 文字列の形式になります。

  • text: 複数行のタブ区切り文字列値の形式で出力されます。出力をテキストプロセッサ (例: grepsedawk) に渡す場合に便利です。

  • table: セルの罫線を形成する文字列 +|- を使用して表形式で出力されます。通常、情報は他の形式よりも読みやすい「わかりやすい」形式で表示されますが、プログラムとしては役立ちません。

AWS_DEFAULT_OUTPUT 環境変数あるいは --output コマンドラインオプションで上書きできます。

output = table
parameter_validation

AWS サービスエンドポイントに送信する前に、CLI クライアントがパラメータを検証を試行するかどうかを指定します。

  • true: これはデフォルト値です。設定すると、CLI はコマンドラインパラメータのローカル検証を実行します。

  • false: これを設定すると、CLIは AWS サービスエンドポイントに送信する前に、コマンドラインパラメータを検証しません。

このエントリには同等の環境変数あるいはコマンドラインオプションがありません。

parameter_validation = false
region

このプロファイルを使用してリクエストされたコマンドへのリクエストを送信するためのデフォルトの AWS リージョンを指定します。『アマゾン ウェブ サービス全般のリファレンス』の「AWS のリージョンとエンドポイント」にリストされるように、選択されたサービスに使用できるリージョンコードのいずれかを指定できます。

AWS_DEFAULT_REGION 環境変数あるいは --region コマンドラインオプションで上書きできます。

region = us-west-2
role_arn

AWS CLI コマンドの実行に使用する IAM ロールの Amazon リソースネーム (ARN) を指定します。また、以下のいずれかのパラメータを指定して、このロールを引き受けるアクセス権限を持つ認証情報を特定する必要があります。

  • source_profile

  • credential_source

role_arn = arn:aws:iam::123456789012:role/role-name
role_session_name

ロールセッションにアタッチする名前を指定します。この値は、AWS CLI が AssumeRole オペレーションを呼び出す場合に RoleSessionName パラメータに提供され、引き受けたロールユーザー ARN arn:aws:sts::123456789012:assumed-role/role_name/role_session_name の一部になります。このパラメータはオプションです。この値を指定しない場合、セッション名は自動的に生成されます。この名前は、このセッションに関連付けられたエントリの AWS CloudTrail ログに表示されます。

role_session_name = maria_garcia_role
source_profile

role_arn パラメータで指定したロールを引き受けるために AWS CLI が使用できる、長期的な認証情報を持つ名前付きプロファイルを指定します。source_profilecredential_source の両方を同じプロファイルで指定することはできません。

source_profile = production-profile
sso_account_id

関連付けられた AWS SSO ユーザーに付与するアクセス権限を持つ IAM ロールを含む AWS アカウント ID。

この設定には、環境変数またはコマンドラインオプションはありません。

sso_account_id = 123456789012
sso_region

AWS SSO ポータルホストを含む AWS リージョン。これはデフォルトの CLI region パラメータとは別で、異なるリージョンにすることができます。

この設定には、環境変数またはコマンドラインオプションはありません。

aws_sso_region = us_west-2
sso_role_name

このプロファイルを使用する際のユーザーの権限を定義する IAM ロールのフレンドリ名。

この設定には、環境変数またはコマンドラインオプションはありません。

sso_role_name = ReadAccess
sso_start_url

組織の AWS SSO ユーザーポータルを指す URL。AWS CLI は、この URL を使用して、AWS SSO サービスとのセッションを確立し、ユーザーを認証します。

この設定には、環境変数またはコマンドラインオプションはありません。

sso_start_url = https://my-sso-portal.awsapps.com/start
sts_regional_endpoints

AWS CLI クライアントが AWS Security Token Service (AWS STS) との通信に使用する AWS サービスエンドポイントを指定します。次の 2 つの値のいずれかを指定できます。

  • regional: AWS CLI は、設定されたリージョンに対応する AWS STS エンドポイントを使用します。たとえば、クライアントが us-west-2 を使用するように設定されている場合、AWS STS へのすべてのコールは、グローバル sts.amazonaws.com エンドポイントではなく、エンドポイントの sts.us-west-2.amazonaws.com のリージョナルエンドポイントに対して行われます。

  • legacy: 以下のリージョンについては、グローバル STS エンドポイント sts.amazonaws.com を使用します: ap-northeast-1ap-south-1ap-southeast-1ap-southeast-2aws-globalca-central-1eu-central-1eu-north-1eu-west-1eu-west-2eu-west-3sa-east-1us-east-1us-east-2us-west-1、および us-west-2。その他のすべてのリージョンでは、それぞれのリージョンエンドポイントが使用されます。

web_identity_token_file

OAuth 2.0 アクセストークンまたは ID プロバイダによって提供される OpenID Connect ID トークンを含むファイルへのパスを指定します。AWS CLI はこのファイルの内容をロードし、WebIdentityToken 引数として AssumeRoleWithWebIdentity オペレーションに渡します。

tcp_keepalive

CLI クライアントが TCP キープアライブパケットを使用するかどうかを指定します。

このエントリには同等の環境変数あるいはコマンドラインオプションがありません。

tcp_keepalive = false

S3 カスタマーコマンド設定

Amazon S3 では、CLI がどのように S3 オペレーションを実行するかを構成する複数の設定をサポートしています。一部は、s3api および s3 名前空間の両方のすべての S3 コマンドに適用されます。それ以外は、一般的なオペレーションを抽象化する S3 の「カスタム」コマンド専用となり、API オペレーションで 1 対 1 のマッピング以上に機能します。aws s3cpsyncmv を転送し、rm には S3 転送に使用できる追加の設定があります。

これらすべてのオプションは、config ファイル内のネストされた s3 設定を指定することで構成できます。各設定は、それぞれの行にインデントされます。

注記

これらの設定はすべてオプションです。これらの設定を一切構成せずに、aws s3 転送コマンドを正しく使用できることが必要です。これらの設定は、パフォーマンスを調整したり、上述の aws s3 コマンドを実行する特定の環境に対応したりできるように用意されています。

次の設定は、s3 あるいは s3api 名前空間内の任意の S3 コマンドに適用されます。

addressing_style

使用するアドレス形式を指定します。バケット名がホスト名にあるか、または URL の一部にあるかを制御します。重要な値は、pathvirtual、および auto です。デフォルト値は auto です。

S3 エンドポイントを構成するには 2 つのスタイルがあります。1 つ目は virtual と呼ばれ、ホスト名の一部としてバケット名が含まれています。例: https://bucketname.s3.amazonaws.com。また、path スタイルでは、バケット名を URI 内のパスとして扱います。例: https://s3.amazonaws.com/bucketname。CLI におけるデフォルト値では、できる範囲では virtual スタイルを使用し、必要に応じて path に戻る auto を使用します。たとえば、バケット名に DNS との互換性がない場合い、このバケット名はホスト名の一部にならず、パス内にする必要があります。auto を使用すると、CLI はこの条件を検出し、ユーザーに代わって自動的に path に切り替えます。アドレス形式を path に設定する場合、AWS CLI で設定した AWS リージョンがバケットのリージョンと一致していることを確認する必要があります。

payload_sigining_enabled

SHA256 が sigv4 ペイロードを署名するかどうかを指定します。デフォルトでは、https 使用時のストリーミングアップロード (UploadPart および PutObject) にはこれが無効化されています。デフォルトでは、ContentMD5 があり (デフォルトで生成されます)、エンドポイントが HTTPS を使用する場合にのみ、これはストリーミングアップロード (UploadPart および PutObject) 用に false に設定されます。

true に設定すると、S3 は SHA256 チェックサム形式 (自動的に計算されてリクエスト署名に追加) で追加のコンテンツ検証の受信をリクエストします。false に設定すると、チェックサムは計算されません。これを無効にすると、チェックサム計算によって生じるパフォーマンスのオーバーヘッドの減少に役立ちます。

use_dualstack_endpoint

すべての s3 および s3api コマンドに Amazon S3 デュアル IPv4 / IPv6 エンドポイントを使用します。デフォルト値は false です。これは use_accelerate_endpoint 設定と相互に排他的となります。

true に設定すると、CLI はすべての Amazon S3 リクエストを設定されているリージョンのデュアル IPv4 / IPv6 エンドポイントに送信します。

use_accelerate_endpoint

すべての s3 および s3api コマンドに Amazon S3 高速化エンドポイントを使用します。デフォルト値は false です。これは use_dualstack_endpoint 設定と相互に排他的となります。

true に設定すると、CLI はすべての Amazon S3 リクエストを s3-accelerate.amazonaws.com で S3 高速化エンドポイントに送信します。このエンドポイントを使用するには、S3 高速化を使用するようにバケットを有効化する必要があります。リクエストはすべて、仮想形式のバケットのアドレス指定 (my-bucket.s3-accelerate.amazonaws.com) を使用して送信されます。いずれの ListBucketsCreateBucketDeleteBucket リクエストも、高速化エンドポイントには送信されません。高速化エンドポイントでは、これらのオペレーションをサポートしていないためです。また、s3 または s3api コマンドのいずれかに --endpoint-url パラメータが https://s3-accelerate.amazonaws.com あるいは http://s3-accelerate.amazonaws.com に設定されている場合には、この動作を実行できます。

以下の設定は、s3 名前空間コマンドセット内のコマンドのみに適用されます。

max_bandwidth

Amazon S3 との間でアップロードおよびダウンロードするデータ用に消費する最大の帯域幅を指定します。デフォルトは無制限です。

これによって、S3 コマンドが S3 との間でデータの転送に使用できる最大の帯域幅が制限されます。この値は、アップロードとダウンロードのみに適用され、コピーや削除には適用されません。この値は 1 秒あたりのバイト数で示されます。この値は次のように指定できます。

  • 整数。たとえば、1048576 は 1 秒あたりの 1 メガバイトの最大帯域幅使用を設定します。

  • 整数に続くレートサフィックス。KB/sMB/s、あるいは GB/s を使用して、レートサフィックスを指定できます。例: 300KB/s10MB/s

一般的には、まず、max_concurrent_requests を低くして、低い帯域幅の消費を試してみることが推奨されます。必要なレートの帯域幅消費を十分に制限できない場合には、次からの帯域幅消費を制限する設定に max_bandwidth を使用できます。これは、max_concurrent_requests が現在実行中のスレッド数を制御できるためです。代わりに、まず max_bandwidth を低くしながら max_concurrent_requests 設定を高くすると、スレッドが不必要に待機する結果が生じることがあり、余分なリソースの消費と接続タイムアウトにつながる可能性があります。

max_concurrent_requests

同時リクエストの最大数を指定します。デフォルト値は 10 です。

aws s3 転送コマンドはマルチスレッドです。どの時点でも、複数の Amazon S3 リクエストを実行することができます。たとえば、コマンド aws s3 cp localdir s3://bucket/ --recursive を使用して S3 バケットにファイルをアップロードする場合、AWS CLI は localdir/file1localdir/file2localdir/file3 ファイルを並行してアップロードできます。max_concurrent_requests の設定は、同時に実行できる転送オペレーションの最大数を指定します。

この値を変更する必要には、いくつかの理由が考えられます。

  • この値を小さくする – 一部の環境では、デフォルトである 10 個の同時リクエストはシステムをひっ迫することがあります。これによって接続タイムアウトやシステムの応答性の低下が見られる場合があります。この値を小さくすると、S3 転送コマンドのリソース消費が減少します。その代わり、S3 転送の完了により長くかかる可能性があります。帯域幅を制限するツールを使用する場合、この値を低めに抑える必要が生じることがあります。

  • この値を大きくする – シナリオによっては、必要に応じた帯域幅を使用して S3 転送をできる限り迅速に完了する場合があります。このシナリオでは、利用できるすべてのネットワーク帯域幅を使用するためにデフォルトの同時リクエスト数が十分でないことがあります。この値を大きくすると、S3 転送が完了する時間を短縮できます。

max_queue_size

タスクキューのタスクの最大数を指定します。デフォルト値は 1000 です。

AWS CLI は、max_concurrent_requests によって数が制限されるコンシューマーによって実行される S3 タスクをキューに入れるモデルを内部で使用します。タスクは通常の場合、単一の S3 オペレーションをマッピングします。たとえば、タスクは PutObjectTaskGetObjectTask、あるいは UploadPartTask にできます。タスクがキューに追加される率は、コンシューマーがタスクを終了する率よりも早くなることがあります。無限の拡大を回避するには、タスクキューのサイズを指定するサイズに抑えます。この設定は、タスクキューの最大数値を変更します。

一般的には、この設定を変更する必要はありません。また、この設定は、CLI が上述の必要性を実行することを認識しているタスクの数に該当します。つまり、デフォルトでは CLI は今後の 1000 個のタスクのみを認識できます。S3 コマンドが実行されたタスクの合計数を認識するまでは、進捗状況ラインは合計のうち ...と示します。この値を大きくすると、CLI は必要なタスクの合計数をより早く認識でき、クエリ率がタスクの完了率よりもさらに高速になると想定されます。その代わり、より大きなキューサイズはより多くのメモリを必要とします。

multipart_chunksize

個別ファイルのマルチパート転送用に CLI が使用するチャンクのサイズを指定します。デフォルト値は 8MB、最小値は 5MB です。

ファイル転送が multipart_threshold を超えると、CLI はファイルをこのサイズのチャンクに分割します。multipart_threshold と同じ構文をバイト数あるいは整数として使用するか、またはサイズとサフィックスを使用して、この値を指定することができます。

multipart_threshold

個別ファイルのマルチパート転送用に CLI が使用するしきい値のサイズを指定します。デフォルト値は 8MB です。

ファイルのアップロード、ダウンロードやコピーを行うとき、S3 コマンドは、ファイルがこのサイズを超える場合に、マルチパートオペレーションに切り替わります。この値は、次の 2 つのいずれかに指定します。

  • ファイルサイズ (バイト単位)。たとえば、1048576 と指定します。

  • サイズのサフィックスを使用したファイルサイズ。KBMBGB、あるいは TB を使用できます。例: 10MB1GB

    注記

    S3 は、マルチパートオペレーションに使用できる有効値に制約を課すことができます。詳細については、『Amazon Simple Storage Service 開発者ガイド』の「S3 マルチパートアップロードのドキュメント」を参照してください。

次の development プロファイルの例に示すように、これらの設定はすべて、config ファイルの上位レベル s3 キーで設定します。

[profile development] s3 = max_concurrent_requests = 20 max_queue_size = 10000 multipart_threshold = 64MB multipart_chunksize = 16MB max_bandwidth = 50MB/s use_accelerate_endpoint = true addressing_style = path