Class CognitoUserPoolConfigurationItem
- java.lang.Object
-
- software.amazon.awssdk.services.verifiedpermissions.model.CognitoUserPoolConfigurationItem
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<CognitoUserPoolConfigurationItem.Builder,CognitoUserPoolConfigurationItem>
@Generated("software.amazon.awssdk:codegen") public final class CognitoUserPoolConfigurationItem extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CognitoUserPoolConfigurationItem.Builder,CognitoUserPoolConfigurationItem>
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 the ConfigurationItem structure that is part of the response to ListIdentitySources.
Example:
"CognitoUserPoolConfiguration":{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCognitoUserPoolConfigurationItem.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CognitoUserPoolConfigurationItem.Builderbuilder()List<String>clientIds()The unique application client IDs that are associated with the specified Amazon Cognito user pool.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)CognitoGroupConfigurationItemgroupConfiguration()The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.booleanhasClientIds()For responses, this returns true if the service returned a value for the ClientIds property.inthashCode()Stringissuer()The OpenID Connect (OIDC)issuerID of the Amazon Cognito user pool that contains the identities to be authorized.List<SdkField<?>>sdkFields()static Class<? extends CognitoUserPoolConfigurationItem.Builder>serializableBuilderClass()CognitoUserPoolConfigurationItem.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringuserPoolArn()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": "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
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;"]
-
issuer
public final String issuer()
The OpenID Connect (OIDC)
issuerID of the Amazon Cognito user pool that contains the identities to be authorized.Example:
"issuer": "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5"- Returns:
- The OpenID Connect (OIDC)
issuerID of the Amazon Cognito user pool that contains the identities to be authorized.Example:
"issuer": "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5"
-
groupConfiguration
public final CognitoGroupConfigurationItem groupConfiguration()
The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
- Returns:
- The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
-
toBuilder
public CognitoUserPoolConfigurationItem.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CognitoUserPoolConfigurationItem.Builder,CognitoUserPoolConfigurationItem>
-
builder
public static CognitoUserPoolConfigurationItem.Builder builder()
-
serializableBuilderClass
public static Class<? extends CognitoUserPoolConfigurationItem.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-