Class CfnUserPoolRiskConfigurationAttachment

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnUserPoolRiskConfigurationAttachment

Implements

IInspectable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnUserPoolRiskConfigurationAttachment : CfnResource, IInspectable

Syntax (vb)

Public Class CfnUserPoolRiskConfigurationAttachment Inherits CfnResource Implements IInspectable

Remarks

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.

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

CloudformationResource: AWS::Cognito::UserPoolRiskConfigurationAttachment

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 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" }
                 }
             });

Synopsis

Constructors

CfnUserPoolRiskConfigurationAttachment(Construct, string, ICfnUserPoolRiskConfigurationAttachmentProps)

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

Properties

AccountTakeoverRiskConfiguration	The settings for automated responses and notification templates for adaptive authentication with threat protection.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::Cognito::UserPoolRiskConfigurationAttachment resource sets the risk configuration that is used for Amazon Cognito advanced security features.
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.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	The AWS::Cognito::UserPoolRiskConfigurationAttachment resource sets the risk configuration that is used for Amazon Cognito advanced security features.

Constructors

CfnUserPoolRiskConfigurationAttachment(Construct, string, ICfnUserPoolRiskConfigurationAttachmentProps)

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

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

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnUserPoolRiskConfigurationAttachmentProps

Resource properties.

Remarks

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.

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

CloudformationResource: AWS::Cognito::UserPoolRiskConfigurationAttachment

ExampleMetadata: fixture=_generated

Properties

AccountTakeoverRiskConfiguration

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

public virtual object? AccountTakeoverRiskConfiguration { get; set; }

Property Value

object

Remarks

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.

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

CloudformationResource: AWS::Cognito::UserPoolRiskConfigurationAttachment

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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.

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

CloudformationResource: AWS::Cognito::UserPoolRiskConfigurationAttachment

ExampleMetadata: fixture=_generated

CfnProperties

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

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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.

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

CloudformationResource: AWS::Cognito::UserPoolRiskConfigurationAttachment

ExampleMetadata: fixture=_generated

ClientId

The app client where this configuration is applied.

public virtual string ClientId { get; set; }

Property Value

string

Remarks

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.

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

CloudformationResource: AWS::Cognito::UserPoolRiskConfigurationAttachment

ExampleMetadata: fixture=_generated

CompromisedCredentialsRiskConfiguration

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

public virtual object? CompromisedCredentialsRiskConfiguration { get; set; }

Property Value

object

Remarks

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.

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

CloudformationResource: AWS::Cognito::UserPoolRiskConfigurationAttachment

ExampleMetadata: fixture=_generated

RiskExceptionConfiguration

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

public virtual object? RiskExceptionConfiguration { get; set; }

Property Value

object

Remarks

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.

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

CloudformationResource: AWS::Cognito::UserPoolRiskConfigurationAttachment

ExampleMetadata: fixture=_generated

UserPoolId

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

public virtual string UserPoolId { get; set; }

Property Value

string

Remarks

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.

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

CloudformationResource: AWS::Cognito::UserPoolRiskConfigurationAttachment

ExampleMetadata: fixture=_generated

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.

Remarks

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.

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

CloudformationResource: AWS::Cognito::UserPoolRiskConfigurationAttachment

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

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

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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.

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

CloudformationResource: AWS::Cognito::UserPoolRiskConfigurationAttachment

ExampleMetadata: fixture=_generated

Implements

IInspectable