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.106.0 (build e852934)",
date="2025-02-05T22:42:01.480Z")
@Stability(Stable)
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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
A list of account-takeover actions for each level of risk that Amazon Cognito might assess with advanced security features.static interface
The automated response to a risk level for adaptive authentication in full-function, orENFORCED
, mode.static interface
The settings for automated responses and notification templates for adaptive authentication with advanced security features.static final class
A fluent builder forCfnUserPoolRiskConfigurationAttachment
.static interface
Settings for user pool actions when Amazon Cognito detects compromised credentials with advanced security features in full-functionENFORCED
mode.static interface
Settings for compromised-credentials actions and authentication-event sources with advanced security features in full-functionENFORCED
mode.static interface
The configuration for Amazon SES email messages that advanced security features sends to a user when your adaptive authentication automated response has a Notify action.static interface
The template for email messages that advanced security features sends to a user when your threat protection automated response has a Notify action.static interface
Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CfnUserPoolRiskConfigurationAttachment
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnUserPoolRiskConfigurationAttachment
(software.amazon.jsii.JsiiObjectRef objRef) CfnUserPoolRiskConfigurationAttachment
(software.constructs.Construct scope, String id, CfnUserPoolRiskConfigurationAttachmentProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe settings for automated responses and notification templates for adaptive authentication with threat protection.The app client where this configuration is applied.Settings for compromised-credentials actions and authentication types with threat protection in full-functionENFORCED
mode.Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.The ID of the user pool that has the risk configuration applied.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
The settings for automated responses and notification templates for adaptive authentication with threat protection.void
setAccountTakeoverRiskConfiguration
(CfnUserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationTypeProperty value) The settings for automated responses and notification templates for adaptive authentication with threat protection.void
setClientId
(String value) The app client where this configuration is applied.void
Settings for compromised-credentials actions and authentication types with threat protection in full-functionENFORCED
mode.void
setCompromisedCredentialsRiskConfiguration
(CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypeProperty value) Settings for compromised-credentials actions and authentication types with threat protection in full-functionENFORCED
mode.void
Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.void
setRiskExceptionConfiguration
(CfnUserPoolRiskConfigurationAttachment.RiskExceptionConfigurationTypeProperty value) Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.void
setUserPoolId
(String value) The ID of the user pool that has the risk configuration applied.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnUserPoolRiskConfigurationAttachment
protected CfnUserPoolRiskConfigurationAttachment(software.amazon.jsii.JsiiObjectRef objRef) -
CfnUserPoolRiskConfigurationAttachment
protected CfnUserPoolRiskConfigurationAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnUserPoolRiskConfigurationAttachment
@Stability(Stable) public CfnUserPoolRiskConfigurationAttachment(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnUserPoolRiskConfigurationAttachmentProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getClientId
The app client where this configuration is applied. -
setClientId
The app client where this configuration is applied. -
getUserPoolId
The ID of the user pool that has the risk configuration applied. -
setUserPoolId
The ID of the user pool that has the risk configuration applied. -
getAccountTakeoverRiskConfiguration
The settings for automated responses and notification templates for adaptive authentication with threat protection. -
setAccountTakeoverRiskConfiguration
The settings for automated responses and notification templates for adaptive authentication with threat protection. -
setAccountTakeoverRiskConfiguration
@Stability(Stable) public void setAccountTakeoverRiskConfiguration(@Nullable CfnUserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationTypeProperty value) The settings for automated responses and notification templates for adaptive authentication with threat protection. -
getCompromisedCredentialsRiskConfiguration
Settings for compromised-credentials actions and authentication types with threat protection in full-functionENFORCED
mode. -
setCompromisedCredentialsRiskConfiguration
@Stability(Stable) public void setCompromisedCredentialsRiskConfiguration(@Nullable IResolvable value) Settings for compromised-credentials actions and authentication types with threat protection in full-functionENFORCED
mode. -
setCompromisedCredentialsRiskConfiguration
@Stability(Stable) public void setCompromisedCredentialsRiskConfiguration(@Nullable CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypeProperty value) Settings for compromised-credentials actions and authentication types with threat protection in full-functionENFORCED
mode. -
getRiskExceptionConfiguration
Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges. -
setRiskExceptionConfiguration
Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges. -
setRiskExceptionConfiguration
@Stability(Stable) public void setRiskExceptionConfiguration(@Nullable CfnUserPoolRiskConfigurationAttachment.RiskExceptionConfigurationTypeProperty value) Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.
-