Skip to content
v2.275.0

CfnUserPoolRiskConfigurationAttachmentProps Struct ​

Properties for defining a CfnUserPoolRiskConfigurationAttachment.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const cfnUserPoolRiskConfigurationAttachmentProps: cognito.CfnUserPoolRiskConfigurationAttachmentProps = {
  clientId: 'clientId',
  userPoolId: 'userPoolId',

  // the properties below are optional
  accountTakeoverRiskConfiguration: {
    actions: {
      highAction: {
        eventAction: 'eventAction',
        notify: false,
      },
      lowAction: {
        eventAction: 'eventAction',
        notify: false,
      },
      mediumAction: {
        eventAction: 'eventAction',
        notify: false,
      },
    },

    // the properties below are optional
    notifyConfiguration: {
      sourceArn: 'sourceArn',

      // the properties below are optional
      blockEmail: {
        subject: 'subject',

        // the properties below are optional
        htmlBody: 'htmlBody',
        textBody: 'textBody',
      },
      from: 'from',
      mfaEmail: {
        subject: 'subject',

        // the properties below are optional
        htmlBody: 'htmlBody',
        textBody: 'textBody',
      },
      noActionEmail: {
        subject: 'subject',

        // the properties below are optional
        htmlBody: 'htmlBody',
        textBody: 'textBody',
      },
      replyTo: 'replyTo',
    },
  },
  compromisedCredentialsRiskConfiguration: {
    actions: {
      eventAction: 'eventAction',
    },

    // the properties below are optional
    eventFilter: ['eventFilter'],
  },
  riskExceptionConfiguration: {
    blockedIpRangeList: ['blockedIpRangeList'],
    skippedIpRangeList: ['skippedIpRangeList'],
  },
};

Properties ​

accountTakeoverRiskConfigurationoptionalIResolvable | CfnUserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationTypePropertyaccount_takeover_risk_configurationoptionaltyping.Union[IResolvable, AccountTakeoverRiskConfigurationTypeProperty]accountTakeoverRiskConfigurationoptionalIResolvableAccountTakeoverRiskConfigurationoptionalIResolvableAccountTakeoverRiskConfigurationoptionalinterface{}#
The settings for automated responses and notification templates for adaptive authentication with threat protection.
clientIdstringclient_idstrclientIdStringClientIdstringClientId*stringrequired#
The app client where this configuration is applied.

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

compromisedCredentialsRiskConfigurationoptionalIResolvable | CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypePropertycompromised_credentials_risk_configurationoptionaltyping.Union[IResolvable, CompromisedCredentialsRiskConfigurationTypeProperty]compromisedCredentialsRiskConfigurationoptionalIResolvableCompromisedCredentialsRiskConfigurationoptionalIResolvableCompromisedCredentialsRiskConfigurationoptionalinterface{}#
Settings for compromised-credentials actions and authentication types with threat protection in full-function `ENFORCED` mode.
riskExceptionConfigurationoptionalIResolvable | CfnUserPoolRiskConfigurationAttachment.RiskExceptionConfigurationTypePropertyrisk_exception_configurationoptionaltyping.Union[IResolvable, RiskExceptionConfigurationTypeProperty]riskExceptionConfigurationoptionalIResolvableRiskExceptionConfigurationoptionalIResolvableRiskExceptionConfigurationoptionalinterface{}#
Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.
userPoolIdstring | IUserPoolRefuser_pool_idtyping.Union[str, IUserPoolRef]userPoolIdStringUserPoolIdstringUserPoolIdinterface{}required#
The ID of the user pool that has the risk configuration applied.