` 要素を追加します。
たとえば、Amazon S3 の場合は、次の行をプロジェクトの `.csproj` ファイルに追加します。
**Linux および macOS の場合:**
```
```
**Windows の場合:**
```
```
1. プロジェクトの `.csproj` ファイルを保存します。
------
#### [ Windows with Visual Studio and .NET Core ]
1. Visual Studio で、プロジェクトをロードして、**プロジェクト**を開き、**リファレンスを追加します**。
1. ダイアログボックスの下部にある [**Browse**] (参照) ボタンをクリックします。プロジェクトのフォルダと必要な DLL ファイルをコピーしたサブフォルダ (`AwsAssemblies` など) に移動します。
1. すべての DLL ファイルを選択し、[**Add**] (追加)、[**OK**] の順に選択します。
1. プロジェクトを保存します。
------
# 認証情報とプロファイルの解決
AWS SDK for .NET は定められた順序で認証情報を検索し、最初に利用できるセットを現在のアプリケーションで使用します。
**認証情報の検索順序**
1. [アプリケーションでの認証情報とプロファイルへのアクセス](creds-locate.md) での記載に従い、AWS サービスクライアントで明示的に設定されている認証情報。
**注記**
このトピックは推奨される認証情報の指定方法ではないため、[特別な考慮事項](special-considerations.md) セクションに記載されています。
1. [AWSConfigs.AWSProfileName](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Amazon/TAWSConfigs.html#properties) の値で指定された名前を持つ認証情報プロファイル。
1. `AWS_PROFILE` 環境変数で指定された名前を持つ認証情報プロファイル。
1. `[default]` 認証情報プロファイル。
1. `AWS_ACCESS_KEY_ID`、`AWS_SECRET_ACCESS_KEY` および `AWS_SESSION_TOKEN` 環境変数がすべて空でない場合に変数を使用して生成される [SessionAWSCredentials](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Runtime/TSessionAWSCredentials.html)。
1. `AWS_ACCESS_KEY_ID`、`AWS_SECRET_ACCESS_KEY` 環境変数が両方とも空でない場合に変数を使用して作成される [BasicAWSCredentials](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Runtime/TBasicAWSCredentials.html)。
1. [コンテナ認証情報プロバイダー](https://docs.aws.amazon.com/sdkref/latest/guide/feature-container-credentials.html)。
1. Amazon EC2 インスタンスメタデータ。
アプリケーションが本番環境などの Amazon EC2 インスタンスで実行されている場合は、「[IAM ロールを使用したアクセス権の付与](net-dg-hosm.md)」の説明に従って IAM ロールを使用します。それ以外の場合 (プレリリーステストなど) は、ウェブアプリケーションがサーバー上でアクセス可能な、AWS 認証情報ファイル形式を使用したファイルに認証情報を保存します。
## プロファイルの解決
2 つの異なる認証情報ストレージメカニズムがあるため、それを使用するように AWS SDK for .NET を設定する方法を理解することが重要です。[AWSConfigs.AWSProfilesLocation](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Amazon/TAWSConfigs.html) プロパティは、AWS SDK for .NET が認証情報プロファイルを検索する方法を制御します。
****
| AWSProfilesLocation | プロファイルの解決動作 |
| --- | --- |
| null (未設定) または空 | プラットフォームでサポートされていれば SDK ストアを検索し、次に[デフォルトの場所](creds-file.md)にある共有 AWS 認証情報ファイルを検索します。プロファイルがいずれの場所にもない場合は、`~/.aws/config` (Linux または macOS) または `%USERPROFILE%\.aws\config` (Windows) を検索します。 |
| AWS 認証情報ファイル形式のファイルへのパス | 指定されたファイル*のみ*を対象に、指定された名前のプロファイルを検索します。 |
## フェデレーティッドユーザーアカウントの認証情報の使用
AWS SDK for .NET ([AWSSDK.Core](https://www.nuget.org/packages/AWSSDK.Core/) バージョン 3.1.6.0 以降) を使用するアプリケーションでは、Active Directory Federation Services (AD FS) を通じてフェデレーティッドユーザーアカウントを使用し、Security Assertion Markup Language (SAML) を使用することによって AWS サービスにアクセスできます。
フェデレーティッドアクセスサポートでは、ユーザーは Active Directory を使用して認証できます。一時的な認証情報は、自動的にユーザーに許可されます。これらの一時的な認証情報は 1 時間有効であり、アプリケーションで AWS サービスを呼び出す際に使用されます。一時的な認証情報の管理は SDK によって処理します。ドメイン結合されたユーザーアカウントでは、アプリケーションが呼び出しを行ったときに資格情報の有効期限が切れている場合に、そのユーザーは自動的に再認証され、新しい認証情報が付与されます (ドメイン結合されていないアカウントでは、ユーザーは再認証の前に認証情報の入力を求められます)。
このサポートを .NET アプリケーションで使用するには、まず PowerShell コマンドレットを使用してロールプロファイルをセットアップする必要があります。方法については、[AWS Tools for Windows PowerShell のドキュメント](https://docs.aws.amazon.com/powershell/latest/userguide/saml-pst.html)を参照してください。
ロールプロファイルを設定したら、アプリケーションでプロファイルを参照します。そのための方法はいくつかありますが、その 1 つとして [AWSConfigs.AWSProfileName](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Amazon/TAWSConfigs.html) プロパティを他の認証情報プロファイルと同じように設定する方法があります。
*AWS Security Token Service* アセンブリ ([AWSSDK.SecurityToken](https://www.nuget.org/packages/AWSSDK.SecurityToken/)) は、AWS 認証情報を取得するための SAML サポートを提供します。フェデレーティッドユーザーアカウントの認証情報を使用するには、アプリケーションでこのアセンブリが使用できることを確認してください。
## ロールまたは一時認証情報の指定
Amazon EC2 インスタンスで実行されるアプリケーションの場合、認証情報を管理する最も安全な方法は、「[IAM ロールを使用したアクセス権の付与](net-dg-hosm.md)」での説明に従って IAM ロールを使用することです。
組織外部のユーザーに対してソフトウェア実行可能ファイルが利用可能になるアプリケーションシナリオでは、*一時的なセキュリティ認証情報*を使用するようにソフトウェアを設計することをお勧めします。これらの認証情報は、AWS リソースへの制限されたアクセスの提供に加えて、指定された期間後に失効するという利点があります。一時的なセキュリティ認証情報の使用方法の詳細については、以下を参照してください。
+ [一時的な認証情報](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html)
+ [Amazon Cognito アイデンティティプール](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html)
## プロキシ認証情報の使用
ソフトウェアがプロキシを介して AWS と通信する場合、サービスの `Config` クラスの `ProxyCredentials` プロパティを使用して、プロキシの認証情報を指定できます。サービスの `Config` クラスは通常、サービスのプライマリ名前空間の一部です。例として、[Amazon.CloudDirectory](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CloudDirectory/NCloudDirectory.html) 名前空間の [AmazonCloudDirectoryConfig](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CloudDirectory/TCloudDirectoryConfig.html) や [Amazon.GameLift](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/GameLift/NGameLift.html) 名前空間の [AmazonGameLiftConfig](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/GameLift/TGameLiftConfig.html) などがあります。
たとえば、[Amazon S3](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/S3/TS3Config.html) の場合は、次のようなコードを使用できます。`SecurelyStoredUserName` と `SecurelyStoredPassword` は、[NetworkCredential](https://learn.microsoft.com/en-us/dotnet/api/system.net.networkcredential) オブジェクトで指定されたプロキシ ユーザー名とパスワードです。
```
AmazonS3Config config = new AmazonS3Config();
config.ProxyCredentials = new NetworkCredential(SecurelyStoredUserName, SecurelyStoredPassword);
```
**注記**
SDK の以前のバージョンでは `ProxyUsername` および `ProxyPassword` が使用されていましたが、これらのプロパティは非推奨になりました。
# ユーザーとロールに関する追加情報
AWS で.NET 開発を行ったり、AWS で NET アプリケーションを実行したりするには、これらのタスクに適したユーザー、アクセス許可セットとサービスロールの組み合わせが必要です。
作成する特定のユーザー、権限セット、サービス ロール、それらの使用方法は、アプリケーションの要件によって異なります。それらが使用される理由とその作成方法について、以下でさらに説明します。
## ユーザーとアクセス許可セット
長期的な認証情報を持つ IAM ユーザーアカウントを使用して AWS のサービスにアクセスすることは可能ですが、これはもはやベストプラクティスではなく、避ける必要があります。開発中であっても、AWS IAM アイデンティティセンター でユーザーとアクセス許可セットを作成し、ID ソースから提供される一時的な認証情報を使用するのがベストプラクティスです。
開発には、自分で作成したユーザー、または [SDK 認証の設定](creds-idc.md) で付与されたユーザーを使用できます。適切な AWS マネジメントコンソール アクセス許可があれば、そのユーザー用の最小特権のアクセス許可で別のアクセス許可セットを作成するか、開発プロジェクト専用の新しいユーザーを作成して、最小特権のアクセス許可セットを提供できます。選択する行動方針 (ある場合) は、状況によって異なります。
これらのユーザーとアクセス許可セット、および作成方法の詳細については、「*AWS SDK とツールリファレンスガイド*」の「[認証とアクセス](https://docs.aws.amazon.com/sdkref/latest/guide/access.html)」と、「*AWS IAM アイデンティティセンターユーザーガイド*」の「[はじめに](https://docs.aws.amazon.com/singlesignon/latest/userguide/getting-started.html)」を参照してください。
## サービスロール
AWS サービスロールを作成すると、ユーザーに代わって AWS サービスにアクセスできます。このタイプのアクセスは、複数のユーザーがアプリケーションをリモートで実行する場合 (たとえば、この目的のために作成した Amazon EC2 インスタンス上で実行する場合など) に適しています。
サービスロールを作成するプロセスは状況によって異なりますが、基本的に次のプロセスを実行します。
1. AWS マネジメントコンソール にサインインして、IAM コンソール [https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/) を開きます。
1. [**ロール**]、[**ロールの作成**] の順に選択します。
1. **[AWS サービス]** を選択して、**[EC2]** (この例の場合) を選択し、**[EC2]** ユースケース (この例の場合) を選択します。
1. [**Next: Permissions**] (次へ: アクセス権限) を選択し、アプリケーションが使用する AWS サービスに[適切なポリシー](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html)を選択します。
**警告**
**AdministratorAccess** ポリシーは選択****しないでください**。このポリシーを選択すると、お使いのアカウント内のほぼすべての情報の読み取りと書き込みのアクセス許可が有効になります。
1. [**Next: Tags**] (次へ: タグ) を選択して、必要なタグをすべて入力します。
タグに関する情報については、[IAM ユーザーガイド](https://docs.aws.amazon.com/IAM/latest/UserGuide/)の「[AWS リソースタグ使用したアクセスコントロール](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html)」を参照してください。
1. [**Next: Review**] (次の手順: 確認) を選択し、**ロール名**と**ロールの説明**を入力します。次に、**[Create role（ロールの作成）]** を選択します。
IAM ロールに関する概要については、[IAM ユーザーガイド](https://docs.aws.amazon.com/IAM/latest/UserGuide/)の「[ID ((ユーザー、グループ、ロール)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id.html)」を参照してください。ロールの詳細については、同ガイドの「[IAM ロール](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)」トピックを参照してください。
**ロールに関する追加情報**
+ Amazon Elastic Container Service (Amazon ECS) タスクで、[タスク用の IAM ロール](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html)を使用します。
+ Amazon EC2 インスタンスで実行中のアプリケーションに対して、[IAM ロール](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)を使用します。
# AWS SDK for .NET プロジェクトの高度な設定
このセクションのトピックでは、お客様が関心を持つ可能性のある追加の設定タスクやメソッドについて説明します。
**Topics**
+ [AWSSDK.Extensions.NETCore.Setup および IConfiguration](net-dg-config-netcore.md)
+ [他のアプリケーションパラメータの設定](net-dg-config-other.md)
+ [AWS SDK for .NET の設定ファイルリファレンス](net-dg-config-ref.md)
# AWSSDK.Extensions.NETCore.Setup および IConfiguration インターフェイスの使用
(このトピックは、以前は「.NET Core AWS SDK for .NET で を設定する」というタイトルでした)
.NET Core における最も大きな変更の 1 つは、`ConfigurationManager` と標準の `app.config` および `web.config` ファイルが削除されたことです。これらは .NET Framework および ASP.NET アプリケーションで使用されていました。
.NET Core での設定は、設定プロバイダーによって定められたキーと値のペアに基づいて行われます。設定プロバイダーは、コマンドライン引数、ディレクトリファイル、環境変数、設定ファイルなど、さまざまな設定ソースから設定データをキーと値のペアに読み込みます。
**注記**
詳細については、「[ASP.NET Core の構成](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/configuration)」を参照してください。
.NET Core AWS SDK for .NET で を簡単に使用するために、[AWSSDK.Extensions.NETCore.Setup](https://www.nuget.org/packages/AWSSDK.Extensions.NETCore.Setup/) NuGet パッケージを使用できます。多くの .NET Core ライブラリと同様に、インターフェイスに拡張機能メソッドを追加して、 AWS 設定をシームレスに`IConfiguration`します。
このパッケージのソースコードは GitHub の [https://github.com/aws/aws-sdk-net/tree/aws-sdk-net-v3.7/extensions/src/AWSSDK.Extensions.NETCore.Setup](https://github.com/aws/aws-sdk-net/tree/aws-sdk-net-v3.7/extensions/src/AWSSDK.Extensions.NETCore.Setup) にあります。
## AWSSDK.Extensions.NETCore.Setup の使用
ASP.NET コアモデル-ビューコントローラー (MVC) アプリケーションを作成するとします。このアプリケーションは、Visual Studio で **ASP.NET Core ウェブアプリケーション**テンプレートを使用するか、または .NET Core CLI で `dotnet new mvc ...` を実行することにより作成できます。アプリケーションを作成すると、`Startup.cs` のコンストラクタは `appsettings.json` などの設定プロバイダーからさまざまな入力ソースを読み取ることによって設定を処理します。
```
public Startup(IConfiguration configuration)
{
Configuration = configuration;
}
```
`Configuration` オブジェクトを使用して *AWS* のオプションを取得するには、まず `AWSSDK.Extensions.NETCore.Setup` NuGet パッケージを追加します。次に、以下の記載に従って設定ファイルにオプションを追加します。
プロジェクトに追加されたファイルの 1 つに、`appsettings.Development.json` があります。このファイルは、`EnvironmentName` が **Development** に設定された場合に対応します。開発時にこのファイルに設定を入力すると、ローカルテスト中にのみ読み取られます。を **Production** に`EnvironmentName`設定した Amazon EC2 インスタンスをデプロイすると、このファイルは無視され、 は Amazon EC2 インスタンス用に設定された IAM 認証情報とリージョンに AWS SDK for .NET フォールバックされます。
次の設定は、`appsettings.Development.json` 設定を指定するためにプロジェクトの AWS ファイルに追加できる値の例を示しています。
```
{
"AWS": {
"Profile": "local-test-profile",
"Region": "us-west-2"
},
"SupportEmail": "TechSupport@example.com"
}
```
*CSHTML* ファイルの設定にアクセスするには、`Configuration` ディレクティブを使用します。
```
@using Microsoft.Extensions.Configuration
@inject IConfiguration Configuration
Contact
Support: @Configuration["SupportEmail"]
```
コードから ファイルで設定された AWS オプションにアクセスするには、 に追加された`GetAWSOptions`拡張メソッドを呼び出します`IConfiguration`。
これらのオプションからサービスクライアントを構築するには、`CreateServiceClient` を呼び出します。次の例は、Amazon S3 サービスクライアントを作成する方法を示しています。(必ず [AWSSDK.S3](https://www.nuget.org/packages/AWSSDK.S3) NuGet パッケージをプロジェクトに追加してください)
```
var options = Configuration.GetAWSOptions();
IAmazonS3 client = options.CreateServiceClient();
```
`appsettings.Development.json` ファイルで複数のエントリを使用して、互換性のない設定を持つ複数のサービスクライアントを作成することもできます。次の例に示すように、`service1` の設定には `us-west-2` リージョンが含まれ、`service2` の設定には特殊なエンドポイント *URL* が含まれています。
```
{
"service1": {
"Profile": "default",
"Region": "us-west-2"
},
"service2": {
"Profile": "default",
"ServiceURL": "URL"
}
}
```
その後、JSON ファイルのエントリを使用することで、特定のサービスのオプションを取得できます。例えば、`service1` の設定を取得するには以下を使用します。
```
var options = Configuration.GetAWSOptions("service1");
```
### appsettings ファイルで指定できる値
`appsettings.Development.json` ファイルには次のアプリケーション設定値を設定できます。フィールド名は、記載された大文字小文字を区別して使用する必要があります。これらの設定の詳細については、「`[AWS.Runtime.ClientConfig](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Runtime/TClientConfig.html)`」クラスを参照してください。
+ Region
+ Profile
+ ProfilesLocation
+ SignatureVersion
+ RegionEndpoint
+ UseHttp
+ ServiceURL
+ AuthenticationRegion
+ AuthenticationServiceName
+ MaxErrorRetry
+ LogResponse
+ BufferSize
+ ProgressUpdateInterval
+ ResignRetries
+ AllowAutoRedirect
+ LogMetrics
+ DisableLogging
+ UseDualstackEndpoint
## ASP.NET Core の依存関係インジェクション
*AWSSDK.Extensions.NETCore.Setup* NuGet パッケージには、ASP.NET Core の新しい依存関係インジェクションシステムも組み込まれています。アプリケーションの `Startup` クラスの `ConfigureServices` メソッドは、MVC サービスが追加される場所です。アプリケーションが Entity Framework を使用している場合は、これが初期化される場所でもあります。
```
public void ConfigureServices(IServiceCollection services)
{
// Add framework services.
services.AddMvc();
}
```
**注記**
.NET Core の依存関係インジェクションの背景については、[.NET Core のドキュメントサイト](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/dependency-injection)を参照してください。
`AWSSDK.Extensions.NETCore.Setup` NuGet パッケージは、依存関係インジェクションに AWS サービスを追加するために`IServiceCollection`使用できる新しい拡張機能メソッドを に追加します。次のコードは、読み取り元の AWS オプションを追加してAmazon S3と DynamoDB をサービスのリスト`IConfiguration`に追加する方法を示しています。(必ず [AWSSDK.S3](https://www.nuget.org/packages/AWSSDK.S3) および [AWSSDK.DynamoDBv2](https://www.nuget.org/packages/AWSSDK.DynamoDBv2) NuGet パッケージをプロジェクトに追加してください)
```
public void ConfigureServices(IServiceCollection services)
{
// Add framework services.
services.AddMvc();
services.AddDefaultAWSOptions(Configuration.GetAWSOptions());
services.AddAWSService();
services.AddAWSService();
}
```
ここで、MVC コントローラーがコンストラクタで `IAmazonS3` または `IAmazonDynamoDB` のいずれかをパラメータとして使用している場合、依存関係インジェクションシステムはこれらのサービスを渡します。
```
public class HomeController : Controller
{
IAmazonS3 S3Client { get; set; }
public HomeController(IAmazonS3 s3Client)
{
this.S3Client = s3Client;
}
...
}
```
# 他のアプリケーションパラメータの設定
**注記**
このトピックの情報は、.NET Framework に基づくプロジェクトに固有のものです。.NET Core に基づくプロジェクトでは、デフォルトでは `App.config` および `Web.config` ファイルは存在しません。
## 開いて .NET Framework のコンテンツを表示する
設定可能なアプリケーションパラメータは多数あります。
+ `AWSLogging`
+ `AWSLogMetrics`
+ `AWSRegion`
+ `AWSResponseLogging`
+ `AWS.DynamoDBContext.TableNamePrefix`
+ `AWS.S3.UseSignatureVersion4`
+ `AWSEndpointDefinition`
+ [AWS サービス生成エンドポイント](#config-setting-service-generated-awsendpointdefinition)
これらのパラメータは、アプリケーションの `App.config` ファイルまたは `Web.config` ファイルで設定できます。 AWS SDK for .NET API を使用してこれらを設定することもできますが、アプリケーションの `.config` ファイルを使用することをお勧めします。ここでは、両方のアプローチについて説明します。
このトピックで後ほど説明する `` エレメントの使用方法の詳細については、「[AWS SDK for .NETの設定ファイルリファレンス](net-dg-config-ref.md)」を参照してください。
### AWSLogging
SDK でイベントを記録する方法を設定します。例えば、推奨される方法としては `` 要素の子要素である `` 要素の使用があります。
```
```
または:
```
```
指定できる値は以下のとおりです。
** `None` **
イベントのログ記録を無効にします。これがデフォルトです。
** `log4net` **
log4net を使用してログを記録します。
** `SystemDiagnostics` **
`System.Diagnostics` クラスを使用してログを記録します。
コンマで区切ることで、`logTo` 属性に複数の値を設定できます。次の例では、`.config` ファイルを使用して `log4net` ログと `System.Diagnostics` ログの両方を設定します。
```
```
または:
```
```
または、 AWS SDK for .NET API を使用して、[LoggingOptions](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Amazon/TLoggingOptions.html) 列挙の値を組み合わせて、[AWSConfigs.Logging](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Amazon/TAWSConfigs.html) プロパティを設定します。
```
AWSConfigs.Logging = LoggingOptions.Log4Net | LoggingOptions.SystemDiagnostics;
```
この設定の変更は、新しい AWS クライアントインスタンスに対してのみ有効になります。
### AWSLogMetrics
SDK でパフォーマンスメトリクスを記録するかどうかを指定します。`.config` ファイルでメトリクスのログを設定するには、`` 要素の `logMetrics` 属性値を設定します。これは、`` 要素の子要素です。
```
```
または、`` セクションで `AWSLogMetrics` キーを設定します。
```
```
または、 AWS SDK for .NET API でメトリクスのログ記録を設定するには、[AWSConfigs.LogMetrics](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Amazon/TAWSConfigs.html) プロパティを設定します。
```
AWSConfigs.LogMetrics = true;
```
この設定では、すべてのクライアント/設定のデフォルトの `LogMetrics` プロパティを設定します。この設定の変更は、新しい AWS クライアントインスタンスに対してのみ有効になります。
### AWSRegion
AWS リージョンを明示的に指定していないクライアントのデフォルトリージョンを設定します。`.config` ファイルでリージョンを設定する推奨される方法は、`aws` 要素の `region` 属性値を設定することです。
```
```
または、`` セクションで *AWSRegion* キーを設定します。
```
```
または、 AWS SDK for .NET API を使用してリージョンを設定するには、[AWSConfigs.AWSRegion](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Amazon/TAWSConfigs.html) プロパティを設定します。
```
AWSConfigs.AWSRegion = "us-west-2";
```
特定のリージョンの AWS クライアントの作成の詳細については、[AWS 「リージョンの選択](net-dg-region-selection.md)」を参照してください。この設定の変更は、新しい AWS クライアントインスタンスに対してのみ有効になります。
### AWSResponseLogging
SDK がサービス応答を記録するタイミングを設定します。指定できる値は以下のとおりです。
** `Never` **
サービス応答を記録しません。これがデフォルトです。
** `Always` **
常にサービス応答を記録します。
** `OnError` **
エラーが発生したときのみサービス応答を記録します。
`.config` ファイルでサービス ログを設定する推奨される方法は、`` 要素の `logResponses` 属性値を設定することです。これは、`` 要素の子要素です。
```
```
または、`` セクションで *AWSResponseLogging* キーを設定します。
```
```
または、 AWS SDK for .NET API でサービスログ記録を設定するには、[AWSConfigs.ResponseLogging](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Amazon/TAWSConfigs.html) プロパティを [ResponseLoggingOption](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Amazon/TResponseLoggingOption.html) 列挙のいずれかの値に設定します。
```
AWSConfigs.ResponseLogging = ResponseLoggingOption.OnError;
```
この設定に対する変更はすぐに反映されます。
### `AWS.DynamoDBContext.TableNamePrefix`
手動で設定しなかった場合に `DynamoDBContext` で使用されるデフォルトの `TableNamePrefix` を設定します。
`.config` ファイルでテーブル名プレフィックスを設定する際の推奨される方法は、`` 要素の `tableNamePrefix` 属性値を設定することです。この要素は `` 要素の子要素であり、これ自体は `` 要素の子要素です。
```
```
または、`` セクションで `AWS.DynamoDBContext.TableNamePrefix` キーを設定します。
```
```
または、 AWS SDK for .NET API でテーブル名のプレフィックスを設定するには、[AWSConfigs.DynamoDBContextTableNamePrefix](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Amazon/TAWSConfigs.html) プロパティを設定します。
```
AWSConfigs.DynamoDBContextTableNamePrefix = "Test-";
```
この設定への変更は、`DynamoDBContextConfig` および `DynamoDBContext` の新しく構築されたインスタンスのみに有効です。
### `AWS.S3.UseSignatureVersion4`
Amazon S3 クライアントがリクエストへの署名で署名バージョン 4 を使用するかどうかを設定します。
Amazon S3 の署名バージョン 4 での署名を `.config` ファイルで設定する際に推奨される方法は、`` 要素の `useSignatureVersion4` 属性を設定することです。これは、`` 要素の子要素です。
```
```
または、`AWS.S3.UseSignatureVersion4` セクションで `true` キーを `` に設定します。
```
```
または、 AWS SDK for .NET API で署名バージョン 4 の署名を設定するには、[AWSConfigs.S3UseSignatureVersion4](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Amazon/TAWSConfigs.html) プロパティを に設定します`true`。
```
AWSConfigs.S3UseSignatureVersion4 = true;
```
デフォルトでは、この設定は `false` ですが、一部のケースまたは一部のリージョンではデフォルトで署名バージョン 4 が使用される場合があります。設定が `true` の場合、すべてのリクエストに署名バージョン 4 が使用されます。この設定の変更は新しい Amazon S3 クライアントインスタンスに対してのみ有効です。
### AWSEndpointDefinition
SDK がリージョンとエンドポイントを定義するカスタム設定ファイルを使用するかどうかを設定します。
`.config` ファイルでエンドポイント定義ファイルを設定するには、`` 要素の `endpointDefinition` 属性値を設定することをお勧めします。
```
```
または、`` セクションで *AWSEndpointDefinition* キーを設定できます。
```
```
または、 AWS SDK for .NET API を使用してエンドポイント定義ファイルを設定するには、[AWSConfigs.EndpointDefinition](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Amazon/TAWSConfigs.html) プロパティを設定します。
```
AWSConfigs.EndpointDefinition = @"c:\config\endpoints.json";
```
ファイル名が指定されていない場合、カスタム設定ファイルは使用されません。この設定の変更は、新しい AWS クライアントインスタンスに対してのみ有効になります。endpoint.json ファイルは、[https://github.com/aws/aws-sdk-net/blob/aws-sdk-net-v3.7/sdk/src/Core/endpoints.json](https://github.com/aws/aws-sdk-net/blob/aws-sdk-net-v3.7/sdk/src/Core/endpoints.json) から入手できます。
### AWS サービス生成エンドポイント
一部の AWS サービスは、リージョンエンドポイントを使用する代わりに独自のエンドポイントを生成します。これらのサービスのクライアントは、そのサービスおよびリソースに固有のサービス URL を使用します。これらのサービスの 2 つの例は、Amazon CloudSearch と です AWS IoT。次の例は、これらのサービスのエンドポイントを取得する方法を示しています。
#### Amazon CloudSearch エンドポイントの例
Amazon CloudSearch クライアントは、Amazon CloudSearch 設定サービスにアクセスするために使用されます。Amazon CloudSearch 設定サービスを使用して、検索ドメインを作成、設定、管理します。検索ドメインを作成するには、[CreateDomainRequest](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CloudSearch/TCreateDomainRequest.html) オブジェクトを作成し、`DomainName` プロパティを指定します。リクエストオブジェクトを使用して [AmazonCloudSearchClient](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CloudSearch/TCloudSearchClient.html) オブジェクトを作成します。[CreateDomain](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CloudSearch/MCloudSearchCreateDomainCreateDomainRequest.html) メソッドを呼び出します。呼び出しから返される [CreateDomainResponse](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CloudSearch/TCreateDomainResponse.html) オブジェクトには、`DocService` および `SearchService` エンドポイントの両方を持つ `DomainStatus` プロパティが含まれます。[AmazonCloudSearchDomainConfig](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CloudSearchDomain/TCloudSearchDomainConfig.html) オブジェクトを作成し、それを使用して [AmazonCloudSearchDomainClient](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CloudSearchDomain/TCloudSearchDomainClient.html) クラスの `DocService` および `SearchService` インスタンスを初期化します。
```
// Create domain and retrieve DocService and SearchService endpoints
DomainStatus domainStatus;
using (var searchClient = new AmazonCloudSearchClient())
{
var request = new CreateDomainRequest
{
DomainName = "testdomain"
};
domainStatus = searchClient.CreateDomain(request).DomainStatus;
Console.WriteLine(domainStatus.DomainName + " created");
}
// Test the DocService endpoint
var docServiceConfig = new AmazonCloudSearchDomainConfig
{
ServiceURL = "https://" + domainStatus.DocService.Endpoint
};
using (var domainDocService = new AmazonCloudSearchDomainClient(docServiceConfig))
{
Console.WriteLine("Amazon CloudSearchDomain DocService client instantiated using the DocService endpoint");
Console.WriteLine("DocService endpoint = " + domainStatus.DocService.Endpoint);
using (var docStream = new FileStream(@"C:\doc_source\XMLFile4.xml", FileMode.Open))
{
var upload = new UploadDocumentsRequest
{
ContentType = ContentType.ApplicationXml,
Documents = docStream
};
domainDocService.UploadDocuments(upload);
}
}
// Test the SearchService endpoint
var searchServiceConfig = new AmazonCloudSearchDomainConfig
{
ServiceURL = "https://" + domainStatus.SearchService.Endpoint
};
using (var domainSearchService = new AmazonCloudSearchDomainClient(searchServiceConfig))
{
Console.WriteLine("Amazon CloudSearchDomain SearchService client instantiated using the SearchService endpoint");
Console.WriteLine("SearchService endpoint = " + domainStatus.SearchService.Endpoint);
var searchReq = new SearchRequest
{
Query = "Gambardella",
Sort = "_score desc",
QueryParser = QueryParser.Simple
};
var searchResp = domainSearchService.Search(searchReq);
}
```
#### AWS IoT エンドポイントの例
のエンドポイントを取得するには AWS IoT、[AmazonIoTClient](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/IoT/TIoTClient.html) オブジェクトを作成し、[DescribeEndPoint](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/IoT/MIoTDescribeEndpointDescribeEndpointRequest.html) メソッドを呼び出します。返される [DescribeEndPointResponse](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/IoT/TDescribeEndpointResponse.html) オブジェクトには、`EndpointAddress` が含まれます。[AmazonIotDataConfig](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/IotData/TIotDataConfig.html) オブジェクトを作成し、`ServiceURL` プロパティを設定します。次に、このオブジェクトを使用して [AmazonIotDataClient](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/IotData/TIotDataClient.html) クラスをインスタンス化します。
```
string iotEndpointAddress;
using (var iotClient = new AmazonIoTClient())
{
var endPointResponse = iotClient.DescribeEndpoint();
iotEndpointAddress = endPointResponse.EndpointAddress;
}
var ioTdocServiceConfig = new AmazonIotDataConfig
{
ServiceURL = "https://" + iotEndpointAddress
};
using (var dataClient = new AmazonIotDataClient(ioTdocServiceConfig))
{
Console.WriteLine("AWS IoTData client instantiated using the endpoint from the IotClient");
}
```
# AWS SDK for .NET の設定ファイルリファレンス
**注記**
このトピックの情報は、.NET Framework に基づくプロジェクトに固有のものです。.NET Core に基づくプロジェクトでは、デフォルトでは `App.config` および `Web.config` ファイルは存在しません。
## 開いて .NET Framework のコンテンツを表示する
.NET プロジェクトの `App.config` ファイルまたは `Web.config` ファイルを使用すると、AWS の認証情報、ログオプション、AWS サービスエンドポイント、AWS リージョンなどの AWS の設定や、Amazon DynamoDB、Amazon EC2、Amazon S3 などの AWS サービスの一部の設定を指定できます。以下では、適切な形式の `App.config` ファイルまたは `Web.config` ファイルを使用してこれらの設定を指定する方法について説明します。
**注記**
`App.config` ファイルまたは `Web.config` ファイルの `` 要素を引き続き使用して AWS の設定を指定することもできますが、このトピックで後ほど説明するように `` 要素および `` 要素を使用することをお勧めします `` エレメントの詳細については、「[AWS SDK for .NET アプリケーションの設定](net-dg-config.md)」の `` エレメントの例を参照してください。
**注記**
以下の [https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Amazon/TAWSConfigs.html](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Amazon/TAWSConfigs.html) クラスプロパティをコードファイルで使用して AWS の設定を指定することはできますが、以下のプロパティは非推奨であり、将来のリリースではサポートされなくなる可能性があります。
`DynamoDBContextTableNamePrefix`
`EC2UseSignatureVersion4`
`LoggingOptions`
`LogMetrics`
`ResponseLoggingOption`
`S3UseSignatureVersion4`
一般に、このトピックでこれから説明するように、コードファイルで `AWSConfigs` クラスのプロパティを使用して AWS の設定を指定するのではなく、`App.config` ファイルまたは `Web.config` ファイルの `` 要素および `` 要素を使用して AWS の設定を指定することをお勧めします。上記のプロパティの詳細については、「[AWS SDK for .NET アプリケーションの設定](net-dg-config.md)」の `AWSConfigs` コード例を参照してください。
**Topics**
+ [AWS 設定セクションの宣言](#net-dg-config-ref-declaring)
+ [使用できる要素](#net-dg-config-ref-elements)
+ [要素のリファレンス](#net-dg-config-ref-elements-ref)
### AWS 設定セクションの宣言
AWS の設定は、`App.config` または `Web.config` ファイルの `` 要素内で指定します。`` 要素の使用を始める前に、次の例で示すように `` 要素 (`` 要素の子要素) を作成し、その `name` 属性を `aws` に、`type` 属性を `Amazon.AWSSection, AWSSDK.Core` に設定する必要があります。
```
...
...
```
Visual Studio のエディタでは、`` 要素またはその子要素の自動コード補完機能（IntelliSense）は提供されていません。
`` 要素を正しくフォーマットするには、`Amazon.AWSConfigs.GenerateConfigTemplate` メソッドを呼び出してください。このメソッドは `` 要素の正規バージョンを適切な文字列として出力するので、それを利用できます。以下のセクションでは、`` 要素の属性と子要素について説明します。
### 使用できる要素
AWS 設定セクションで使用できる要素の間の論理的な関係を次に示します。このリストの最新バージョンは `Amazon.AWSConfigs.GenerateConfigTemplate` メソッドを呼び出すことによって生成できます。このメソッドは、`` 要素の正規バージョンをそのまま使用できる文字列として出力します。
```
```
### 要素のリファレンス
AWS 設定セクションで使用できる要素のリストを次に示します。各要素について、使用できる属性と親子要素が示されています。
**Topics**
+ [alias](#net-dg-config-ref-elements-alias)
+ [`aws`](#net-dg-config-ref-elements-aws)
+ [dynamoDB](#net-dg-config-ref-elements-dynamodb)
+ [dynamoDBContext](#net-dg-config-ref-elements-ddbcontext)
+ [Ec2](#net-dg-config-ref-elements-ec2)
+ [ログ記録](#net-dg-config-ref-elements-logging)
+ [マップ](#net-dg-config-ref-elements-map)
+ [property](#net-dg-config-ref-elements-property)
+ [proxy](#net-dg-config-ref-elements-proxy)
+ [s3](#net-dg-config-ref-elements-s3)
#### alias
`` 要素は、1 つ以上のテーブル間マッピングのコレクションに含まれる、タイプに対して設定されているものとは異なるテーブルを指定する単一の項目を表します この要素は、`Amazon.Util.TableAlias` の `Amazon.AWSConfigs.DynamoDBConfig.Context.TableAliases` プロパティから AWS SDK for .NET クラスのインスタンスにマッピングされます。テーブル名のプレフィックスを適用する前に再マッピングが行われます。
この要素は次の属性を含むことができます:
** `fromTable` **
マップ元テーブルからマップ先テーブルへのマッピングのマップ元テーブル部分です。この属性は、`Amazon.Util.TableAlias.FromTable` の AWS SDK for .NET プロパティにマッピングされます。
** `toTable` **
マップ元テーブルからマップ先テーブルへのマッピングのマップ先テーブル部分です この属性は、`Amazon.Util.TableAlias.ToTable` の AWS SDK for .NET プロパティにマッピングされます。
`` 要素の親は、`` 要素です。
`` 要素には子要素は含まれません。
次に `` 要素の使用例を示します。
```
```
#### `aws`
`` 要素は、AWS 設定セクションの最上位要素を表します。この要素は次の属性を含むことができます:
** `endpointDefinition` **
使用する AWS のリージョンとエンドポイントを定義するカスタム設定ファイルの絶対パスです。この属性は、`Amazon.AWSConfigs.EndpointDefinition` の AWS SDK for .NET プロパティにマッピングされます。
** `profileName` **
サービスの呼び出しに使用される、保存された AWS 認証情報のプロファイル名です。この属性は、`Amazon.AWSConfigs.AWSProfileName` の AWS SDK for .NET プロパティにマッピングされます。
** `profilesLocation` **
他の AWS SDK に共有される認証情報ファイルの場所の絶対パスです。デフォルトでは、認証情報ファイルは現在のユーザーのホームディレクトリにある `.aws` ディレクトリに格納されます。この属性は、`Amazon.AWSConfigs.AWSProfilesLocation` の AWS SDK for .NET プロパティにマッピングされます。
** `region` **
明示的にリージョンを指定していないクライアントで使用されるデフォルトの AWS リージョン ID です。この属性は、`Amazon.AWSConfigs.AWSRegion` の AWS SDK for .NET プロパティにマッピングされます。
`` 要素に親要素はありません。
`` 要素は次の子要素を含むことができます。
+ ``
+ ``
+ ``
+ ``
+ ``
次に `` 要素の使用例を示します。
```
```
#### dynamoDB
`` 要素は、Amazon DynamoDB の設定のコレクションを表します。この要素は、*conversionSchema* 属性を含むことができます。この属性は、.NET と DynamoDB オブジェクトの間の変換に使用するバージョンを表します。使用できる値は、V1 および V2 です。この属性は、`Amazon.DynamoDBv2.DynamoDBEntryConversion` の AWS SDK for .NET クラスにマッピングされます。詳細については、「[DynamoDB Series - Conversion Schemas](http://blogs.aws.amazon.com/net/post/Tx2TCOGWG7ARUH5/DynamoDB-Series-Conversion-Schemas)」を参照してください。
`` 要素の親は、`` 要素です。
`` 要素は、`` 子要素を含むことができます。
次に `` 要素の使用例を示します。
```
```
#### dynamoDBContext
`` 要素は、Amazon DynamoDB コンテキスト固有の設定のコレクションを表します。この要素は *tableNamePrefix* 属性を含むことができます。この属性は、テーブル名プレフィックスが手動で設定されていない場合に DynamoDB コンテキストが使用するデフォルトのプレフィックスを表します。この属性は、`Amazon.Util.DynamoDBContextConfig.TableNamePrefix` の `Amazon.AWSConfigs.DynamoDBConfig.Context.TableNamePrefix` プロパティから AWS SDK for .NET プロパティにマッピングされます。詳細については、「[Enhancements to the DynamoDB SDK](http://blogs.aws.amazon.com/net/post/Tx2C4MHH2H0SA5W/Enhancements-to-the-DynamoDB-SDK)」を参照してください。
`` 要素の親は、`` 要素です。
`` 要素は次の子要素を含むことができます。
+ `` (1 つまたは複数のインスタンス)
+ `