java.lang.Object
- software.amazon.awssdk.services.cognitoidentityprovider.model.ManagedLoginBrandingType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ManagedLoginBrandingType.Builder,ManagedLoginBrandingType>
```
@Generated("software.amazon.awssdk:codegen")
public final class ManagedLoginBrandingType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ManagedLoginBrandingType.Builder,ManagedLoginBrandingType>
```
A managed login branding style that's assigned to a user pool app client.

This data type is a response parameter of CreateManagedLoginBranding, UpdateManagedLoginBranding, DescribeManagedLoginBranding, and DescribeManagedLoginBrandingByClient.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ManagedLoginBrandingType.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<AssetType>`	`assets()`	An array of image files that you want to apply to roles like backgrounds, logos, and icons.
`static ManagedLoginBrandingType.Builder`	`builder()`
`Instant`	`creationDate()`	The date and time when the item was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAssets()`	For responses, this returns true if the service returned a value for the Assets property.
`int`	`hashCode()`
`Instant`	`lastModifiedDate()`	The date and time when the item was modified.
`String`	`managedLoginBrandingId()`	The ID of the managed login branding style.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ManagedLoginBrandingType.Builder>`	`serializableBuilderClass()`
`Document`	`settings()`	A JSON file, encoded as a `Document` type, with the the settings that you want to apply to your style.
`ManagedLoginBrandingType.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Boolean`	`useCognitoProvidedValues()`	When true, applies the default branding style options.
`String`	`userPoolId()`	The user pool where the branding style is assigned.

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
  - managedLoginBrandingId
```
public final String managedLoginBrandingId()
```
    The ID of the managed login branding style.
    
    Returns:
    
    The ID of the managed login branding style.
  - userPoolId
```
public final String userPoolId()
```
    The user pool where the branding style is assigned.
    
    Returns:
    
    The user pool where the branding style is assigned.
  - useCognitoProvidedValues
```
public final Boolean useCognitoProvidedValues()
```
    When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer.
    
    When you specify true for this option, you must also omit values for Settings and Assets in the request.
    
    Returns:
    
    When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer.
    
    When you specify true for this option, you must also omit values for Settings and Assets in the request.
  - settings
```
public final Document settings()
```
    A JSON file, encoded as a Document type, with the the settings that you want to apply to your style.
    
    Returns:
    
    A JSON file, encoded as a Document type, with the the settings that you want to apply to your style.
  - hasAssets
```
public final boolean hasAssets()
```
    For responses, this returns true if the service returned a value for the Assets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - assets
```
public final List<AssetType> assets()
```
    An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAssets() method.
    
    Returns:
    
    An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.
  - creationDate
```
public final Instant creationDate()
```
    The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
    
    Returns:
    
    The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
  - lastModifiedDate
```
public final Instant lastModifiedDate()
```
    The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
    
    Returns:
    
    The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
  - toBuilder
```
public ManagedLoginBrandingType.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ManagedLoginBrandingType.Builder,ManagedLoginBrandingType>
  - builder
```
public static ManagedLoginBrandingType.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ManagedLoginBrandingType.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - 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

Class ManagedLoginBrandingType

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

managedLoginBrandingId

userPoolId

useCognitoProvidedValues

settings

hasAssets

assets

creationDate

lastModifiedDate

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField