public static interface UserPoolClientType.Builder extends CopyableBuilder<UserPoolClientType.Builder,UserPoolClientType>
Modifier and Type | Method and Description |
---|---|
UserPoolClientType.Builder |
allowedOAuthFlows(Collection<String> allowedOAuthFlows)
Set to
code to initiate a code grant flow, which provides an authorization code as the response. |
UserPoolClientType.Builder |
allowedOAuthFlows(String... allowedOAuthFlows)
Set to
code to initiate a code grant flow, which provides an authorization code as the response. |
UserPoolClientType.Builder |
allowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
|
UserPoolClientType.Builder |
allowedOAuthScopes(Collection<String> allowedOAuthScopes)
A list of allowed
OAuth scopes. |
UserPoolClientType.Builder |
allowedOAuthScopes(String... allowedOAuthScopes)
A list of allowed
OAuth scopes. |
UserPoolClientType.Builder |
callbackURLs(Collection<String> callbackURLs)
A list of allowed callback URLs for the identity providers.
|
UserPoolClientType.Builder |
callbackURLs(String... callbackURLs)
A list of allowed callback URLs for the identity providers.
|
UserPoolClientType.Builder |
clientId(String clientId)
The ID of the client associated with the user pool.
|
UserPoolClientType.Builder |
clientName(String clientName)
The client name from the user pool request of the client type.
|
UserPoolClientType.Builder |
clientSecret(String clientSecret)
The client secret from the user pool request of the client type.
|
UserPoolClientType.Builder |
creationDate(Instant creationDate)
The date the user pool client was created.
|
UserPoolClientType.Builder |
defaultRedirectURI(String defaultRedirectURI)
The default redirect URI.
|
UserPoolClientType.Builder |
explicitAuthFlows(Collection<String> explicitAuthFlows)
The explicit authentication flows.
|
UserPoolClientType.Builder |
explicitAuthFlows(String... explicitAuthFlows)
The explicit authentication flows.
|
UserPoolClientType.Builder |
lastModifiedDate(Instant lastModifiedDate)
The date the user pool client was last modified.
|
UserPoolClientType.Builder |
logoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the identity providers.
|
UserPoolClientType.Builder |
logoutURLs(String... logoutURLs)
A list of allowed logout URLs for the identity providers.
|
UserPoolClientType.Builder |
readAttributes(Collection<String> readAttributes)
The Read-only attributes.
|
UserPoolClientType.Builder |
readAttributes(String... readAttributes)
The Read-only attributes.
|
UserPoolClientType.Builder |
refreshTokenValidity(Integer refreshTokenValidity)
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
|
UserPoolClientType.Builder |
supportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
|
UserPoolClientType.Builder |
supportedIdentityProviders(String... supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
|
UserPoolClientType.Builder |
userPoolId(String userPoolId)
The user pool ID for the user pool client.
|
UserPoolClientType.Builder |
writeAttributes(Collection<String> writeAttributes)
The writeable attributes.
|
UserPoolClientType.Builder |
writeAttributes(String... writeAttributes)
The writeable attributes.
|
copy
apply, build
UserPoolClientType.Builder userPoolId(String userPoolId)
The user pool ID for the user pool client.
userPoolId
- The user pool ID for the user pool client.UserPoolClientType.Builder clientName(String clientName)
The client name from the user pool request of the client type.
clientName
- The client name from the user pool request of the client type.UserPoolClientType.Builder clientId(String clientId)
The ID of the client associated with the user pool.
clientId
- The ID of the client associated with the user pool.UserPoolClientType.Builder clientSecret(String clientSecret)
The client secret from the user pool request of the client type.
clientSecret
- The client secret from the user pool request of the client type.UserPoolClientType.Builder lastModifiedDate(Instant lastModifiedDate)
The date the user pool client was last modified.
lastModifiedDate
- The date the user pool client was last modified.UserPoolClientType.Builder creationDate(Instant creationDate)
The date the user pool client was created.
creationDate
- The date the user pool client was created.UserPoolClientType.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.UserPoolClientType.Builder readAttributes(Collection<String> readAttributes)
The Read-only attributes.
readAttributes
- The Read-only attributes.UserPoolClientType.Builder readAttributes(String... readAttributes)
The Read-only attributes.
readAttributes
- The Read-only attributes.UserPoolClientType.Builder writeAttributes(Collection<String> writeAttributes)
The writeable attributes.
writeAttributes
- The writeable attributes.UserPoolClientType.Builder writeAttributes(String... writeAttributes)
The writeable attributes.
writeAttributes
- The writeable attributes.UserPoolClientType.Builder explicitAuthFlows(Collection<String> explicitAuthFlows)
The explicit authentication flows.
explicitAuthFlows
- The explicit authentication flows.UserPoolClientType.Builder explicitAuthFlows(String... explicitAuthFlows)
The explicit authentication flows.
explicitAuthFlows
- The explicit authentication flows.UserPoolClientType.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.UserPoolClientType.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.UserPoolClientType.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.UserPoolClientType.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.UserPoolClientType.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.UserPoolClientType.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.UserPoolClientType.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.UserPoolClientType.Builder allowedOAuthFlows(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.
UserPoolClientType.Builder allowedOAuthFlows(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.
UserPoolClientType.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"
.UserPoolClientType.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"
.UserPoolClientType.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.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.