Package software.amazon.awscdk.services.cognito

Class CfnUserPoolRegionalConfigurationAttachment

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.CfnUserPoolRegionalConfigurationAttachment

All Implemented Interfaces:

IInspectable, IUserPoolRegionalConfigurationAttachmentRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-07-22T17:37:23.050Z")
@Stability(Stable)
public class CfnUserPoolRegionalConfigurationAttachment
extends CfnResource
implements IInspectable, IUserPoolRegionalConfigurationAttachmentRef, ITaggableV2

Resource Type definition for AWS::Cognito::UserPoolRegionalConfigurationAttachment.

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.*;
 CfnUserPoolRegionalConfigurationAttachment cfnUserPoolRegionalConfigurationAttachment = CfnUserPoolRegionalConfigurationAttachment.Builder.create(this, "MyCfnUserPoolRegionalConfigurationAttachment")
         .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	Class	Description
static final class	CfnUserPoolRegionalConfigurationAttachment.Builder	A fluent builder for CfnUserPoolRegionalConfigurationAttachment.
static interface	CfnUserPoolRegionalConfigurationAttachment.CustomEmailSenderProperty	Example:
static interface	CfnUserPoolRegionalConfigurationAttachment.CustomSMSSenderProperty	Example:
static interface	CfnUserPoolRegionalConfigurationAttachment.EmailConfigurationProperty	Example:
static interface	CfnUserPoolRegionalConfigurationAttachment.InboundFederationProperty	Example:
static interface	CfnUserPoolRegionalConfigurationAttachment.LambdaConfigProperty	Example:
static interface	CfnUserPoolRegionalConfigurationAttachment.PreTokenGenerationConfigProperty	Example:
static interface	CfnUserPoolRegionalConfigurationAttachment.SmsConfigurationProperty	Example:

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.cognito.IUserPoolRegionalConfigurationAttachmentRef

IUserPoolRegionalConfigurationAttachmentRef.Jsii$Default, IUserPoolRegionalConfigurationAttachmentRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnUserPoolRegionalConfigurationAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUserPoolRegionalConfigurationAttachment(software.amazon.jsii.JsiiObjectRef objRef)
	CfnUserPoolRegionalConfigurationAttachment(software.constructs.Construct scope, String id, CfnUserPoolRegionalConfigurationAttachmentProps props)	Create a new AWS::Cognito::UserPoolRegionalConfigurationAttachment.

Method Summary

Modifier and Type	Method	Description
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
protected Map<String,String>	getCfnPropertyNames()
Object	getEmailConfiguration()	Returns union: either IResolvable or CfnUserPoolRegionalConfigurationAttachment.EmailConfigurationProperty
Object	getLambdaConfig()	Returns union: either IResolvable or CfnUserPoolRegionalConfigurationAttachment.LambdaConfigProperty
Object	getSmsConfiguration()	Returns union: either IResolvable or CfnUserPoolRegionalConfigurationAttachment.SmsConfigurationProperty
String	getStatus()	The status of the replica.
String	getUserPoolId()
UserPoolRegionalConfigurationAttachmentReference	getUserPoolRegionalConfigurationAttachmentRef()	A reference to a UserPoolRegionalConfigurationAttachment resource.
Map<String,String>	getUserPoolTags()
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnUserPoolRegionalConfigurationAttachment(Object x)	Checks whether the given object is a CfnUserPoolRegionalConfigurationAttachment.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setEmailConfiguration(IResolvable value)
void	setEmailConfiguration(CfnUserPoolRegionalConfigurationAttachment.EmailConfigurationProperty value)
void	setLambdaConfig(IResolvable value)
void	setLambdaConfig(CfnUserPoolRegionalConfigurationAttachment.LambdaConfigProperty value)
void	setSmsConfiguration(IResolvable value)
void	setSmsConfiguration(CfnUserPoolRegionalConfigurationAttachment.SmsConfigurationProperty value)
void	setStatus(String value)	The status of the replica.
void	setUserPoolId(String value)
void	setUserPoolTags(Map<String,String> value)

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, addResourceDependency, addResourceDependency, applyCrossStackReferenceStrength, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, cfnPropertyName, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, removeDependency, removeResourceDependency, 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, with

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.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnUserPoolRegionalConfigurationAttachment

protected CfnUserPoolRegionalConfigurationAttachment(software.amazon.jsii.JsiiObjectRef objRef)

CfnUserPoolRegionalConfigurationAttachment

protected CfnUserPoolRegionalConfigurationAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnUserPoolRegionalConfigurationAttachment

@Stability(Stable)
public CfnUserPoolRegionalConfigurationAttachment(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnUserPoolRegionalConfigurationAttachmentProps props)

Create a new AWS::Cognito::UserPoolRegionalConfigurationAttachment.

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

isCfnUserPoolRegionalConfigurationAttachment

@Stability(Stable)
@NotNull
public static Boolean isCfnUserPoolRegionalConfigurationAttachment(@NotNull
 Object x)

Checks whether the given object is a CfnUserPoolRegionalConfigurationAttachment.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

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 class CfnResource

Parameters:

props - This parameter is required.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCfnPropertyNames

@Stability(Stable)
@NotNull
protected Map<String,String> getCfnPropertyNames()

Overrides:

getCfnPropertyNames in class CfnResource

getUserPoolRegionalConfigurationAttachmentRef

@Stability(Stable)
@NotNull
public UserPoolRegionalConfigurationAttachmentReference getUserPoolRegionalConfigurationAttachmentRef()

A reference to a UserPoolRegionalConfigurationAttachment resource.

Specified by:

getUserPoolRegionalConfigurationAttachmentRef in interface IUserPoolRegionalConfigurationAttachmentRef

getUserPoolId

@Stability(Stable)
@NotNull
public String getUserPoolId()

setUserPoolId

@Stability(Stable)
public void setUserPoolId(@NotNull
 String value)

getEmailConfiguration

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

Returns union: either IResolvable or CfnUserPoolRegionalConfigurationAttachment.EmailConfigurationProperty

setEmailConfiguration

@Stability(Stable)
public void setEmailConfiguration(@Nullable
 IResolvable value)

setEmailConfiguration

@Stability(Stable)
public void setEmailConfiguration(@Nullable
 CfnUserPoolRegionalConfigurationAttachment.EmailConfigurationProperty value)

getLambdaConfig

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

Returns union: either IResolvable or CfnUserPoolRegionalConfigurationAttachment.LambdaConfigProperty

setLambdaConfig

@Stability(Stable)
public void setLambdaConfig(@Nullable
 IResolvable value)

setLambdaConfig

@Stability(Stable)
public void setLambdaConfig(@Nullable
 CfnUserPoolRegionalConfigurationAttachment.LambdaConfigProperty value)

getSmsConfiguration

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

Returns union: either IResolvable or CfnUserPoolRegionalConfigurationAttachment.SmsConfigurationProperty

setSmsConfiguration

@Stability(Stable)
public void setSmsConfiguration(@Nullable
 IResolvable value)

setSmsConfiguration

@Stability(Stable)
public void setSmsConfiguration(@Nullable
 CfnUserPoolRegionalConfigurationAttachment.SmsConfigurationProperty value)

getStatus

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

The status of the replica.

setStatus

@Stability(Stable)
public void setStatus(@Nullable
 String value)

The status of the replica.

getUserPoolTags

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

setUserPoolTags

@Stability(Stable)
public void setUserPoolTags(@Nullable
 Map<String,String> value)