設定リファレンス

SDK はの言語固有の API を提供します。 AWS のサービス認証、再試行動作など、API コールを正常に行うために必要な面倒な作業の一部はこれらによって処理されます。そのために、SDK にはリクエストに使用する認証情報の取得、各サービスで使用する設定の管理、グローバル設定に使用する値の取得といった柔軟な戦略があります。

構成設定に関する詳細情報は、以下のセクションに記載されています。

• 標準化された認証情報プロバイダー – 複数の SDK で標準化された共通の認証情報プロバイダー。

• 標準化された機能 – 複数の SDK で標準化された共通機能。

サービスクライアントの作成

SDK はプログラムからアクセスするために AWS のサービス、それぞれにクライアントクラス/オブジェクトを使用します。 AWS のサービスたとえば、アプリケーションが Amazon EC2 にアクセスする必要がある場合、アプリケーションはそのサービスとインターフェイスをとる Amazon EC2 クライアントオブジェクトを作成します。次に、サービスクライアントを使用して、その AWS のサービスに対してリクエストを実行します。ほとんどの SDK では、サービスクライアントオブジェクトは不変なので、リクエストを送信するサービスごとに、また異なる設定を使用して同じサービスにリクエストを送信するたびに、新しいクライアントを作成する必要があります。

設定の優先順位

グローバル設定は、ほとんどの SDK でサポートされ、 AWS のサービス全体に幅広く影響する機能、認証情報プロバイダー、およびその他の機能を設定します。すべての SDK には、グローバル設定の値を見つけるための一連の場所（またはソース）があります。設定検索の優先順位は次のとおりです。

1. コードまたはサービスクライアント自体に設定されている明示的な設定は、他の設定よりも優先されます。

   • 一部の設定はオペレーションごとに設定でき、呼び出すオペレーションごとに必要に応じて変更できます。 AWS CLI またはの場合 AWS Tools for PowerShell、これらはコマンドラインに入力する操作ごとのパラメータという形をとります。SDK の場合、明示的な割り当ては、 AWS のサービス クライアントや設定オブジェクトをインスタンス化するときや、個々の API を呼び出すときに設定するパラメータの形式をとることができます。

2. Java/Kotlin のみ:設定の JVM システムプロパティがチェックされます。設定されている場合は、その値を使用してクライアントが設定されます。

3. 環境変数が確認されます。設定されている場合は、その値を使用してクライアントが設定されます。

4. SDK credentials は共有ファイルの設定を確認します。設定されている場合、クライアントはそれを使用します。

5. config設定用の共有ファイル。設定が存在する場合、SDK はその設定を使用します。

   • AWS_PROFILE環境変数または aws.profile JVM システムプロパティを使用して、SDK がロードするプロファイルを指定できます。

6. SDK ソースコード自体が提供するデフォルト値が最後に使用されます。

注記

SDK やツールによっては、チェックの順序が異なる場合があります。また、SDK やツールの中には、他の方法でパラメータを保存したり取得したりできるものもあります。たとえば、は SDK AWS SDK for .NET ストアと呼ばれる追加のソースをサポートしています。SDK またはツールにのみ存在するプロバイダーについて詳しくは、使用している SDK またはツールの特定のガイドを参照してください。

順序によって、どのメソッドが優先され、他のメソッドをオーバーライドするかが決まります。たとえば、共有 config ファイルにプロファイルを設定した場合、そのプロファイルは SDK またはツールが最初に他の場所を確認した後にのみ検出され、使用されます。つまり、credentials ファイルに設定を入力すると、config ファイルにある設定の代わりにその設定が使用されます。環境変数に設定と値を設定すると、credentials と config ファイルの両方の設定がオーバーライドされます。最後に、個々のオペレーション（AWS CLI コマンドラインパラメータまたは API パラメータ）またはコード内の設定は、その 1 つのコマンドの他のすべての値をオーバーライドします。

Config ファイル設定リスト

次の表に示す設定は、 AWS config共有ファイルに割り当てることができます。これらはグローバルで、すべての AWS のサービスに影響します。

