Package software.amazon.awscdk.services.cognito

Interface CfnUserPoolRiskConfigurationAttachmentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPoolRiskConfigurationAttachmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-25T14:21:12.500Z")
@Stability(Stable)
public interface CfnUserPoolRiskConfigurationAttachmentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnUserPoolRiskConfigurationAttachment.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 CfnUserPoolRiskConfigurationAttachmentProps cfnUserPoolRiskConfigurationAttachmentProps = CfnUserPoolRiskConfigurationAttachmentProps.builder()
         .clientId("clientId")
         .userPoolId("userPoolId")
         // the properties below are optional
         .accountTakeoverRiskConfiguration(AccountTakeoverRiskConfigurationTypeProperty.builder()
                 .actions(AccountTakeoverActionsTypeProperty.builder()
                         .highAction(AccountTakeoverActionTypeProperty.builder()
                                 .eventAction("eventAction")
                                 .notify(false)
                                 .build())
                         .lowAction(AccountTakeoverActionTypeProperty.builder()
                                 .eventAction("eventAction")
                                 .notify(false)
                                 .build())
                         .mediumAction(AccountTakeoverActionTypeProperty.builder()
                                 .eventAction("eventAction")
                                 .notify(false)
                                 .build())
                         .build())
                 // the properties below are optional
                 .notifyConfiguration(NotifyConfigurationTypeProperty.builder()
                         .sourceArn("sourceArn")
                         // the properties below are optional
                         .blockEmail(NotifyEmailTypeProperty.builder()
                                 .subject("subject")
                                 // the properties below are optional
                                 .htmlBody("htmlBody")
                                 .textBody("textBody")
                                 .build())
                         .from("from")
                         .mfaEmail(NotifyEmailTypeProperty.builder()
                                 .subject("subject")
                                 // the properties below are optional
                                 .htmlBody("htmlBody")
                                 .textBody("textBody")
                                 .build())
                         .noActionEmail(NotifyEmailTypeProperty.builder()
                                 .subject("subject")
                                 // the properties below are optional
                                 .htmlBody("htmlBody")
                                 .textBody("textBody")
                                 .build())
                         .replyTo("replyTo")
                         .build())
                 .build())
         .compromisedCredentialsRiskConfiguration(CompromisedCredentialsRiskConfigurationTypeProperty.builder()
                 .actions(CompromisedCredentialsActionsTypeProperty.builder()
                         .eventAction("eventAction")
                         .build())
                 // the properties below are optional
                 .eventFilter(List.of("eventFilter"))
                 .build())
         .riskExceptionConfiguration(RiskExceptionConfigurationTypeProperty.builder()
                 .blockedIpRangeList(List.of("blockedIpRangeList"))
                 .skippedIpRangeList(List.of("skippedIpRangeList"))
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPoolRiskConfigurationAttachmentProps.Builder	A builder for CfnUserPoolRiskConfigurationAttachmentProps
static final class	CfnUserPoolRiskConfigurationAttachmentProps.Jsii$Proxy	An implementation for CfnUserPoolRiskConfigurationAttachmentProps

Method Summary

Modifier and Type	Method	Description
static CfnUserPoolRiskConfigurationAttachmentProps.Builder	builder()
default Object	getAccountTakeoverRiskConfiguration()	The settings for automated responses and notification templates for adaptive authentication with advanced security features.
String	getClientId()	The app client where this configuration is applied.
default Object	getCompromisedCredentialsRiskConfiguration()	Settings for compromised-credentials actions and authentication types with advanced security features in full-function ENFORCED mode.
default Object	getRiskExceptionConfiguration()	Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.
String	getUserPoolId()	The ID of the user pool that has the risk configuration applied.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClientId

@Stability(Stable)
@NotNull
String getClientId()

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.

See Also:

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

getUserPoolId

@Stability(Stable)
@NotNull
String getUserPoolId()

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

See Also:

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

getAccountTakeoverRiskConfiguration

@Stability(Stable)
@Nullable
default Object getAccountTakeoverRiskConfiguration()

The settings for automated responses and notification templates for adaptive authentication with advanced security features.

See Also:

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

getCompromisedCredentialsRiskConfiguration

@Stability(Stable)
@Nullable
default Object getCompromisedCredentialsRiskConfiguration()

Settings for compromised-credentials actions and authentication types with advanced security features in full-function ENFORCED mode.

See Also:

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

getRiskExceptionConfiguration

@Stability(Stable)
@Nullable
default Object getRiskExceptionConfiguration()

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

See Also:

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

builder

@Stability(Stable)
static CfnUserPoolRiskConfigurationAttachmentProps.Builder builder()

Returns:

a CfnUserPoolRiskConfigurationAttachmentProps.Builder of CfnUserPoolRiskConfigurationAttachmentProps