Interface ICfnUserPoolRiskConfigurationAttachmentProps

Properties for defining a CfnUserPoolRiskConfigurationAttachment.

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnUserPoolRiskConfigurationAttachmentProps

Syntax (vb)

Public Interface ICfnUserPoolRiskConfigurationAttachmentProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Cognito;

             var cfnUserPoolRiskConfigurationAttachmentProps = new CfnUserPoolRiskConfigurationAttachmentProps {
                 ClientId = "clientId",
                 UserPoolId = "userPoolId",

                 // the properties below are optional
                 AccountTakeoverRiskConfiguration = new AccountTakeoverRiskConfigurationTypeProperty {
                     Actions = new AccountTakeoverActionsTypeProperty {
                         HighAction = new AccountTakeoverActionTypeProperty {
                             EventAction = "eventAction",
                             Notify = false
                         },
                         LowAction = new AccountTakeoverActionTypeProperty {
                             EventAction = "eventAction",
                             Notify = false
                         },
                         MediumAction = new AccountTakeoverActionTypeProperty {
                             EventAction = "eventAction",
                             Notify = false
                         }
                     },

                     // the properties below are optional
                     NotifyConfiguration = new NotifyConfigurationTypeProperty {
                         SourceArn = "sourceArn",

                         // the properties below are optional
                         BlockEmail = new NotifyEmailTypeProperty {
                             Subject = "subject",

                             // the properties below are optional
                             HtmlBody = "htmlBody",
                             TextBody = "textBody"
                         },
                         From = "from",
                         MfaEmail = new NotifyEmailTypeProperty {
                             Subject = "subject",

                             // the properties below are optional
                             HtmlBody = "htmlBody",
                             TextBody = "textBody"
                         },
                         NoActionEmail = new NotifyEmailTypeProperty {
                             Subject = "subject",

                             // the properties below are optional
                             HtmlBody = "htmlBody",
                             TextBody = "textBody"
                         },
                         ReplyTo = "replyTo"
                     }
                 },
                 CompromisedCredentialsRiskConfiguration = new CompromisedCredentialsRiskConfigurationTypeProperty {
                     Actions = new CompromisedCredentialsActionsTypeProperty {
                         EventAction = "eventAction"
                     },

                     // the properties below are optional
                     EventFilter = new [] { "eventFilter" }
                 },
                 RiskExceptionConfiguration = new RiskExceptionConfigurationTypeProperty {
                     BlockedIpRangeList = new [] { "blockedIpRangeList" },
                     SkippedIpRangeList = new [] { "skippedIpRangeList" }
                 }
             };

Synopsis

Properties

AccountTakeoverRiskConfiguration	The settings for automated responses and notification templates for adaptive authentication with threat protection.
ClientId	The app client where this configuration is applied.
CompromisedCredentialsRiskConfiguration	Settings for compromised-credentials actions and authentication types with threat protection in full-function ENFORCED mode.
RiskExceptionConfiguration	Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.
UserPoolId	The ID of the user pool that has the risk configuration applied.

Properties

AccountTakeoverRiskConfiguration

The settings for automated responses and notification templates for adaptive authentication with threat protection.

object? AccountTakeoverRiskConfiguration { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfiguration

ClientId

The app client where this configuration is applied.

string ClientId { get; }

Property Value

string

Remarks

When this parameter isn't present, the risk configuration applies to all user pool app clients that don't have client-level settings.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-clientid

CompromisedCredentialsRiskConfiguration

Settings for compromised-credentials actions and authentication types with threat protection in full-function ENFORCED mode.

object? CompromisedCredentialsRiskConfiguration { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfiguration

RiskExceptionConfiguration

Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.

object? RiskExceptionConfiguration { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-riskexceptionconfiguration

UserPoolId

The ID of the user pool that has the risk configuration applied.

string UserPoolId { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-userpoolid