Interface CfnIdentityPool.ICognitoIdentityProviderProperty
CognitoIdentityProvider
is a property of the AWS::Cognito::IdentityPool resource that represents an Amazon Cognito user pool and its client ID.
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public interface ICognitoIdentityProviderProperty
Syntax (vb)
Public Interface ICognitoIdentityProviderProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;
var cognitoIdentityProviderProperty = new CognitoIdentityProviderProperty {
ClientId = "clientId",
ProviderName = "providerName",
ServerSideTokenCheck = false
};
Synopsis
Properties
ClientId | The client ID for the Amazon Cognito user pool. |
ProviderName | The provider name for an Amazon Cognito user pool. |
ServerSideTokenCheck | TRUE if server-side token validation is enabled for the identity provider’s token. |
Properties
ClientId
The client ID for the Amazon Cognito user pool.
virtual string ClientId { get; }
Property Value
System.String
Remarks
ProviderName
The provider name for an Amazon Cognito user pool.
virtual string ProviderName { get; }
Property Value
System.String
Remarks
For example: cognito-idp.us-east-2.amazonaws.com/us-east-2_123456789
.
ServerSideTokenCheck
TRUE if server-side token validation is enabled for the identity provider’s token.
virtual object ServerSideTokenCheck { get; }
Property Value
System.Object
Remarks
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.