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

Class UserPoolDescriptionType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.UserPoolDescriptionType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<UserPoolDescriptionType.Builder,UserPoolDescriptionType>

@Generated("software.amazon.awssdk:codegen")
public final class UserPoolDescriptionType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UserPoolDescriptionType.Builder,UserPoolDescriptionType>

A short description of a user pool.

This data type is a response parameter of ListUserPools.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UserPoolDescriptionType.Builder

Method Summary

Modifier and Type	Method	Description
static UserPoolDescriptionType.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)
int	hashCode()
String	id()	The user pool ID.
LambdaConfigType	lambdaConfig()	A collection of user pool Lambda triggers.
Instant	lastModifiedDate()	The date and time when the item was modified.
String	name()	The user pool name.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UserPoolDescriptionType.Builder>	serializableBuilderClass()
StatusType	status()	Deprecated. This property is no longer available.
String	statusAsString()	Deprecated. This property is no longer available.
UserPoolDescriptionType.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

id

public final String id()

The user pool ID.

Returns:

The user pool ID.

name

public final String name()

The user pool name.

Returns:

The user pool name.

lambdaConfig

public final LambdaConfigType lambdaConfig()

A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of user pool operations. Triggers can modify the outcome of the operations that invoked them.

Returns:

A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of user pool operations. Triggers can modify the outcome of the operations that invoked them.

status

@Deprecated
public final StatusType status()

Deprecated.

This property is no longer available.

The user pool status.

If the service returns an enum value that is not available in the current SDK version, status will return StatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The user pool status.

See Also:

StatusType

statusAsString

@Deprecated
public final String statusAsString()

Deprecated.

This property is no longer available.

The user pool status.

If the service returns an enum value that is not available in the current SDK version, status will return StatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The user pool status.

See Also:

StatusType

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.

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.

toBuilder

public UserPoolDescriptionType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UserPoolDescriptionType.Builder,UserPoolDescriptionType>

builder

public static UserPoolDescriptionType.Builder builder()

serializableBuilderClass

public static Class<? extends UserPoolDescriptionType.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