software.amazon.awssdk.services.verifiedpermissions.model

Class CognitoUserPoolConfiguration

java.lang.Object

software.amazon.awssdk.services.verifiedpermissions.model.CognitoUserPoolConfiguration

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class CognitoUserPoolConfiguration
extends Object
implements SdkPojo, Serializable, 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 the Configuration.

Example: "CognitoUserPoolConfiguration":{"UserPoolArn":"cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"]}

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CognitoUserPoolConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static CognitoUserPoolConfiguration.Builder	builder()
List<String>	clientIds() The unique application client IDs that are associated with the specified Amazon Cognito user pool.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasClientIds() For responses, this returns true if the service returned a value for the ClientIds property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CognitoUserPoolConfiguration.Builder>	serializableBuilderClass()
CognitoUserPoolConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	userPoolArn() The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.

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

userPoolArn

public final String userPoolArn()

The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.

Example: "UserPoolArn": "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": "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 the isEmpty() 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

public final List<String> 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;"]

toBuilder

public CognitoUserPoolConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CognitoUserPoolConfiguration.Builder,CognitoUserPoolConfiguration>

builder

public static CognitoUserPoolConfiguration.Builder builder()

serializableBuilderClass

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