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.97.0 (build 729de35)",
           date="2024-04-18T17:54:14.552Z")
@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 account takeover risk configuration object, including the NotifyConfiguration object and Actions to take if there is an account takeover.
String	getClientId()	The app client ID.
default Object	getCompromisedCredentialsRiskConfiguration()	The compromised credentials risk configuration object, including the EventFilter and the EventAction .
default Object	getRiskExceptionConfiguration()	The configuration to override the risk decision.
String	getUserPoolId()	The user pool ID.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClientId

@Stability(Stable)
@NotNull
String getClientId()

The app client ID.

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

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 user pool ID.

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 account takeover risk configuration object, including the NotifyConfiguration object and Actions to take if there is an account takeover.

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()

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

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()

The configuration to override the risk decision.

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