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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.650Z")
 @Stability(value=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();
 

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 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 Detail

getClientId

@Stability(value=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 ).

getUserPoolId

@Stability(value=Stable)
 @NotNull
String getUserPoolId()

The user pool ID.

getAccountTakeoverRiskConfiguration

@Stability(value=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.

getCompromisedCredentialsRiskConfiguration

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

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

getRiskExceptionConfiguration

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

The configuration to override the risk decision.

builder

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

Returns:

a CfnUserPoolRiskConfigurationAttachmentProps.Builder of CfnUserPoolRiskConfigurationAttachmentProps