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("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.cognito.kotlin
import com.pulumi.awsnative.cognito.UserPoolClientArgs.builder
import com.pulumi.awsnative.cognito.kotlin.inputs.UserPoolClientAnalyticsConfigurationArgs
import com.pulumi.awsnative.cognito.kotlin.inputs.UserPoolClientAnalyticsConfigurationArgsBuilder
import com.pulumi.awsnative.cognito.kotlin.inputs.UserPoolClientTokenValidityUnitsArgs
import com.pulumi.awsnative.cognito.kotlin.inputs.UserPoolClientTokenValidityUnitsArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* Resource Type definition for AWS::Cognito::UserPoolClient
* @property accessTokenValidity The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for `AccessTokenValidity` as `seconds` , `minutes` , `hours` , or `days` , set a `TokenValidityUnits` value in your API request.
* For example, when you set `AccessTokenValidity` to `10` and `TokenValidityUnits` to `hours` , your user can authorize access with their access token for 10 hours.
* The default time unit for `AccessTokenValidity` in an API request is hours.
* @property allowedOAuthFlows The OAuth grant types that you want your app client to generate. To create an app client that generates client credentials grants, you must add `client_credentials` as the only allowed OAuth flow.
* - **code** - Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the `/oauth2/token` endpoint.
* - **implicit** - Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
* - **client_credentials** - Issue the access token from the `/oauth2/token` endpoint directly to a non-person user using a combination of the client ID and client secret.
* @property allowedOAuthFlowsUserPoolClient Set to `true` to use OAuth 2.0 features in your user pool app client.
* `AllowedOAuthFlowsUserPoolClient` must be `true` before you can configure the following features in your app client.
* - `CallBackURLs` : Callback URLs.
* - `LogoutURLs` : Sign-out redirect URLs.
* - `AllowedOAuthScopes` : OAuth 2.0 scopes.
* - `AllowedOAuthFlows` : Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
* To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set `AllowedOAuthFlowsUserPoolClient` to `true` in a `CreateUserPoolClient` or `UpdateUserPoolClient` API request. If you don't set a value for `AllowedOAuthFlowsUserPoolClient` in a request with the AWS CLI or SDKs, it defaults to `false` .
* @property allowedOAuthScopes The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported.
* @property analyticsConfiguration The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
* > In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
* @property authSessionValidity Amazon Cognito creates a session token for each API request in an authentication flow. `AuthSessionValidity` is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
* @property callbackUrls A list of allowed redirect (callback) URLs for the IdPs.
* A redirect URI must:
* - Be an absolute URI.
* - Be registered with the authorization server.
* - Not include a fragment component.
* See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) .
* Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
* App callback URLs such as myapp://example are also supported.
* @property clientName The client name for the user pool client you would like to create.
* @property defaultRedirectUri The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list.
* A redirect URI must:
* - Be an absolute URI.
* - Be registered with the authorization server.
* - Not include a fragment component.
* For more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) .
* Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
* App callback URLs such as myapp://example are also supported.
* @property enablePropagateAdditionalUserContextData Activates the propagation of additional user context data. For more information about propagation of user context data, see [Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html) . If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate `EnablePropagateAdditionalUserContextData` in an app client that has a client secret.
* @property enableTokenRevocation Activates or deactivates token revocation. For more information about revoking tokens, see [RevokeToken](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html) .
* If you don't include this parameter, token revocation is automatically activated for the new user pool client.
* @property explicitAuthFlows The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
* > If you don't specify a value for `ExplicitAuthFlows` , your user client supports `ALLOW_REFRESH_TOKEN_AUTH` , `ALLOW_USER_SRP_AUTH` , and `ALLOW_CUSTOM_AUTH` .
* Valid values include:
* - `ALLOW_ADMIN_USER_PASSWORD_AUTH` : Enable admin based user password authentication flow `ADMIN_USER_PASSWORD_AUTH` . This setting replaces the `ADMIN_NO_SRP_AUTH` setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
* - `ALLOW_CUSTOM_AUTH` : Enable Lambda trigger based authentication.
* - `ALLOW_USER_PASSWORD_AUTH` : Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
* - `ALLOW_USER_SRP_AUTH` : Enable SRP-based authentication.
* - `ALLOW_REFRESH_TOKEN_AUTH` : Enable authflow to refresh tokens.
* In some environments, you will see the values `ADMIN_NO_SRP_AUTH` , `CUSTOM_AUTH_FLOW_ONLY` , or `USER_PASSWORD_AUTH` . You can't assign these legacy `ExplicitAuthFlows` values to user pool clients at the same time as values that begin with `ALLOW_` ,
* like `ALLOW_USER_SRP_AUTH` .
* @property generateSecret Boolean to specify whether you want to generate a secret for the user pool client being created.
* @property idTokenValidity The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for `IdTokenValidity` as `seconds` , `minutes` , `hours` , or `days` , set a `TokenValidityUnits` value in your API request.
* For example, when you set `IdTokenValidity` as `10` and `TokenValidityUnits` as `hours` , your user can authenticate their session with their ID token for 10 hours.
* The default time unit for `IdTokenValidity` in an API request is hours.
* @property logoutUrls A list of allowed logout URLs for the IdPs.
* @property preventUserExistenceErrors Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to `ENABLED` and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to `LEGACY` , those APIs will return a `UserNotFoundException` exception if the user does not exist in the user pool.
* @property readAttributes The list of user attributes that you want your app client to have read access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a [GetUser](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUser.html) API request to retrieve and display your user's profile data.
* When you don't specify the `ReadAttributes` for your app client, your app can read the values of `email_verified` , `phone_number_verified` , and the Standard attributes of your user pool. When your user pool app client has read access to these default attributes, `ReadAttributes` doesn't return any information. Amazon Cognito only populates `ReadAttributes` in the API response if you have specified your own custom set of read attributes.
* @property refreshTokenValidity The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for `RefreshTokenValidity` as `seconds` , `minutes` , `hours` , or `days` , set a `TokenValidityUnits` value in your API request.
* For example, when you set `RefreshTokenValidity` as `10` and `TokenValidityUnits` as `days` , your user can refresh their session and retrieve new access and ID tokens for 10 days.
* The default time unit for `RefreshTokenValidity` in an API request is days. You can't set `RefreshTokenValidity` to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days.
* @property supportedIdentityProviders A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` .
* @property tokenValidityUnits The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
* @property userPoolId The user pool ID for the user pool where you want to create a user pool client.
* @property writeAttributes The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an [UpdateUserAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html) API request and sets `family_name` to the new value.
* When you don't specify the `WriteAttributes` for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, `WriteAttributes` doesn't return any information. Amazon Cognito only populates `WriteAttributes` in the API response if you have specified your own custom set of write attributes.
* If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see [Specifying IdP Attribute Mappings for Your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html) .
*/
public data class UserPoolClientArgs(
public val accessTokenValidity: Output? = null,
public val allowedOAuthFlows: Output>? = null,
public val allowedOAuthFlowsUserPoolClient: Output? = null,
public val allowedOAuthScopes: Output>? = null,
public val analyticsConfiguration: Output? = null,
public val authSessionValidity: Output? = null,
public val callbackUrls: Output>? = null,
public val clientName: Output? = null,
public val defaultRedirectUri: Output? = null,
public val enablePropagateAdditionalUserContextData: Output? = null,
public val enableTokenRevocation: Output? = null,
public val explicitAuthFlows: Output>? = null,
public val generateSecret: Output? = null,
public val idTokenValidity: Output? = null,
public val logoutUrls: Output>? = null,
public val preventUserExistenceErrors: Output? = null,
public val readAttributes: Output>? = null,
public val refreshTokenValidity: Output? = null,
public val supportedIdentityProviders: Output>? = null,
public val tokenValidityUnits: Output? = null,
public val userPoolId: Output? = null,
public val writeAttributes: Output>? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.awsnative.cognito.UserPoolClientArgs =
com.pulumi.awsnative.cognito.UserPoolClientArgs.builder()
.accessTokenValidity(accessTokenValidity?.applyValue({ args0 -> args0 }))
.allowedOAuthFlows(allowedOAuthFlows?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.allowedOAuthFlowsUserPoolClient(allowedOAuthFlowsUserPoolClient?.applyValue({ args0 -> args0 }))
.allowedOAuthScopes(allowedOAuthScopes?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.analyticsConfiguration(
analyticsConfiguration?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.authSessionValidity(authSessionValidity?.applyValue({ args0 -> args0 }))
.callbackUrls(callbackUrls?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.clientName(clientName?.applyValue({ args0 -> args0 }))
.defaultRedirectUri(defaultRedirectUri?.applyValue({ args0 -> args0 }))
.enablePropagateAdditionalUserContextData(
enablePropagateAdditionalUserContextData?.applyValue({ args0 ->
args0
}),
)
.enableTokenRevocation(enableTokenRevocation?.applyValue({ args0 -> args0 }))
.explicitAuthFlows(explicitAuthFlows?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.generateSecret(generateSecret?.applyValue({ args0 -> args0 }))
.idTokenValidity(idTokenValidity?.applyValue({ args0 -> args0 }))
.logoutUrls(logoutUrls?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.preventUserExistenceErrors(preventUserExistenceErrors?.applyValue({ args0 -> args0 }))
.readAttributes(readAttributes?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.refreshTokenValidity(refreshTokenValidity?.applyValue({ args0 -> args0 }))
.supportedIdentityProviders(
supportedIdentityProviders?.applyValue({ args0 ->
args0.map({ args0 ->
args0
})
}),
)
.tokenValidityUnits(
tokenValidityUnits?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.userPoolId(userPoolId?.applyValue({ args0 -> args0 }))
.writeAttributes(writeAttributes?.applyValue({ args0 -> args0.map({ args0 -> args0 }) })).build()
}
/**
* Builder for [UserPoolClientArgs].
*/
@PulumiTagMarker
public class UserPoolClientArgsBuilder internal constructor() {
private var accessTokenValidity: Output? = null
private var allowedOAuthFlows: Output>? = null
private var allowedOAuthFlowsUserPoolClient: Output? = null
private var allowedOAuthScopes: Output>? = null
private var analyticsConfiguration: Output? = null
private var authSessionValidity: Output? = null
private var callbackUrls: Output>? = null
private var clientName: Output? = null
private var defaultRedirectUri: Output? = null
private var enablePropagateAdditionalUserContextData: Output? = null
private var enableTokenRevocation: Output? = null
private var explicitAuthFlows: Output>? = null
private var generateSecret: Output? = null
private var idTokenValidity: Output? = null
private var logoutUrls: Output>? = null
private var preventUserExistenceErrors: Output? = null
private var readAttributes: Output>? = null
private var refreshTokenValidity: Output? = null
private var supportedIdentityProviders: Output>? = null
private var tokenValidityUnits: Output? = null
private var userPoolId: Output? = null
private var writeAttributes: Output>? = null
/**
* @param value The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for `AccessTokenValidity` as `seconds` , `minutes` , `hours` , or `days` , set a `TokenValidityUnits` value in your API request.
* For example, when you set `AccessTokenValidity` to `10` and `TokenValidityUnits` to `hours` , your user can authorize access with their access token for 10 hours.
* The default time unit for `AccessTokenValidity` in an API request is hours.
*/
@JvmName("jnuunvyagqaieqta")
public suspend fun accessTokenValidity(`value`: Output) {
this.accessTokenValidity = value
}
/**
* @param value The OAuth grant types that you want your app client to generate. To create an app client that generates client credentials grants, you must add `client_credentials` as the only allowed OAuth flow.
* - **code** - Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the `/oauth2/token` endpoint.
* - **implicit** - Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
* - **client_credentials** - Issue the access token from the `/oauth2/token` endpoint directly to a non-person user using a combination of the client ID and client secret.
*/
@JvmName("mpusequsvxvfaxpl")
public suspend fun allowedOAuthFlows(`value`: Output>) {
this.allowedOAuthFlows = value
}
@JvmName("misvlfvcytswxtku")
public suspend fun allowedOAuthFlows(vararg values: Output) {
this.allowedOAuthFlows = Output.all(values.asList())
}
/**
* @param values The OAuth grant types that you want your app client to generate. To create an app client that generates client credentials grants, you must add `client_credentials` as the only allowed OAuth flow.
* - **code** - Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the `/oauth2/token` endpoint.
* - **implicit** - Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
* - **client_credentials** - Issue the access token from the `/oauth2/token` endpoint directly to a non-person user using a combination of the client ID and client secret.
*/
@JvmName("wqkjstqctslwdegd")
public suspend fun allowedOAuthFlows(values: List>) {
this.allowedOAuthFlows = Output.all(values)
}
/**
* @param value Set to `true` to use OAuth 2.0 features in your user pool app client.
* `AllowedOAuthFlowsUserPoolClient` must be `true` before you can configure the following features in your app client.
* - `CallBackURLs` : Callback URLs.
* - `LogoutURLs` : Sign-out redirect URLs.
* - `AllowedOAuthScopes` : OAuth 2.0 scopes.
* - `AllowedOAuthFlows` : Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
* To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set `AllowedOAuthFlowsUserPoolClient` to `true` in a `CreateUserPoolClient` or `UpdateUserPoolClient` API request. If you don't set a value for `AllowedOAuthFlowsUserPoolClient` in a request with the AWS CLI or SDKs, it defaults to `false` .
*/
@JvmName("sfiecnhcwyssfwrj")
public suspend fun allowedOAuthFlowsUserPoolClient(`value`: Output) {
this.allowedOAuthFlowsUserPoolClient = value
}
/**
* @param value The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported.
*/
@JvmName("beirilnxyxhiwuja")
public suspend fun allowedOAuthScopes(`value`: Output>) {
this.allowedOAuthScopes = value
}
@JvmName("fneihodtxmlkjcfn")
public suspend fun allowedOAuthScopes(vararg values: Output) {
this.allowedOAuthScopes = Output.all(values.asList())
}
/**
* @param values The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported.
*/
@JvmName("vjqfuoyjsmwrihlt")
public suspend fun allowedOAuthScopes(values: List>) {
this.allowedOAuthScopes = Output.all(values)
}
/**
* @param value The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
* > In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
*/
@JvmName("ypwhsomsmpbdqqef")
public suspend fun analyticsConfiguration(`value`: Output) {
this.analyticsConfiguration = value
}
/**
* @param value Amazon Cognito creates a session token for each API request in an authentication flow. `AuthSessionValidity` is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
*/
@JvmName("feikprieumnnsbpp")
public suspend fun authSessionValidity(`value`: Output) {
this.authSessionValidity = value
}
/**
* @param value A list of allowed redirect (callback) URLs for the IdPs.
* A redirect URI must:
* - Be an absolute URI.
* - Be registered with the authorization server.
* - Not include a fragment component.
* See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) .
* Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
* App callback URLs such as myapp://example are also supported.
*/
@JvmName("blrbteqpnevtwgfo")
public suspend fun callbackUrls(`value`: Output>) {
this.callbackUrls = value
}
@JvmName("rcfgqywucgtedhku")
public suspend fun callbackUrls(vararg values: Output) {
this.callbackUrls = Output.all(values.asList())
}
/**
* @param values A list of allowed redirect (callback) URLs for the IdPs.
* A redirect URI must:
* - Be an absolute URI.
* - Be registered with the authorization server.
* - Not include a fragment component.
* See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) .
* Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
* App callback URLs such as myapp://example are also supported.
*/
@JvmName("mqfuvlbquoglhfdt")
public suspend fun callbackUrls(values: List>) {
this.callbackUrls = Output.all(values)
}
/**
* @param value The client name for the user pool client you would like to create.
*/
@JvmName("ymciexlfjnmwbsdw")
public suspend fun clientName(`value`: Output) {
this.clientName = value
}
/**
* @param value The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list.
* A redirect URI must:
* - Be an absolute URI.
* - Be registered with the authorization server.
* - Not include a fragment component.
* For more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) .
* Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
* App callback URLs such as myapp://example are also supported.
*/
@JvmName("seoeaaehyrqopqwn")
public suspend fun defaultRedirectUri(`value`: Output) {
this.defaultRedirectUri = value
}
/**
* @param value Activates the propagation of additional user context data. For more information about propagation of user context data, see [Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html) . If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate `EnablePropagateAdditionalUserContextData` in an app client that has a client secret.
*/
@JvmName("sxembjxtrswxwolx")
public suspend fun enablePropagateAdditionalUserContextData(`value`: Output) {
this.enablePropagateAdditionalUserContextData = value
}
/**
* @param value Activates or deactivates token revocation. For more information about revoking tokens, see [RevokeToken](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html) .
* If you don't include this parameter, token revocation is automatically activated for the new user pool client.
*/
@JvmName("eamnxxeypgrhctfr")
public suspend fun enableTokenRevocation(`value`: Output) {
this.enableTokenRevocation = value
}
/**
* @param value The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
* > If you don't specify a value for `ExplicitAuthFlows` , your user client supports `ALLOW_REFRESH_TOKEN_AUTH` , `ALLOW_USER_SRP_AUTH` , and `ALLOW_CUSTOM_AUTH` .
* Valid values include:
* - `ALLOW_ADMIN_USER_PASSWORD_AUTH` : Enable admin based user password authentication flow `ADMIN_USER_PASSWORD_AUTH` . This setting replaces the `ADMIN_NO_SRP_AUTH` setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
* - `ALLOW_CUSTOM_AUTH` : Enable Lambda trigger based authentication.
* - `ALLOW_USER_PASSWORD_AUTH` : Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
* - `ALLOW_USER_SRP_AUTH` : Enable SRP-based authentication.
* - `ALLOW_REFRESH_TOKEN_AUTH` : Enable authflow to refresh tokens.
* In some environments, you will see the values `ADMIN_NO_SRP_AUTH` , `CUSTOM_AUTH_FLOW_ONLY` , or `USER_PASSWORD_AUTH` . You can't assign these legacy `ExplicitAuthFlows` values to user pool clients at the same time as values that begin with `ALLOW_` ,
* like `ALLOW_USER_SRP_AUTH` .
*/
@JvmName("duaqpknnjhixrdsx")
public suspend fun explicitAuthFlows(`value`: Output>) {
this.explicitAuthFlows = value
}
@JvmName("vfyotwayiulqswaq")
public suspend fun explicitAuthFlows(vararg values: Output) {
this.explicitAuthFlows = Output.all(values.asList())
}
/**
* @param values The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
* > If you don't specify a value for `ExplicitAuthFlows` , your user client supports `ALLOW_REFRESH_TOKEN_AUTH` , `ALLOW_USER_SRP_AUTH` , and `ALLOW_CUSTOM_AUTH` .
* Valid values include:
* - `ALLOW_ADMIN_USER_PASSWORD_AUTH` : Enable admin based user password authentication flow `ADMIN_USER_PASSWORD_AUTH` . This setting replaces the `ADMIN_NO_SRP_AUTH` setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
* - `ALLOW_CUSTOM_AUTH` : Enable Lambda trigger based authentication.
* - `ALLOW_USER_PASSWORD_AUTH` : Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
* - `ALLOW_USER_SRP_AUTH` : Enable SRP-based authentication.
* - `ALLOW_REFRESH_TOKEN_AUTH` : Enable authflow to refresh tokens.
* In some environments, you will see the values `ADMIN_NO_SRP_AUTH` , `CUSTOM_AUTH_FLOW_ONLY` , or `USER_PASSWORD_AUTH` . You can't assign these legacy `ExplicitAuthFlows` values to user pool clients at the same time as values that begin with `ALLOW_` ,
* like `ALLOW_USER_SRP_AUTH` .
*/
@JvmName("giqotgoqchnqlfnd")
public suspend fun explicitAuthFlows(values: List>) {
this.explicitAuthFlows = Output.all(values)
}
/**
* @param value Boolean to specify whether you want to generate a secret for the user pool client being created.
*/
@JvmName("nekgeffhhrjpylum")
public suspend fun generateSecret(`value`: Output) {
this.generateSecret = value
}
/**
* @param value The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for `IdTokenValidity` as `seconds` , `minutes` , `hours` , or `days` , set a `TokenValidityUnits` value in your API request.
* For example, when you set `IdTokenValidity` as `10` and `TokenValidityUnits` as `hours` , your user can authenticate their session with their ID token for 10 hours.
* The default time unit for `IdTokenValidity` in an API request is hours.
*/
@JvmName("lfdqdepbfajkodev")
public suspend fun idTokenValidity(`value`: Output) {
this.idTokenValidity = value
}
/**
* @param value A list of allowed logout URLs for the IdPs.
*/
@JvmName("uceolshgcenlotpv")
public suspend fun logoutUrls(`value`: Output>) {
this.logoutUrls = value
}
@JvmName("sqqxtxveygesoqcj")
public suspend fun logoutUrls(vararg values: Output) {
this.logoutUrls = Output.all(values.asList())
}
/**
* @param values A list of allowed logout URLs for the IdPs.
*/
@JvmName("gcqmypoqsovucjir")
public suspend fun logoutUrls(values: List>) {
this.logoutUrls = Output.all(values)
}
/**
* @param value Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to `ENABLED` and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to `LEGACY` , those APIs will return a `UserNotFoundException` exception if the user does not exist in the user pool.
*/
@JvmName("xuutuhgsgwxfkjdv")
public suspend fun preventUserExistenceErrors(`value`: Output) {
this.preventUserExistenceErrors = value
}
/**
* @param value The list of user attributes that you want your app client to have read access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a [GetUser](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUser.html) API request to retrieve and display your user's profile data.
* When you don't specify the `ReadAttributes` for your app client, your app can read the values of `email_verified` , `phone_number_verified` , and the Standard attributes of your user pool. When your user pool app client has read access to these default attributes, `ReadAttributes` doesn't return any information. Amazon Cognito only populates `ReadAttributes` in the API response if you have specified your own custom set of read attributes.
*/
@JvmName("gbwobeerkewpxflh")
public suspend fun readAttributes(`value`: Output>) {
this.readAttributes = value
}
@JvmName("fcfubctvtwoutmun")
public suspend fun readAttributes(vararg values: Output) {
this.readAttributes = Output.all(values.asList())
}
/**
* @param values The list of user attributes that you want your app client to have read access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a [GetUser](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUser.html) API request to retrieve and display your user's profile data.
* When you don't specify the `ReadAttributes` for your app client, your app can read the values of `email_verified` , `phone_number_verified` , and the Standard attributes of your user pool. When your user pool app client has read access to these default attributes, `ReadAttributes` doesn't return any information. Amazon Cognito only populates `ReadAttributes` in the API response if you have specified your own custom set of read attributes.
*/
@JvmName("isnffydbdhpmstlf")
public suspend fun readAttributes(values: List>) {
this.readAttributes = Output.all(values)
}
/**
* @param value The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for `RefreshTokenValidity` as `seconds` , `minutes` , `hours` , or `days` , set a `TokenValidityUnits` value in your API request.
* For example, when you set `RefreshTokenValidity` as `10` and `TokenValidityUnits` as `days` , your user can refresh their session and retrieve new access and ID tokens for 10 days.
* The default time unit for `RefreshTokenValidity` in an API request is days. You can't set `RefreshTokenValidity` to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days.
*/
@JvmName("eycvxxdjvurfurcq")
public suspend fun refreshTokenValidity(`value`: Output) {
this.refreshTokenValidity = value
}
/**
* @param value A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` .
*/
@JvmName("wyhqlljppukoorjg")
public suspend fun supportedIdentityProviders(`value`: Output>) {
this.supportedIdentityProviders = value
}
@JvmName("ohxklvtqibmogoek")
public suspend fun supportedIdentityProviders(vararg values: Output) {
this.supportedIdentityProviders = Output.all(values.asList())
}
/**
* @param values A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` .
*/
@JvmName("dyqiedhbpcisowac")
public suspend fun supportedIdentityProviders(values: List>) {
this.supportedIdentityProviders = Output.all(values)
}
/**
* @param value The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
*/
@JvmName("nomqrddqlrbsucxa")
public suspend fun tokenValidityUnits(`value`: Output) {
this.tokenValidityUnits = value
}
/**
* @param value The user pool ID for the user pool where you want to create a user pool client.
*/
@JvmName("jcitxrdpqcffhpim")
public suspend fun userPoolId(`value`: Output) {
this.userPoolId = value
}
/**
* @param value The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an [UpdateUserAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html) API request and sets `family_name` to the new value.
* When you don't specify the `WriteAttributes` for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, `WriteAttributes` doesn't return any information. Amazon Cognito only populates `WriteAttributes` in the API response if you have specified your own custom set of write attributes.
* If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see [Specifying IdP Attribute Mappings for Your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html) .
*/
@JvmName("jpqkaedacsyhdhgi")
public suspend fun writeAttributes(`value`: Output>) {
this.writeAttributes = value
}
@JvmName("wkursxyyillyhuxv")
public suspend fun writeAttributes(vararg values: Output) {
this.writeAttributes = Output.all(values.asList())
}
/**
* @param values The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an [UpdateUserAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html) API request and sets `family_name` to the new value.
* When you don't specify the `WriteAttributes` for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, `WriteAttributes` doesn't return any information. Amazon Cognito only populates `WriteAttributes` in the API response if you have specified your own custom set of write attributes.
* If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see [Specifying IdP Attribute Mappings for Your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html) .
*/
@JvmName("febuncpegvgsiite")
public suspend fun writeAttributes(values: List>) {
this.writeAttributes = Output.all(values)
}
/**
* @param value The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for `AccessTokenValidity` as `seconds` , `minutes` , `hours` , or `days` , set a `TokenValidityUnits` value in your API request.
* For example, when you set `AccessTokenValidity` to `10` and `TokenValidityUnits` to `hours` , your user can authorize access with their access token for 10 hours.
* The default time unit for `AccessTokenValidity` in an API request is hours.
*/
@JvmName("typtvsjgalrifoiw")
public suspend fun accessTokenValidity(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.accessTokenValidity = mapped
}
/**
* @param value The OAuth grant types that you want your app client to generate. To create an app client that generates client credentials grants, you must add `client_credentials` as the only allowed OAuth flow.
* - **code** - Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the `/oauth2/token` endpoint.
* - **implicit** - Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
* - **client_credentials** - Issue the access token from the `/oauth2/token` endpoint directly to a non-person user using a combination of the client ID and client secret.
*/
@JvmName("ojvxvkjvoqaokaks")
public suspend fun allowedOAuthFlows(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.allowedOAuthFlows = mapped
}
/**
* @param values The OAuth grant types that you want your app client to generate. To create an app client that generates client credentials grants, you must add `client_credentials` as the only allowed OAuth flow.
* - **code** - Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the `/oauth2/token` endpoint.
* - **implicit** - Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
* - **client_credentials** - Issue the access token from the `/oauth2/token` endpoint directly to a non-person user using a combination of the client ID and client secret.
*/
@JvmName("ublfwnxflkvktkxb")
public suspend fun allowedOAuthFlows(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.allowedOAuthFlows = mapped
}
/**
* @param value Set to `true` to use OAuth 2.0 features in your user pool app client.
* `AllowedOAuthFlowsUserPoolClient` must be `true` before you can configure the following features in your app client.
* - `CallBackURLs` : Callback URLs.
* - `LogoutURLs` : Sign-out redirect URLs.
* - `AllowedOAuthScopes` : OAuth 2.0 scopes.
* - `AllowedOAuthFlows` : Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
* To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set `AllowedOAuthFlowsUserPoolClient` to `true` in a `CreateUserPoolClient` or `UpdateUserPoolClient` API request. If you don't set a value for `AllowedOAuthFlowsUserPoolClient` in a request with the AWS CLI or SDKs, it defaults to `false` .
*/
@JvmName("jrvobrlepqykesly")
public suspend fun allowedOAuthFlowsUserPoolClient(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.allowedOAuthFlowsUserPoolClient = mapped
}
/**
* @param value The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported.
*/
@JvmName("nvfacabklwahugct")
public suspend fun allowedOAuthScopes(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.allowedOAuthScopes = mapped
}
/**
* @param values The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported.
*/
@JvmName("oryviodpqvdmaslt")
public suspend fun allowedOAuthScopes(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.allowedOAuthScopes = mapped
}
/**
* @param value The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
* > In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
*/
@JvmName("qtnfylcplapjlqup")
public suspend fun analyticsConfiguration(`value`: UserPoolClientAnalyticsConfigurationArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.analyticsConfiguration = mapped
}
/**
* @param argument The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
* > In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
*/
@JvmName("proeoxygiayetres")
public suspend fun analyticsConfiguration(argument: suspend UserPoolClientAnalyticsConfigurationArgsBuilder.() -> Unit) {
val toBeMapped = UserPoolClientAnalyticsConfigurationArgsBuilder().applySuspend {
argument()
}.build()
val mapped = of(toBeMapped)
this.analyticsConfiguration = mapped
}
/**
* @param value Amazon Cognito creates a session token for each API request in an authentication flow. `AuthSessionValidity` is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
*/
@JvmName("rxrwrrjikknlnqws")
public suspend fun authSessionValidity(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.authSessionValidity = mapped
}
/**
* @param value A list of allowed redirect (callback) URLs for the IdPs.
* A redirect URI must:
* - Be an absolute URI.
* - Be registered with the authorization server.
* - Not include a fragment component.
* See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) .
* Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
* App callback URLs such as myapp://example are also supported.
*/
@JvmName("dojpsfyvstqqtghk")
public suspend fun callbackUrls(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.callbackUrls = mapped
}
/**
* @param values A list of allowed redirect (callback) URLs for the IdPs.
* A redirect URI must:
* - Be an absolute URI.
* - Be registered with the authorization server.
* - Not include a fragment component.
* See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) .
* Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
* App callback URLs such as myapp://example are also supported.
*/
@JvmName("orwvxecugjektctt")
public suspend fun callbackUrls(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.callbackUrls = mapped
}
/**
* @param value The client name for the user pool client you would like to create.
*/
@JvmName("sspfxpnggdfmyrwu")
public suspend fun clientName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.clientName = mapped
}
/**
* @param value The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list.
* A redirect URI must:
* - Be an absolute URI.
* - Be registered with the authorization server.
* - Not include a fragment component.
* For more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) .
* Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
* App callback URLs such as myapp://example are also supported.
*/
@JvmName("pkhouemkcbpgfjsj")
public suspend fun defaultRedirectUri(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.defaultRedirectUri = mapped
}
/**
* @param value Activates the propagation of additional user context data. For more information about propagation of user context data, see [Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html) . If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate `EnablePropagateAdditionalUserContextData` in an app client that has a client secret.
*/
@JvmName("dhmdoaafgiygagqp")
public suspend fun enablePropagateAdditionalUserContextData(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.enablePropagateAdditionalUserContextData = mapped
}
/**
* @param value Activates or deactivates token revocation. For more information about revoking tokens, see [RevokeToken](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html) .
* If you don't include this parameter, token revocation is automatically activated for the new user pool client.
*/
@JvmName("sxigqehyyupgskxn")
public suspend fun enableTokenRevocation(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.enableTokenRevocation = mapped
}
/**
* @param value The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
* > If you don't specify a value for `ExplicitAuthFlows` , your user client supports `ALLOW_REFRESH_TOKEN_AUTH` , `ALLOW_USER_SRP_AUTH` , and `ALLOW_CUSTOM_AUTH` .
* Valid values include:
* - `ALLOW_ADMIN_USER_PASSWORD_AUTH` : Enable admin based user password authentication flow `ADMIN_USER_PASSWORD_AUTH` . This setting replaces the `ADMIN_NO_SRP_AUTH` setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
* - `ALLOW_CUSTOM_AUTH` : Enable Lambda trigger based authentication.
* - `ALLOW_USER_PASSWORD_AUTH` : Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
* - `ALLOW_USER_SRP_AUTH` : Enable SRP-based authentication.
* - `ALLOW_REFRESH_TOKEN_AUTH` : Enable authflow to refresh tokens.
* In some environments, you will see the values `ADMIN_NO_SRP_AUTH` , `CUSTOM_AUTH_FLOW_ONLY` , or `USER_PASSWORD_AUTH` . You can't assign these legacy `ExplicitAuthFlows` values to user pool clients at the same time as values that begin with `ALLOW_` ,
* like `ALLOW_USER_SRP_AUTH` .
*/
@JvmName("onqjqygajbjstgov")
public suspend fun explicitAuthFlows(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.explicitAuthFlows = mapped
}
/**
* @param values The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
* > If you don't specify a value for `ExplicitAuthFlows` , your user client supports `ALLOW_REFRESH_TOKEN_AUTH` , `ALLOW_USER_SRP_AUTH` , and `ALLOW_CUSTOM_AUTH` .
* Valid values include:
* - `ALLOW_ADMIN_USER_PASSWORD_AUTH` : Enable admin based user password authentication flow `ADMIN_USER_PASSWORD_AUTH` . This setting replaces the `ADMIN_NO_SRP_AUTH` setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
* - `ALLOW_CUSTOM_AUTH` : Enable Lambda trigger based authentication.
* - `ALLOW_USER_PASSWORD_AUTH` : Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
* - `ALLOW_USER_SRP_AUTH` : Enable SRP-based authentication.
* - `ALLOW_REFRESH_TOKEN_AUTH` : Enable authflow to refresh tokens.
* In some environments, you will see the values `ADMIN_NO_SRP_AUTH` , `CUSTOM_AUTH_FLOW_ONLY` , or `USER_PASSWORD_AUTH` . You can't assign these legacy `ExplicitAuthFlows` values to user pool clients at the same time as values that begin with `ALLOW_` ,
* like `ALLOW_USER_SRP_AUTH` .
*/
@JvmName("grmlaamufthasykp")
public suspend fun explicitAuthFlows(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.explicitAuthFlows = mapped
}
/**
* @param value Boolean to specify whether you want to generate a secret for the user pool client being created.
*/
@JvmName("waniljxvgssxbvud")
public suspend fun generateSecret(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.generateSecret = mapped
}
/**
* @param value The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for `IdTokenValidity` as `seconds` , `minutes` , `hours` , or `days` , set a `TokenValidityUnits` value in your API request.
* For example, when you set `IdTokenValidity` as `10` and `TokenValidityUnits` as `hours` , your user can authenticate their session with their ID token for 10 hours.
* The default time unit for `IdTokenValidity` in an API request is hours.
*/
@JvmName("ajwghxfjyxeksqgk")
public suspend fun idTokenValidity(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.idTokenValidity = mapped
}
/**
* @param value A list of allowed logout URLs for the IdPs.
*/
@JvmName("qbbixyflmiidlksn")
public suspend fun logoutUrls(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.logoutUrls = mapped
}
/**
* @param values A list of allowed logout URLs for the IdPs.
*/
@JvmName("fmkbfqonpwpubhte")
public suspend fun logoutUrls(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.logoutUrls = mapped
}
/**
* @param value Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to `ENABLED` and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to `LEGACY` , those APIs will return a `UserNotFoundException` exception if the user does not exist in the user pool.
*/
@JvmName("jiarhjvanfnskabt")
public suspend fun preventUserExistenceErrors(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.preventUserExistenceErrors = mapped
}
/**
* @param value The list of user attributes that you want your app client to have read access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a [GetUser](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUser.html) API request to retrieve and display your user's profile data.
* When you don't specify the `ReadAttributes` for your app client, your app can read the values of `email_verified` , `phone_number_verified` , and the Standard attributes of your user pool. When your user pool app client has read access to these default attributes, `ReadAttributes` doesn't return any information. Amazon Cognito only populates `ReadAttributes` in the API response if you have specified your own custom set of read attributes.
*/
@JvmName("orumqndvqjpiiatp")
public suspend fun readAttributes(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.readAttributes = mapped
}
/**
* @param values The list of user attributes that you want your app client to have read access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a [GetUser](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUser.html) API request to retrieve and display your user's profile data.
* When you don't specify the `ReadAttributes` for your app client, your app can read the values of `email_verified` , `phone_number_verified` , and the Standard attributes of your user pool. When your user pool app client has read access to these default attributes, `ReadAttributes` doesn't return any information. Amazon Cognito only populates `ReadAttributes` in the API response if you have specified your own custom set of read attributes.
*/
@JvmName("fwnowcxwsvhifdtq")
public suspend fun readAttributes(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.readAttributes = mapped
}
/**
* @param value The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for `RefreshTokenValidity` as `seconds` , `minutes` , `hours` , or `days` , set a `TokenValidityUnits` value in your API request.
* For example, when you set `RefreshTokenValidity` as `10` and `TokenValidityUnits` as `days` , your user can refresh their session and retrieve new access and ID tokens for 10 days.
* The default time unit for `RefreshTokenValidity` in an API request is days. You can't set `RefreshTokenValidity` to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days.
*/
@JvmName("gmlxfmshxipllqfc")
public suspend fun refreshTokenValidity(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.refreshTokenValidity = mapped
}
/**
* @param value A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` .
*/
@JvmName("orvqjbdjovjtnpev")
public suspend fun supportedIdentityProviders(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.supportedIdentityProviders = mapped
}
/**
* @param values A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` .
*/
@JvmName("rfytajtybetseamh")
public suspend fun supportedIdentityProviders(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.supportedIdentityProviders = mapped
}
/**
* @param value The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
*/
@JvmName("embexngotwucbjsy")
public suspend fun tokenValidityUnits(`value`: UserPoolClientTokenValidityUnitsArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.tokenValidityUnits = mapped
}
/**
* @param argument The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
*/
@JvmName("mgwqgrlfdofvijbx")
public suspend fun tokenValidityUnits(argument: suspend UserPoolClientTokenValidityUnitsArgsBuilder.() -> Unit) {
val toBeMapped = UserPoolClientTokenValidityUnitsArgsBuilder().applySuspend {
argument()
}.build()
val mapped = of(toBeMapped)
this.tokenValidityUnits = mapped
}
/**
* @param value The user pool ID for the user pool where you want to create a user pool client.
*/
@JvmName("waxtfjcadufxtdyd")
public suspend fun userPoolId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.userPoolId = mapped
}
/**
* @param value The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an [UpdateUserAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html) API request and sets `family_name` to the new value.
* When you don't specify the `WriteAttributes` for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, `WriteAttributes` doesn't return any information. Amazon Cognito only populates `WriteAttributes` in the API response if you have specified your own custom set of write attributes.
* If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see [Specifying IdP Attribute Mappings for Your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html) .
*/
@JvmName("vxhrkeeamiiwqudf")
public suspend fun writeAttributes(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.writeAttributes = mapped
}
/**
* @param values The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an [UpdateUserAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html) API request and sets `family_name` to the new value.
* When you don't specify the `WriteAttributes` for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, `WriteAttributes` doesn't return any information. Amazon Cognito only populates `WriteAttributes` in the API response if you have specified your own custom set of write attributes.
* If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see [Specifying IdP Attribute Mappings for Your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html) .
*/
@JvmName("vvscwnunsfcpkumf")
public suspend fun writeAttributes(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.writeAttributes = mapped
}
internal fun build(): UserPoolClientArgs = UserPoolClientArgs(
accessTokenValidity = accessTokenValidity,
allowedOAuthFlows = allowedOAuthFlows,
allowedOAuthFlowsUserPoolClient = allowedOAuthFlowsUserPoolClient,
allowedOAuthScopes = allowedOAuthScopes,
analyticsConfiguration = analyticsConfiguration,
authSessionValidity = authSessionValidity,
callbackUrls = callbackUrls,
clientName = clientName,
defaultRedirectUri = defaultRedirectUri,
enablePropagateAdditionalUserContextData = enablePropagateAdditionalUserContextData,
enableTokenRevocation = enableTokenRevocation,
explicitAuthFlows = explicitAuthFlows,
generateSecret = generateSecret,
idTokenValidity = idTokenValidity,
logoutUrls = logoutUrls,
preventUserExistenceErrors = preventUserExistenceErrors,
readAttributes = readAttributes,
refreshTokenValidity = refreshTokenValidity,
supportedIdentityProviders = supportedIdentityProviders,
tokenValidityUnits = tokenValidityUnits,
userPoolId = userPoolId,
writeAttributes = writeAttributes,
)
}
