AWS::Cognito::UserPoolRiskConfigurationAttachment - AWS CloudFormation

AWS::Cognito::UserPoolRiskConfigurationAttachment

AWS::Cognito::UserPoolRiskConfigurationAttachment リソースは、Amazon Cognito の高度なセキュリティ機能に使用されるリスク設定を設定します。

1 つのクライアント(特定の clientId を持つ)またはすべてのクライアント(clientIdALL に設定して)のリスク設定を指定できます。ALL を指定した場合は、以前にリスクが設定されていないすべてのクライアントにデフォルトの設定が使用されます。特定のクライアントにリスク設定を指定した場合、ALL 設定にフォールバックされなくなります。

構文

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

プロパティ

AccountTakeoverRiskConfiguration

アカウントの乗っ取り時に取る、NotifyConfiguration オブジェクトおよび Actions を含むアカウントの乗っ取りリスク設定オブジェクト。

必須: いいえ

タイプ: AccountTakeoverRiskConfigurationType

Update requires: No interruption

ClientId

アプリクライアント ID。1 つのクライアント (特定の ClientId を持つ) またはすべてのクライアント (ClientId を ALL に設定して) のリスク設定を指定できます。

必須: はい

タイプ: 文字列

最小: 1

最大: 128

パターン: [\w+]+

Update requires: Replacement

CompromisedCredentialsRiskConfiguration

EventFilter および EventAction などの漏洩した認証情報のリスク設定オブジェクト

必須: いいえ

タイプ: CompromisedCredentialsRiskConfigurationType

Update requires: No interruption

RiskExceptionConfiguration

リスク決定を上書きする設定。

必須: いいえ

タイプ: RiskExceptionConfigurationType

Update requires: No interruption

UserPoolId

ユーザープール ID。

必須: はい

タイプ: 文字列

最小: 1

最大: 55

パターン: [\w-]+_[0-9a-zA-Z]+

Update requires: Replacement

戻り値

参照番号

このリソースの論理 ID を組み込みの Ref 関数に渡すと、Ref は次を返します: physicalResourceId (「UserPoolRiskConfigurationAttachment-UserPoolId-ClientId」)。次に例を示します。

{ "Ref": “UserPoolRiskConfigurationAttachment-us-east-1_FAKEPOOLID-2asc123fakeclientidajjulj6bh” }

Amazon Cognito リスク設定アタッチメント UserPoolRiskConfigurationAttachment-us-east-1_FAKEPOOLID-2asc123fakeclientidajjulj6bh の場合、Ref はリスク設定アタッチメントの名前を返します。

For more information about using the Ref function, see Ref.

ユーザープールの新しいリスク設定アタッチメントの作成

次の例では、参照されるユーザープールおよびクライアントでリスク設定を設定します。

JSON

{ "UserPoolRiskConfiguration":{ "Type":"AWS::Cognito::UserPoolRiskConfigurationAttachment", "Properties":{ "UserPoolId":{ "Ref":"UserPool" }, "ClientId":{ "Ref":"Client" }, "AccountTakeoverRiskConfiguration":{ "Actions":{ "HighAction":{ "EventAction":"MFA_REQUIRED", "Notify":true, }, "MediumAction":{ "EventAction":"MFA_IF_CONFIGURED", "Notify":true }, "LowAction":{ "EventAction":{ "Ref":"EventAction" }, "Notify":false } }, "NotifyConfiguration":{ "BlockEmail":{ "HtmlBody":"html body", "Subject":"Your account got blocked", "TextBody":"Your account got blocked" }, "MfaEmail":{ "HtmlBody":"html body", "Subject":"Your account needs MFA verification", "TextBody":"Your account needs MFA verification" }, "NoActionEmail":{ "HtmlBody":{ "Ref":"HtmlBody" }, "Subject":{ "Ref":"Subject" }, "TextBody":{ "Ref":"TextBody" }, }, "From":"your-from-email@amazon.com", "SourceArn":{ "Ref":"SourceArn" }, "ReplyTo":"your-reply-to@amazon.com" } }, "CompromisedCredentialsRiskConfiguration":{ "Actions":{ "EventAction":"BLOCKED" }, "EventFilter":[ { "Ref":"EventFilter" }, ] }, "RiskExceptionConfiguration":{ "BlockedIPRangeList":[ "198.0.0.1" ], "SkippedIPRangeList":[ "198.0.0.1" ] } } } }

YAML

UserPoolRiskConfiguration: Type: AWS::Cognito::UserPoolRiskConfigurationAttachment Properties: UserPoolId: !Ref UserPool ClientId: !Ref Client AccountTakeoverRiskConfiguration: Actions: HighAction: EventAction: "MFA_REQUIRED" Notify: True MediumAction: EventAction: "MFA_IF_CONFIGURED" Notify: True LowAction: EventAction: !Ref LowEventAction Notify: False NotifyConfiguration: BlockEmail: HtmlBody: "html body" Subject: "Your account got blocked" TextBody: "Your account got blocked" MfaEmail: HtmlBody: "html body" Subject: "Your account needs MFA verification" TextBody: "Your account needs MFA verification" NoActionEmail: HtmlBody: !Ref HtmlBody Subject: !Ref Subject TextBody: !Ref TextBody From: "your-from-email@amazon.com" SourceArn: !Ref SourceArn ReplyTo: "your-reply-to@amazon.com" CompromisedCredentialsRiskConfiguration: Actions: EventAction: "BLOCKED" EventFilter: - !Ref EventFilter RiskExceptionConfiguration: BlockedIPRangeList: - "198.0.0.1" SkippedIPRangeList: - "198.0.0.1"