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

カスタム送信者 Lambda SMS トリガー

ユーザープールにカスタムSMS送信者トリガーを割り当てると、ユーザーイベントがSMSメッセージを送信する必要がある場合、Amazon Cognito はデフォルトの動作ではなく Lambda 関数を呼び出します。カスタム送信者トリガーを使用すると、 AWS Lambda 関数は選択したメソッドとプロバイダーを通じてユーザーにSMS通知を送信できます。関数のカスタムコードは、ユーザープールからすべてのSMSメッセージを処理および配信する必要があります。

このトリガーは、ユーザープールがSMSメッセージを送信する方法をより細かく制御したいシナリオを提供します。Lambda 関数は、複数の送信元IDsまたはクロス を管理する場合など、Amazon SNSAPIオペレーションへの呼び出しをカスタマイズできます AWS リージョン。関数は、メッセージを別の配信メディアまたはサードパーティーのサービスにリダイレクトすることもできます。

このトリガーをセットアップするには、以下のステップを実行します。

カスタム送信者 Lambda SMS トリガーパラメータ

Amazon Cognito がこの Lambda 関数に渡すリクエストは、以下のパラメータと Amazon Cognito がすべてのリクエストに追加する共通パラメータを組み合わせたものです。

JSON

{
    "request": {
        "type": "customSMSSenderRequestV1",
        "code": "string",
        "clientMetadata": {
            "string": "string",
             . . .
            },
        "userAttributes": {
            "string": "string",
            . . .
         }
}

カスタムSMS送信者リクエストパラメータ

カスタムSMS送信者レスポンスパラメータ

Amazon Cognito は、レスポンスに追加の返品情報を期待しません。関数は、 APIオペレーションを使用してリソースをクエリおよび変更したり、イベントメタデータを外部システムに記録したりできます。

カスタム送信者 Lambda SMS トリガーのアクティブ化

カスタムロジックを使用してユーザープールのSMSメッセージを送信するカスタムSMS送信者トリガーを設定できます。次の手順では、カスタムSMSトリガー、カスタム E メールトリガー、またはその両方をユーザープールに割り当てます。カスタムSMS送信者トリガーを追加すると、Amazon Cognito は、Amazon Simple Notification Service でSMSメッセージを送信するデフォルトの動作ではなく、電話番号や 1 回限りのコードを含むユーザー属性を Lambda 関数に常に送信します。

でカスタム送信者 Lambda トリガーを削除するにはupdate-user-pool AWS CLI、 から CustomSMSSender または CustomEmailSenderパラメータを省略し--lambda-config、ユーザープールで使用する他のすべてのトリガーを含めます。

UpdateUserPool API リクエストを使用してカスタム送信者 Lambda トリガーを削除するには、残りのユーザープール設定を含むリクエスト本文から CustomSMSSender または CustomEmailSenderパラメータを省略します。

コード例

次の Node.js の例では、カスタム送信者 Lambda SMS 関数でSMSメッセージイベントを処理します。この例では、関数に 2 つの環境変数が定義されていることを前提としています。

const AWS = require('aws-sdk');
const b64 = require('base64-js');
const encryptionSdk = require('@aws-crypto/client-node');
//Configure the encryption SDK client with the KMS key from the environment variables.  
const { encrypt, decrypt } = encryptionSdk.buildClient(encryptionSdk.CommitmentPolicy.REQUIRE_ENCRYPT_ALLOW_DECRYPT);
const generatorKeyId = process.env.KEY_ALIAS;
const keyIds = [ process.env.KEY_ARN ];
const keyring = new encryptionSdk.KmsKeyringNode({ generatorKeyId, keyIds })
exports.handler = async (event) => {
	//Decrypt the secret code using encryption SDK.
	let plainTextCode;
	if(event.request.code){
		const { plaintext, messageHeader } = await decrypt(keyring, b64.toByteArray(event.request.code));
		plainTextCode = plaintext
	}
	//PlainTextCode now contains the decrypted secret.
	if(event.triggerSource == 'CustomSMSSender_SignUp'){
		//Send an SMS message to your user via a custom provider.
		//Include the temporary password in the message.
	}
	else if(event.triggerSource == 'CustomSMSSender_ResendCode'){
	}
	else if(event.triggerSource == 'CustomSMSSender_ForgotPassword'){
	}
	else if(event.triggerSource == 'CustomSMSSender_UpdateUserAttribute'){
	}
	else if(event.triggerSource == 'CustomSMSSender_VerifyUserAttribute'){
	}
	else if(event.triggerSource == 'CustomSMSSender_AdminCreateUser'){
	}
	else if(event.triggerSource == 'CustomSMSSender_AccountTakeOverNotification'){
	}
	return;
};

カスタムSMS送信者関数を使用してSMSメッセージ機能を評価する

カスタムSMS送信者 Lambda 関数は、ユーザープールが送信するSMSメッセージを受け入れ、関数はカスタムロジックに基づいてコンテンツを配信します。Amazon Cognito は関数に カスタム送信者 Lambda SMS トリガーパラメータ を送信します。この情報を使用して、関数はユーザーが望むことを実行できます。例えば、Amazon Simple Notification Service (Amazon SNS) トピックにコードを送信できます。Amazon SNSトピックサブスクライバーは、SMSメッセージ、HTTPSエンドポイント、または E メールアドレスのいずれかです。

カスタム送信者 Lambda 関数を使用して Amazon Cognito SMS SMSメッセージングのテスト環境を作成するには、 の aws-samples ライブラリ GitHubのamazon-cognito-user-pool「-development-and-testing-with-sms-redirected-to-email」を参照してください。リポジトリには、新しいユーザープールを作成したり、既に持っているユーザープールを操作することができる AWS CloudFormation テンプレートが含まれています。これらのテンプレートは、Lambda 関数と Amazon SNSトピックを作成します。テンプレートがカスタムSMS送信者トリガーとして割り当てる Lambda 関数は、SMSメッセージをサブスクライバーに Amazon SNSトピックにリダイレクトします。

このソリューションをユーザープールにデプロイすると、Amazon Cognito が通常SMSメッセージングを介して送信するすべてのメッセージは、代わりに Lambda 関数が中央 E メールアドレスに送信します。このソリューションを使用して、SMSメッセージをカスタマイズしてプレビューし、Amazon Cognito がSMSメッセージを送信する原因となるユーザープールイベントをテストします。テストが完了したら、 CloudFormation スタックをロールバックするか、ユーザープールからカスタムSMS送信者関数の割り当てを削除します。

カスタム送信者 Lambda SMS トリガーソース

次の表は、Lambda コード内のカスタムトリガーソースのSMSトリガーイベントを示しています。