認証情報プロバイダ - AWS SDK for JavaScript
デフォルトの認証情報プロバイダー一時認証情報Amazon Cognito ID 認証情報EC2 メタデータ (IMDS) 認証情報ECS 認証情報ファイルシステムの認証情報SAML 認証情報プロバイダー共有認証情報ファイル認証情報ウェブ ID 認証情報Web Identity フェデレーション認証情報

AWS SDK for JavaScript V3 APIリファレンスガイドでは、バージョン 3 (V3) のすべてのAPIオペレーションについて詳しく説明しています AWS SDK for JavaScript 。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

認証情報プロバイダ

v2 では、 SDK for は、選択できる認証情報プロバイダーのリストと、Node.js でデフォルトで利用可能な認証情報プロバイダーチェーン JavaScript を提供し、最も一般的なすべてのプロバイダーから AWS 認証情報をロードしようとします。SDK for JavaScript v3 は、認証情報プロバイダーのインターフェイスを簡素化し、カスタム認証情報プロバイダーの使用と書き込みを容易にします。新しい認証情報プロバイダーチェーンに加えて、SDK for JavaScript v3 はすべて、v2 と同等のものを提供することを目的とした認証情報プロバイダーのリストを提供します。

v2 のすべての認証情報プロバイダーと v3 の同等の認証情報プロバイダーは次のとおりです。

デフォルトの認証情報プロバイダー

デフォルトの認証情報プロバイダーは、明示的に指定しない場合の SDK for による AWS 認証情報の JavaScript 解決方法です。

一時認証情報

  • v2: から取得した一時的な認証情報ChainableTemporaryCredentialsを表しますAWS.STS。追加のパラメータがない場合、認証情報は AWS.STS.getSessionToken()オペレーションから取得されます。IAM ロールが指定されている場合、 AWS.STS.assumeRole()オペレーションは代わりにロールの認証情報を取得するために使用されます。 は masterCredentials と更新の処理AWS.TemporaryCredentials方法AWS.ChainableTemporaryCredentialsとは異なります。 は、STS 認証情報の連鎖をサポートするためにユーザーが渡した masterCredentials を使用して期限切れの認証情報AWS.ChainableTemporaryCredentialsを更新します。ただし、 はインスタンス化中に masterCredentials AWS.TemporaryCredentialsを再帰的に折りたたむため、中間の一時的な認証情報を必要とする認証情報を更新する機能は除外されます。

    元の TemporaryCredentialsは v2 ChainableTemporaryCredentialsで を優先して廃止されました。

  • v3: fromTemporaryCredentials。@aws-sdk/credential-providers パッケージfromTemporaryCredentials()から を呼び出すことができます。例を示します。

    import { FooClient } from "@aws-sdk/client-foo";
import { fromTemporaryCredentials } from "@aws-sdk/credential-providers"; // ES6 import
// const { FooClient } = require("@aws-sdk/client-foo");
// const { fromTemporaryCredentials } = require("@aws-sdk/credential-providers"); // CommonJS import

const sourceCredentials = {
  // A credential can be a credential object or an async function that returns a credential object
};
const client = new FooClient({
  credentials: fromTemporaryCredentials({
    masterCredentials: sourceCredentials,
    params: { RoleArn },
  }),
});

Amazon Cognito ID 認証情報

Amazon Cognito ID サービスから認証情報をロードします。通常、ブラウザで使用されます。

  • v2: Amazon Cognito Identity CognitoIdentityCredentials サービスを使用して STS Web Identity フェデレーションから取得した認証情報を表します。

  • v3: @aws/credential-providersパッケージには 2 Cognito Identity Credential Provider つの認証情報プロバイダー関数があり、1 つは ID fromCognitoIdentityを受け取り を呼び出しcognitoIdentity:GetCredentialsForIdentity、もう 1 つは ID プール ID fromCognitoIdentityPool を受け取り、最初の呼び出しcognitoIdentity:GetIdで を呼び出し、次に を呼び出しますfromCognitoIdentity。後者の呼び出しは を再呼び出ししません GetId。

    プロバイダーは、Amazon Cognito デベロッパーガイド」で説明されている「Simplified Flow」を実装します。の呼び出しcognito:GetOpenIdTokenと呼び出しを含む「Classic Flowsts:AssumeRoleWithWebIdentity」はサポートされていません。必要に応じて、機能リクエストを開いてください。

    // fromCognitoIdentityPool example
import { fromCognitoIdentityPool } from "@aws-sdk/credential-providers"; // ES6 import
// const { fromCognitoIdentityPool } = require("@aws-sdk/credential-providers"); // CommonJS import

const client = new FooClient({
  region: "us-east-1",
  credentials: fromCognitoIdentityPool({
    clientConfig: cognitoIdentityClientConfig, // Optional
    identityPoolId: "us-east-1:1699ebc0-7900-4099-b910-2df94f52a030",
    customRoleArn: "arn:aws:iam::1234567890:role/MYAPP-CognitoIdentity", // Optional
    logins: {
      // Optional
      "graph.facebook.com": "FBTOKEN",
      "www.amazon.com": "AMAZONTOKEN",
      "api.twitter.com": "TWITTERTOKEN",
    },
  }),
});

    // fromCognitoIdentity example
