public static interface UpdateUserPoolClientRequest.Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<UpdateUserPoolClientRequest.Builder,UpdateUserPoolClientRequest>
Modifier and Type | Method and Description |
---|---|
UpdateUserPoolClientRequest.Builder |
allowedOAuthFlows(Collection<OAuthFlowType> allowedOAuthFlows)
Set to
code to initiate a code grant flow, which provides an authorization code as the response. |
UpdateUserPoolClientRequest.Builder |
allowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)
Set to
code to initiate a code grant flow, which provides an authorization code as the response. |
UpdateUserPoolClientRequest.Builder |
allowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
|
UpdateUserPoolClientRequest.Builder |
allowedOAuthFlowsWithStrings(Collection<String> allowedOAuthFlows)
Set to
code to initiate a code grant flow, which provides an authorization code as the response. |
UpdateUserPoolClientRequest.Builder |
allowedOAuthFlowsWithStrings(String... allowedOAuthFlows)
Set to
code to initiate a code grant flow, which provides an authorization code as the response. |
UpdateUserPoolClientRequest.Builder |
allowedOAuthScopes(Collection<String> allowedOAuthScopes)
A list of allowed
OAuth scopes. |
UpdateUserPoolClientRequest.Builder |
allowedOAuthScopes(String... allowedOAuthScopes)
A list of allowed
OAuth scopes. |
UpdateUserPoolClientRequest.Builder |
analyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
|
default UpdateUserPoolClientRequest.Builder |
analyticsConfiguration(Consumer<AnalyticsConfigurationType.Builder> analyticsConfiguration)
The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
|
UpdateUserPoolClientRequest.Builder |
callbackURLs(Collection<String> callbackURLs)
A list of allowed redirect (callback) URLs for the identity providers.
|
UpdateUserPoolClientRequest.Builder |
callbackURLs(String... callbackURLs)
A list of allowed redirect (callback) URLs for the identity providers.
|
UpdateUserPoolClientRequest.Builder |
clientId(String clientId)
The ID of the client associated with the user pool.
|
UpdateUserPoolClientRequest.Builder |
clientName(String clientName)
The client name from the update user pool client request.
|
UpdateUserPoolClientRequest.Builder |
defaultRedirectURI(String defaultRedirectURI)
The default redirect URI.
|
UpdateUserPoolClientRequest.Builder |
explicitAuthFlows(Collection<ExplicitAuthFlowsType> explicitAuthFlows)
Explicit authentication flows.
|
UpdateUserPoolClientRequest.Builder |
explicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)
Explicit authentication flows.
|
UpdateUserPoolClientRequest.Builder |
explicitAuthFlowsWithStrings(Collection<String> explicitAuthFlows)
Explicit authentication flows.
|
UpdateUserPoolClientRequest.Builder |
explicitAuthFlowsWithStrings(String... explicitAuthFlows)
Explicit authentication flows.
|
UpdateUserPoolClientRequest.Builder |
logoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the identity providers.
|
UpdateUserPoolClientRequest.Builder |
logoutURLs(String... logoutURLs)
A list of allowed logout URLs for the identity providers.
|
UpdateUserPoolClientRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
UpdateUserPoolClientRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
UpdateUserPoolClientRequest.Builder |
readAttributes(Collection<String> readAttributes)
The read-only attributes of the user pool.
|
UpdateUserPoolClientRequest.Builder |
readAttributes(String... readAttributes)
The read-only attributes of the user pool.
|
UpdateUserPoolClientRequest.Builder |
refreshTokenValidity(Integer refreshTokenValidity)
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
|
UpdateUserPoolClientRequest.Builder |
supportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
|
UpdateUserPoolClientRequest.Builder |
supportedIdentityProviders(String... supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
|
UpdateUserPoolClientRequest.Builder |
userPoolId(String userPoolId)
The user pool ID for the user pool where you want to update the user pool client.
|
UpdateUserPoolClientRequest.Builder |
writeAttributes(Collection<String> writeAttributes)
The writeable attributes of the user pool.
|
UpdateUserPoolClientRequest.Builder |
writeAttributes(String... writeAttributes)
The writeable attributes of the user pool.
|
build
overrideConfiguration
copy
applyMutation, build
UpdateUserPoolClientRequest.Builder userPoolId(String userPoolId)
The user pool ID for the user pool where you want to update the user pool client.
userPoolId
- The user pool ID for the user pool where you want to update the user pool client.UpdateUserPoolClientRequest.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.UpdateUserPoolClientRequest.Builder clientName(String clientName)
The client name from the update user pool client request.
clientName
- The client name from the update user pool client request.UpdateUserPoolClientRequest.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.UpdateUserPoolClientRequest.Builder readAttributes(Collection<String> readAttributes)
The read-only attributes of the user pool.
readAttributes
- The read-only attributes of the user pool.UpdateUserPoolClientRequest.Builder readAttributes(String... readAttributes)
The read-only attributes of the user pool.
readAttributes
- The read-only attributes of the user pool.UpdateUserPoolClientRequest.Builder writeAttributes(Collection<String> writeAttributes)
The writeable attributes of the user pool.
writeAttributes
- The writeable attributes of the user pool.UpdateUserPoolClientRequest.Builder writeAttributes(String... writeAttributes)
The writeable attributes of the user pool.
writeAttributes
- The writeable attributes of the user pool.UpdateUserPoolClientRequest.Builder explicitAuthFlowsWithStrings(Collection<String> explicitAuthFlows)
Explicit authentication flows.
explicitAuthFlows
- Explicit authentication flows.UpdateUserPoolClientRequest.Builder explicitAuthFlowsWithStrings(String... explicitAuthFlows)
Explicit authentication flows.
explicitAuthFlows
- Explicit authentication flows.UpdateUserPoolClientRequest.Builder explicitAuthFlows(Collection<ExplicitAuthFlowsType> explicitAuthFlows)
Explicit authentication flows.
explicitAuthFlows
- Explicit authentication flows.UpdateUserPoolClientRequest.Builder explicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)
Explicit authentication flows.
explicitAuthFlows
- Explicit authentication flows.UpdateUserPoolClientRequest.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.UpdateUserPoolClientRequest.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.UpdateUserPoolClientRequest.Builder callbackURLs(Collection<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.
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.
UpdateUserPoolClientRequest.Builder callbackURLs(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.
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.
UpdateUserPoolClientRequest.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.UpdateUserPoolClientRequest.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.UpdateUserPoolClientRequest.Builder defaultRedirectURI(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.
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.
UpdateUserPoolClientRequest.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.
UpdateUserPoolClientRequest.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.
UpdateUserPoolClientRequest.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.
UpdateUserPoolClientRequest.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.
UpdateUserPoolClientRequest.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"
.UpdateUserPoolClientRequest.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"
.UpdateUserPoolClientRequest.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.UpdateUserPoolClientRequest.Builder analyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
analyticsConfiguration
- The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.default UpdateUserPoolClientRequest.Builder analyticsConfiguration(Consumer<AnalyticsConfigurationType.Builder> analyticsConfiguration)
The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
This is a convenience that creates an instance of theAnalyticsConfigurationType.Builder
avoiding the
need to create one manually via AnalyticsConfigurationType.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately
and its result is passed to analyticsConfiguration(AnalyticsConfigurationType)
.analyticsConfiguration
- a consumer that will call methods on AnalyticsConfigurationType.Builder
analyticsConfiguration(AnalyticsConfigurationType)
UpdateUserPoolClientRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.UpdateUserPoolClientRequest.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.