CognitoUserPoolConfigurationItem (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.verifiedpermissions.model.CognitoUserPoolConfigurationItem

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CognitoUserPoolConfigurationItem
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CognitoUserPoolConfigurationItem()

Constructors
Constructor and Description
`CognitoUserPoolConfigurationItem()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CognitoUserPoolConfigurationItem`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getClientIds()` The unique application client IDs that are associated with the specified Amazon Cognito user pool.
`CognitoGroupConfigurationItem`	`getGroupConfiguration()` The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
`String`	`getIssuer()` The OpenID Connect (OIDC) `issuer` ID of the Amazon Cognito user pool that contains the identities to be authorized.
`String`	`getUserPoolArn()` The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setClientIds(Collection<String> clientIds)` The unique application client IDs that are associated with the specified Amazon Cognito user pool.
`void`	`setGroupConfiguration(CognitoGroupConfigurationItem groupConfiguration)` The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
`void`	`setIssuer(String issuer)` The OpenID Connect (OIDC) `issuer` ID of the Amazon Cognito user pool that contains the identities to be authorized.
`void`	`setUserPoolArn(String userPoolArn)` The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.
`String`	`toString()` Returns a string representation of this object.
`CognitoUserPoolConfigurationItem`	`withClientIds(Collection<String> clientIds)` The unique application client IDs that are associated with the specified Amazon Cognito user pool.
`CognitoUserPoolConfigurationItem`	`withClientIds(String... clientIds)` The unique application client IDs that are associated with the specified Amazon Cognito user pool.
`CognitoUserPoolConfigurationItem`	`withGroupConfiguration(CognitoGroupConfigurationItem groupConfiguration)` The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
`CognitoUserPoolConfigurationItem`	`withIssuer(String issuer)` The OpenID Connect (OIDC) `issuer` ID of the Amazon Cognito user pool that contains the identities to be authorized.
`CognitoUserPoolConfigurationItem`	`withUserPoolArn(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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CognitoUserPoolConfigurationItem
```
public CognitoUserPoolConfigurationItem()
```
- Method Detail
  - setUserPoolArn
```
public void setUserPoolArn(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"
    
    Parameters:
    
    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"
  - getUserPoolArn
```
public String getUserPoolArn()
```
    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"
  - withUserPoolArn
```
public CognitoUserPoolConfigurationItem withUserPoolArn(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"
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getClientIds
```
public List<String> getClientIds()
```
    The unique application client IDs that are associated with the specified Amazon Cognito user pool.
    
    Example: "clientIds": ["&ExampleCogClientId;"]
    
    Returns:
    
    The unique application client IDs that are associated with the specified Amazon Cognito user pool.
    
    Example: "clientIds": ["&ExampleCogClientId;"]
  - setClientIds
```
public void setClientIds(Collection<String> clientIds)
```
    The unique application client IDs that are associated with the specified Amazon Cognito user pool.
    
    Example: "clientIds": ["&ExampleCogClientId;"]
    
    Parameters:
    
    clientIds - The unique application client IDs that are associated with the specified Amazon Cognito user pool.
    
    Example: "clientIds": ["&ExampleCogClientId;"]
  - withClientIds
```
public CognitoUserPoolConfigurationItem withClientIds(String... clientIds)
```
    The unique application client IDs that are associated with the specified Amazon Cognito user pool.
    
    Example: "clientIds": ["&ExampleCogClientId;"]
    
    NOTE: This method appends the values to the existing list (if any). Use setClientIds(java.util.Collection) or withClientIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    clientIds - The unique application client IDs that are associated with the specified Amazon Cognito user pool.
    
    Example: "clientIds": ["&ExampleCogClientId;"]
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withClientIds
```
public CognitoUserPoolConfigurationItem withClientIds(Collection<String> clientIds)
```
    The unique application client IDs that are associated with the specified Amazon Cognito user pool.
    
    Example: "clientIds": ["&ExampleCogClientId;"]
    
    Parameters:
    
    clientIds - The unique application client IDs that are associated with the specified Amazon Cognito user pool.
    
    Example: "clientIds": ["&ExampleCogClientId;"]
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIssuer
```
public void setIssuer(String issuer)
```
    The OpenID Connect (OIDC) issuer ID 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"
    
    Parameters:
    
    issuer - The OpenID Connect (OIDC) issuer ID 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"
  - getIssuer
```
public String getIssuer()
```
    The OpenID Connect (OIDC) issuer ID 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) issuer ID 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"
  - withIssuer
```
public CognitoUserPoolConfigurationItem withIssuer(String issuer)
```
    The OpenID Connect (OIDC) issuer ID 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"
    
    Parameters:
    
    issuer - The OpenID Connect (OIDC) issuer ID 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGroupConfiguration
```
public void setGroupConfiguration(CognitoGroupConfigurationItem groupConfiguration)
```
    The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
    
    Parameters:
    
    groupConfiguration - The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
  - getGroupConfiguration
```
public CognitoGroupConfigurationItem getGroupConfiguration()
```
    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.
  - withGroupConfiguration
```
public CognitoUserPoolConfigurationItem withGroupConfiguration(CognitoGroupConfigurationItem groupConfiguration)
```
    The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
    
    Parameters:
    
    groupConfiguration - The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CognitoUserPoolConfigurationItem clone()
```
    Overrides:
    
    clone in class Object
  - 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.

AWS SDK for Java 1.x API Reference - 1.12.792

Class CognitoUserPoolConfigurationItem

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CognitoUserPoolConfigurationItem

Method Detail

setUserPoolArn

getUserPoolArn

withUserPoolArn

getClientIds

setClientIds

withClientIds

withClientIds

setIssuer

getIssuer

withIssuer

setGroupConfiguration

getGroupConfiguration

withGroupConfiguration

toString

equals

hashCode

clone

marshall