設定名	詳細
api_versions	一般設定
aws_access_key_id	AWS アクセスキー
aws_secret_access_key	AWS アクセスキー
aws_session_token	AWS アクセスキー
ca_bundle	一般設定
credential_process	プロセス認証情報プロバイダー
credential_source	ロール認証情報プロバイダーを引き受けます
defaults_mode	スマート設定デフォルト
disable_request_compression	リクエスト圧縮
duration_seconds	ロール認証情報プロバイダーを引き受けます
ec2_metadata_service_endpoint	IMDS 認証情報プロバイダー
ec2_metadata_service_endpoint_mode	IMDS 認証情報プロバイダー
ec2_metadata_v1_disabled	IMDS 認証情報プロバイダー
endpoint_discovery_enabled	エンドポイント検出
endpoint_url	サービス固有のエンドポイント
external_id	ロール認証情報プロバイダーを引き受けます
ignore_configured_endpoint_urls	サービス固有のエンドポイント
max_attempts	再試行動作
metadata_service_num_attempts	Amazon EC2 インスタンスメタデータ
metadata_service_timeout	Amazon EC2 インスタンスメタデータ
mfa_serial	ロール認証情報プロバイダーを引き受けます
output	一般設定
parameter_validation	一般設定
region	AWS リージョン
request_min_compression_size_bytes	リクエスト圧縮
retry_mode	再試行動作
role_arn	ロール認証情報プロバイダーを引き受けます
role_session_name	ロール認証情報プロバイダーを引き受けます
s3_disable_multiregion_access_points	Amazon S3 マルチリージョンアクセスポイント
s3_use_arn_region	Amazon S3 アクセスポイント
source_profile	ロール認証情報プロバイダーを引き受けます
sso_account_id	IAM Identity Center 認証情報プロバイダー
sso_region	IAM Identity Center 認証情報プロバイダー
sso_registration_scopes	IAM Identity Center 認証情報プロバイダー
sso_role_name	IAM Identity Center 認証情報プロバイダー
sso_start_url	IAM Identity Center 認証情報プロバイダー
sts_regional_endpoints	AWS STS 地域化されたエンドポイント
use_dualstack_endpoint	デュアルスタックと FIPS エンドポイント
use_fips_endpoint	デュアルスタックと FIPS エンドポイント
web_identity_token_file	ロール認証情報プロバイダーを引き受けます

Credentials ファイル設定リスト

次の表に示す設定は、共有ファイルに割り当てることができます。 AWS credentialsこれらはグローバルで、すべての AWS のサービスに影響します。

設定名	詳細
aws_access_key_id	AWS アクセスキー
aws_secret_access_key	AWS アクセスキー
aws_session_token	AWS アクセスキー

環境変数の一覧

ほとんどの SDK でサポートされる環境変数は、以下の表に示されています。これらはグローバルで、すべての AWS のサービスに影響します。

