Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class SetUiCustomizationRequest

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.SetUiCustomizationRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SetUiCustomizationRequest.Builder,SetUiCustomizationRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SetUiCustomizationRequest.Builder

Method Summary

Modifier and Type	Method	Description
static SetUiCustomizationRequest.Builder	builder()
String	clientId()	The ID of the app client that you want to customize.
String	css()	A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
SdkBytes	imageFile()	The image that you want to set as your login in the classic hosted UI, as a Base64-formatted binary object.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SetUiCustomizationRequest.Builder>	serializableBuilderClass()
SetUiCustomizationRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userPoolId()	The ID of the user pool where you want to apply branding to the classic hosted UI.

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 final String userPoolId()

The ID of the user pool where you want to apply branding to the classic hosted UI.

Returns:

The ID of the user pool where you want to apply branding to the classic hosted UI.

clientId

public final String clientId()

The ID of the app client that you want to customize. To apply a default style to all app clients not configured with client-level branding, set this parameter value to ALL.

Returns:

The ID of the app client that you want to customize. To apply a default style to all app clients not configured with client-level branding, set this parameter value to ALL.

css

public final String css()

A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client. To download a template, go to the Amazon Cognito console. Navigate to your user pool App clients tab, select Login pages, edit Hosted UI (classic) style, and select the link to CSS template.css.

Returns:

A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client. To download a template, go to the Amazon Cognito console. Navigate to your user pool App clients tab, select Login pages, edit Hosted UI (classic) style, and select the link to CSS template.css.

imageFile

public final SdkBytes imageFile()

The image that you want to set as your login in the classic hosted UI, as a Base64-formatted binary object.

Returns:

The image that you want to set as your login in the classic hosted UI, as a Base64-formatted binary object.

toBuilder

public SetUiCustomizationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SetUiCustomizationRequest.Builder,SetUiCustomizationRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static SetUiCustomizationRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SetUiCustomizationRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo