AWS::Cognito::UserPool EmailConfiguration - AWS CloudFormation

AWS::Cognito::UserPool EmailConfiguration

E メール設定です。

構文

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

JSON

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

YAML

ConfigurationSet: String EmailSendingAccount: String From: String ReplyToEmailAddress: String SourceArn: String

プロパティ

ConfigurationSet

Amazon SES を使用して送信される E メールに適用できる設定ルールのセット。E メールのヘッダーに設定セットへの参照を含めることで、E メールに設定セットが適用されます。適用されると、その設定セット内のすべてのルールが E メールに適用されます。設定セットを使用して、次のタイプのルールを E メールに適用できます。

  • イベントの発行 – Amazon SES は送信される各 E メールの送信、配信、開封、クリック、バウンス、苦情イベントの数を追跡できます。イベント発行を使用して、これらのイベントに関する情報を SNS や CloudWatch などの他の AWS サービスに送信します。

  • IP プールの管理 — Amazon SES で専用 IP アドレスをリースする場合、専用 IP プールと呼ばれる IP アドレスのグループを作成できます。その後、専用 IP プールと設定セットを関連付けることができます。

必須: いいえ

タイプ: 文字列

最小: 1

最大: 64

パターン: ^[a-zA-Z0-9_-]+$

Update requires: No interruption

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

From

送信者のE メールアドレスを識別するか、E メールアドレスで送信者の名前を識別します。例えば、testuser@example.comTest User <testuser@example.com> などです。このアドレスは、E メールの本文の前に表示されます。

必須: いいえ

タイプ: 文字列

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