Package software.amazon.awssdk.services.appsync.model

Class UserPoolConfig

java.lang.Object

software.amazon.awssdk.services.appsync.model.UserPoolConfig

All Implemented Interfaces:

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

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

Describes an Amazon Cognito user pool configuration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UserPoolConfig.Builder

Method Summary

Modifier and Type	Method	Description
String	appIdClientRegex()	A regular expression for validating the incoming Amazon Cognito user pool app client ID.
String	awsRegion()	The Amazon Web Services Region in which the user pool was created.
static UserPoolConfig.Builder	builder()
DefaultAction	defaultAction()	The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.
String	defaultActionAsString()	The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends UserPoolConfig.Builder>	serializableBuilderClass()
UserPoolConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userPoolId()	The user pool ID.

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 user pool ID.

Returns:

The user pool ID.

awsRegion

public final String awsRegion()

The Amazon Web Services Region in which the user pool was created.

Returns:

The Amazon Web Services Region in which the user pool was created.

defaultAction

public final DefaultAction defaultAction()

The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.

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

Returns:

The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.

See Also:

DefaultAction

defaultActionAsString

public final String defaultActionAsString()

The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.

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

Returns:

The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.

See Also:

DefaultAction

appIdClientRegex

public final String appIdClientRegex()

A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.

Returns:

A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.

toBuilder

public UserPoolConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UserPoolConfig.Builder,UserPoolConfig>

builder

public static UserPoolConfig.Builder builder()

serializableBuilderClass

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