Class UserPoolConfig
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<UserPoolConfig.Builder,
UserPoolConfig>
Describes an Amazon Cognito user pool configuration.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
A regular expression for validating the incoming Amazon Cognito user pool app client ID.final String
The Amazon Web Services Region in which the user pool was created.static UserPoolConfig.Builder
builder()
final 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.final String
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.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends UserPoolConfig.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The user pool ID.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
userPoolId
The user pool ID.
- Returns:
- The user pool ID.
-
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
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 returnDefaultAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdefaultActionAsString()
.- 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:
-
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 returnDefaultAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdefaultActionAsString()
.- 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:
-
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
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 interfaceToCopyableBuilder<UserPoolConfig.Builder,
UserPoolConfig> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-