com.amazonaws.services.verifiedpermissions.model

Class CognitoUserPoolConfiguration

java.lang.Object

com.amazonaws.services.verifiedpermissions.model.CognitoUserPoolConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CognitoUserPoolConfiguration
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 an Configuration structure that is used as a parameter to the Configuration.

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CognitoUserPoolConfiguration()

Method Summary

Modifier and Type	Method and Description
CognitoUserPoolConfiguration	clone()
boolean	equals(Object obj)
List<String>	getClientIds() The unique application client IDs that are associated with the specified Amazon Cognito user pool.
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	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.
CognitoUserPoolConfiguration	withClientIds(Collection<String> clientIds) The unique application client IDs that are associated with the specified Amazon Cognito user pool.
CognitoUserPoolConfiguration	withClientIds(String... clientIds) The unique application client IDs that are associated with the specified Amazon Cognito user pool.
CognitoUserPoolConfiguration	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

CognitoUserPoolConfiguration

public CognitoUserPoolConfiguration()

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 CognitoUserPoolConfiguration 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 CognitoUserPoolConfiguration 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 CognitoUserPoolConfiguration 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.

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 CognitoUserPoolConfiguration 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.