Package software.amazon.awscdk.services.cognito

Class CfnUserPoolReplica

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

All Implemented Interfaces:

IInspectable, IUserPoolReplicaRef, 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.054Z")
@Stability(Stable)
public class CfnUserPoolReplica
extends CfnResource
implements IInspectable, IUserPoolReplicaRef, ITaggableV2

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

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.*;
 CfnUserPoolReplica cfnUserPoolReplica = CfnUserPoolReplica.Builder.create(this, "MyCfnUserPoolReplica")
         .regionName("regionName")
         .userPoolId("userPoolId")
         // the properties below are optional
         .userPoolTagsAtCreate(Map.of(
                 "userPoolTagsAtCreateKey", "userPoolTagsAtCreate"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnUserPoolReplica.Builder	A fluent builder for CfnUserPoolReplica.

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

IUserPoolReplicaRef.Jsii$Default, IUserPoolReplicaRef.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	CfnUserPoolReplica(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUserPoolReplica(software.amazon.jsii.JsiiObjectRef objRef)
	CfnUserPoolReplica(software.constructs.Construct scope, String id, CfnUserPoolReplicaProps props)	Create a new AWS::Cognito::UserPoolReplica.

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()
String	getRegionName()
String	getUserPoolId()
UserPoolReplicaReference	getUserPoolReplicaRef()	A reference to a UserPoolReplica resource.
Map<String,String>	getUserPoolTagsAtCreate()
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnUserPoolReplica(Object x)	Checks whether the given object is a CfnUserPoolReplica.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setRegionName(String value)
void	setUserPoolId(String value)
void	setUserPoolTagsAtCreate(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

CfnUserPoolReplica

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

CfnUserPoolReplica

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

CfnUserPoolReplica

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

Create a new AWS::Cognito::UserPoolReplica.

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

isCfnUserPoolReplica

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

Checks whether the given object is a CfnUserPoolReplica.

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

getUserPoolReplicaRef

@Stability(Stable)
@NotNull
public UserPoolReplicaReference getUserPoolReplicaRef()

A reference to a UserPoolReplica resource.

Specified by:

getUserPoolReplicaRef in interface IUserPoolReplicaRef

getRegionName

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

setRegionName

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

getUserPoolId

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

setUserPoolId

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

getUserPoolTagsAtCreate

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

setUserPoolTagsAtCreate

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