Menu
Lumberyard
Developer Guide (Version 1.11)

Cognito (Player Identity) Nodes

Use Amazon Cognito to configure player identity with these flow graph nodes.

ConfigureAnonymousPlayer node

Creates an anonymous identity on the device in your AWS account.


                    ConfigureAnonymousPlayer

Inputs

Port Type Description
Configure Any Configure your game to use Amazon Cognito for anonymous players
AWSAccountNumber String Your AWS account number. This is needed to access Amazon Cognito.
IdentityPoolID String The unique ID of your Amazon Cognito identity pool. To create an identity pool ID, sign in to the AWS Management Console and use the Amazon Cognito console at https://console.aws.amazon.com/cognito/.
CachingFileLocationOverride String If specified, causes the Amazon Cognito ID to be cached to the path specified instead of to <HOME_DIR>/.aws/.identities.

Outputs

Port Type Description
Success Any Activated upon a successful operation
Error String Activated upon an error being detected; the value of the port is the error message
CognitoIdentityID String The unique ID of the user

The first time the player runs the game and this node is triggered, an anonymous ID is generated for the player. This ID is persisted locally, and future runs of the game use the same identity.

ConfigureAuthenticatedPlayer node

Creates an authenticated identity on the device in your AWS account.


                    ConfigureAuthenticatedPlayer

Inputs

Port Type Description
Configure Any Configure your game to use Amazon Cognito with the values specified.
AWSAccountNumber String Your AWS account number. This is needed for configuring Amazon Cognito.
IdentityPoolID String The unique ID of your Amazon Cognito identity pool. To edit your identity pool ID, open the AWS Management Console and choose Cognito.
ProviderName String Specifies the provider that authenticates the user
ProviderToken String Provider token with which to authenticate the user

Outputs

Port Type Description
Success Any Activated upon a successful operation
Error String Activated upon an error being detected; the value of the port is the error message
CognitoIdentityID String The unique ID of the user

The first time the player runs the game and this node is triggered, an authenticated ID is generated for the player. The same ID is returned any time the user logs in with the same account, even on a second device.