AWS CLI のコンフィグファイルと環境変数とコマンドラインオプションで指定できる内容をまとめて確認してみた

コンバンハ、千葉（幸）です。

~/.aws/config、いじってますか？

[default]
region = ap-northeast-1
output = json

[profile chiba]
region = ap-northeast-1
output = json
role_arn = arn:aws:iam::999999999999:role/chibayuki-role
source_profile = jump-account
mfa_serial = arn:aws:iam::000000000000:mfa/cm-chiba.yukihiro

~/.aws/configでデフォルトリージョンや出力形式、スイッチロールのための設定などを行う機会は多いかと思います。ここで設定可能な項目は他にもたくさんあり、その数は30個以上にのぼります。

今回はその一覧をまとめてみました。以下一覧をベースとしています。

• 設定ファイルと認証情報ファイルの設定 - AWS Command Line Interface

設定項目に対応する環境変数やコマンドライオプションがある（場合がある）ので、それも一緒にまとめています。

AWS CLI コンフィグファイルの基本をおさらい

一覧の確認の前に、基本的な考え方を押さえておきましょう。

~/.aws/config と ~/.aws/credentials

以下のように aws configure を実行したとします。（アクセスキーの値はドキュメントに載っているサンプルのものです。）

$ aws configure
AWS Access Key ID [None]: AKIAIOSFODNN7EXAMPLE
AWS Secret Access Key [None]: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
Default region name [None]: us-west-2
Default output format [None]: json

このコマンドを実行すると以下のように二つのファイルに設定が行われます。

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

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

認証情報（アクセスキーとシークレットアクセスキー）のみ別ファイルに保存され、それ以外の設定は~/.aws/configに保存されます。

こういった（両ファイルにまたがった）設定内容の集まりをプロファイルと呼びます。ここではdefaultプロファイルを使用しているということになります。

名前付きプロファイル

プロファイルを複数持つこともできます。先程の aws configure に--profileオプションを指定し、プロファイル名にSampleを指定したとします。

$ aws configure --profile Sample
AWS Access Key ID [None]: AKIAIOSFODNN7EXAMPLE
AWS Secret Access Key [None]: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
Default region name [None]: us-west-2
Default output format [None]: json

各設定ファイルにはSampleという名称でプロファイルが追加されます。

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

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

（ここではdefaultとSampleに同じ値を入れましたが、一般的には別の設定値を入れます。）

このように複数プロファイルを持てます。aws configure を使用せずに設定ファイルを直接編集しても設定できます。

コンフィグ設定と優先順位

~/.aws/configの設定内容は環境変数やコマンドラインオプションによって上書きされます。

プロファイルでデフォルトリージョンとしてus-west-2が指定されていたとします。

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

この状態で特に指定なしに AWS CLI を実行するとコマンド実行対象のリージョンはus-wast-2となります。

ここで環境変数AWS_DEFAULT_REGIONを設定すれば、設定は上書きされます。（環境変数が有効な間のみ）

$ export AWS_DEFAULT_REGION=ap-northeast-1

さらにその状態でコマンドラインオプション--regionを使用すれば、その指定が優先されます。（オプションを付与したコマンド一回のみ）

$ aws ec2 describe-vpcs\
  --region ap-northeast-3

今回取り上げた項目では以下順に優先されます。

1. コマンドラインオプション
2. 環境変数
3. AWS CLI コンフィグファイル

とは言え、すべての設定項目においてそれに対応するコマンドラインオプションや環境変数が存在するわけではないことに注意してください。

また、その他にもいくつか優先順位が考慮される要素があります。詳細は以下を参照してください。

• 設定の基本 - AWS Command Line Interface

AWS CLI コンフィググローバル設定の一覧

~/.aws/configで設定できる項目の一覧をまとめました。

AWS CLI のバージョンによって使用できるか否かが異なるため、「v1,v2」の列で表現しています。また、設定項目を上書きできる環境変数やコマンドラインオプションがあるものはそれを記載しています。

AWS CLI コンフィグ S3 カスタムコマンド設定

ここまで見てきたのは AWS CLI コンフィグのグローバル設定であり AWS サービスを問わず適用されます。S3 に限定して適用が可能な設定項目があるため、それを取り上げます。

設定項目は以下のように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

すべての項目はv1とv2の両方で使用できます。

AWS CLI の環境変数

ここまで確認してきたコンフィグの設定項目に対応するものがない環境変数もあるため、ここで取り上げます。

• Environment variables to configure the AWS CLI - AWS Command Line Interface

AWS CLI コマンドラインオプション

同じように、コンフィグ設定項目にも環境変数にも対応するものがないコマンドラインオプションがあるため、ここで取り上げます。

• Command line options - AWS Command Line Interface

終わりに

AWS CLI のコンフィグファイル、環境変数、コマンドラインオプションで指定できる内容をまとめてみました。

改めて見てみると設定項目の数がかなり多く、細かい部分まで設定変更ができることが分かりました。全部を使いこなす必要はありませんが、「こういう設定もできたな」ということを覚えておくと役に立つ時が来るかもしれません。

特に、 S3 まわりで転送のパフォーマンスが出ていない……という時のチューニングに思い出したりすると幸せになりそうです。

https://dev.classmethod.jp/articles/aws-s3-sync-with-aws-cli-s3-configuration/

ご参考ください。

以上、 チバユキ (@batchicchi) がお送りしました。

参考

• Global settings for config and credentials files - AWS SDKs and Tools