AWS Amplify for Godot Engine - Plugin

This project contains a Godot Engine plugin to interact with AWS Amplify deployed resources on AWS.

Note: “The sample code; software libraries; command line tools; proofs of concept; templates; or other related technology (including any of the foregoing that are provided by our personnel) is provided to you as AWS Content under the AWS Customer Agreement, or the relevant written agreement between you and AWS (whichever applies). You should not use this AWS Content in your production accounts, or on production or other critical data. You are responsible for testing, securing, and optimizing the AWS Content, such as sample code, as appropriate for production grade use based on your specific quality control practices and standards. Deploying AWS Content may incur AWS charges for creating or using AWS chargeable resources, such as running Amazon EC2 instances or using Amazon S3 storage.”

Quickstart

If you need step by step tutorials you can use our quicktstarts or explore labs on the wiki.

Install the Plugin

Download the plugin

1. Go to the GitHub Release Section
2. Click on the latest release
3. Download the source code
4. Extract the plugin code
5. Copy the addons/aws-amplify folder at the root of your Godot project

Enable the plugin

1. Open Project -> Project Settings -> Plugins -> Enabled (AWS Amplify)
2. The plugin autload the aws_amplify singleton when enabled

The AWS Amplify Plugin is ready to be used!

Architecture

The plugin is organized in the same way as the amplify-js client. The base class AWSAmplify contains several module, each of them implementing specific features. You can access each module from the base class direcly with the global variable aws_amplify.

Client (client)

This module offers basic features to send http requests to AWS resources.

You can find the source code here.

Here's a list of all the functions with their parameters from the provided AWSAmplifyClient class:

Http Requests (raw)

You can send http request and receive responses, with plain text bodies:

• get_(endpoint: String, headers: Array, body: String)
• post(endpoint: String, headers: Array, body: String)
• put(endpoint: String, headers: Array, body: String)
• delete(endpoint: String, headers: Array, body: String)
• send(endpoint: String, headers: Array, method: HTTPClient.Method, body: String)

Http Requests (json)

You can send http request and receive responses, with JSON bodies:

• get_json(endpoint: String, headers: Array, json_body: Dictionary)
• post_json(endpoint: String, headers: Array, json_body: Dictionary)
• put_json(endpoint: String, headers: Array, json_body: Dictionary)
• delete_json(endpoint: String, headers: Array, body: Dictionary)
• send_json(endpoint: String, headers: Array, method: HTTPClient.Method, json_body: Dictionary)

This module is used in other modules such as auth and data.

Authentication (auth)

This module offers authentication features.

You can find the source code here.

Sign-Up

• sign_up(username, password, options: Dictionary = {})
• confirm_sign_up(username: String, confirmation_code: String, options: Dictionary = {})
• resend_sign_up_code(username, options: Dictionary = {})

Sign-In

• sign_in(username, password, options: Dictionary = {})
• reset_password(username, options: Dictionary = {})
• confirm_reset_password(username, new_password, confirmation_code, options: Dictionary = {})
• update_password(old_password, new_password, options: Dictionary = {})

Sign-Out

• sign_out(global: bool = false)
• refresh_token(refresh_token)

User Attributes

• update_user_attributes(user_attributes: Dictionary, options: Dictionary = {})
• update_user_attribute(user_attribute_name: String, user_attribute_value, options: Dictionary = {})
• confirm_user_attribute(attribute_name: String, confirmation_code: String, options: Dictionary = {})
• send_user_attribute_confirmation_code(attribute_name: String, confirmation_code: String, options: Dictionary = {})
• delete_user_attributes(user_attribute_names: Array[String])

Cached variables manipulation (tokens and user attributes)

• get_token(name)
• get_user_attribute(name: String, refresh_attributes = false)
• get_user_attributes(refresh_attributes = false)
• add_user_attributes(user_attributes: Dictionary)
• remove_user_attributes(keys: Array)
• refresh_user(refresh_token = false, refresh_user_attributes = false)

Authenticated http request (raw)

• get_(endpoint: String, headers: Array, body: String)
• post(endpoint: String, headers: Array, body: String)
• put(endpoint: String, headers: Array, body: String)
• delete(endpoint: String, headers: Array, body: String)
• send(endpoint: String, headers: Array, method: HTTPClient.Method, body: String)

Authenticated http request (json)

• get_json(endpoint: String, headers: Array, json_body: Dictionary)
• post_json(endpoint: String, headers: Array, json_body: Dictionary)
• put_json(endpoint: String, headers: Array, json_body: Dictionary)
• delete_json(endpoint: String, headers: Array, body: Dictionary)
• send_json(endpoint: String, headers: Array, method: HTTPClient.Method, json_body: Dictionary)

Data (data)

This module offers GraphQL features.

You can find the source code here

Here's a list of all the functions defined in the AWSAmplifyData class:

• query(operation, operation_name = "MyQuery", authenticated: bool = true)
• mutation(operation, operation_name = "MyMutation", authenticated: bool = true)
• subscription(operation, operation_name = "MySubscription", authenticated: bool = true)
• send(operation, operation_name, method: GraphQLMethod, authenticated: bool = true)

UI (AuthForm)

The plugin offers sign-up, sign-in and sign-out forms to handle various user authentication flows.

You can find the source code here

You can find also various samples showing how to use the form here

Wiki

The wiki contains everything you want to know about getting started with AWS Amplify with the Godot Engine.

Discussions

If you have a question or you want to discuss with the AWS Amplify for Godot Engine community go to the main project discussions channels.

Issues

If you have any issue with a custom build image report a bug and if you need a new image or something else create a feature request.

Security

See CONTRIBUTING for more information.

License

This library is licensed under the MIT-0 License. See the LICENSE file.

Third Party Licenses

See THIRD_PARTY_LICENSES for more information.