software.amazon.awssdk.services.appsync.model

Class UserPoolConfig

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<UserPoolConfig.Builder,UserPoolConfig>

@Generated(value="software.amazon.awssdk:codegen")
public class UserPoolConfig
extends Object
implements StructuredPojo, ToCopyableBuilder<UserPoolConfig.Builder,UserPoolConfig>

Describes an Amazon Cognito User Pool configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UserPoolConfig.Builder

Method Summary

Modifier and Type	Method and Description
String	appIdClientRegex() A regular expression for validating the incoming Amazon Cognito User Pool app client ID.
String	awsRegion() The AWS 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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
static Class<? extends UserPoolConfig.Builder>	serializableBuilderClass()
UserPoolConfig.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	userPoolId() The user pool ID.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

userPoolId

public String userPoolId()

The user pool ID.

Returns:

The user pool ID.

awsRegion

public String awsRegion()

The AWS region in which the user pool was created.

Returns:

The AWS region in which the user pool was created.

defaultAction

public 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 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 String appIdClientRegex()

A regular expression for validating the incoming Amazon Cognito User Pool app client ID.

Returns:

A regular expression for validating the incoming Amazon Cognito User Pool app client ID.

toBuilder

public UserPoolConfig.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UserPoolConfig.Builder,UserPoolConfig>

Returns:

a builder for type T

builder

public static UserPoolConfig.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.