software.amazon.awscdk.services.cognito

Class CfnUserPoolRiskConfigurationAttachment

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.cognito.CfnUserPoolRiskConfigurationAttachment

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.647Z")
 @Stability(value=Stable)
public class CfnUserPoolRiskConfigurationAttachment
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Cognito::UserPoolRiskConfigurationAttachment`.

The AWS::Cognito::UserPoolRiskConfigurationAttachment resource sets the risk configuration that is used for Amazon Cognito advanced security features.

You can specify risk configuration for a single client (with a specific clientId ) or for all clients (by setting the clientId to ALL ). If you specify ALL , the default configuration is used for every client that has had no risk configuration set previously. If you specify risk configuration for a particular client, it no longer falls back to the ALL configuration.

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.*;
 CfnUserPoolRiskConfigurationAttachment cfnUserPoolRiskConfigurationAttachment = CfnUserPoolRiskConfigurationAttachment.Builder.create(this, "MyCfnUserPoolRiskConfigurationAttachment")
         .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	Class and Description
static interface	CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionsTypeProperty Account takeover actions type.
static interface	CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty Account takeover action type.
static interface	CfnUserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationTypeProperty Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.
static class	CfnUserPoolRiskConfigurationAttachment.Builder A fluent builder for CfnUserPoolRiskConfigurationAttachment.
static interface	CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsActionsTypeProperty The compromised credentials actions type.
static interface	CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypeProperty The compromised credentials risk configuration type.
static interface	CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty The notify configuration type.
static interface	CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypeProperty The notify email type.
static interface	CfnUserPoolRiskConfigurationAttachment.RiskExceptionConfigurationTypeProperty The type of the configuration to override the risk decision.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnUserPoolRiskConfigurationAttachment(software.constructs.Construct scope, String id, CfnUserPoolRiskConfigurationAttachmentProps props) Create a new `AWS::Cognito::UserPoolRiskConfigurationAttachment`.
protected	CfnUserPoolRiskConfigurationAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUserPoolRiskConfigurationAttachment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAccountTakeoverRiskConfiguration() The account takeover risk configuration object, including the `NotifyConfiguration` object and `Actions` to take if there is an account takeover.
protected Map<String,Object>	getCfnProperties()
String	getClientId() The app client ID.
Object	getCompromisedCredentialsRiskConfiguration() The compromised credentials risk configuration object, including the `EventFilter` and the `EventAction` .
Object	getRiskExceptionConfiguration() The configuration to override the risk decision.
String	getUserPoolId() The user pool ID.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccountTakeoverRiskConfiguration(CfnUserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationTypeProperty value) The account takeover risk configuration object, including the `NotifyConfiguration` object and `Actions` to take if there is an account takeover.
void	setAccountTakeoverRiskConfiguration(IResolvable value) The account takeover risk configuration object, including the `NotifyConfiguration` object and `Actions` to take if there is an account takeover.
void	setClientId(String value) The app client ID.
void	setCompromisedCredentialsRiskConfiguration(CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypeProperty value) The compromised credentials risk configuration object, including the `EventFilter` and the `EventAction` .
void	setCompromisedCredentialsRiskConfiguration(IResolvable value) The compromised credentials risk configuration object, including the `EventFilter` and the `EventAction` .
void	setRiskExceptionConfiguration(CfnUserPoolRiskConfigurationAttachment.RiskExceptionConfigurationTypeProperty value) The configuration to override the risk decision.
void	setRiskExceptionConfiguration(IResolvable value) The configuration to override the risk decision.
void	setUserPoolId(String value) The user pool ID.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnUserPoolRiskConfigurationAttachment

protected CfnUserPoolRiskConfigurationAttachment(software.amazon.jsii.JsiiObjectRef objRef)

CfnUserPoolRiskConfigurationAttachment

protected CfnUserPoolRiskConfigurationAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnUserPoolRiskConfigurationAttachment

@Stability(value=Stable)
public CfnUserPoolRiskConfigurationAttachment(@NotNull
                                                                       software.constructs.Construct scope,
                                                                       @NotNull
                                                                       String id,
                                                                       @NotNull
                                                                       CfnUserPoolRiskConfigurationAttachmentProps props)

Create a new `AWS::Cognito::UserPoolRiskConfigurationAttachment`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getClientId

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

setClientId

@Stability(value=Stable)
public void setClientId(@NotNull
                                                 String value)

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
public String getUserPoolId()

The user pool ID.

setUserPoolId

@Stability(value=Stable)
public void setUserPoolId(@NotNull
                                                   String value)

The user pool ID.

getAccountTakeoverRiskConfiguration

@Stability(value=Stable)
 @Nullable
public Object getAccountTakeoverRiskConfiguration()

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

setAccountTakeoverRiskConfiguration

@Stability(value=Stable)
public void setAccountTakeoverRiskConfiguration(@Nullable
                                                                         CfnUserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationTypeProperty value)

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

setAccountTakeoverRiskConfiguration

@Stability(value=Stable)
public void setAccountTakeoverRiskConfiguration(@Nullable
                                                                         IResolvable value)

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
public Object getCompromisedCredentialsRiskConfiguration()

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

setCompromisedCredentialsRiskConfiguration

@Stability(value=Stable)
public void setCompromisedCredentialsRiskConfiguration(@Nullable
                                                                                CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypeProperty value)

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

setCompromisedCredentialsRiskConfiguration

@Stability(value=Stable)
public void setCompromisedCredentialsRiskConfiguration(@Nullable
                                                                                IResolvable value)

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

getRiskExceptionConfiguration

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

The configuration to override the risk decision.

setRiskExceptionConfiguration

@Stability(value=Stable)
public void setRiskExceptionConfiguration(@Nullable
                                                                   CfnUserPoolRiskConfigurationAttachment.RiskExceptionConfigurationTypeProperty value)

The configuration to override the risk decision.

setRiskExceptionConfiguration

@Stability(value=Stable)
public void setRiskExceptionConfiguration(@Nullable
                                                                   IResolvable value)

The configuration to override the risk decision.