Class CfnIdentityPool.CognitoIdentityProviderProperty
CognitoIdentityProvider
is a property of the AWS::Cognito::IdentityPool resource that represents an Amazon Cognito user pool and its client ID.
Inheritance
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CognitoIdentityProviderProperty : Object, CfnIdentityPool.ICognitoIdentityProviderProperty
Syntax (vb)
Public Class CognitoIdentityProviderProperty
Inherits Object
Implements CfnIdentityPool.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",
// the properties below are optional
ServerSideTokenCheck = false
};
Synopsis
Constructors
CognitoIdentityProviderProperty() |
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. |
Constructors
CognitoIdentityProviderProperty()
public CognitoIdentityProviderProperty()
Properties
ClientId
The client ID for the Amazon Cognito user pool.
public string ClientId { get; set; }
Property Value
System.String
Remarks
ProviderName
The provider name for an Amazon Cognito user pool.
public string ProviderName { get; set; }
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.
public object ServerSideTokenCheck { get; set; }
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.