software.amazon.awscdk.services.cognito

Interface CfnUserPoolRiskConfigurationAttachmentProps

All Known Implementing Classes:

CfnUserPoolRiskConfigurationAttachmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.830Z")
public interface CfnUserPoolRiskConfigurationAttachmentProps

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnUserPoolRiskConfigurationAttachmentProps.Builder	builder()
default java.lang.Object	getAccountTakeoverRiskConfiguration() The account takeover risk configuration object, including the `NotifyConfiguration` object and `Actions` to take if there is an account takeover.
java.lang.String	getClientId() The app client ID.
default java.lang.Object	getCompromisedCredentialsRiskConfiguration() The compromised credentials risk configuration object, including the `EventFilter` and the `EventAction` .
default java.lang.Object	getRiskExceptionConfiguration() The configuration to override the risk decision.
java.lang.String	getUserPoolId() The user pool ID.

Method Detail

getClientId

java.lang.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 ).

getUserPoolId

java.lang.String getUserPoolId()

The user pool ID.

getAccountTakeoverRiskConfiguration

default java.lang.Object getAccountTakeoverRiskConfiguration()

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

getCompromisedCredentialsRiskConfiguration

default java.lang.Object getCompromisedCredentialsRiskConfiguration()

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

getRiskExceptionConfiguration

default java.lang.Object getRiskExceptionConfiguration()

The configuration to override the risk decision.

builder

static CfnUserPoolRiskConfigurationAttachmentProps.Builder builder()

Returns:

a CfnUserPoolRiskConfigurationAttachmentProps.Builder of CfnUserPoolRiskConfigurationAttachmentProps