CognitoIdentityProvider (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cognitoidentity.model.CognitoIdentityProvider

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CognitoIdentityProvider
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A provider representing an Amazon Cognito user pool and its client ID.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CognitoIdentityProvider()

Constructors
Constructor and Description
`CognitoIdentityProvider()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CognitoIdentityProvider`	`clone()`
`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`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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.
`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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CognitoIdentityProvider
```
public CognitoIdentityProvider()
```
- Method Detail
  - 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.
    
    Parameters:
    
    providerName - The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.
  - 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.
    
    Returns:
    
    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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientId
```
public void setClientId(String clientId)
```
    The client ID for the Amazon Cognito user pool.
    
    Parameters:
    
    clientId - The client ID for the Amazon Cognito user pool.
  - getClientId
```
public String getClientId()
```
    The client ID for the Amazon Cognito user pool.
    
    Returns:
    
    The client ID for the Amazon Cognito user pool.
  - withClientId
```
public CognitoIdentityProvider withClientId(String clientId)
```
    The client ID for the Amazon Cognito user pool.
    
    Parameters:
    
    clientId - The client ID for the Amazon Cognito user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    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:
    
    Returns a reference to this 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.
  - 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 CognitoIdentityProvider 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.779

Class CognitoIdentityProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CognitoIdentityProvider

Method Detail

setProviderName

getProviderName

withProviderName

setClientId

getClientId

withClientId

setServerSideTokenCheck

getServerSideTokenCheck

withServerSideTokenCheck

isServerSideTokenCheck

toString

equals

hashCode

clone

marshall