UpdateUserPoolClientRequest (AWS Java SDK :: Services :: Amazon Cognito Identity Provider Service 2.9.7 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest
    - - software.amazon.awssdk.services.cognitoidentityprovider.model.UpdateUserPoolClientRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateUserPoolClientRequest.Builder,UpdateUserPoolClientRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateUserPoolClientRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<UpdateUserPoolClientRequest.Builder,UpdateUserPoolClientRequest>

Represents the request to update the user pool client.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UpdateUserPoolClientRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UpdateUserPoolClientRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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>`	`allowedOAuthFlowsAsStrings()` 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.
`AnalyticsConfigurationType`	`analyticsConfiguration()` The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
`static UpdateUserPoolClientRequest.Builder`	`builder()`
`List<String>`	`callbackURLs()` A list of allowed redirect (callback) URLs for the identity providers.
`String`	`clientId()` The ID of the client associated with the user pool.
`String`	`clientName()` The client name from the update user pool client request.
`String`	`defaultRedirectURI()` The default redirect URI.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<ExplicitAuthFlowsType>`	`explicitAuthFlows()` Explicit authentication flows.
`List<String>`	`explicitAuthFlowsAsStrings()` Explicit authentication flows.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`List<String>`	`logoutURLs()` A list of allowed logout URLs for the identity providers.
`List<String>`	`readAttributes()` The read-only attributes of the user pool.
`Integer`	`refreshTokenValidity()` The time limit, in days, after which the refresh token is no longer valid and cannot be used.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateUserPoolClientRequest.Builder>`	`serializableBuilderClass()`
`List<String>`	`supportedIdentityProviders()` A list of provider names for the identity providers that are supported on this client.
`UpdateUserPoolClientRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`userPoolId()` The user pool ID for the user pool where you want to update the user pool client.
`List<String>`	`writeAttributes()` The writeable attributes of the user pool.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - userPoolId
```
public String userPoolId()
```
    The user pool ID for the user pool where you want to update the user pool client.
    
    Returns:
    
    The user pool ID for the user pool where you want to update the user pool client.
  - clientId
```
public String clientId()
```
    The ID of the client associated with the user pool.
    
    Returns:
    
    The ID of the client associated with the user pool.
  - clientName
```
public String clientName()
```
    The client name from the update user pool client request.
    
    Returns:
    
    The client name from the update user pool client request.
  - 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-only attributes of the user pool.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The read-only attributes of the user pool.
  - writeAttributes
```
public List<String> writeAttributes()
```
    The writeable attributes of the user pool.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The writeable attributes of the user pool.
  - explicitAuthFlows
```
public List<ExplicitAuthFlowsType> explicitAuthFlows()
```
    Explicit authentication flows.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Explicit authentication flows.
  - explicitAuthFlowsAsStrings
```
public List<String> explicitAuthFlowsAsStrings()
```
    Explicit authentication flows.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Explicit authentication flows.
  - supportedIdentityProviders
```
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.
    
    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 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    Returns:
    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.
  - logoutURLs
```
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.
    
    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.
    
    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.
    Returns:
    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.
  - allowedOAuthFlows
```
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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    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.
  - allowedOAuthFlowsAsStrings
```
public List<String> allowedOAuthFlowsAsStrings()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    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.
  - allowedOAuthScopes
```
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.
    
    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.
  - analyticsConfiguration
```
public AnalyticsConfigurationType analyticsConfiguration()
```
    The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
    
    Returns:
    
    The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
  - toBuilder
```
public UpdateUserPoolClientRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateUserPoolClientRequest.Builder,UpdateUserPoolClientRequest>
    
    Specified by:
    
    toBuilder in class CognitoIdentityProviderRequest
  - builder
```
public static UpdateUserPoolClientRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateUserPoolClientRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdateUserPoolClientRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

userPoolId

clientId

clientName

refreshTokenValidity

readAttributes

writeAttributes

explicitAuthFlows

explicitAuthFlowsAsStrings

supportedIdentityProviders

callbackURLs

logoutURLs

defaultRedirectURI

allowedOAuthFlows

allowedOAuthFlowsAsStrings

allowedOAuthScopes

allowedOAuthFlowsUserPoolClient

analyticsConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields