Class CfnUserPoolRiskConfigurationAttachment

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

A CloudFormation AWS::Cognito::UserPoolRiskConfigurationAttachment.

public class CfnUserPoolRiskConfigurationAttachment : CfnResource, IInspectable

Inheritance

object

CfnUserPoolRiskConfigurationAttachment

Implements

IInspectable

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 cfnUserPoolRiskConfigurationAttachment = new CfnUserPoolRiskConfigurationAttachment(this, "MyCfnUserPoolRiskConfigurationAttachment", 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" }
                 }
             });

Remarks

The AWS::Cognito::UserPoolRiskConfigurationAttachment resource sets the risk configuration that is used for Amazon Cognito advanced security features.

You can specify risk configuration for a single client (with a specific clientId ) or for all clients (by setting the clientId to ALL ). If you specify ALL , the default configuration is used for every client that has had no risk configuration set previously. If you specify risk configuration for a particular client, it no longer falls back to the ALL configuration.

CloudformationResource: AWS::Cognito::UserPoolRiskConfigurationAttachment

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

ExampleMetadata: fixture=_generated

Constructors

CfnUserPoolRiskConfigurationAttachment(Construct, string, ICfnUserPoolRiskConfigurationAttachmentProps)

Create a new AWS::Cognito::UserPoolRiskConfigurationAttachment.

public CfnUserPoolRiskConfigurationAttachment(Construct scope, string id, ICfnUserPoolRiskConfigurationAttachmentProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id string

• scoped id of the resource.

props ICfnUserPoolRiskConfigurationAttachmentProps

• resource properties.

Properties

AccountTakeoverRiskConfiguration

The account takeover risk configuration object, including the NotifyConfiguration object and Actions to take if there is an account takeover.

public virtual object? AccountTakeoverRiskConfiguration { get; set; }

Property Value

object

Remarks

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

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

ClientId

The app client ID.

public virtual string ClientId { get; set; }

Property Value

string

Remarks

You can specify the risk configuration for a single client (with a specific ClientId) or for all clients (by setting the ClientId to ALL ).

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

CompromisedCredentialsRiskConfiguration

The compromised credentials risk configuration object, including the EventFilter and the EventAction .

public virtual object? CompromisedCredentialsRiskConfiguration { get; set; }

Property Value

object

Remarks

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

RiskExceptionConfiguration

The configuration to override the risk decision.

public virtual object? RiskExceptionConfiguration { get; set; }

Property Value

object

Remarks

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

UserPoolId

The user pool ID.

public virtual string UserPoolId { get; set; }

Property Value

string

Remarks

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

• tree inspector to collect and process attributes.

RenderProperties(IDictionary<string, object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>