Class CfnUserPoolUser
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.CfnUserPoolUser
- All Implemented Interfaces:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-06T23:25:06.379Z")
@Stability(Stable)
public class CfnUserPoolUser
extends CfnResource
implements IInspectable
The
AWS::Cognito::UserPoolUser
resource creates an Amazon Cognito user pool user.
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.*; CfnUserPoolUser cfnUserPoolUser = CfnUserPoolUser.Builder.create(this, "MyCfnUserPoolUser") .userPoolId("userPoolId") // the properties below are optional .clientMetadata(Map.of( "clientMetadataKey", "clientMetadata")) .desiredDeliveryMediums(List.of("desiredDeliveryMediums")) .forceAliasCreation(false) .messageAction("messageAction") .userAttributes(List.of(AttributeTypeProperty.builder() .name("name") .value("value") .build())) .username("username") .validationData(List.of(AttributeTypeProperty.builder() .name("name") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
The name and value of a user attribute.static final class
A fluent builder forCfnUserPoolUser
.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
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnUserPoolUser
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnUserPoolUser
(software.amazon.jsii.JsiiObjectRef objRef) CfnUserPoolUser
(software.constructs.Construct scope, String id, CfnUserPoolUserProps props) -
Method Summary
Modifier and TypeMethodDescriptionA map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.Specify"EMAIL"
if email will be used to send the welcome message.This parameter is used only if thephone_number_verified
oremail_verified
attribute is set toTrue
.Set toRESEND
to resend the invitation message to a user that already exists and reset the expiration limit on the user's account.An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created.The value that you want to set as the username sign-in attribute.The user pool ID for the user pool where the user will be created.Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setClientMetadata
(Map<String, String> value) A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.void
setClientMetadata
(IResolvable value) A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.void
setDesiredDeliveryMediums
(List<String> value) Specify"EMAIL"
if email will be used to send the welcome message.void
setForceAliasCreation
(Boolean value) This parameter is used only if thephone_number_verified
oremail_verified
attribute is set toTrue
.void
setForceAliasCreation
(IResolvable value) This parameter is used only if thephone_number_verified
oremail_verified
attribute is set toTrue
.void
setMessageAction
(String value) Set toRESEND
to resend the invitation message to a user that already exists and reset the expiration limit on the user's account.void
setUserAttributes
(List<Object> value) An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created.void
setUserAttributes
(IResolvable value) An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created.void
setUsername
(String value) The value that you want to set as the username sign-in attribute.void
setUserPoolId
(String value) The user pool ID for the user pool where the user will be created.void
setValidationData
(List<Object> value) Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.void
setValidationData
(IResolvable value) Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, 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
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.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnUserPoolUser
protected CfnUserPoolUser(software.amazon.jsii.JsiiObjectRef objRef) -
CfnUserPoolUser
protected CfnUserPoolUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnUserPoolUser
@Stability(Stable) public CfnUserPoolUser(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnUserPoolUserProps props) - 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
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getUserPoolId
The user pool ID for the user pool where the user will be created. -
setUserPoolId
The user pool ID for the user pool where the user will be created. -
getClientMetadata
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. -
setClientMetadata
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. -
setClientMetadata
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. -
getDesiredDeliveryMediums
Specify"EMAIL"
if email will be used to send the welcome message. -
setDesiredDeliveryMediums
Specify"EMAIL"
if email will be used to send the welcome message. -
getForceAliasCreation
This parameter is used only if thephone_number_verified
oremail_verified
attribute is set toTrue
. -
setForceAliasCreation
This parameter is used only if thephone_number_verified
oremail_verified
attribute is set toTrue
. -
setForceAliasCreation
This parameter is used only if thephone_number_verified
oremail_verified
attribute is set toTrue
. -
getMessageAction
Set toRESEND
to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. -
setMessageAction
Set toRESEND
to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. -
getUserAttributes
An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. -
setUserAttributes
An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. -
setUserAttributes
An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. -
getUsername
The value that you want to set as the username sign-in attribute. -
setUsername
The value that you want to set as the username sign-in attribute. -
getValidationData
Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. -
setValidationData
Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. -
setValidationData
Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.
-