Skip to content
v2.276.0

UserPoolAddOnsProperty Struct ​

User pool add-ons.

Contains settings for activation of threat protection. To log user security information but take no action, set to AUDIT . To configure automatic security responses to risky 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 .

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const userPoolAddOnsProperty: cognito.CfnUserPool.UserPoolAddOnsProperty = {
  advancedSecurityAdditionalFlows: {
    customAuthMode: 'customAuthMode',
  },
  advancedSecurityMode: 'advancedSecurityMode',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cognito as cognito

user_pool_add_ons_property = cognito.CfnUserPool.UserPoolAddOnsProperty(
    advanced_security_additional_flows=cognito.CfnUserPool.AdvancedSecurityAdditionalFlowsProperty(
        custom_auth_mode="customAuthMode"
    ),
    advanced_security_mode="advancedSecurityMode"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;

var userPoolAddOnsProperty = new UserPoolAddOnsProperty {
    AdvancedSecurityAdditionalFlows = new AdvancedSecurityAdditionalFlowsProperty {
        CustomAuthMode = "customAuthMode"
    },
    AdvancedSecurityMode = "advancedSecurityMode"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

userPoolAddOnsProperty := &UserPoolAddOnsProperty{
	AdvancedSecurityAdditionalFlows: &AdvancedSecurityAdditionalFlowsProperty{
		CustomAuthMode: jsii.String("customAuthMode"),
	},
	AdvancedSecurityMode: jsii.String("advancedSecurityMode"),
}

Properties ​

advancedSecurityAdditionalFlowsoptionalIResolvable | CfnUserPool.AdvancedSecurityAdditionalFlowsPropertyadvanced_security_additional_flowsoptionaltyping.Union[IResolvable, AdvancedSecurityAdditionalFlowsProperty]advancedSecurityAdditionalFlowsoptionalIResolvableAdvancedSecurityAdditionalFlowsoptionalIResolvableAdvancedSecurityAdditionalFlowsoptionalinterface{}#
Threat protection configuration options for additional authentication types in your user pool, including custom authentication.
advancedSecurityModeoptionalstringadvanced_security_modeoptionalstradvancedSecurityModeoptionalStringAdvancedSecurityModeoptionalstringAdvancedSecurityModeoptional*string#
The operating mode of threat protection for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.