Cloud Gem Portal
The Cloud Gem Portal (CGP) is deprecated and will be removed in a future version of Lumberyard. |
A cloud gem is a gem in Lumberyard whose scripts and assets use AWS resources to implement cloud-connected game features. A cloud gem creates a Cloud Gem Portal (CGP) that you can use to manage the cloud data for your game. For example, the Leaderboard Cloud Gem Portal can provide a way for a support person to remove fraudulent high scores. The Cloud Gem Portal is hosted in your AWS account and is a website that you own. The Cloud Gem Portal is part of the Cloud Gem Framework and can be customized.
How a Cloud Gem Portal Works
Cloud gem portals use Amazon Web Services to implement their functionality, as shown in the following diagram.

Amazon S3
Cloud Gem Workflow
A cloud gem provides content (for example, HTML, JavaScript, or images) from its
subdirectory. When you deploy a cloud gem, the Cloud Canvas Resource Manager uploads
this content to the project’s configuration bucket. To determine which cloud gems
are
available to it, the Cloud Gem Portal page uses the Cloud Gem Portal service API to
call the Cloud Gem Portal Lambda function.
When you select a cloud gem, its content is loaded into the Cloud Gem Portal webpage.
To query the
state of the cloud gem or perform other operations, JavaScript code can use a service
API
defined for the cloud gem. The service API calls the cloud gem's Lambda function that
implements the cloud gem's functionality.
lumberyard_version
\dev\Gems\gemName
\vN
\AWS\cgp-resource-code
Setting Up and Accessing the Cloud Gem Portal
In order to use the Cloud Gem Portal for a cloud gem, the corresponding cloud gem must be enabled in your project and you must create a project stack and a deployment stack in AWS. For information on using the Project Configurator to enable gems and cloud gems in your project, see Enabling Gems. For information on using Cloud Canvas Resource Manager to create a project stack and a deployment stack in AWS, see Tutorial: Getting Started with Cloud Canvas.
Topics