software.amazon.awscdk.services.cognito

Class CfnUserPoolRiskConfigurationAttachment

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.cognito.CfnUserPoolRiskConfigurationAttachment

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.819Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnUserPoolRiskConfigurationAttachment(Construct scope, java.lang.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
java.lang.Object	getAccountTakeoverRiskConfiguration() The account takeover risk configuration object, including the `NotifyConfiguration` object and `Actions` to take if there is an account takeover.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getClientId() The app client ID.
java.lang.Object	getCompromisedCredentialsRiskConfiguration() The compromised credentials risk configuration object, including the `EventFilter` and the `EventAction` .
java.lang.Object	getRiskExceptionConfiguration() The configuration to override the risk decision.
java.lang.String	getUserPoolId() The user pool ID.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.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(java.lang.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(java.lang.String value) The user pool ID.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnUserPoolRiskConfigurationAttachment(Construct scope,
                                              java.lang.String id,
                                              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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getClientId

public 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 ).

setClientId

public void setClientId(java.lang.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

public java.lang.String getUserPoolId()

The user pool ID.

setUserPoolId

public void setUserPoolId(java.lang.String value)

The user pool ID.

getAccountTakeoverRiskConfiguration

public java.lang.Object getAccountTakeoverRiskConfiguration()

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

setAccountTakeoverRiskConfiguration

public void setAccountTakeoverRiskConfiguration(IResolvable value)

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

setAccountTakeoverRiskConfiguration

public 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.

getCompromisedCredentialsRiskConfiguration

public java.lang.Object getCompromisedCredentialsRiskConfiguration()

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

setCompromisedCredentialsRiskConfiguration

public void setCompromisedCredentialsRiskConfiguration(IResolvable value)

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

setCompromisedCredentialsRiskConfiguration

public void setCompromisedCredentialsRiskConfiguration(CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypeProperty value)

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

getRiskExceptionConfiguration

public java.lang.Object getRiskExceptionConfiguration()

The configuration to override the risk decision.

setRiskExceptionConfiguration

public void setRiskExceptionConfiguration(IResolvable value)

The configuration to override the risk decision.

setRiskExceptionConfiguration

public void setRiskExceptionConfiguration(CfnUserPoolRiskConfigurationAttachment.RiskExceptionConfigurationTypeProperty value)

The configuration to override the risk decision.