AWS gamelift documentation change
Summary
Updated Amazon GameLift documentation to include resource management, reorganized SDK and plugin information, added details about runtime support and AMIs, and expanded tooling documentation. Removed some redundant sections and improved overall structure.
Security assessment
The changes are primarily organizational and informational, focusing on SDKs, plugins, and tooling. There is no mention of security vulnerabilities, incidents, or specific security features in the diff.
Diff
diff --git a/gamelift/latest/developerguide/gamelift-supported.md index ba0a125ad..996791f21 100644 --- a/gamelift/latest/developerguide/gamelift-supported.md +++ b/gamelift/latest/developerguide/gamelift-supported.md @@ -5 +5 @@ -For game serversFor game client servicesFor Realtime Servers +For game serversFor game client servicesFor Amazon GameLift resource managementFor Realtime Servers @@ -9,3 +9 @@ For game serversFor game client servicesFor Realtime Servers -Amazon GameLift provides a set of SDKs that you can use with your game hosting solutions. Use Amazon GameLift SDKs to add functionality to game servers, game clients, and backend services that interact with the Amazon GameLift service. - -For the latest information about Amazon GameLift SDK versions and SDK compatibility, see [Amazon GameLift release notes](./release-notes.html). +Amazon GameLift provides a set of SDKs and other tools to help you build game hosting solutions for your games. The SDKs add functionality to game servers, game clients, and backend services that enables them to interact with the Amazon GameLift service. For the latest information about Amazon GameLift SDK versions and compatibility, see [Amazon GameLift release notes](./release-notes.html). @@ -15 +13,3 @@ For the latest information about Amazon GameLift SDK versions and SDK compatibil -Integrate and build your 64-bit game servers with the Amazon GameLift server SDK. Game servers use the server SDK to communicate with the Amazon GameLift service to start and manage game sessions. For information on integrating the server SDK, see the topics in [Preparing games for Amazon GameLift](./integration-intro.html). +Integrate and build your 64-bit game servers with the server SDK for Amazon GameLift. The game server uses the server SDK to communicate with the Amazon GameLift service for game session management, including starting, updating, and stopping game sessions. For help with integrating the server SDK into your game projects, see [Preparing games for Amazon GameLift](./integration-intro.html). + +**Development support** @@ -17 +17 @@ Integrate and build your 64-bit game servers with the Amazon GameLift server SDK -**Development operating systems** +**[Get the Server SDK](https://aws.amazon.com/gamelift/getting-started-sdks/) for Amazon GameLift.** For version-specific information and install instructions, see the included readme files in each package. @@ -19 +19 @@ Integrate and build your 64-bit game servers with the Amazon GameLift server SDK -The Amazon GameLift server SDK supports the following development environments: + * Development OS @@ -25,6 +25 @@ The Amazon GameLift server SDK supports the following development environments: - - - -**Programming languages** - -The Amazon GameLift server SDK is available in the following languages. [ Download Server SDKs](https://aws.amazon.com/gamelift/getting-started-sdks/). For version-specific information and install instructions, see the included readme files in each package. + * Programming languages @@ -34 +29 @@ The Amazon GameLift server SDK is available in the following languages. [ Downlo - * [SDK reference](./integration-server-sdk5-cpp-actions.html) + * [Server SDK reference](./integration-server-sdk5-cpp-actions.html) @@ -36 +31 @@ The Amazon GameLift server SDK is available in the following languages. [ Downlo - * [SDK integration](./gamelift-sdk-server-api.html) + * [How to integrate](./gamelift-sdk-server-api.html) @@ -40 +35 @@ The Amazon GameLift server SDK is available in the following languages. [ Downlo - * [SDK reference](./integration-server-sdk5-csharp-actions.html) + * [Server SDK reference](./integration-server-sdk5-csharp-actions.html) @@ -42 +37 @@ The Amazon GameLift server SDK is available in the following languages. [ Downlo - * [SDK integration](./gamelift-sdk-server-api.html) + * [How to integrate](./gamelift-sdk-server-api.html) @@ -46 +41 @@ The Amazon GameLift server SDK is available in the following languages. [ Downlo - * [SDK reference](./integration-server-sdk-go-actions.html) + * [Server SDK reference](./integration-server-sdk-go-actions.html) @@ -48 +43 @@ The Amazon GameLift server SDK is available in the following languages. [ Downlo - * [SDK integration](./gamelift-sdk-server-api.html) + * [How to integrate](./gamelift-sdk-server-api.html) @@ -53 +48 @@ The Amazon GameLift server SDK is available in the following languages. [ Downlo -**Game engines** + * Runtime support @@ -55 +50 @@ The Amazon GameLift server SDK is available in the following languages. [ Downlo -Use language-specific SDKs with any engine that supports C++, C#, or Go libraries. In addition, Amazon GameLift offers plugins for the following game engines. [ Download Amazon GameLift plugins](https://aws.amazon.com/gamelift/getting-started/) +For a managed hosting solution, build your game server to run on one of the following Amazon machine images (AMIs). See [Amazon GameLift AMI versions](./reference-ec2-ami-version-history.html) for Amazon GameLift for more details. @@ -57 +52 @@ Use language-specific SDKs with any engine that supports C++, C#, or Go librarie - * **Unity** + * [Windows Server 2016](https://aws.amazon.com/windows/products/ec2/windows-server-2016/) @@ -59 +54 @@ Use language-specific SDKs with any engine that supports C++, C#, or Go librarie - * C# server SDK plugin for Unity is a lightweight plugin with pre-built libraries that you can install using the Unity package manager. Use this plugin with LTS versions of Unity 6.0, 2022.3 or 2021.3. It supports Unity's .NET Framework and .NET Standard profiles, with .NET Standard 2.1 and .NET 4.x. Check the readme in each server SDK download package for Unity version support. + * [Amazon Linux 2023](https://aws.amazon.com/linux/amazon-linux-2023/) @@ -61 +56 @@ Use language-specific SDKs with any engine that supports C++, C#, or Go librarie - * [Integrate Amazon GameLift into a Unity project](./integration-engines-unity-using.html) + * [Amazon Linux 2](https://aws.amazon.com/amazon-linux-2/) @@ -63 +58 @@ Use language-specific SDKs with any engine that supports C++, C#, or Go librarie - * Standalone plugin for Unity is a full-featured plugin with the C# SDK libraries built for Unity and GUI elements for configuring and deploying Amazon GameLift resources for hosting. Use the plugin with LTS versions of Unity 6.0, 2022.3, or 2021.3. Check the readme in each server SDK download package for Unity version support. +###### Note @@ -65 +60 @@ Use language-specific SDKs with any engine that supports C++, C#, or Go librarie - * [Amazon GameLift plugin for Unity (server SDK 5.x)](./unity-plug-in.html) +Amazon Linux 2 (AL2) will reach end of support on June 30, 2025. See more details in the [Amazon Linux 2 FAQs](https://aws.amazon.com/amazon-linux-2/faqs/). For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See [Migrate to Amazon GameLift server SDK 5.x](./reference-serversdk5-migration.html). @@ -67 +61,0 @@ Use language-specific SDKs with any engine that supports C++, C#, or Go librarie - * [Amazon GameLift server SDK 5.x for C# and Unity -- Actions](./integration-server-sdk5-csharp-actions.html) @@ -69 +62,0 @@ Use language-specific SDKs with any engine that supports C++, C#, or Go librarie - * **Unreal Engine** @@ -71 +63,0 @@ Use language-specific SDKs with any engine that supports C++, C#, or Go librarie - * C++ server SDK plugin for Unreal is a lightweight plugin consisting of C++ Unreal source code that you can build into libraries for use with Unreal Engine versions 5.0, 5.1, 5.2, 5.3, 5.4, and 5.5. Check the readme in each server SDK download package for Unreal version support. @@ -73 +65 @@ Use language-specific SDKs with any engine that supports C++, C#, or Go librarie - * [Integrate Amazon GameLift into an Unreal Engine project](./integration-engines-setup-unreal.html) +**Game engine support** @@ -75 +67 @@ Use language-specific SDKs with any engine that supports C++, C#, or Go librarie - * [Amazon GameLift server SDK 5.x for Unreal Engine -- Actions](./integration-server-sdk5-unreal-actions.html) +A full-featured plugin for [Amazon GameLift](https://aws.amazon.com/gamelift/getting-started/) includes detailed GUI workflows and sample assets, as well as built-in versions of the AWS SDK and server SDK. The GUI workflows guide you through how to configure and deploy your game server for hosting with managed EC2 fleets, managed container fleets, or self-managed Anywhere fleets. If you're using another game engine or development environment that the plugin doesn't support, get the server SDK for your programming language and add it to your game project. @@ -77 +69 @@ Use language-specific SDKs with any engine that supports C++, C#, or Go librarie - * Standalone plugin for Unreal Engine is a full-featured plugin with the C++ for Unreal server SDK libraries and AWS SDK built in. The plugin is installed in the Unreal editor, with UI elements and supporting materials for configuring and deploying Amazon GameLift resources for hosting. use with Unreal Engine versions 5.0, 5.1, 5.2, 5.3, 5.4, and 5.5. Check the readme in each server SDK download package for Unreal version support. +[Get the plugins for Amazon GameLift](https://aws.amazon.com/gamelift/getting-started/). For version-specific information and install instructions, see the included readme files in each package. @@ -79 +71 @@ Use language-specific SDKs with any engine that supports C++, C#, or Go librarie - * [Amazon GameLift plugin for Unreal Engine](./unreal-plugin.html) + * Plugin for Unity – The plugin includes server SDK (C#) for Amazon GameLift. Use the plugin with LTS versions of Unity Editor 6.0, 2022.3, or 2021.3. It supports Unity's .NET Framework and .NET Standard profiles, with .NET Standard 2.1 and .NET 4.x. Check the readme in the server SDK download package for specific Unity version support. @@ -81 +73 @@ Use language-specific SDKs with any engine that supports C++, C#, or Go librarie - * [Amazon GameLift server SDK 5.x for Unreal Engine -- Actions](./integration-server-sdk5-unreal-actions.html) + * [Amazon GameLift plugin for Unity (server SDK 5.x)](./unity-plug-in.html) @@ -82,0 +75 @@ Use language-specific SDKs with any engine that supports C++, C#, or Go librarie + * [Amazon GameLift server SDK 5.x for C# and Unity -- Actions](./integration-server-sdk5-csharp-actions.html)C# server SDK reference @@ -83,0 +77 @@ Use language-specific SDKs with any engine that supports C++, C#, or Go librarie + * Plugin for Unreal Engine– The plugin includes server SDK (C++) for Amazon GameLift, built for use with Unreal versions 5.0, 5.1, 5.2, 5.3, 5.4, and 5.5. Check the readme in the server SDK download package for specific Unity version support. @@ -84,0 +79 @@ Use language-specific SDKs with any engine that supports C++, C#, or Go librarie + * [Amazon GameLift plugin for Unreal Engine](./unreal-plugin.html) @@ -86 +81 @@ Use language-specific SDKs with any engine that supports C++, C#, or Go librarie -**Game server runtime operating systems** + * [Amazon GameLift server SDK 5.x for Unreal Engine -- Actions](./integration-server-sdk5-unreal-actions.html) @@ -88 +82,0 @@ Use language-specific SDKs with any engine that supports C++, C#, or Go librarie -The Amazon GameLift server SDK supports game servers that are built to run on the following platforms: @@ -90 +83,0 @@ The Amazon GameLift server SDK supports game servers that are built to run on th - * [Windows Server 2016](https://aws.amazon.com/windows/products/ec2/windows-server-2016/) @@ -92 +84,0 @@ The Amazon GameLift server SDK supports game servers that are built to run on th - * [Amazon Linux 2023](https://aws.amazon.com/linux/amazon-linux-2023/) @@ -94 +86 @@ The Amazon GameLift server SDK supports game servers that are built to run on th - * [Amazon Linux 2](https://aws.amazon.com/amazon-linux-2/) +**Additional tools** @@ -96 +88 @@ The Amazon GameLift server SDK supports game servers that are built to run on th -###### Note +The Amazon GameLift Toolkit is a collection of scripts and other tools that we've developed to help developers with common scenarios and issues. Toolkit materials include scripts, sample code, and readmes, available in the Github repository [aws/amazon-gamelift-toolkit](https://github.com/aws/aws/amazon-gamelift-toolkit). @@ -98 +90,3 @@ The Amazon GameLift server SDK supports game servers that are built to run on th -Amazon Linux 2 (AL2) will reach end of support on June 30, 2025. See more details in the [Amazon Linux 2 FAQs](https://aws.amazon.com/amazon-linux-2/faqs/). For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See [Migrate to Amazon GameLift server SDK 5.x](./reference-serversdk5-migration.html). + * [ Containers starter kit](https://github.com/aws/amazon-gamelift-toolkit/tree/main/containers-starter-kit) – Use this tool to streamline the tasks of setting up game server builds for hosting with Amazon GameLift managed containers. The kit integrates essential game session management features into a game server, and uses pre-configured templates to create a container fleet and set up an automated deployment pipeline for your game server build. After deployment, you can monitor fleet performance, manage game sessions, and analyze metrics using the Amazon GameLift console and API tools. The kit integrates with AWS CodeBuild for build automation, Amazon Simple Storage Service for storage, and AWS CloudFormation for infrastructure deployment. + + * [ Fast build update tool](https://github.com/aws/amazon-gamelift-toolkit/tree/main/fast-build-update-tool) – Use this tool to modify a game server build that's already deployed to a managed EC2 fleet. The tool is built to help you quickly swap out game build files without having to configure and create new EC2 fleets with every change. You can update individual instances or all instances in the fleet. Options let you replace specific build files or an entire build, and let you manage how to restart game servers after the updates. @@ -105 +99,3 @@ Amazon Linux 2 (AL2) will reach end of support on June 30, 2025. See more detail -Create a 64-bit backend service for your game clients using the AWS SDK with the Amazon GameLift API. Your backend service handles client-side interactions with the Amazon GameLift to start new game sessions, join players to games, and other tasks. [Download the AWS SDK](https://aws.amazon.com/developer/tools/#SDKs). +Create a 64-bit backend service for your game clients using the AWS SDK, which includes the service API for Amazon GameLift. Your game's backend service handles client-side interactions with the Amazon GameLift service, including starting new game sessions and joining players to games. + +[Get the AWS SDK](https://aws.amazon.com/developer/tools/#SDKs) @@ -112,0 +109,17 @@ For more information about using the AWS SDK with Amazon GameLift, see the follo + * [Design a client backend service](./gamelift_quickstart_customservers_designbackend.html) + + + + +## For Amazon GameLift resource management + +Use the following tools to create, update, and monitor your Amazon GameLift managed hosting resources. + + * [AWS Management Console]() – The AWS Console is a web-based application that provides centralized access to all individual AWS service consoles, including Amazon GameLift. Use the Console to create or sign into an AWS account and open the Amazon GameLift console to work with your game hosting resources. You can configure and deploy hosting fleets and other resources, view usage and performance metrics, track resourses in the dashboard, and many other tasks. [Go to the Amazon GameLift console.](https://console.aws.amazon.com/gamelift) + + * [Service API for Amazon GameLift](https://docs.aws.amazon.com/gamelift/latest/apireference/Welcome.html) – This API gives you programmatic access to all of your Amazon GameLift resources. It is part of the AWS SDK, which you can download for use with most popular programming languages. [Get the AWS SDK.](https://aws.amazon.com/developer) + + * [AWS command line interface (CLI)](https://docs.aws.amazon.com/cli/) – The AWS CLI lets you interact with AWS services using a command-line shell. The tools provides direct access to the public APIs for AWS services as well as customized commands that are available for a service. [Get the AWS CLI.](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) + + * [AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html) for Amazon GameLift – The AWS CloudFormation service helps you model and set up AWS resources to streamline infrastructure deployment and management. Create an AWS CloudFormation template to describe the Amazon GameLift resources for your hosting solution, and then use the template to build additional resources or update configurations. View the [Amazon GameLift resource type reference.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_GameLift.html) +