Package software.amazon.awscdk.services.cognito

Interface CfnUserPool.UserPoolAddOnsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPool.UserPoolAddOnsProperty.Jsii$Proxy

Enclosing class:

CfnUserPool

@Stability(Stable)
public static interface CfnUserPool.UserPoolAddOnsProperty
extends software.amazon.jsii.JsiiSerializable

Contains settings for activation of threat protection, including the operating mode and additional authentication types.

To log user security information but take no action, set to AUDIT . To configure automatic security responses to potentially unwanted traffic to your user pool, set to ENFORCED .

For more information, see Adding advanced security to a user pool . To activate this setting, your user pool must be on the Plus tier .

This data type is a request and response parameter of API_CreateUserPool and API_UpdateUserPool , and a response parameter of API_DescribeUserPool .

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.*;
 UserPoolAddOnsProperty userPoolAddOnsProperty = UserPoolAddOnsProperty.builder()
         .advancedSecurityAdditionalFlows(AdvancedSecurityAdditionalFlowsProperty.builder()
                 .customAuthMode("customAuthMode")
                 .build())
         .advancedSecurityMode("advancedSecurityMode")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userpooladdons.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPool.UserPoolAddOnsProperty.Builder	A builder for CfnUserPool.UserPoolAddOnsProperty
static final class	CfnUserPool.UserPoolAddOnsProperty.Jsii$Proxy	An implementation for CfnUserPool.UserPoolAddOnsProperty

Method Summary

Modifier and Type	Method	Description
static CfnUserPool.UserPoolAddOnsProperty.Builder	builder()
default Object	getAdvancedSecurityAdditionalFlows()	Threat protection configuration options for additional authentication types in your user pool, including custom authentication.
default String	getAdvancedSecurityMode()	The operating mode of threat protection for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAdvancedSecurityAdditionalFlows

@Stability(Stable)
@Nullable
default Object getAdvancedSecurityAdditionalFlows()

Threat protection configuration options for additional authentication types in your user pool, including custom authentication.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userpooladdons.html#cfn-cognito-userpool-userpooladdons-advancedsecurityadditionalflows

getAdvancedSecurityMode

@Stability(Stable)
@Nullable
default String getAdvancedSecurityMode()

The operating mode of threat protection for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userpooladdons.html#cfn-cognito-userpool-userpooladdons-advancedsecuritymode

builder

@Stability(Stable)
static CfnUserPool.UserPoolAddOnsProperty.Builder builder()

Returns:

a CfnUserPool.UserPoolAddOnsProperty.Builder of CfnUserPool.UserPoolAddOnsProperty