Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package cloudshift.awscdk.dsl.services.cognito
import cloudshift.awscdk.common.CdkDslMarker
import cloudshift.awscdk.common.MapBuilder
import kotlin.Any
import kotlin.Boolean
import kotlin.String
import kotlin.Unit
import kotlin.collections.Collection
import kotlin.collections.MutableList
import software.amazon.awscdk.IResolvable
import software.amazon.awscdk.services.cognito.CfnUserPoolUser
import software.constructs.Construct
/**
* 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.*;
* Object clientMetadata;
* CfnUserPoolUser cfnUserPoolUser = CfnUserPoolUser.Builder.create(this, "MyCfnUserPoolUser")
* .userPoolId("userPoolId")
* // the properties below are optional
* .clientMetadata(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();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html)
*/
@CdkDslMarker
public class CfnUserPoolUserDsl(
scope: Construct,
id: String,
) {
private val cdkBuilder: CfnUserPoolUser.Builder = CfnUserPoolUser.Builder.create(scope, id)
private val _desiredDeliveryMediums: MutableList = mutableListOf()
private val _userAttributes: MutableList = mutableListOf()
private val _validationData: MutableList = mutableListOf()
/**
* A map of custom key-value pairs that you can provide as input for the custom workflow that is
* invoked by the *pre sign-up* trigger.
*
* You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you
* create a `UserPoolUser` resource and include the `ClientMetadata` property, 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
* property. 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](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html)
* in the *Amazon Cognito Developer Guide* .
*
*
* Take the following limitations into consideration when you use the ClientMetadata parameter:
*
* * Amazon Cognito does not 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 does not include triggers, the ClientMetadata parameter serves no purpose.
* * Amazon Cognito does not validate the ClientMetadata value.
* * Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide
* sensitive information.
*
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-clientmetadata)
* @param clientMetadata A map of custom key-value pairs that you can provide as input for the
* custom workflow that is invoked by the *pre sign-up* trigger.
*/
public fun clientMetadata(clientMetadata: MapBuilder.() -> Unit = {}) {
val builder = MapBuilder()
builder.apply(clientMetadata)
cdkBuilder.clientMetadata(builder.map)
}
/**
* A map of custom key-value pairs that you can provide as input for the custom workflow that is
* invoked by the *pre sign-up* trigger.
*
* You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you
* create a `UserPoolUser` resource and include the `ClientMetadata` property, 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
* property. 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](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html)
* in the *Amazon Cognito Developer Guide* .
*
*
* Take the following limitations into consideration when you use the ClientMetadata parameter:
*
* * Amazon Cognito does not 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 does not include triggers, the ClientMetadata parameter serves no purpose.
* * Amazon Cognito does not validate the ClientMetadata value.
* * Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide
* sensitive information.
*
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-clientmetadata)
* @param clientMetadata A map of custom key-value pairs that you can provide as input for the
* custom workflow that is invoked by the *pre sign-up* trigger.
*/
public fun clientMetadata(clientMetadata: Any) {
cdkBuilder.clientMetadata(clientMetadata)
}
/**
* 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.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-desireddeliverymediums)
* @param desiredDeliveryMediums Specify `"EMAIL"` if email will be used to send the welcome
* message.
*/
public fun desiredDeliveryMediums(vararg desiredDeliveryMediums: String) {
_desiredDeliveryMediums.addAll(listOf(*desiredDeliveryMediums))
}
/**
* 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.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-desireddeliverymediums)
* @param desiredDeliveryMediums Specify `"EMAIL"` if email will be used to send the welcome
* message.
*/
public fun desiredDeliveryMediums(desiredDeliveryMediums: Collection) {
_desiredDeliveryMediums.addAll(desiredDeliveryMediums)
}
/**
* 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` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-forcealiascreation)
* @param forceAliasCreation This parameter is used only if the `phone_number_verified` or
* `email_verified` attribute is set to `True` .
*/
public fun forceAliasCreation(forceAliasCreation: Boolean) {
cdkBuilder.forceAliasCreation(forceAliasCreation)
}
/**
* 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` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-forcealiascreation)
* @param forceAliasCreation This parameter is used only if the `phone_number_verified` or
* `email_verified` attribute is set to `True` .
*/
public fun forceAliasCreation(forceAliasCreation: IResolvable) {
cdkBuilder.forceAliasCreation(forceAliasCreation)
}
/**
* 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.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-messageaction)
* @param messageAction Set to `RESEND` to resend the invitation message to a user that already
* exists and reset the expiration limit on the user's account.
*/
public fun messageAction(messageAction: String) {
cdkBuilder.messageAction(messageAction)
}
/**
* The user attributes and attribute values to be set for the user to be created.
*
* These are name-value pairs You can create a user without specifying any attributes other than
* `Username` . However, any attributes that you specify as required (in
* [](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html)
* or in the *Attributes* tab of the console) must be supplied either by you (in your call to
* `AdminCreateUser` ) or by the user (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. This can be done 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
* [](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html)
* .)
*
* * *email* : The email address of the user to whom the message that contains the code and user
* name 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
* user name will be sent. Required if the `phone_number_verified` attribute is set to `True` , or if
* `"SMS"` is specified in the `DesiredDeliveryMediums` parameter.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-userattributes)
* @param userAttributes The user attributes and attribute values to be set for the user to be
* created.
*/
public fun userAttributes(vararg userAttributes: Any) {
_userAttributes.addAll(listOf(*userAttributes))
}
/**
* The user attributes and attribute values to be set for the user to be created.
*
* These are name-value pairs You can create a user without specifying any attributes other than
* `Username` . However, any attributes that you specify as required (in
* [](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html)
* or in the *Attributes* tab of the console) must be supplied either by you (in your call to
* `AdminCreateUser` ) or by the user (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. This can be done 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
* [](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html)
* .)
*
* * *email* : The email address of the user to whom the message that contains the code and user
* name 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
* user name will be sent. Required if the `phone_number_verified` attribute is set to `True` , or if
* `"SMS"` is specified in the `DesiredDeliveryMediums` parameter.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-userattributes)
* @param userAttributes The user attributes and attribute values to be set for the user to be
* created.
*/
public fun userAttributes(userAttributes: Collection) {
_userAttributes.addAll(userAttributes)
}
/**
* The user attributes and attribute values to be set for the user to be created.
*
* These are name-value pairs You can create a user without specifying any attributes other than
* `Username` . However, any attributes that you specify as required (in
* [](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html)
* or in the *Attributes* tab of the console) must be supplied either by you (in your call to
* `AdminCreateUser` ) or by the user (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. This can be done 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
* [](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html)
* .)
*
* * *email* : The email address of the user to whom the message that contains the code and user
* name 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
* user name will be sent. Required if the `phone_number_verified` attribute is set to `True` , or if
* `"SMS"` is specified in the `DesiredDeliveryMediums` parameter.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-userattributes)
* @param userAttributes The user attributes and attribute values to be set for the user to be
* created.
*/
public fun userAttributes(userAttributes: IResolvable) {
cdkBuilder.userAttributes(userAttributes)
}
/**
* The user pool ID for the user pool where the user will be created.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-userpoolid)
* @param userPoolId The user pool ID for the user pool where the user will be created.
*/
public fun userPoolId(userPoolId: String) {
cdkBuilder.userPoolId(userPoolId)
}
/**
* The username for the user.
*
* Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After
* the user is created, the username can't be changed.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-username)
* @param username The username for the user.
*/
public fun username(username: String) {
cdkBuilder.username(username)
}
/**
* The user's validation data.
*
* This is an array of name-value pairs that contain user attributes and attribute values that you
* can use for custom validation, such as restricting the types of user accounts that can be
* registered. For example, you might choose to allow or disallow user sign-up based on the user's
* domain.
*
* To configure custom validation, you must create a Pre Sign-up AWS Lambda trigger for the user
* pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the
* validation data and uses it in the validation process.
*
* The user's validation data isn't persisted.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-validationdata)
* @param validationData The user's validation data.
*/
public fun validationData(vararg validationData: Any) {
_validationData.addAll(listOf(*validationData))
}
/**
* The user's validation data.
*
* This is an array of name-value pairs that contain user attributes and attribute values that you
* can use for custom validation, such as restricting the types of user accounts that can be
* registered. For example, you might choose to allow or disallow user sign-up based on the user's
* domain.
*
* To configure custom validation, you must create a Pre Sign-up AWS Lambda trigger for the user
* pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the
* validation data and uses it in the validation process.
*
* The user's validation data isn't persisted.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-validationdata)
* @param validationData The user's validation data.
*/
public fun validationData(validationData: Collection) {
_validationData.addAll(validationData)
}
/**
* The user's validation data.
*
* This is an array of name-value pairs that contain user attributes and attribute values that you
* can use for custom validation, such as restricting the types of user accounts that can be
* registered. For example, you might choose to allow or disallow user sign-up based on the user's
* domain.
*
* To configure custom validation, you must create a Pre Sign-up AWS Lambda trigger for the user
* pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the
* validation data and uses it in the validation process.
*
* The user's validation data isn't persisted.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-validationdata)
* @param validationData The user's validation data.
*/
public fun validationData(validationData: IResolvable) {
cdkBuilder.validationData(validationData)
}
public fun build(): CfnUserPoolUser {
if(_desiredDeliveryMediums.isNotEmpty())
cdkBuilder.desiredDeliveryMediums(_desiredDeliveryMediums)
if(_userAttributes.isNotEmpty()) cdkBuilder.userAttributes(_userAttributes)
if(_validationData.isNotEmpty()) cdkBuilder.validationData(_validationData)
return cdkBuilder.build()
}
}
