Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class CreateUserPoolClientRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CreateUserPoolClientRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateUserPoolClientRequest.Builder,CreateUserPoolClientRequest>

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

Represents the request to create a user pool client.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateUserPoolClientRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
List<String>	allowedOAuthFlows()	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.
static CreateUserPoolClientRequest.Builder	builder()
List<String>	callbackURLs()	A list of allowed 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<String>	explicitAuthFlows()	The explicit authentication flows.
Boolean	generateSecret()	Boolean to specify whether you want to generate a secret for the user pool client being created.
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.
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()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	userPoolId()	The user pool ID for the user pool where you want to create a user pool client.
List<String>	writeAttributes()	The write attributes.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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.

Returns:

The read attributes.

writeAttributes

public List<String> writeAttributes()

The write attributes.

Returns:

The write attributes.

explicitAuthFlows

public List<String> explicitAuthFlows()

The explicit authentication flows.

Returns:

The explicit authentication flows.

See Also:

ExplicitAuthFlowsType

supportedIdentityProviders

public List<String> supportedIdentityProviders()

A list of provider names for the identity providers that are supported on this client.

Returns:

A list of provider names for the identity providers that are supported on this client.

callbackURLs

public List<String> callbackURLs()

A list of allowed callback URLs for the identity providers.

Returns:

A list of allowed callback URLs for the identity providers.

logoutURLs

public List<String> logoutURLs()

A list of allowed logout URLs for the identity providers.

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.

Returns:

The default redirect URI. Must be in the CallbackURLs list.

allowedOAuthFlows

public List<String> 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.

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.

See Also:

OAuthFlowType

allowedOAuthScopes

public List<String> allowedOAuthScopes()

A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".

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.

toBuilder

public CreateUserPoolClientRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateUserPoolClientRequest.Builder,CreateUserPoolClientRequest>

Returns:

a builder for type T

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()

Overrides:

toString in class Object