com.amazonaws.services.cognitoidentityprovider.model

Class SetUICustomizationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.SetUICustomizationRequest

All Implemented Interfaces:

Serializable, Cloneable

public class SetUICustomizationRequest
extends AmazonWebServiceRequest
implements Serializable

Sets the UI customization information for a user pool's built-in app UI.

You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration will be used for every client that has no UI customization set previously. If you specify UI customization settings for a particular client, it will no longer fall back to the ALL configuration.

To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SetUICustomizationRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getClientId() The client ID for the client app.
String	getCSS() The CSS values in the UI customization.
ByteBuffer	getImageFile() The uploaded logo image for the UI customization.
String	getUserPoolId() The user pool ID for the user pool.
int	hashCode()
void	setClientId(String clientId) The client ID for the client app.
void	setCSS(String cSS) The CSS values in the UI customization.
void	setImageFile(ByteBuffer imageFile) The uploaded logo image for the UI customization.
void	setUserPoolId(String userPoolId) The user pool ID for the user pool.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SetUICustomizationRequest	withClientId(String clientId) The client ID for the client app.
SetUICustomizationRequest	withCSS(String cSS) The CSS values in the UI customization.
SetUICustomizationRequest	withImageFile(ByteBuffer imageFile) The uploaded logo image for the UI customization.
SetUICustomizationRequest	withUserPoolId(String userPoolId) The user pool ID for the user pool.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SetUICustomizationRequest

public SetUICustomizationRequest()

Method Detail

getUserPoolId

public String getUserPoolId()

The user pool ID for the user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Returns:

The user pool ID for the user pool.

setUserPoolId

public void setUserPoolId(String userPoolId)

The user pool ID for the user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The user pool ID for the user pool.

withUserPoolId

public SetUICustomizationRequest withUserPoolId(String userPoolId)

The user pool ID for the user pool.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The user pool ID for the user pool.

Returns:

A reference to this updated object so that method calls can be chained together.

getClientId

public String getClientId()

The client ID for the client app.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

Returns:

The client ID for the client app.

setClientId

public void setClientId(String clientId)

The client ID for the client app.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

Parameters:

clientId -

The client ID for the client app.

withClientId

public SetUICustomizationRequest withClientId(String clientId)

The client ID for the client app.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

Parameters:

clientId -

The client ID for the client app.

Returns:

A reference to this updated object so that method calls can be chained together.

getCSS

public String getCSS()

The CSS values in the UI customization.

Returns:

The CSS values in the UI customization.

setCSS

public void setCSS(String cSS)

The CSS values in the UI customization.

Parameters:

cSS -

The CSS values in the UI customization.

withCSS

public SetUICustomizationRequest withCSS(String cSS)

The CSS values in the UI customization.

Returns a reference to this object so that method calls can be chained together.

Parameters:

cSS -

The CSS values in the UI customization.

Returns:

A reference to this updated object so that method calls can be chained together.

getImageFile

public ByteBuffer getImageFile()

The uploaded logo image for the UI customization.

Returns:

The uploaded logo image for the UI customization.

setImageFile

public void setImageFile(ByteBuffer imageFile)

The uploaded logo image for the UI customization.

Parameters:

imageFile -

The uploaded logo image for the UI customization.

withImageFile

public SetUICustomizationRequest withImageFile(ByteBuffer imageFile)

The uploaded logo image for the UI customization.

Returns a reference to this object so that method calls can be chained together.

Parameters:

imageFile -

The uploaded logo image for the UI customization.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object