@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 part of a 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"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}
Constructor and Description |
---|
CognitoUserPoolConfiguration() |
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.
|
CognitoGroupConfiguration |
getGroupConfiguration()
The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
|
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(CognitoGroupConfiguration groupConfiguration)
The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
|
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 |
withGroupConfiguration(CognitoGroupConfiguration groupConfiguration)
The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
|
CognitoUserPoolConfiguration |
withUserPoolArn(String userPoolArn)
The Amazon Resource Name
(ARN) of the Amazon Cognito user pool that contains the identities to be authorized.
|
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"
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"
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"
Example:
"UserPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"
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"
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"
public List<String> getClientIds()
The unique application client IDs that are associated with the specified Amazon Cognito user pool.
Example: "ClientIds": ["&ExampleCogClientId;"]
Example: "ClientIds": ["&ExampleCogClientId;"]
public void setClientIds(Collection<String> clientIds)
The unique application client IDs that are associated with the specified Amazon Cognito user pool.
Example: "ClientIds": ["&ExampleCogClientId;"]
clientIds
- The unique application client IDs that are associated with the specified Amazon Cognito user pool.
Example: "ClientIds": ["&ExampleCogClientId;"]
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.
clientIds
- The unique application client IDs that are associated with the specified Amazon Cognito user pool.
Example: "ClientIds": ["&ExampleCogClientId;"]
public CognitoUserPoolConfiguration withClientIds(Collection<String> clientIds)
The unique application client IDs that are associated with the specified Amazon Cognito user pool.
Example: "ClientIds": ["&ExampleCogClientId;"]
clientIds
- The unique application client IDs that are associated with the specified Amazon Cognito user pool.
Example: "ClientIds": ["&ExampleCogClientId;"]
public void setGroupConfiguration(CognitoGroupConfiguration groupConfiguration)
The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
groupConfiguration
- The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.public CognitoGroupConfiguration getGroupConfiguration()
The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
public CognitoUserPoolConfiguration withGroupConfiguration(CognitoGroupConfiguration groupConfiguration)
The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
groupConfiguration
- The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.public String toString()
toString
in class Object
Object.toString()
public CognitoUserPoolConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.