com.amazonaws.services.cognitoidentity.model

Class CognitoIdentityProvider

java.lang.Object

com.amazonaws.services.cognitoidentity.model.CognitoIdentityProvider

All Implemented Interfaces:

Serializable

public class CognitoIdentityProvider
extends Object
implements Serializable

A provider representing an Amazon Cognito user pool and its client ID.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CognitoIdentityProvider()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getClientId() The client ID for the Amazon Cognito user pool.
String	getProviderName() The provider name for an Amazon Cognito user pool.
Boolean	getServerSideTokenCheck() TRUE if server-side token validation is enabled for the identity provider’s token.
int	hashCode()
Boolean	isServerSideTokenCheck() TRUE if server-side token validation is enabled for the identity provider’s token.
void	setClientId(String clientId) The client ID for the Amazon Cognito user pool.
void	setProviderName(String providerName) The provider name for an Amazon Cognito user pool.
void	setServerSideTokenCheck(Boolean serverSideTokenCheck) TRUE if server-side token validation is enabled for the identity provider’s token.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CognitoIdentityProvider	withClientId(String clientId) The client ID for the Amazon Cognito user pool.
CognitoIdentityProvider	withProviderName(String providerName) The provider name for an Amazon Cognito user pool.
CognitoIdentityProvider	withServerSideTokenCheck(Boolean serverSideTokenCheck) TRUE if server-side token validation is enabled for the identity provider’s token.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CognitoIdentityProvider

public CognitoIdentityProvider()

Method Detail

getProviderName

public String getProviderName()

The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.

Constraints:
Length: 1 - 128
Pattern: [\w._:/-]+

Returns:

The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789 .

setProviderName

public void setProviderName(String providerName)

The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.

Constraints:
Length: 1 - 128
Pattern: [\w._:/-]+

Parameters:

providerName -

The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789 .

withProviderName

public CognitoIdentityProvider withProviderName(String providerName)

The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [\w._:/-]+

Parameters:

providerName -

The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789 .

Returns:

A reference to this updated object so that method calls can be chained together.

getClientId

public String getClientId()

The client ID for the Amazon Cognito user pool.

Constraints:
Length: 1 - 128
Pattern: [\w_]+

Returns:

The client ID for the Amazon Cognito user pool.

setClientId

public void setClientId(String clientId)

The client ID for the Amazon Cognito user pool.

Constraints:
Length: 1 - 128
Pattern: [\w_]+

Parameters:

clientId -

The client ID for the Amazon Cognito user pool.

withClientId

public CognitoIdentityProvider withClientId(String clientId)

The client ID for the Amazon Cognito user pool.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [\w_]+

Parameters:

clientId -

The client ID for the Amazon Cognito user pool.

Returns:

A reference to this updated object so that method calls can be chained together.

isServerSideTokenCheck

public Boolean isServerSideTokenCheck()

TRUE if server-side token validation is enabled for the identity provider’s token.

Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.

Returns:

TRUE if server-side token validation is enabled for the identity provider’s token.

Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.

getServerSideTokenCheck

public Boolean getServerSideTokenCheck()

TRUE if server-side token validation is enabled for the identity provider’s token.

Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.

Returns:

TRUE if server-side token validation is enabled for the identity provider’s token.

Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.

setServerSideTokenCheck

public void setServerSideTokenCheck(Boolean serverSideTokenCheck)

TRUE if server-side token validation is enabled for the identity provider’s token.

Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.

Parameters:

serverSideTokenCheck -

TRUE if server-side token validation is enabled for the identity provider’s token.

Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.

withServerSideTokenCheck

public CognitoIdentityProvider withServerSideTokenCheck(Boolean serverSideTokenCheck)

TRUE if server-side token validation is enabled for the identity provider’s token.

Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.

Returns a reference to this object so that method calls can be chained together.

Parameters:

serverSideTokenCheck -

TRUE if server-side token validation is enabled for the identity provider’s token.

Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object