@Generated(value="software.amazon.awssdk:codegen") public class CreateUserPoolClientRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<CreateUserPoolClientRequest.Builder,CreateUserPoolClientRequest>
Represents the request to create a user pool client.
Modifier and Type | Class and Description |
---|---|
static interface |
CreateUserPoolClientRequest.Builder |
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> |
allowedOAuthFlowsStrings()
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<ExplicitAuthFlowsType> |
explicitAuthFlows()
The explicit authentication flows.
|
List<String> |
explicitAuthFlowsStrings()
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)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
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.
|
requestOverrideConfig
copy
public String userPoolId()
The user pool ID for the user pool where you want to create a user pool client.
public String clientName()
The client name for the user pool client you would like to create.
public Boolean generateSecret()
Boolean to specify whether you want to generate a secret for the user pool client being created.
public Integer refreshTokenValidity()
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
public List<String> readAttributes()
The read attributes.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> writeAttributes()
The write attributes.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<ExplicitAuthFlowsType> explicitAuthFlows()
The explicit authentication flows.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> explicitAuthFlowsStrings()
The explicit authentication flows.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> supportedIdentityProviders()
A list of provider names for the identity providers that are supported on this client.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> callbackURLs()
A list of allowed callback URLs for the identity providers.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.
public String defaultRedirectURI()
The default redirect URI. Must be in the CallbackURLs
list.
CallbackURLs
list.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.
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.
public List<String> allowedOAuthFlowsStrings()
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.
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.
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.
OAuth
scopes. Currently supported values are "phone"
,
"email"
, "openid"
, and "Cognito"
.public Boolean allowedOAuthFlowsUserPoolClient()
Set to True
if the client is allowed to follow the OAuth protocol when interacting with Cognito user
pools.
True
if the client is allowed to follow the OAuth protocol when interacting with
Cognito user pools.public CreateUserPoolClientRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateUserPoolClientRequest.Builder,CreateUserPoolClientRequest>
toBuilder
in class CognitoIdentityProviderRequest
public static CreateUserPoolClientRequest.Builder builder()
public static Class<? extends CreateUserPoolClientRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.