import { fromCognitoIdentity } from "@aws-sdk/credential-providers"; // ES6 import
// const { fromCognitoIdentity } = require("@aws-sdk/credential-provider-cognito-identity"); // CommonJS import

const client = new FooClient({
  region: "us-east-1",
  credentials: fromCognitoIdentity({
    clientConfig: cognitoIdentityClientConfig, // Optional
    identityId: "us-east-1:128d0a74-c82f-4553-916d-90053e4a8b0f",
    customRoleArn: "arn:aws:iam::1234567890:role/MYAPP-CognitoIdentity", // Optional
    logins: {
      // Optional
      "graph.facebook.com": "FBTOKEN",
      "www.amazon.com": "AMAZONTOKEN",
      "api.twitter.com": "TWITTERTOKEN",
    },
  }),
});

EC2 メタデータ (IMDS) 認証情報

Amazon EC2 インスタンスのメタデータサービスから受信した認証情報を表します。

  • v2: EC2MetadataCredentials

  • v3: fromInstanceMetadata: Amazon EC2 インスタンスメタデータサービスから認証情報を取得する認証情報プロバイダーを作成します。

    import { fromInstanceMetadata } from "@aws-sdk/credential-providers"; // ES6 import
// const { fromInstanceMetadata } = require("@aws-sdk/credential-providers"); // CommonJS import

const client = new FooClient({
  credentials: fromInstanceMetadata({
    maxRetries: 3, // Optional
    timeout: 0, // Optional
  }),
});

ECS 認証情報

指定された URL から受信した認証情報を表します。このプロバイダーは、 AWS_CONTAINER_CREDENTIALS_RELATIVE_URIまたは AWS_CONTAINER_CREDENTIALS_FULL_URI環境変数で指定された URI に一時的な認証情報をリクエストします。

  • v2: ECSCredentialsまたは RemoteCredentials。

  • v3: Amazon ECS Container Metadata Service から認証情報を取得する認証情報プロバイダーfromContainerMetadataを作成します。

    import { fromContainerMetadata } from "@aws-sdk/credential-providers"; // ES6 import

const client = new FooClient({
  credentials: fromContainerMetadata({
    maxRetries: 3, // Optional
    timeout: 0, // Optional
  }),
});

ファイルシステムの認証情報

  • v2: ディスク上の JSON ファイルからの認証情報FileSystemCredentialsを表します。

  • v3: を廃止しました。JSON ファイルを明示的に読み取り、クライアントに を指定できます。必要に応じて、機能リクエストを開いてください。

SAML 認証情報プロバイダー

  • v2: STS SAML サポートから取得した認証情報SAMLCredentialsを表します。

  • v3: は使用できません。必要に応じて、機能リクエストを開いてください。

共有認証情報ファイル認証情報

共有認証情報ファイルから認証情報をロードします (デフォルトは ~/.aws/credentialsまたは AWS_SHARED_CREDENTIALS_FILE環境変数で定義されます）。このファイルは、さまざまな AWS SDKsとツールでサポートされています。詳細については、共有 config ファイルと認証情報ファイルのドキュメントを参照してください。

  • v2: SharedIniFileCredentials

  • v3: fromIni。

    
import { fromIni } from "@aws-sdk/credential-providers";
// const { fromIni } from("@aws-sdk/credential-providers");

const client = new FooClient({
  credentials: fromIni({
    configFilepath: "~/.aws/config", // Optional
    filepath: "~/.aws/credentials", // Optional
    mfaCodeProvider: async (mfaSerial) => {
      // implement a pop-up asking for MFA code
      return "some_code";
    }, // Optional
    profile: "default", // Optional
    clientConfig: { region }, // Optional
  }),
});

ウェブ ID 認証情報

ディスク上のファイルから OIDC トークンを使用して認証情報を取得します。これは EKS でよく使用されます。

  • v2: TokenFileWebIdentityCredentials。

  • v3: fromTokenFile 

    
import { fromTokenFile } from "@aws-sdk/credential-providers"; // ES6 import
// const { fromTokenFile } from("@aws-sdk/credential-providers"); // CommonJS import

const client = new FooClient({
  credentials: fromTokenFile({
    // Optional. If skipped, read from `AWS_ROLE_ARN` environmental variable
    roleArn: "arn:xxxx",
    // Optional. If skipped, read from `AWS_ROLE_SESSION_NAME` environmental variable
    roleSessionName: "session:a",
    // Optional. STS client config to make the assume role request.
    clientConfig: { region },
  }),
});

Web Identity フェデレーション認証情報

STS ウェブ ID フェデレーションサポートから認証情報を取得します。

  • v2: WebIdentityCredentials

  • v3: fromWebToken 

    
import { fromWebToken } from "@aws-sdk/credential-providers"; // ES6 import
// const { fromWebToken } from("@aws-sdk/credential-providers"); // CommonJS import

const client = new FooClient({
  credentials: fromWebToken({
    // Optional. If skipped, read from `AWS_ROLE_ARN` environmental variable
    roleArn: "arn:xxxx",
    // Optional. If skipped, read from `AWS_ROLE_SESSION_NAME` environmental variable
    roleSessionName: "session:a",
    // Optional. STS client config to make the assume role request.
    clientConfig: { region },
  }),
});