.NET Core を使用した AWS SDK for .NET の設定 - AWS SDK for .NET

.NET Core を使用した AWS SDK for .NET の設定

.NET Core における最も大きな変更の 1 つは、ConfigurationManager と標準の app.config および web.config ファイルが削除されたことです。これらは .NET Framework および ASP.NET アプリケーションで使用されていました。

.NET Core の設定は、設定プロバイダーによって確立されたキーと値のペアに基づいています。設定プロバイダーは、コマンドライン引数、ディレクトリファイル、環境変数、設定ファイルなど、さまざまな設定ソースから設定データをキーと値のペアを読み取ります。

注記

詳細については、「ASP.NET Core の設定」を参照してください。

.NET Core と併せて AWS SDK for .NET を使いやすくするために、AWSSDK.Extensions.NETCore.Setup NuGet パッケージを使用できます。これは多くの .NET Core ライブラリと同様に IConfiguration インターフェイスに拡張メソッドを追加して、AWS 設定の取得をシームレスに行えるようにします。

AWSSDK.Extensions.NETCore.Setup の使用

Visual Studio で ASP.NET Core MVC アプリケーションを作成する場合、Startup.cs のコンストラクタは、appsettings.jsonの読み取りなど、設定プロバイダーからさまざまな入力ソースを読み取ることによって設定を処理します。

public Startup(IConfiguration configuration) { Configuration = configuration; }

Configuration オブジェクトを使用して AWS のオプションを取得するには、まず AWSSDK.Extensions.NETCore.Setup NuGet パッケージを追加します。次に、設定ファイルにオプションを追加します。ConfigurationBuilder に追加されたファイルの 1 つは $"appsettings.{env.EnvironmentName}.json" であることに注意してください。プロジェクトのプロパティの [デバッグ] タブを見ると、このファイルが Development に設定されていることがわかります。これは設定を appsettings.Development.json ファイルに書き込むことができるため、ローカルテストの場合に非常に役に立ちます。このファイルはローカルテストの際には読み取り専用になります。EnvironmentNameProduction に設定した Amazon EC2 インスタンスをデプロイするとき、このファイルは無視され、AWS SDK for .NET は Amazon EC2 インスタンス用に設定された IAM 認証情報とリージョンにフォールバックします。

次の設定は、AWS 設定を指定するためにプロジェクトの appsettings.Development.json ファイルに追加できる値の例を示しています。

{ "AWS": { "Profile": "local-test-profile", "Region": "us-west-2" }, "SupportEmail": "TechSupport@example.com" }

CSHTML ファイルの設定にアクセスするには、Configuration ディレクティブを使用します。

@using Microsoft.Extensions.Configuration @inject IConfiguration Configuration <h1>Contact</h1> <p> <strong>Support:</strong> <a href='mailto:@Configuration["SupportEmail"]'>@Configuration["SupportEmail"]</a><br /> </p>

ファイルで設定されている AWS オプションにコードからアクセスするには、GetAWSOptions に追加された IConfiguration 拡張メソッドを呼び出します。

これらのオプションからサービスクライアントを構築するには、CreateServiceClient を呼び出します。次のコード例は、Amazon S3 サービスクライアントを作成する方法を示しています。

var options = Configuration.GetAWSOptions(); IAmazonS3 client = options.CreateServiceClient<IAmazonS3>();

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 クラスを参照してください。

  • リージョン

  • プロフィール

  • 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 の新しい依存関係インジェクションシステムが組み込まれています。StartupConfigureServices メソッドは、MVC サービスが追加されている場所です。アプリケーションが Entity Framework を使用している場合は、これが初期化される場所でもあります。

public void ConfigureServices(IServiceCollection services) { // Add framework services. services.AddMvc(); }
注記

.NET Core の依存関係インジェクションの背景については、.NET Coreドキュメントのサイトを参照してください。

AWSSDK.Extensions.NETCore.Setup NuGet パッケージでは新しい拡張メソッドが IServiceCollection に追加されており、AWS サービスを依存関係インジェクションに追加するために使用できます。次のコードは、IConfiguration から読み込んだ AWS のオプションを追加して、Amazon S3 や DynamoDB をサービスのリストに追加する方法を示しています。

public void ConfigureServices(IServiceCollection services) { // Add framework services. services.AddMvc(); services.AddDefaultAWSOptions(Configuration.GetAWSOptions()); services.AddAWSService<IAmazonS3>(); services.AddAWSService<IAmazonDynamoDB>(); }

ここで、MVC コントローラがコンストラクタで IAmazonS3 または IAmazonDynamoDB のいずれかをパラメータとして使用している場合、依存関係インジェクションシステムはこれらのサービスを渡します。

public class HomeController : Controller { IAmazonS3 S3Client { get; set; } public HomeController(IAmazonS3 s3Client) { this.S3Client = s3Client; } ... }