AWS Core Gem
AWS Gems Have Moved:DawnEngine no longer includes AWS gems by default. Visit https://github.com/aws/o3de-repo for instructions on how to install AWS gems (the upstream O3DE-compatible AWS gems repository).
The AWS Core Gem lets you use AWS services from within O3DE. Other AWS Gems typically have a dependency on this Gem since it provides the common mechanisms to do the following:
- Set up the required AWS SDK for C++.
- Configure platform clients.
- Make HTTPS RESTful calls.
- Handle generic responses and errors
- Set up and use AWS credentials.
Features
The AWS Core Gem has the following key features:
Initializes, configures , and terminates the AWS SDK for C++ .
- Includes platform extensions for the SDK for C++.
- Provides a common client configuration ready for O3DE. Refer to AWS Client configuration for details.
Handles HTTPS calls to AWS services, including responses and errors.
Lets you use AWS credentials, including existing AWS Command Line Interface (AWS CLI) profiles and roles, along with console variables (CVARs) for easier configuration. Refer to Configuring AWS Credentials for details.
Supports AWS resource sharing, helping you identify AWS resources that you can use from O3DE.
Provides utility functions that make it easier to work with AWS services and resources.
Enabling the AWS Core Gem
To enable the AWS Core Gem, do the following:
Use O3DE Project Manager or the command line to add the AWS Core Gem to your project.
Build your project using Project Manager, Visual Studio, or CMake.
To configure your environment and project to use AWS services, follow the instructions in Getting Started with AWS Gems.
Getting Started with AWS Gems
Learn how to set up the AWS Core Gem for accessing AWS services from your Open 3D Engine (O3DE) project.
Configuring AWS Credentials
Learn how to configure AWS credentials in Open 3D Engine for AWS cloud-connected features.
Deploying the AWS CDK Application
Learn how to deploy the optional Python AWS CDK application in Open 3D Engine.
Resource Mapping Files
Learn about the resource mapping file used by AWS Gems in the Open 3D Engine (O3DE).
Resource Mapping Schema
View the JSON resource mapping schema used by AWS Gems in the Open 3D Engine (O3DE).
Using the Resource Mapping Tool
Learn how to use the AWS Resource Mapping Tool in Open 3D Engine.
Scripting
Examples of using the AWS Core Gem with Script Canvas in Open 3D Engine (O3DE).
Metric Data Collection
Metric data collected by the AWS Core Gem in Open 3D Engine.