翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
設定リファレンス
SDKs APIsに言語固有の を提供します AWS のサービス。認証、再試行動作など、API通話を正常に行うために必要な負担の一部を負担します。そのためには、 SDKsには、リクエストに使用する認証情報を取得し、各サービスで使用する設定を維持し、グローバル設定に使用する値を取得する柔軟な戦略があります。
設定の詳細については、以下のセクションを参照してください。
-
AWS SDKs およびツール標準化された認証情報プロバイダー – 複数の にまたがって標準化された一般的な認証情報プロバイダーSDKs。
-
AWS SDKs およびツールの標準化された機能 – 複数の で標準化された一般的な機能SDKs。
サービスクライアントの作成
にプログラムでアクセスするには AWS のサービス、各 にクライアントクラス/オブジェクトSDKsを使用します AWS のサービス。例えば、アプリケーションが Amazon にアクセスする必要がある場合EC2、アプリケーションはそのサービスとインターフェイスする Amazon EC2クライアントオブジェクトを作成します。次に、サービスクライアントを使用して、その AWS のサービスに対してリクエストを実行します。ほとんどの ではSDKs、サービスクライアントオブジェクトはイミュータブルであるため、リクエストを行うサービスごとに新しいクライアントを作成し、別の設定を使用して同じサービスにリクエストを行う必要があります。
設定の優先順位
グローバル設定は、ほとんどの でサポートされ、 全体に広範な影響を与える機能SDKs、認証情報プロバイダー、およびその他の機能を設定します AWS のサービス。すべての SDKs には、グローバル設定の値を見つけるためにチェックする一連の場所 (またはソース) があります。設定検索の優先順位は次のとおりです。
-
コードまたはサービスクライアント自体に設定されている明示的な設定は、他の設定よりも優先されます。
-
一部の設定はオペレーションごとに設定でき、呼び出すオペレーションごとに必要に応じて変更できます。 AWS CLI または の場合 AWS Tools for PowerShell、これらはコマンドラインで入力するオペレーションごとのパラメータの形式になります。の場合SDK、明示的な割り当ては、 AWS のサービス クライアントまたは設定オブジェクトをインスタンス化するときに設定したパラメータの形式をとることができ、場合によっては個々の を呼び出すときにもかまいませんAPI。
-
-
Java/Kotlin のみ: 設定のJVMシステムプロパティがチェックされます。設定されている場合は、その値を使用してクライアントが設定されます。
-
環境変数が確認されます。設定されている場合は、その値を使用してクライアントが設定されます。
-
は、共有
credentialsファイルで設定SDKをチェックします。設定されている場合、クライアントはそれを使用します。 -
設定の共有
configファイル。設定が存在する場合、 はそれSDKを使用します。-
AWS_PROFILE環境変数またはaws.profileJVMシステムプロパティを使用して、SDKロードするプロファイルを指定できます。
-
-
SDK ソースコード自体によって提供されるデフォルト値が最後に使用されます。
注記
一部の SDKsおよび ツールでは、異なる順序でチェックされる場合があります。また、一部の SDKs および ツールでは、パラメータを保存および取得する他の方法をサポートしています。例えば、 は SDK Store と呼ばれる追加のソース AWS SDK for .NET をサポートしています。SDK または ツールに固有のプロバイダーの詳細については、使用している SDKまたは ツールの特定のガイドを参照してください。
順序によって、どのメソッドが優先され、他のメソッドをオーバーライドするかが決まります。例えば、共有configファイルにプロファイルを設定した場合、 SDKまたは ツールが他の場所を最初にチェックした後にのみ検出され使用されます。つまり、credentials ファイルに設定を入力すると、config ファイルにある設定の代わりにその設定が使用されます。環境変数に設定と値を設定すると、credentials と config ファイルの両方の設定がオーバーライドされます。最後に、個々のオペレーション (AWS CLI コマンドラインパラメータまたはAPIパラメータ) またはコードでの設定は、その 1 つのコマンドの他のすべての値を上書きします。
設定ページ
このガイドの設定リファレンスセクションのページには、さまざまなメカニズムで設定できる利用可能な設定の詳細が記載されています。次のテーブルには、設定ファイルと認証情報ファイルの設定、環境変数、および (Java と Kotlin の場合SDKs) コードの外部で機能を設定するために使用できるJVM設定が一覧表示されます。各リスト内のリンクされたトピックごとに、対応する設定ページに移動します。
各認証情報プロバイダーまたは機能には、その機能の設定に使用される設定が一覧表示されるページがあります。設定ごとに、設定を設定ファイルに追加するか、環境変数を設定するか、JVMシステムプロパティを設定して (Java と Kotlin のみ) 値を設定できます。各設定には、説明の詳細の上にあるブロックで値を設定するサポートされているすべての方法が一覧表示されます。優先順位は異なりますが、結果の機能は設定方法に関係なく同じです。
説明には、何もしない場合に有効になるデフォルト値が含まれる。また、その設定の有効な値も定義します。
例えば、リクエスト圧縮機能ページから設定を見てみましょう。
サンプルdisable_request_compression設定の情報は、以下を伝達します。
-
コードベース外でリクエストの圧縮を制御するには、3 つの同等の方法があります。次のいずれかを行うことができます。
-
を使用して設定ファイルに設定
disable_request_compression -
を使用して環境変数として設定する
AWS_DISABLE_REQUEST_COMPRESSION -
または、Java または Kotlin を使用している場合はSDK、 を使用してJVMシステムプロパティとして設定します。
aws.disableRequestCompression
注記
また、コード内で同じ機能を直接設定する方法もありますが、このリファレンスでは、各 に固有のため、これについては説明していませんSDK。コード自体で設定を設定する場合は、特定のSDKガイドまたはAPIリファレンスを参照してください。
-
-
何もしない場合、値はデフォルトで になります
false。 -
このブール値設定の有効な値は
trueと のみですfalse。
各機能ページの下部には、 テーブルとの互換性 AWS SDKsがあります。
この表は、 がページにリストされている設定SDKをサポートしているかどうかを示しています。Supported 列には、次の値を持つサポートレベルが表示されます。
-
Yes– 設定は、記述されているSDKように によって完全にサポートされています。 -
Partial– 一部の設定がサポートされているか、動作が説明から逸脱しています。の場合Partial、追加のメモは偏差を示します。 -
No– どの設定もサポートされていません。これにより、同じ機能がコードで達成されるかどうかが主張されるわけではなく、リストされている外部設定がサポートされていないことを意味します。
Config ファイル設定リスト
次の表に示す設定は、共有 AWS configファイルで割り当てることができます。これらはグローバルで、すべての AWS のサービスに影響します。SDKs および ツールは、一意の設定と環境変数をサポートする場合もあります。個人SDKまたはツールのみがサポートする設定と環境変数を確認するには、その特定の SDK またはツールガイドを参照してください。
| 設定名 | 詳細 |
|---|---|
account_id_endpoint_mode
|
アカウントベースのエンドポイント |
api_versions
|
一般設定 |
aws_access_key_id
|
AWS アクセスキー |
aws_account_id
|
アカウントベースのエンドポイント |
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 アクセスポイント |
sdk_ua_app_id
|
アプリケーション ID |
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 のサービスに影響します。SDKs および ツールは、一意の設定と環境変数をサポートする場合もあります。個人SDKまたはツールのみがサポートする設定と環境変数を確認するには、その特定の SDK またはツールガイドを参照してください。
| 設定名 | 詳細 |
|---|---|
aws_access_key_id
|
AWS アクセスキー |
aws_secret_access_key
|
AWS アクセスキー |
aws_session_token
|
AWS アクセスキー |
環境変数の一覧
ほとんどの でサポートされている環境変数SDKsを次の表に示します。これらはグローバルで、すべての AWS のサービスに影響します。SDKs および ツールは、一意の設定と環境変数をサポートする場合もあります。個人SDKまたはツールのみがサポートする設定と環境変数を確認するには、その特定の SDK またはツールガイドを参照してください。
| 設定名 | 詳細 |
|---|---|
AWS_ACCESS_KEY_ID
|
AWS アクセスキー |
AWS_ACCOUNT_ID
|
アカウントベースのエンドポイント |
AWS_ACCOUNT_ID_ENDPOINT_MODE
|
アカウントベースのエンドポイント |
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_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_ROLE_ARN
|
ロール認証情報プロバイダーを引き受けます |
AWS_ROLE_SESSION_NAME
|
ロール認証情報プロバイダーを引き受けます |
AWS_S3_DISABLE_MULTIREGION_ACCESS_POINTS
|
Amazon S3 マルチリージョンアクセスポイント |
AWS_S3_USE_ARN_REGION
|
Amazon S3 アクセスポイント |
AWS_SDK_UA_APP_ID
|
アプリケーション ID |
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.accountId
|
アカウントベースのエンドポイント |
aws.accountIdEndpointMode
|
アカウントベースのエンドポイント |
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.userAgentAppId
|
アプリケーション ID |
aws.webIdentityTokenFile
|
ロール認証情報プロバイダーを引き受けます |
