Package software.amazon.awscdk.services.cognito

Interface CfnUserPoolRegionalConfigurationAttachmentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPoolRegionalConfigurationAttachmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-07-22T17:37:23.053Z")
@Stability(Stable)
public interface CfnUserPoolRegionalConfigurationAttachmentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnUserPoolRegionalConfigurationAttachment.

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.*;
 CfnUserPoolRegionalConfigurationAttachmentProps cfnUserPoolRegionalConfigurationAttachmentProps = CfnUserPoolRegionalConfigurationAttachmentProps.builder()
         .userPoolId("userPoolId")
         // the properties below are optional
         .emailConfiguration(EmailConfigurationProperty.builder()
                 .configurationSet("configurationSet")
                 .emailSendingAccount("emailSendingAccount")
                 .from("from")
                 .replyToEmailAddress("replyToEmailAddress")
                 .sourceArn("sourceArn")
                 .build())
         .lambdaConfig(LambdaConfigProperty.builder()
                 .createAuthChallenge("createAuthChallenge")
                 .customEmailSender(CustomEmailSenderProperty.builder()
                         .lambdaArn("lambdaArn")
                         .lambdaVersion("lambdaVersion")
                         .build())
                 .customMessage("customMessage")
                 .customSmsSender(CustomSMSSenderProperty.builder()
                         .lambdaArn("lambdaArn")
                         .lambdaVersion("lambdaVersion")
                         .build())
                 .defineAuthChallenge("defineAuthChallenge")
                 .inboundFederation(InboundFederationProperty.builder()
                         .lambdaArn("lambdaArn")
                         .lambdaVersion("lambdaVersion")
                         .build())
                 .kmsKeyId("kmsKeyId")
                 .postAuthentication("postAuthentication")
                 .postConfirmation("postConfirmation")
                 .preAuthentication("preAuthentication")
                 .preSignUp("preSignUp")
                 .preTokenGeneration("preTokenGeneration")
                 .preTokenGenerationConfig(PreTokenGenerationConfigProperty.builder()
                         .lambdaArn("lambdaArn")
                         .lambdaVersion("lambdaVersion")
                         .build())
                 .userMigration("userMigration")
                 .verifyAuthChallengeResponse("verifyAuthChallengeResponse")
                 .build())
         .smsConfiguration(SmsConfigurationProperty.builder()
                 .externalId("externalId")
                 .snsCallerArn("snsCallerArn")
                 .snsRegion("snsRegion")
                 .build())
         .status("status")
         .userPoolTags(Map.of(
                 "userPoolTagsKey", "userPoolTags"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolregionalconfigurationattachment.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnUserPoolRegionalConfigurationAttachmentProps.Builder	builder()
default Object	getEmailConfiguration()	Returns union: either IResolvable or CfnUserPoolRegionalConfigurationAttachment.EmailConfigurationProperty
default Object	getLambdaConfig()	Returns union: either IResolvable or CfnUserPoolRegionalConfigurationAttachment.LambdaConfigProperty
default Object	getSmsConfiguration()	Returns union: either IResolvable or CfnUserPoolRegionalConfigurationAttachment.SmsConfigurationProperty
default String	getStatus()	The status of the replica.
String	getUserPoolId()
default Map<String,String>	getUserPoolTags()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getUserPoolId

@Stability(Stable)
@NotNull
String getUserPoolId()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolregionalconfigurationattachment.html#cfn-cognito-userpoolregionalconfigurationattachment-userpoolid

getEmailConfiguration

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

Returns union: either IResolvable or CfnUserPoolRegionalConfigurationAttachment.EmailConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolregionalconfigurationattachment.html#cfn-cognito-userpoolregionalconfigurationattachment-emailconfiguration

getLambdaConfig

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

Returns union: either IResolvable or CfnUserPoolRegionalConfigurationAttachment.LambdaConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolregionalconfigurationattachment.html#cfn-cognito-userpoolregionalconfigurationattachment-lambdaconfig

getSmsConfiguration

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

Returns union: either IResolvable or CfnUserPoolRegionalConfigurationAttachment.SmsConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolregionalconfigurationattachment.html#cfn-cognito-userpoolregionalconfigurationattachment-smsconfiguration

getStatus

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

The status of the replica.

Set to ACTIVE or INACTIVE.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolregionalconfigurationattachment.html#cfn-cognito-userpoolregionalconfigurationattachment-status

getUserPoolTags

@Stability(Stable)
@Nullable
default Map<String,String> getUserPoolTags()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolregionalconfigurationattachment.html#cfn-cognito-userpoolregionalconfigurationattachment-userpooltags

builder

@Stability(Stable)
static CfnUserPoolRegionalConfigurationAttachmentProps.Builder builder()

Returns:

a CfnUserPoolRegionalConfigurationAttachmentProps.Builder of CfnUserPoolRegionalConfigurationAttachmentProps