public static interface CreateUserPoolClientRequest.Builder extends CognitoIdentityProviderRequest.Builder, CopyableBuilder<CreateUserPoolClientRequest.Builder,CreateUserPoolClientRequest>
Modifier and Type | Method and Description |
---|---|
CreateUserPoolClientRequest.Builder |
allowedOAuthFlows(Collection<OAuthFlowType> allowedOAuthFlows)
Set to
code to initiate a code grant flow, which provides an authorization code as the response. |
CreateUserPoolClientRequest.Builder |
allowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)
Set to
code to initiate a code grant flow, which provides an authorization code as the response. |
CreateUserPoolClientRequest.Builder |
allowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to
True if the client is allowed to follow the OAuth protocol when interacting with Cognito
user pools. |
CreateUserPoolClientRequest.Builder |
allowedOAuthFlowsWithStrings(Collection<String> allowedOAuthFlows)
Set to
code to initiate a code grant flow, which provides an authorization code as the response. |
CreateUserPoolClientRequest.Builder |
allowedOAuthFlowsWithStrings(String... allowedOAuthFlows)
Set to
code to initiate a code grant flow, which provides an authorization code as the response. |
CreateUserPoolClientRequest.Builder |
allowedOAuthScopes(Collection<String> allowedOAuthScopes)
A list of allowed
OAuth scopes. |
CreateUserPoolClientRequest.Builder |
allowedOAuthScopes(String... allowedOAuthScopes)
A list of allowed
OAuth scopes. |
CreateUserPoolClientRequest.Builder |
callbackURLs(Collection<String> callbackURLs)
A list of allowed callback URLs for the identity providers.
|
CreateUserPoolClientRequest.Builder |
callbackURLs(String... callbackURLs)
A list of allowed callback URLs for the identity providers.
|
CreateUserPoolClientRequest.Builder |
clientName(String clientName)
The client name for the user pool client you would like to create.
|
CreateUserPoolClientRequest.Builder |
defaultRedirectURI(String defaultRedirectURI)
The default redirect URI.
|
CreateUserPoolClientRequest.Builder |
explicitAuthFlows(Collection<ExplicitAuthFlowsType> explicitAuthFlows)
The explicit authentication flows.
|
CreateUserPoolClientRequest.Builder |
explicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)
The explicit authentication flows.
|
CreateUserPoolClientRequest.Builder |
explicitAuthFlowsWithStrings(Collection<String> explicitAuthFlows)
The explicit authentication flows.
|
CreateUserPoolClientRequest.Builder |
explicitAuthFlowsWithStrings(String... explicitAuthFlows)
The explicit authentication flows.
|
CreateUserPoolClientRequest.Builder |
generateSecret(Boolean generateSecret)
Boolean to specify whether you want to generate a secret for the user pool client being created.
|
CreateUserPoolClientRequest.Builder |
logoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the identity providers.
|
CreateUserPoolClientRequest.Builder |
logoutURLs(String... logoutURLs)
A list of allowed logout URLs for the identity providers.
|
CreateUserPoolClientRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
CreateUserPoolClientRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
CreateUserPoolClientRequest.Builder |
readAttributes(Collection<String> readAttributes)
The read attributes.
|
CreateUserPoolClientRequest.Builder |
readAttributes(String... readAttributes)
The read attributes.
|
CreateUserPoolClientRequest.Builder |
refreshTokenValidity(Integer refreshTokenValidity)
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
|
CreateUserPoolClientRequest.Builder |
supportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
|
CreateUserPoolClientRequest.Builder |
supportedIdentityProviders(String... supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
|
CreateUserPoolClientRequest.Builder |
userPoolId(String userPoolId)
The user pool ID for the user pool where you want to create a user pool client.
|
CreateUserPoolClientRequest.Builder |
writeAttributes(Collection<String> writeAttributes)
The write attributes.
|
CreateUserPoolClientRequest.Builder |
writeAttributes(String... writeAttributes)
The write attributes.
|
build
overrideConfiguration
copy
applyMutation, build
CreateUserPoolClientRequest.Builder userPoolId(String userPoolId)
The user pool ID for the user pool where you want to create a user pool client.
userPoolId
- The user pool ID for the user pool where you want to create a user pool client.CreateUserPoolClientRequest.Builder clientName(String clientName)
The client name for the user pool client you would like to create.
clientName
- The client name for the user pool client you would like to create.CreateUserPoolClientRequest.Builder generateSecret(Boolean generateSecret)
Boolean to specify whether you want to generate a secret for the user pool client being created.
generateSecret
- Boolean to specify whether you want to generate a secret for the user pool client being created.CreateUserPoolClientRequest.Builder refreshTokenValidity(Integer refreshTokenValidity)
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
refreshTokenValidity
- The time limit, in days, after which the refresh token is no longer valid and cannot be used.CreateUserPoolClientRequest.Builder readAttributes(Collection<String> readAttributes)
The read attributes.
readAttributes
- The read attributes.CreateUserPoolClientRequest.Builder readAttributes(String... readAttributes)
The read attributes.
readAttributes
- The read attributes.CreateUserPoolClientRequest.Builder writeAttributes(Collection<String> writeAttributes)
The write attributes.
writeAttributes
- The write attributes.CreateUserPoolClientRequest.Builder writeAttributes(String... writeAttributes)
The write attributes.
writeAttributes
- The write attributes.CreateUserPoolClientRequest.Builder explicitAuthFlowsWithStrings(Collection<String> explicitAuthFlows)
The explicit authentication flows.
explicitAuthFlows
- The explicit authentication flows.CreateUserPoolClientRequest.Builder explicitAuthFlowsWithStrings(String... explicitAuthFlows)
The explicit authentication flows.
explicitAuthFlows
- The explicit authentication flows.CreateUserPoolClientRequest.Builder explicitAuthFlows(Collection<ExplicitAuthFlowsType> explicitAuthFlows)
The explicit authentication flows.
explicitAuthFlows
- The explicit authentication flows.CreateUserPoolClientRequest.Builder explicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)
The explicit authentication flows.
explicitAuthFlows
- The explicit authentication flows.CreateUserPoolClientRequest.Builder supportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
supportedIdentityProviders
- A list of provider names for the identity providers that are supported on this client.CreateUserPoolClientRequest.Builder supportedIdentityProviders(String... supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
supportedIdentityProviders
- A list of provider names for the identity providers that are supported on this client.CreateUserPoolClientRequest.Builder callbackURLs(Collection<String> callbackURLs)
A list of allowed callback URLs for the identity providers.
callbackURLs
- A list of allowed callback URLs for the identity providers.CreateUserPoolClientRequest.Builder callbackURLs(String... callbackURLs)
A list of allowed callback URLs for the identity providers.
callbackURLs
- A list of allowed callback URLs for the identity providers.CreateUserPoolClientRequest.Builder logoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the identity providers.
logoutURLs
- A list of allowed logout URLs for the identity providers.CreateUserPoolClientRequest.Builder logoutURLs(String... logoutURLs)
A list of allowed logout URLs for the identity providers.
logoutURLs
- A list of allowed logout URLs for the identity providers.CreateUserPoolClientRequest.Builder defaultRedirectURI(String defaultRedirectURI)
The default redirect URI. Must be in the CallbackURLs
list.
defaultRedirectURI
- The default redirect URI. Must be in the CallbackURLs
list.CreateUserPoolClientRequest.Builder allowedOAuthFlowsWithStrings(Collection<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.
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.
CreateUserPoolClientRequest.Builder allowedOAuthFlowsWithStrings(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.
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.
CreateUserPoolClientRequest.Builder allowedOAuthFlows(Collection<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.
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.
CreateUserPoolClientRequest.Builder allowedOAuthFlows(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.
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.
CreateUserPoolClientRequest.Builder allowedOAuthScopes(Collection<String> allowedOAuthScopes)
A list of allowed OAuth
scopes. Currently supported values are "phone"
,
"email"
, "openid"
, and "Cognito"
.
allowedOAuthScopes
- A list of allowed OAuth
scopes. Currently supported values are "phone"
,
"email"
, "openid"
, and "Cognito"
.CreateUserPoolClientRequest.Builder allowedOAuthScopes(String... allowedOAuthScopes)
A list of allowed OAuth
scopes. Currently supported values are "phone"
,
"email"
, "openid"
, and "Cognito"
.
allowedOAuthScopes
- A list of allowed OAuth
scopes. Currently supported values are "phone"
,
"email"
, "openid"
, and "Cognito"
.CreateUserPoolClientRequest.Builder allowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to True
if the client is allowed to follow the OAuth protocol when interacting with Cognito
user pools.
allowedOAuthFlowsUserPoolClient
- Set to True
if the client is allowed to follow the OAuth protocol when interacting with
Cognito user pools.CreateUserPoolClientRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.CreateUserPoolClientRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.