Class CognitoUserPoolConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CognitoUserPoolConfiguration.Builder,
CognitoUserPoolConfiguration>
The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.
This data type is used as a field that is part of an Configuration structure that is used as a parameter to CreateIdentitySource.
Example:
"CognitoUserPoolConfiguration":{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"]}
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The unique application client IDs that are associated with the specified Amazon Cognito user pool.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) The configuration of the user groups from an Amazon Cognito user pool identity source.final boolean
For responses, this returns true if the service returned a value for the ClientIds property.final int
hashCode()
static Class
<? extends CognitoUserPoolConfiguration.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 Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
userPoolArn
The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.
Example:
"UserPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"
- Returns:
- The Amazon Resource
Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.
Example:
"UserPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"
-
hasClientIds
public final boolean hasClientIds()For responses, this returns true if the service returned a value for the ClientIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
clientIds
The unique application client IDs that are associated with the specified Amazon Cognito user pool.
Example:
"ClientIds": ["&ExampleCogClientId;"]
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
hasClientIds()
method.- Returns:
- The unique application client IDs that are associated with the specified Amazon Cognito user pool.
Example:
"ClientIds": ["&ExampleCogClientId;"]
-
groupConfiguration
The configuration of the user groups from an Amazon Cognito user pool identity source.
- Returns:
- The configuration of the user groups from an Amazon Cognito user pool identity source.
-
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<CognitoUserPoolConfiguration.Builder,
CognitoUserPoolConfiguration> - 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
-