@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:46.819Z") public class CfnUserPoolRiskConfigurationAttachment extends CfnResource implements IInspectable
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();
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnUserPoolRiskConfigurationAttachment(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnUserPoolRiskConfigurationAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnUserPoolRiskConfigurationAttachment(Construct scope, java.lang.String id, CfnUserPoolRiskConfigurationAttachmentProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getClientId()
You can specify the risk configuration for a single client (with a specific ClientId) or for all clients (by setting the ClientId to ALL
).
public void setClientId(java.lang.String value)
You can specify the risk configuration for a single client (with a specific ClientId) or for all clients (by setting the ClientId to ALL
).
public java.lang.String getUserPoolId()
public void setUserPoolId(java.lang.String value)
public java.lang.Object getAccountTakeoverRiskConfiguration()
public void setAccountTakeoverRiskConfiguration(IResolvable value)
public void setAccountTakeoverRiskConfiguration(CfnUserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationTypeProperty value)
public java.lang.Object getCompromisedCredentialsRiskConfiguration()
public void setCompromisedCredentialsRiskConfiguration(IResolvable value)
public void setCompromisedCredentialsRiskConfiguration(CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypeProperty value)
public java.lang.Object getRiskExceptionConfiguration()
public void setRiskExceptionConfiguration(IResolvable value)
public void setRiskExceptionConfiguration(CfnUserPoolRiskConfigurationAttachment.RiskExceptionConfigurationTypeProperty value)