com.pulumi.awsnative.cognito.kotlin.UserPoolUser.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-native-kotlin Show documentation
Show all versions of pulumi-aws-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.cognito.kotlin
import com.pulumi.awsnative.cognito.kotlin.outputs.UserPoolUserAttributeType
import com.pulumi.awsnative.cognito.kotlin.outputs.UserPoolUserAttributeType.Companion.toKotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
/**
* Builder for [UserPoolUser].
*/
@PulumiTagMarker
public class UserPoolUserResourceBuilder internal constructor() {
public var name: String? = null
public var args: UserPoolUserArgs = UserPoolUserArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend UserPoolUserArgsBuilder.() -> Unit) {
val builder = UserPoolUserArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): UserPoolUser {
val builtJavaResource = com.pulumi.awsnative.cognito.UserPoolUser(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return UserPoolUser(builtJavaResource)
}
}
/**
* Resource Type definition for AWS::Cognito::UserPoolUser
*/
public class UserPoolUser internal constructor(
override val javaResource: com.pulumi.awsnative.cognito.UserPoolUser,
) : KotlinCustomResource(javaResource, UserPoolUserMapper) {
/**
* 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](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) 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.
*/
public val clientMetadata: Output>?
get() = javaResource.clientMetadata().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0.key.to(args0.value) }).toMap()
}).orElse(null)
})
/**
* 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.
*/
public val desiredDeliveryMediums: Output>?
get() = javaResource.desiredDeliveryMediums().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0 })
}).orElse(null)
})
/**
* 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` .
*/
public val forceAliasCreation: Output?
get() = javaResource.forceAliasCreation().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* 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.
*/
public val messageAction: Output?
get() = javaResource.messageAction().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* An array of name-value pairs that contain user attributes and attribute values.
*/
public val userAttributes: Output>?
get() = javaResource.userAttributes().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0.let({ args0 -> toKotlin(args0) }) })
}).orElse(null)
})
/**
* The user pool ID for the user pool where the user will be created.
*/
public val userPoolId: Output
get() = javaResource.userPoolId().applyValue({ args0 -> args0 })
/**
* 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](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) .
*/
public val username: Output?
get() = javaResource.username().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* 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](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html) .
*/
public val validationData: Output>?
get() = javaResource.validationData().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0.let({ args0 -> toKotlin(args0) }) })
}).orElse(null)
})
}
public object UserPoolUserMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.awsnative.cognito.UserPoolUser::class == javaResource::class
override fun map(javaResource: Resource): UserPoolUser = UserPoolUser(
javaResource as
com.pulumi.awsnative.cognito.UserPoolUser,
)
}
/**
* @see [UserPoolUser].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [UserPoolUser].
*/
public suspend fun userPoolUser(
name: String,
block: suspend UserPoolUserResourceBuilder.() -> Unit,
): UserPoolUser {
val builder = UserPoolUserResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [UserPoolUser].
* @param name The _unique_ name of the resulting resource.
*/
public fun userPoolUser(name: String): UserPoolUser {
val builder = UserPoolUserResourceBuilder()
builder.name(name)
return builder.build()
}