Package software.amazon.awscdk.services.cognito

Class CfnUserPoolUserProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cognito.CfnUserPoolUserProps.Jsii$Proxy

All Implemented Interfaces:

CfnUserPoolUserProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnUserPoolUserProps

@Stability(Stable)
@Internal
public static final class CfnUserPoolUserProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnUserPoolUserProps

An implementation for CfnUserPoolUserProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

CfnUserPoolUserProps.Builder, CfnUserPoolUserProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnUserPoolUserProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnUserPoolUserProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getClientMetadata()	A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
final List<String>	getDesiredDeliveryMediums()	Specify "EMAIL" if email will be used to send the welcome message.
final Object	getForceAliasCreation()	This parameter is used only if the phone_number_verified or email_verified attribute is set to True .
final String	getMessageAction()	Set to RESEND to resend the invitation message to a user that already exists and reset the expiration limit on the user's account.
final Object	getUserAttributes()	An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created.
final String	getUsername()	The value that you want to set as the username sign-in attribute.
final String	getUserPoolId()	The user pool ID for the user pool where the user will be created.
final Object	getValidationData()	Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.
final int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnUserPoolUserProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnUserPoolUserProps.Builder.

Method Details

getUserPoolId

public final String getUserPoolId()

Description copied from interface: CfnUserPoolUserProps

The user pool ID for the user pool where the user will be created.

Specified by:

getUserPoolId in interface CfnUserPoolUserProps

See Also:

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

getClientMetadata

public final Object getClientMetadata()

Description copied from interface: CfnUserPoolUserProps

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide .

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
• Validate the ClientMetadata value.
• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

Specified by:

getClientMetadata in interface CfnUserPoolUserProps

See Also:

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

getDesiredDeliveryMediums

public final List<String> getDesiredDeliveryMediums()

Description copied from interface: CfnUserPoolUserProps

Specify "EMAIL" if email will be used to send the welcome message.

Specify "SMS" if the phone number will be used. The default value is "SMS" . You can specify more than one value.

Specified by:

getDesiredDeliveryMediums in interface CfnUserPoolUserProps

See Also:

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

getForceAliasCreation

public final Object getForceAliasCreation()

Description copied from interface: CfnUserPoolUserProps

This parameter is used only if the phone_number_verified or email_verified attribute is set to True .

Otherwise, it is ignored.

If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.

If this parameter is set to False , the API throws an AliasExistsException error if the alias already exists. The default value is False .

Specified by:

getForceAliasCreation in interface CfnUserPoolUserProps

See Also:

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

getMessageAction

public final String getMessageAction()

Description copied from interface: CfnUserPoolUserProps

Set to RESEND to resend the invitation message to a user that already exists and reset the expiration limit on the user's account.

Set to SUPPRESS to suppress sending the message. You can specify only one value.

Specified by:

getMessageAction in interface CfnUserPoolUserProps

See Also:

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

getUserAttributes

public final Object getUserAttributes()

Description copied from interface: CfnUserPoolUserProps

An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created.

You can create a user without specifying any attributes other than Username . However, any attributes that you specify as required (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to AdminCreateUser ) or the user should supply (when they sign up in response to your welcome message).

For custom attributes, you must prepend the custom: prefix to the attribute name.

To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.

In your call to AdminCreateUser , you can set the email_verified attribute to True , and you can set the phone_number_verified attribute to True . You can also do this by calling AdminUpdateUserAttributes .

• email : The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True , or if "EMAIL" is specified in the DesiredDeliveryMediums parameter.
• phone_number : The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True , or if "SMS" is specified in the DesiredDeliveryMediums parameter.

Specified by:

getUserAttributes in interface CfnUserPoolUserProps

See Also:

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

getUsername

public final String getUsername()

Description copied from interface: CfnUserPoolUserProps

The value that you want to set as the username sign-in attribute.

The following conditions apply to the username parameter.

• The username can't be a duplicate of another username in the same user pool.
• You can't change the value of a username after you create it.
• You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see Customizing sign-in attributes .

Specified by:

getUsername in interface CfnUserPoolUserProps

See Also:

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

getValidationData

public final Object getValidationData()

Description copied from interface: CfnUserPoolUserProps

Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.

This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.

Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.

For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger .

Specified by:

getValidationData in interface CfnUserPoolUserProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object