CreateUserPoolClientRequest (AWS Java SDK :: Services :: Amazon Cognito Identity Provider Service 2.5.32 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
`List<OAuthFlowType>`	`allowedOAuthFlows()` Set to `code` to initiate a code grant flow, which provides an authorization code as the response.
`List<String>`	`allowedOAuthFlowsAsStrings()` Set to `code` to initiate a code grant flow, which provides an authorization code as the response.
`Boolean`	`allowedOAuthFlowsUserPoolClient()` Set to `True` if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
`List<String>`	`allowedOAuthScopes()` A list of allowed `OAuth` scopes.
`AnalyticsConfigurationType`	`analyticsConfiguration()` The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
`static CreateUserPoolClientRequest.Builder`	`builder()`
`List<String>`	`callbackURLs()` A list of allowed redirect (callback) URLs for the identity providers.
`String`	`clientName()` The client name for the user pool client you would like to create.
`String`	`defaultRedirectURI()` The default redirect URI.
`boolean`	`equals(Object obj)`
`List<ExplicitAuthFlowsType>`	`explicitAuthFlows()` The explicit authentication flows.
`List<String>`	`explicitAuthFlowsAsStrings()` The explicit authentication flows.
`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)`
`int`	`hashCode()`
`List<String>`	`logoutURLs()` A list of allowed logout URLs for the identity providers.
`List<String>`	`readAttributes()` The read attributes.
`Integer`	`refreshTokenValidity()` The time limit, in days, after which the refresh token is no longer valid and cannot be used.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateUserPoolClientRequest.Builder>`	`serializableBuilderClass()`
`List<String>`	`supportedIdentityProviders()` A list of provider names for the identity providers that are supported on this client.
`CreateUserPoolClientRequest.Builder`	`toBuilder()`
`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 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 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 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 Integer refreshTokenValidity()
```
    The time limit, in days, after which the refresh token is no longer valid and cannot be used.
    
    Returns:
    
    The time limit, in days, after which the refresh token is no longer valid and cannot be used.
  - readAttributes
```
public List<String> readAttributes()
```
    The read attributes.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The read attributes.
  - writeAttributes
```
public 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 identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The user pool attributes that the app client can write to.
    
    If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
  - explicitAuthFlows
```
public List<ExplicitAuthFlowsType> explicitAuthFlows()
```
    The explicit authentication flows.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The explicit authentication flows.
  - explicitAuthFlowsAsStrings
```
public List<String> explicitAuthFlowsAsStrings()
```
    The explicit authentication flows.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The explicit authentication flows.
  - supportedIdentityProviders
```
public List<String> supportedIdentityProviders()
```
    A list of provider names for the identity providers that are supported on this client. The following are supported: COGNITO, Facebook, Google and LoginWithAmazon.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of provider names for the identity providers that are supported on this client. The following are supported: COGNITO, Facebook, Google and LoginWithAmazon.
  - callbackURLs
```
public List<String> callbackURLs()
```
    A list of allowed redirect (callback) URLs for the identity providers.
    
    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.
    Returns:
    A list of allowed redirect (callback) URLs for the identity providers.
    
    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.
  - logoutURLs
```
public List<String> logoutURLs()
```
    A list of allowed logout URLs for the identity providers.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of allowed logout URLs for the identity providers.
  - defaultRedirectURI
```
public 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 List<OAuthFlowType> allowedOAuthFlows()
```
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
  - allowedOAuthFlowsAsStrings
```
public List<String> allowedOAuthFlowsAsStrings()
```
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
  - allowedOAuthScopes
```
public List<String> allowedOAuthScopes()
```
    A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".
  - allowedOAuthFlowsUserPoolClient
```
public Boolean allowedOAuthFlowsUserPoolClient()
```
    Set to True if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
    
    Returns:
    
    Set to True if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
  - analyticsConfiguration
```
public AnalyticsConfigurationType analyticsConfiguration()
```
    The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
    
    Returns:
    
    The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public 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

readAttributes

writeAttributes

explicitAuthFlows

explicitAuthFlowsAsStrings

supportedIdentityProviders

callbackURLs

logoutURLs

defaultRedirectURI

allowedOAuthFlows

allowedOAuthFlowsAsStrings

allowedOAuthScopes

allowedOAuthFlowsUserPoolClient

analyticsConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields