software.amazon.awscdk.services.cognito

Interface CfnIdentityPool.CognitoIdentityProviderProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIdentityPool.CognitoIdentityProviderProperty.Jsii$Proxy

Enclosing class:

CfnIdentityPool

@Stability(value=Stable)
public static interface CfnIdentityPool.CognitoIdentityProviderProperty
extends software.amazon.jsii.JsiiSerializable

`CognitoIdentityProvider` is a property of the [AWS::Cognito::IdentityPool](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html) resource that represents an Amazon Cognito user pool and its client ID.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 CognitoIdentityProviderProperty cognitoIdentityProviderProperty = CognitoIdentityProviderProperty.builder()
         .clientId("clientId")
         .providerName("providerName")
         .serverSideTokenCheck(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnIdentityPool.CognitoIdentityProviderProperty.Builder A builder for CfnIdentityPool.CognitoIdentityProviderProperty
static class	CfnIdentityPool.CognitoIdentityProviderProperty.Jsii$Proxy An implementation for CfnIdentityPool.CognitoIdentityProviderProperty

Method Summary

Modifier and Type	Method and Description
static CfnIdentityPool.CognitoIdentityProviderProperty.Builder	builder()
default String	getClientId() The client ID for the Amazon Cognito user pool.
default String	getProviderName() The provider name for an Amazon Cognito user pool.
default Object	getServerSideTokenCheck() TRUE if server-side token validation is enabled for the identity provider’s token.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getClientId

@Stability(value=Stable)
 @Nullable
default String getClientId()

The client ID for the Amazon Cognito user pool.

getProviderName

@Stability(value=Stable)
 @Nullable
default String getProviderName()

The provider name for an Amazon Cognito user pool.

For example: cognito-idp.us-east-2.amazonaws.com/us-east-2_123456789 .

getServerSideTokenCheck

@Stability(value=Stable)
 @Nullable
default Object getServerSideTokenCheck()

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

After you set the ServerSideTokenCheck to TRUE for an identity pool, that identity pool checks with the integrated user pools to make sure 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 returns a 400 Not Authorized error.

builder

@Stability(value=Stable)
static CfnIdentityPool.CognitoIdentityProviderProperty.Builder builder()

Returns:

a CfnIdentityPool.CognitoIdentityProviderProperty.Builder of CfnIdentityPool.CognitoIdentityProviderProperty