設定名	詳細
AWS_ACCESS_KEY_ID	AWS アクセスキー
AWS_CA_BUNDLE	一般設定
AWS_CONFIG_FILE	共有 config ファイルと credentials ファイルの場所
AWS_CONTAINER_AUTHORIZATION_TOKEN	コンテナ認証情報プロバイダー
AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE	コンテナ認証情報プロバイダー
AWS_CONTAINER_CREDENTIALS_FULL_URI	コンテナ認証情報プロバイダー
AWS_CONTAINER_CREDENTIALS_RELATIVE_URI	コンテナ認証情報プロバイダー
AWS_DEFAULTS_MODE	スマート設定デフォルト
AWS_DISABLE_REQUEST_COMPRESSION	リクエスト圧縮
AWS_EC2_METADATA_DISABLED	IMDS 認証情報プロバイダー
AWS_EC2_METADATA_SERVICE_ENDPOINT	IMDS 認証情報プロバイダー
AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE	IMDS 認証情報プロバイダー
AWS_EC2_METADATA_V1_DISABLED	IMDS 認証情報プロバイダー
AWS_ENABLE_ENDPOINT_DISCOVERY	エンドポイント検出
AWS_ENDPOINT_URL	サービス固有のエンドポイント
AWS_ENDPOINT_URL_<SERVICE>	サービス固有のエンドポイント
AWS_IAM_ROLE_ARN	ロール認証情報プロバイダーを引き受けます
AWS_IAM_ROLE_SESSION_NAME	ロール認証情報プロバイダーを引き受けます
AWS_IGNORE_CONFIGURED_ENDPOINT_URLS	サービス固有のエンドポイント
AWS_MAX_ATTEMPTS	再試行動作
AWS_METADATA_SERVICE_NUM_ATTEMPTS	Amazon EC2 インスタンスメタデータ
AWS_METADATA_SERVICE_TIMEOUT	Amazon EC2 インスタンスメタデータ
AWS_PROFILE	共有 config および credentials ファイル
AWS_REGION	AWS リージョン
AWS_REQUEST_MIN_COMPRESSION_SIZE_BYTES	リクエスト圧縮
AWS_RETRY_MODE	再試行動作
AWS_S3_DISABLE_MULTIREGION_ACCESS_POINTS	Amazon S3 マルチリージョンアクセスポイント
AWS_S3_USE_ARN_REGION	Amazon S3 アクセスポイント
AWS_SECRET_ACCESS_KEY	AWS アクセスキー
AWS_SESSION_TOKEN	AWS アクセスキー
AWS_SHARED_CREDENTIALS_FILE	共有 config ファイルと credentials ファイルの場所
AWS_STS_REGIONAL_ENDPOINTS	AWS STS 地域化されたエンドポイント
AWS_USE_DUALSTACK_ENDPOINT	デュアルスタックと FIPS エンドポイント
AWS_USE_FIPS_ENDPOINT	デュアルスタックと FIPS エンドポイント
AWS_WEB_IDENTITY_TOKEN_FILE	ロール認証情報プロバイダーを引き受けます

JVM システムプロパティリスト

AWS SDK for Java および AWS SDK for Kotlin （JVM を対象とする）には、次の JVM システムプロパティを使用できます。JVM JVM システムプロパティの設定方法 システムプロパティの設定方法については、を参照してください。

設定名	詳細
aws.accessKeyId	AWS アクセスキー
aws.configFile	共有 config ファイルと credentials ファイルの場所
aws.defaultsMode	スマート設定デフォルト
aws.disableEc2MetadataV1	IMDS 認証情報プロバイダー
aws.disableRequestCompression	リクエスト圧縮
aws.ec2MetadataServiceEndpoint	IMDS 認証情報プロバイダー
aws.ec2MetadataServiceEndpointMode	IMDS 認証情報プロバイダー
aws.endpointDiscoveryEnabled	エンドポイント検出
aws.endpointUrl	サービス固有のエンドポイント
aws.endpointUrl<ServiceName>	サービス固有のエンドポイント
aws.ignoreConfiguredEndpointUrls	サービス固有のエンドポイント
aws.maxAttempts	再試行動作
aws.profile	共有 config および credentials ファイル
aws.region	AWS リージョン
aws.requestMinCompressionSizeBytes	リクエスト圧縮
aws.retryMode	再試行動作
aws.roleArn	ロール認証情報プロバイダーを引き受けます
aws.roleSessionName	ロール認証情報プロバイダーを引き受けます
aws.s3DisableMultiRegionAccessPoints	Amazon S3 マルチリージョンアクセスポイント
aws.s3UseArnRegion	Amazon S3 アクセスポイント
aws.secretAccessKey	AWS アクセスキー
aws.sessionToken	AWS アクセスキー
aws.sharedCredentialsFile	共有 config ファイルと credentials ファイルの場所
aws.useDualstackEndpoint	デュアルスタックと FIPS エンドポイント
aws.useFipsEndpoint	デュアルスタックと FIPS エンドポイント
aws.webIdentityTokenFile	ロール認証情報プロバイダーを引き受けます