AWS CloudFormation
ユーザーガイド (API バージョン 2010-05-15)

AWS::Cognito::UserPool EmailConfiguration

EmailConfiguration は、AWS::Cognito::UserPool リソースのプロパティであり、Amazon Cognito ユーザープールの E メール設定を定義します。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

{ "EmailSendingAccount" : String, "ReplyToEmailAddress" : String, "SourceArn" : String }

YAML

EmailSendingAccount: String ReplyToEmailAddress: String SourceArn: String

プロパティ

EmailSendingAccount

Amazon Cognito が組み込みの E メール機能または Amazon SES E メール設定を使用してユーザーに E メールを送信するかどうかを指定します。以下のいずれかの値を指定します。

COGNITO_DEFAULT

Amazon Cognito は、組み込みの E メール機能を使用して、ユーザーに E メールを送信します。デフォルトのオプションを使用すると、Amazon Cognito により、限られた数の E メールのみが毎日ユーザープールに対して処理されます。一般的な実稼働環境では、デフォルトの E メール制限は必要な配信ボリュームを下回っています。配信ボリュームを増やすには、DEVELOPER を指定して、Amazon SES E メール設定を使用します。

デフォルトのオプションの E メール配信制限については、Amazon Cognito 開発者ガイドの「Amazon Cognito における制限」を参照してください。

デフォルトの FROM アドレスは no-reply@verificationemail.com です。FROM アドレスをカスタマイズするには、Amazon SES で検証済みの E メールアドレスの ARN を SourceArn パラメータに提供します。

DEVELOPER

Amazon Cognito は、Amazon SES 設定を使用して、ユーザーに E メールを送信します。Amazon Cognito が自動的に Amazon SES を呼び出して、検証済みの E メールアドレスから E メールを送信します。このオプションの使用時の E メール配信制限は、AWS アカウントで Amazon SES が検証した E メールアドレスに適用される制限と同じです。

このオプションを使用する場合は、Amazon SES で検証済みの E メールアドレスの ARN を SourceArn パラメータに提供する必要があります。

Amazon Cognito がユーザーに E メールを送信するためには、Amazon SES を自動的に呼び出すためのアクセス権限が必要となります。このオプションでユーザープールを更新すると、Amazon Cognito はサービスにリンクされたロールを作成します。これは、AWS アカウントにおける IAM ロールのタイプの 1 つです。このロールには、Amazon Cognito が Amazon SES にアクセスし、お客様のアドレスを使用して E メールを送信することを許可するアクセス権限が含まれています。Amazon Cognito が作成するサービスにリンクされたロールの詳細については、Amazon Cognito 開発者ガイドの「Amazon Cognito のサービスにリンクされたロールの使用」を参照してください。

必須: いいえ

タイプ: 文字列

許可された値: COGNITO_DEFAULT | DEVELOPER

Update requires: No interruption

ReplyToEmailAddress

E メールの受信者が返信する送信先。

必須: いいえ

タイプ: 文字列

パターン: [\p{L}\p{M}\p{S}\p{N}\p{P}]+@[\p{L}\p{M}\p{S}\p{N}\p{P}]+

Update requires: No interruption

SourceArn

Amazon SES で検証された E メールアドレスの Amazon リソースネーム (ARN)。この E メールアドレスは、EmailSendingAccount パラメータに指定した値に応じて、以下のいずれかの方法で使用されます。

  • COGNITO_DEFAULT を指定した場合、Amazon Cognito は、ビルトイン E メールアカウントを使用してユーザーに E メールを送信するときに、このアドレスをカスタム FROM アドレスとして使用します。

  • DEVELOPER を指定した場合、Amazon Cognito は、Amazon SES を自動的に呼び出して、このアドレスをユーザーに E メールで送信します。

必須: いいえ

タイプ: 文字列

最小: 20

最大: 2048

パターン: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Update requires: No interruption

このページの内容: