CreateUserPoolClientRequest (AWS Java SDK :: Services :: Amazon Cognito Identity Provider Service 2.20.7 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest
    - - software.amazon.awssdk.services.cognitoidentityprovider.model.CreateUserPoolClientRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateUserPoolClientRequest.Builder,CreateUserPoolClientRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateUserPoolClientRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<CreateUserPoolClientRequest.Builder,CreateUserPoolClientRequest>

Represents the request to create a user pool client.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateUserPoolClientRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateUserPoolClientRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`accessTokenValidity()` The access token time limit.
`List<OAuthFlowType>`	`allowedOAuthFlows()` The allowed OAuth flows.
`List<String>`	`allowedOAuthFlowsAsStrings()` The allowed OAuth flows.
`Boolean`	`allowedOAuthFlowsUserPoolClient()` Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
`List<String>`	`allowedOAuthScopes()` The allowed OAuth scopes.
`AnalyticsConfigurationType`	`analyticsConfiguration()` The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
`Integer`	`authSessionValidity()` Amazon Cognito creates a session token for each API request in an authentication flow.
`static CreateUserPoolClientRequest.Builder`	`builder()`
`List<String>`	`callbackURLs()` A list of allowed redirect (callback) URLs for the IdPs.
`String`	`clientName()` The client name for the user pool client you would like to create.
`String`	`defaultRedirectURI()` The default redirect URI.
`Boolean`	`enablePropagateAdditionalUserContextData()` Activates the propagation of additional user context data.
`Boolean`	`enableTokenRevocation()` Activates or deactivates token revocation.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<ExplicitAuthFlowsType>`	`explicitAuthFlows()` The authentication flows that you want your user pool client to support.
`List<String>`	`explicitAuthFlowsAsStrings()` The authentication flows that you want your user pool client to support.
`Boolean`	`generateSecret()` Boolean to specify whether you want to generate a secret for the user pool client being created.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAllowedOAuthFlows()` For responses, this returns true if the service returned a value for the AllowedOAuthFlows property.
`boolean`	`hasAllowedOAuthScopes()` For responses, this returns true if the service returned a value for the AllowedOAuthScopes property.
`boolean`	`hasCallbackURLs()` For responses, this returns true if the service returned a value for the CallbackURLs property.
`boolean`	`hasExplicitAuthFlows()` For responses, this returns true if the service returned a value for the ExplicitAuthFlows property.
`int`	`hashCode()`
`boolean`	`hasLogoutURLs()` For responses, this returns true if the service returned a value for the LogoutURLs property.
`boolean`	`hasReadAttributes()` For responses, this returns true if the service returned a value for the ReadAttributes property.
`boolean`	`hasSupportedIdentityProviders()` For responses, this returns true if the service returned a value for the SupportedIdentityProviders property.
`boolean`	`hasWriteAttributes()` For responses, this returns true if the service returned a value for the WriteAttributes property.
`Integer`	`idTokenValidity()` The ID token time limit.
`List<String>`	`logoutURLs()` A list of allowed logout URLs for the IdPs.
`PreventUserExistenceErrorTypes`	`preventUserExistenceErrors()` Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool.
`String`	`preventUserExistenceErrorsAsString()` Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool.
`List<String>`	`readAttributes()` The read attributes.
`Integer`	`refreshTokenValidity()` The refresh token time limit.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateUserPoolClientRequest.Builder>`	`serializableBuilderClass()`
`List<String>`	`supportedIdentityProviders()` A list of provider names for the identity providers (IdPs) that are supported on this client.
`CreateUserPoolClientRequest.Builder`	`toBuilder()`
`TokenValidityUnitsType`	`tokenValidityUnits()` The units in which the validity times are represented.
`String`	`toString()` Returns a string representation of this object.
`String`	`userPoolId()` The user pool ID for the user pool where you want to create a user pool client.
`List<String>`	`writeAttributes()` The user pool attributes that the app client can write to.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - userPoolId
```
public final String userPoolId()
```
    The user pool ID for the user pool where you want to create a user pool client.
    
    Returns:
    
    The user pool ID for the user pool where you want to create a user pool client.
  - clientName
```
public final String clientName()
```
    The client name for the user pool client you would like to create.
    
    Returns:
    
    The client name for the user pool client you would like to create.
  - generateSecret
```
public final Boolean generateSecret()
```
    Boolean to specify whether you want to generate a secret for the user pool client being created.
    
    Returns:
    
    Boolean to specify whether you want to generate a secret for the user pool client being created.
  - refreshTokenValidity
```
public final Integer 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. Valid range is displayed below in seconds.
    
    If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
    
    Returns:
    
    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. Valid range is displayed below in seconds.
    
    If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
  - accessTokenValidity
```
public final Integer 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. Valid range is displayed below in seconds.
    
    If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
    
    Returns:
    
    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. Valid range is displayed below in seconds.
    
    If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
  - idTokenValidity
```
public final Integer 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 AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
    
    If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
    
    Returns:
    
    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 AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
    
    If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
  - tokenValidityUnits
```
public final TokenValidityUnitsType 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.
    
    Returns:
    
    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.
  - hasReadAttributes
```
public final boolean hasReadAttributes()
```
    For responses, this returns true if the service returned a value for the ReadAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - readAttributes
```
public final List<String> readAttributes()
```
    The read attributes.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReadAttributes() method.
    
    Returns:
    
    The read attributes.
  - hasWriteAttributes
```
public final boolean hasWriteAttributes()
```
    For responses, this returns true if the service returned a value for the WriteAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - writeAttributes
```
public final List<String> writeAttributes()
```
    The user pool attributes that the app client can write to.
    
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWriteAttributes() method.
    
    Returns:
    
    The user pool attributes that the app client can write to.
    
    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.
  - explicitAuthFlows
```
public final List<ExplicitAuthFlowsType> 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExplicitAuthFlows() method.
    Returns:
    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.
  - hasExplicitAuthFlows
```
public final boolean hasExplicitAuthFlows()
```
    For responses, this returns true if the service returned a value for the ExplicitAuthFlows property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - explicitAuthFlowsAsStrings
```
public final List<String> explicitAuthFlowsAsStrings()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExplicitAuthFlows() method.
    Returns:
    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.
  - hasSupportedIdentityProviders
```
public final boolean hasSupportedIdentityProviders()
```
    For responses, this returns true if the service returned a value for the SupportedIdentityProviders property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - supportedIdentityProviders
```
public final List<String> 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSupportedIdentityProviders() method.
    
    Returns:
    
    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.
  - hasCallbackURLs
```
public final boolean hasCallbackURLs()
```
    For responses, this returns true if the service returned a value for the CallbackURLs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - callbackURLs
```
public final List<String> 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.
    
    Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
    
    App callback URLs such as myapp://example are also supported.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCallbackURLs() method.
    Returns:
    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.
    
    Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
    
    App callback URLs such as myapp://example are also supported.
  - hasLogoutURLs
```
public final boolean hasLogoutURLs()
```
    For responses, this returns true if the service returned a value for the LogoutURLs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - logoutURLs
```
public final List<String> logoutURLs()
```
    A list of allowed logout URLs for the IdPs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLogoutURLs() method.
    
    Returns:
    
    A list of allowed logout URLs for the IdPs.
  - defaultRedirectURI
```
public final String defaultRedirectURI()
```
    The default redirect URI. 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.
    See OAuth 2.0 - Redirection Endpoint.
    
    Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
    
    App callback URLs such as myapp://example are also supported.
    Returns:
    The default redirect URI. 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.
    
    See OAuth 2.0 - Redirection Endpoint.
    
    Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
    
    App callback URLs such as myapp://example are also supported.
  - allowedOAuthFlows
```
public final List<OAuthFlowType> allowedOAuthFlows()
```
    The allowed OAuth flows.
    
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAllowedOAuthFlows() method.
    
    Returns:
    
    The allowed OAuth flows.
    
    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.
  - hasAllowedOAuthFlows
```
public final boolean hasAllowedOAuthFlows()
```
    For responses, this returns true if the service returned a value for the AllowedOAuthFlows property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - allowedOAuthFlowsAsStrings
```
public final List<String> allowedOAuthFlowsAsStrings()
```
    The allowed OAuth flows.
    
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAllowedOAuthFlows() method.
    
    Returns:
    
    The allowed OAuth flows.
    
    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.
  - hasAllowedOAuthScopes
```
public final boolean hasAllowedOAuthScopes()
```
    For responses, this returns true if the service returned a value for the AllowedOAuthScopes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - allowedOAuthScopes
```
public final List<String> allowedOAuthScopes()
```
    The allowed OAuth scopes. Possible values provided by OAuth are phone, email, openid, and profile. Possible values provided by Amazon Web Services are aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAllowedOAuthScopes() method.
    
    Returns:
    
    The allowed OAuth scopes. Possible values provided by OAuth are phone, email, openid, and profile. Possible values provided by Amazon Web Services are aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
  - allowedOAuthFlowsUserPoolClient
```
public final Boolean allowedOAuthFlowsUserPoolClient()
```
    Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
    
    Returns:
    
    Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
  - analyticsConfiguration
```
public final AnalyticsConfigurationType analyticsConfiguration()
```
    The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
    
    In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
    
    Returns:
    
    The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
    
    In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
  - preventUserExistenceErrors
```
public final PreventUserExistenceErrorTypes preventUserExistenceErrors()
```
    Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't exist in the user pool.
    
    Valid values include:
    - ENABLED - This prevents user existence-related errors.
    - LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.
    If the service returns an enum value that is not available in the current SDK version, preventUserExistenceErrors will return PreventUserExistenceErrorTypes.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from preventUserExistenceErrorsAsString().
    Returns:
    Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't exist in the user pool.
    
    Valid values include:
    
    ENABLED - This prevents user existence-related errors.
    
    LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.
    See Also:
    
    PreventUserExistenceErrorTypes
  - preventUserExistenceErrorsAsString
```
public final String preventUserExistenceErrorsAsString()
```
    Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't exist in the user pool.
    
    Valid values include:
    - ENABLED - This prevents user existence-related errors.
    - LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.
    If the service returns an enum value that is not available in the current SDK version, preventUserExistenceErrors will return PreventUserExistenceErrorTypes.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from preventUserExistenceErrorsAsString().
    Returns:
    Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't exist in the user pool.
    
    Valid values include:
    
    ENABLED - This prevents user existence-related errors.
    
    LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.
    See Also:
    
    PreventUserExistenceErrorTypes
  - enableTokenRevocation
```
public final Boolean enableTokenRevocation()
```
    Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
    
    If you don't include this parameter, token revocation is automatically activated for the new user pool client.
    
    Returns:
    
    Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
    
    If you don't include this parameter, token revocation is automatically activated for the new user pool client.
  - enablePropagateAdditionalUserContextData
```
public final Boolean 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. 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.
    
    Returns:
    
    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. 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.
  - authSessionValidity
```
public final Integer 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.
    
    Returns:
    
    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.
  - toBuilder
```
public CreateUserPoolClientRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateUserPoolClientRequest.Builder,CreateUserPoolClientRequest>
    
    Specified by:
    
    toBuilder in class CognitoIdentityProviderRequest
  - builder
```
public static CreateUserPoolClientRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateUserPoolClientRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateUserPoolClientRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

userPoolId

clientName

generateSecret

refreshTokenValidity

accessTokenValidity

idTokenValidity

tokenValidityUnits

hasReadAttributes

readAttributes

hasWriteAttributes

writeAttributes

explicitAuthFlows

hasExplicitAuthFlows

explicitAuthFlowsAsStrings

hasSupportedIdentityProviders

supportedIdentityProviders

hasCallbackURLs

callbackURLs

hasLogoutURLs

logoutURLs

defaultRedirectURI

allowedOAuthFlows

hasAllowedOAuthFlows

allowedOAuthFlowsAsStrings

hasAllowedOAuthScopes

allowedOAuthScopes

allowedOAuthFlowsUserPoolClient

analyticsConfiguration

preventUserExistenceErrors

preventUserExistenceErrorsAsString

enableTokenRevocation

enablePropagateAdditionalUserContextData

authSessionValidity

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields