AWS gamelift documentation change
Summary
Updated documentation to consistently use 'Amazon GameLift Servers' branding throughout, updated SDK/plugin references, and modified links to reflect service name changes
Security assessment
Changes appear to be branding/terminology updates from 'Amazon GameLift' to 'Amazon GameLift Servers' without any explicit mention of security vulnerabilities, patches, or new security features. No security-related content was added or modified beyond service name standardization.
Diff
diff --git a/gamelift/latest/developerguide/gamelift-roadmap-hybrid.md index dd55d95d0..333cbf99f 100644 --- a/gamelift/latest/developerguide/gamelift-roadmap-hybrid.md +++ b/gamelift/latest/developerguide/gamelift-roadmap-hybrid.md @@ -3 +3 @@ -[Documentation](/index.html)[Amazon GameLift](/gamelift/index.html)[Developer Guide](gamelift-intro.html) +[Documentation](/index.html)[Amazon GameLift](/gamelift/index.html)[Hosting Guide](gamelift-intro.html) @@ -5 +5 @@ -# Development roadmap for hybrid hosting with Amazon GameLift +# Development roadmap for hybrid hosting with Amazon GameLift Servers @@ -7 +7 @@ -This roadmap guides you through how to develop a hosting solution for your multiplayer game. Amazon GameLift offers several game hosting options; for more information on these options, see [Amazon GameLift solutions](./gamelift-intro-flavors.html). +This roadmap guides you through how to develop a hosting solution for your multiplayer game. Amazon GameLift Servers offers several game hosting options; for more information on these options, see [Amazon GameLift Servers solutions](./gamelift-intro-flavors.html). @@ -9 +9 @@ This roadmap guides you through how to develop a hosting solution for your multi -A hybrid solution uses a combination of hosting resources, including cloud-based resources managed by Amazon GameLift and your own self-managed hosting resources. For a more detailed discussion of hybrid hosting, see this article: [ Hybrid game server hosting with Amazon GameLift Anywhere](https://aws.amazon.com/blogs/gametech/hybrid-game-server-hosting-with-amazon-gamelift-anywhere/). With Amazon GameLift, you can set up a hybrid solution that uses common components and processes, so you can centrally manage a global fleet and easily move loads between all types of resources. +A hybrid solution uses a combination of hosting resources, including cloud-based resources managed by Amazon GameLift Servers and your own self-managed hosting resources. For a more detailed discussion of hybrid hosting, see this article: [ Hybrid game server hosting with Amazon GameLift Servers Anywhere](https://aws.amazon.com/blogs/gametech/hybrid-game-server-hosting-with-amazon-gamelift-anywhere/). With Amazon GameLift Servers, you can set up a hybrid solution that uses common components and processes, so you can centrally manage a global fleet and easily move loads between all types of resources. @@ -13 +13 @@ A hybrid architecture consists of the following components: - * One or more Amazon GameLift managed fleets, which use Amazon Elastic Compute Cloud (Amazon EC2) instances optimized for multiplayer game hosting. + * One or more Amazon GameLift Servers managed fleets, which use Amazon Elastic Compute Cloud (Amazon EC2) instances optimized for multiplayer game hosting. @@ -15 +15 @@ A hybrid architecture consists of the following components: - * One or more Amazon GameLift Anywhere fleets, which use your existing on-premises or other hosting resources, including your configuration management and deployment tooling. (You can optionally use the AWS Systems Manager.) + * One or more Amazon GameLift Servers Anywhere fleets, which use your existing on-premises or other hosting resources, including your configuration management and deployment tooling. (You can optionally use the AWS Systems Manager.) @@ -17 +17 @@ A hybrid architecture consists of the following components: - * A single game server build, integrated with the Amazon GameLift server SDK, to deploy across all fleets. + * A single game server build, integrated with the server SDK for Amazon GameLift Servers, to deploy across all fleets. @@ -19 +19 @@ A hybrid architecture consists of the following components: - * A single game client and backend service, integrated with the AWS SDK, to interact with the Amazon GameLift service and request game sessions. + * A single game client and backend service, integrated with the AWS SDK, to interact with the Amazon GameLift Servers service and request game sessions. @@ -21 +21 @@ A hybrid architecture consists of the following components: - * A shared Amazon GameLift queue to place new game sessions with available game servers and balance load across all fleets. + * A shared Amazon GameLift Servers queue to place new game sessions with available game servers and balance load across all fleets. @@ -23 +23 @@ A hybrid architecture consists of the following components: - * The Amazon GameLift Agent, which is deployed with an Anywhere fleet, to simplify server process management tasks across computes in all fleets. + * The Amazon GameLift Servers Agent, which is deployed with an Anywhere fleet, to simplify server process management tasks across computes in all fleets. @@ -30 +30 @@ A hybrid architecture consists of the following components: -This roadmap presents a streamlined path to getting your multiplayer game up and running successfully in a hybrid hosting solution with Amazon GameLift. After you have the necessary components in place, you can continue to iterate on game development and customize your hosting solution. As you get closer to launch, see these [Preparing your game for launch with Amazon GameLift hosting](./gamelift_quickstart_customservers_checklist.html) for help with preparing your hosting solution for production-level usage. +This roadmap presents a streamlined path to getting your multiplayer game up and running successfully in a hybrid hosting solution with Amazon GameLift Servers. After you have the necessary components in place, you can continue to iterate on game development and customize your hosting solution. As you get closer to launch, see these [Preparing your game for launch with Amazon GameLift Servers hosting](./gamelift_quickstart_customservers_checklist.html) for help with preparing your hosting solution for production-level usage. @@ -32 +32 @@ This roadmap presents a streamlined path to getting your multiplayer game up and -###### Get a jump start with the Amazon GameLift plugin +###### Get a jump start with the Amazon GameLift Servers plugin @@ -34 +34 @@ This roadmap presents a streamlined path to getting your multiplayer game up and -If you're developing projects with Unreal Engine or Unity, start setting up your game for hosting with the Amazon GameLift plugin. With the plugin, you can add the Amazon GameLift SDKs to your game project and use the guided workflows to build a simple working version of a hybrid hosting solution with both an Anywhere fleet and an Amazon GameLift managed fleet. You can then use these fundamentals to build on and customize as needed. +If you're developing projects with Unreal Engine or Unity, start setting up your game for hosting with the Amazon GameLift Servers plugin. With the plugin, you can add the Amazon GameLift Servers SDKs to your game project and use the guided workflows to build a simple working version of a hybrid hosting solution with both an Anywhere fleet and an Amazon GameLift Servers managed fleet. You can then use these fundamentals to build on and customize as needed. @@ -36 +36 @@ If you're developing projects with Unreal Engine or Unity, start setting up your -Add functionality to your game server so that it can communicate with the Amazon GameLift service when it's deployed for hosting. The same functionality is required if the game server is running on an Amazon GameLift managed fleet or an Anywhere fleet. +Add functionality to your game server so that it can communicate with the Amazon GameLift Servers service when it's deployed for hosting. The same functionality is required if the game server is running on an Amazon GameLift Servers managed fleet or an Anywhere fleet. @@ -38 +38 @@ Add functionality to your game server so that it can communicate with the Amazon - * **Get the Amazon GameLift server SDK(version 5.x) for your game project.** The server SDK is available in C++, C#, and Go. [ Download a Amazon GameLift server SDK](https://aws.amazon.com/gamelift/getting-started-sdks/). + * **Get the server SDK for Amazon GameLift Servers(version 5.x) for your game project.** The server SDK is available in C++, C#, and Go. [Download the server SDK for Amazon GameLift Servers](https://aws.amazon.com/gamelift/servers/getting-started-sdks/). @@ -42 +42 @@ Add functionality to your game server so that it can communicate with the Amazon - * Add code to initialize the Amazon GameLift SDK and establish a WebSocket connection with the Amazon GameLift service. Use the server SDK action `InitSdk()`. Include code to specify server parameters when running on an Anywhere fleet compute. + * Add code to initialize the Amazon GameLift Servers SDK and establish a WebSocket connection with the Amazon GameLift Servers service. Use the server SDK action `InitSdk()`. Include code to specify server parameters when running on an Anywhere fleet compute. @@ -44 +44 @@ Add functionality to your game server so that it can communicate with the Amazon - * Add code to report to the Amazon GameLift service when the server process is ready to host game sessions. Use the server SDK action `ProcessReady()`. + * Add code to report to the Amazon GameLift Servers service when the server process is ready to host game sessions. Use the server SDK action `ProcessReady()`. @@ -46 +46 @@ Add functionality to your game server so that it can communicate with the Amazon - * Implement the required callback functions `OnProcessTerminate()`, and `OnStartGameSession()`. With these functions, game server processes can maintain a connection with the Amazon GameLift service, initiate a game session when prompted by Amazon GameLift, and respond to a prompt to end the game server process. + * Implement the required callback functions `OnProcessTerminate()`, and `OnStartGameSession()`. With these functions, game server processes can maintain a connection with the Amazon GameLift Servers service, initiate a game session when prompted by Amazon GameLift Servers, and respond to a prompt to end the game server process. @@ -48 +48 @@ Add functionality to your game server so that it can communicate with the Amazon - * Add code to report to the Amazon GameLift service when the server process is ending a game session. Use the server SDK action `ProcessEnding()`. + * Add code to report to the Amazon GameLift Servers service when the server process is ending a game session. Use the server SDK action `ProcessEnding()`. @@ -52 +52 @@ Add functionality to your game server so that it can communicate with the Amazon - * **Test your game server integration.** For this task, we recommend setting up an Amazon GameLift Anywhere fleet with a local workstation, as described in [Set up local testing with Amazon GameLift Anywhere](./integration-testing.html). For this step, manually install your game server build onto the test device and start a server process. Use the AWS CLI to request a new game session, and verify that the Amazon GameLift service successfully prompts your server process to start a game session. + * **Test your game server integration.** For this task, we recommend setting up an Amazon GameLift Servers Anywhere fleet with a local workstation, as described in [Set up local testing with Amazon GameLift Servers Anywhere](./integration-testing.html). For this step, manually install your game server build onto the test device and start a server process. Use the AWS CLI to request a new game session, and verify that the Amazon GameLift Servers service successfully prompts your server process to start a game session. @@ -57 +57 @@ Add functionality to your game server so that it can communicate with the Amazon -Create a way for your game client to request to join a game session, get connection info, and then connect directly to a hosted game session. The most common approach is to set up backend service functionality that serves as a middleman between your game client and the Amazon GameLift service. This approach protects your hosting resources and gives you greater control over how players are placed into game sessions. +Create a way for your game client to request to join a game session, get connection info, and then connect directly to a hosted game session. The most common approach is to set up backend service functionality that serves as a middleman between your game client and the Amazon GameLift Servers service. This approach protects your hosting resources and gives you greater control over how players are placed into game sessions. @@ -59 +59 @@ Create a way for your game client to request to join a game session, get connect - * **Build backend service functionality for hosting.** The backend service communicates with the Amazon GameLift service and delivers connection information to a game client. This functionality includes starting game sessions, placing players into games, and retrieving game session information. For guidance, see [Integrate games with custom game servers](./integration-custom-intro.html). At a minimum, do the following: + * **Build backend service functionality for hosting.** The backend service communicates with the Amazon GameLift Servers service and delivers connection information to a game client. This functionality includes starting game sessions, placing players into games, and retrieving game session information. For guidance, see [Integrate games with custom game servers](./integration-custom-intro.html). At a minimum, do the following: @@ -61 +61 @@ Create a way for your game client to request to join a game session, get connect - * Get the AWS SDK for Amazon GameLift and add it to your backend service project. See [Amazon GameLift SDK resources for client services](./gamelift-supported.html#gamelift-supported-clients). + * Get the AWS SDK for Amazon GameLift Servers and add it to your backend service project. See [Amazon GameLift Servers SDK resources for client services](./gamelift-supported.html#gamelift-supported-clients). @@ -63 +63 @@ Create a way for your game client to request to join a game session, get connect - * Add code to initialize an Amazon GameLift client and store key settings. See [Set up Amazon GameLift on a backend service](./gamelift-sdk-client-api.html#gamelift-sdk-client-api-initialize). + * Add code to initialize an Amazon GameLift Servers client and store key settings. See [Set up Amazon GameLift Servers on a backend service](./gamelift-sdk-client-api.html#gamelift-sdk-client-api-initialize). @@ -71 +71 @@ For guidance on designing your backend service, see [Design your game client ser - * **Add functionality to your game client that lets players join a hosted game session.** The game client makes requests to your backend service, not directly to Amazon GameLift. After the backend service provides game session connection information, the game client connects directly with the game session to play the game. + * **Add functionality to your game client that lets players join a hosted game session.** The game client makes requests to your backend service, not directly to Amazon GameLift Servers. After the backend service provides game session connection information, the game client connects directly with the game session to play the game. @@ -73 +73 @@ For guidance on designing your backend service, see [Design your game client ser - * **Test your game client integration.** You can use the same Amazon GameLift Anywhere fleet with a local workstation for testing. + * **Test your game client integration.** You can use the same Amazon GameLift Servers Anywhere fleet with a local workstation for testing. @@ -75 +75 @@ For guidance on designing your backend service, see [Design your game client ser -During the development phase, if you want to test how your game build behaves in an Amazon GameLift managed fleet, we recommend that you also set up a [ cloud-based test environment](./integration-dev-iteration-cloud.html). This Amazon GameLift Toolkit solution mimics the behavior of a managed fleet but lets you update game server builds with minimal turnaround time. +During the development phase, if you want to test how your game build behaves in an Amazon GameLift Servers managed fleet, we recommend that you also set up a [ cloud-based test environment](./integration-dev-iteration-cloud.html). This Amazon GameLift Servers Toolkit solution mimics the behavior of a managed fleet but lets you update game server builds with minimal turnaround time. @@ -80 +80 @@ During the development phase, if you want to test how your game build behaves in -Customize how you want Amazon GameLift to process requests for new game session and locate available game servers to host them. Amazon GameLift automatically tracks the availability of all game servers on all fleets. When a game client sends a request to join a game session, Amazon GameLift looks for the "best possible" placement based on a set of defined priorities such as minimum latency, cost, and availability. +Customize how you want Amazon GameLift Servers to process requests for new game session and locate available game servers to host them. Amazon GameLift Servers automatically tracks the availability of all game servers on all fleets. When a game client sends a request to join a game session, Amazon GameLift Servers looks for the "best possible" placement based on a set of defined priorities such as minimum latency, cost, and availability. @@ -90 +90 @@ Customize how you want Amazon GameLift to process requests for new game session - * (Optional) **Add FlexMatch matchmaking components.** For guidance, see the [ Amazon GameLift FlexMatch developer guide](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-intro.html). + * (Optional) **Add FlexMatch matchmaking components.** For guidance, see the [Amazon GameLift ServersFlexMatch developer guide](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-intro.html). @@ -95 +95 @@ Customize how you want Amazon GameLift to process requests for new game session -Up to this point you've been working with local devices (registered as Anywhere fleet computes) to test and iterate on your game components. The next step is to set up the type of fleets you'll need for a production system. Start with an Anywhere fleet, and add the Amazon GameLift Agent to manage some key on-compute host management tasks. For more details, see [Work with the Amazon GameLift Agent](./integration-dev-iteration-agent.html). +Up to this point you've been working with local devices (registered as Anywhere fleet computes) to test and iterate on your game components. The next step is to set up the type of fleets you'll need for a production system. Start with an Anywhere fleet, and add the Amazon GameLift Servers Agent to manage some key on-compute host management tasks. For more details, see [Work with the Amazon GameLift Servers Agent](./integration-dev-iteration-agent.html). @@ -97 +97 @@ Up to this point you've been working with local devices (registered as Anywhere - * **Get the Amazon GameLift Agent and add it to your game server install package.** Get and build the Agent source code, available in the [Amazon GameLift Agent Github repository](https://github.com/aws/amazon-gamelift-agent). Place the resulting JAR file executable into the same directory as your game build executable. + * **Get the Amazon GameLift Servers Agent and add it to your game server install package.** Get and build the Agent source code, available in the [Amazon GameLift Servers Agent Github repository](https://github.com/aws/amazon-gamelift-agent). Place the resulting JAR file executable into the same directory as your game build executable. @@ -105 +105 @@ The Agent automatically handles the following tasks for you, so if you've been h - * Calls `GetComputeAuthToken()` to authenticate game servers when they connect to the Amazon GameLift service. The Agent manages getting and refreshing the auth token, which can be used by all game server processes that are running on the compute. + * Calls `GetComputeAuthToken()` to authenticate game servers when they connect to the Amazon GameLift Servers service. The Agent manages getting and refreshing the auth token, which can be used by all game server processes that are running on the compute. @@ -109 +109 @@ The Agent automatically handles the following tasks for you, so if you've been h - * **Create a runtime configuration for computes in your Anywhere fleet.** At minimum, specify the launch path for your game server executable. You can use the Amazon GameLift console or the AWS CLI to create or modify runtime instructions for the fleet. The Agent carries out these instructions and periodically requests updates from the Amazon GameLift service. + * **Create a runtime configuration for computes in your Anywhere fleet.** At minimum, specify the launch path for your game server executable. You can use the Amazon GameLift Servers console or the AWS CLI to create or modify runtime instructions for the fleet. The Agent carries out these instructions and periodically requests updates from the Amazon GameLift Servers service. @@ -111 +111 @@ The Agent automatically handles the following tasks for you, so if you've been h - * **Set up or modify your game session queue as needed.** Create a new queue (or update an existing one) and designate a destination for the Anywhere fleet deployed with the Amazon GameLift Agent. + * **Set up or modify your game session queue as needed.** Create a new queue (or update an existing one) and designate a destination for the Anywhere fleet deployed with the Amazon GameLift Servers Agent. @@ -118 +118 @@ The Agent automatically handles the following tasks for you, so if you've been h -Create an Amazon GameLift managed EC2 fleet to supplement your Anywhere fleet. If you set up a cloud-based test environment in Step 2 to speed up development, plan to create a managed fleet after you've completed most of your game development and testing. You need a fully managed fleet to configure and test additional settings such as automatic capacity scaling. +Create an Amazon GameLift Servers managed EC2 fleet to supplement your Anywhere fleet. If you set up a cloud-based test environment in Step 2 to speed up development, plan to create a managed fleet after you've completed most of your game development and testing. You need a fully managed fleet to configure and test additional settings such as automatic capacity scaling. @@ -120 +120 @@ Create an Amazon GameLift managed EC2 fleet to supplement your Anywhere fleet. I - * **Package your game server build and upload to Amazon GameLift.** Create an install script with your build files, dependencies and supporting software. You can use the same build software with both your Anywhere and managed fleets. See [Deploy a custom server build for Amazon GameLift hosting](./gamelift-build-cli-uploading.html). You can upload your build to Amazon GameLift using either the console or the AWS CLI. + * **Package your game server build and upload to Amazon GameLift Servers.** Create an install script with your build files, dependencies and supporting software. You can use the same build software with both your Anywhere and managed fleets. See [Deploy a custom server build for Amazon GameLift Servers hosting](./gamelift-build-cli-uploading.html). You can upload your build to Amazon GameLift Servers using either the console or the AWS CLI. @@ -124 +124 @@ Before uploading your build, decide in what AWS Region you want to create the ma - * **Create a managed EC2 fleet.** You can use the Amazon GameLift console or the AWS CLI to create a managed fleet. When you create a fleet, Amazon GameLift immediately begins deploying your game server build for hosting. You can configure many aspects of a managed fleet. For guidance, see [Create an Amazon GameLift managed EC2 fleet](./fleets-creating.html). At minimum, do the following: + * **Create a managed EC2 fleet.** You can use the Amazon GameLift Servers console or the AWS CLI to create a managed fleet. When you create a fleet, Amazon GameLift Servers immediately begins deploying your game server build for hosting. You can configure many aspects of a managed fleet. For guidance, see [Create an Amazon GameLift Servers managed EC2 fleet](./fleets-creating.html). At minimum, do the following: @@ -134 +134 @@ Before uploading your build, decide in what AWS Region you want to create the ma - * **Add the managed fleet to your shared game session queue.** Update the queue from Step 4 so that it includes destinations for both the managed fleet and the Anywhere fleet deployed with the Amazon GameLift Agent. + * **Add the managed fleet to your shared game session queue.** Update the queue from Step 4 so that it includes destinations for both the managed fleet and the Anywhere fleet deployed with the Amazon GameLift Servers Agent. @@ -147 +147 @@ As you prepare for game launch, you'll need to fine-tune your hosting solutions. - * Determine where geographically you want to position game servers. Add remote locations to your managed fleets. See [Customize your Amazon GameLift EC2 managed fleets](./fleets-design.html). + * Determine where geographically you want to position game servers. Add remote locations to your managed fleets. See [Customize your Amazon GameLift Servers EC2 managed fleets](./fleets-design.html). @@ -149 +149 @@ As you prepare for game launch, you'll need to fine-tune your hosting solutions. - * For managed fleets, consider using Spot fleets for cost savings. See [Tutorial: Create an Amazon GameLift queue with Spot Instances](./tutorial-queues-spot.html). + * For managed fleets, consider using Spot fleets for cost savings. See [Tutorial: Create an Amazon GameLift Servers queue with Spot Instances](./tutorial-queues-spot.html). @@ -151 +151 @@ As you prepare for game launch, you'll need to fine-tune your hosting solutions. - * Optimize fleet performance by selecting compute resource configurations, then configure your the runtime instructions to run the optimal number of server processes per compute. Do this for both Anywhere fleets and managed fleets. See [Manage how Amazon GameLift launches game servers](./fleets-multiprocess.html). + * Optimize fleet performance by selecting compute resource configurations, then configure your the runtime instructions to run the optimal number of server processes per compute. Do this for both Anywhere fleets and managed fleets. See [Manage how Amazon GameLift Servers launches game servers](./fleets-multiprocess.html). @@ -155 +155 @@ As you prepare for game launch, you'll need to fine-tune your hosting solutions. - * For managed fleets, set up automatic capacity scaling to meet expected player demand. See [Scaling game hosting capacity with Amazon GameLift](./fleets-manage-capacity.html). + * For managed fleets, set up automatic capacity scaling to meet expected player demand. See [Scaling game hosting capacity with Amazon GameLift Servers](./fleets-manage-capacity.html). @@ -161 +161 @@ As you prepare for game launch, you'll need to fine-tune your hosting solutions. - * Set up hosting observability tools, including analytics and logging. See [Monitoring Amazon GameLift](./monitoring-overview.html). Create metric groups to aggregate analytics for all your hosting resources. + * Set up hosting observability tools, including analytics and logging. See [Monitoring Amazon GameLift Servers](./monitoring-overview.html). Create metric groups to aggregate analytics for all your hosting resources. @@ -163 +163 @@ As you prepare for game launch, you'll need to fine-tune your hosting solutions. - * Automate your deployment using [infrastructure as code (IaC)](https://docs.aws.amazon.com/whitepapers/latest/introduction-devops-aws/infrastructure-as-code.html). See [Managing Amazon GameLift hosting resources using AWS CloudFormation](./resources-cloudformation.html). + * Automate your deployment using [infrastructure as code (IaC)](https://docs.aws.amazon.com/whitepapers/latest/introduction-devops-aws/infrastructure-as-code.html). See [Managing Amazon GameLift Servers hosting resources using AWS CloudFormation](./resources-cloudformation.html). @@ -165 +165 @@ As you prepare for game launch, you'll need to fine-tune your hosting solutions. -Amazon GameLift supports the use of AWS CloudFormation templates for any deployment-specific configurations. You can also use the AWS Cloud Development Kit (AWS CDK) to define your Amazon GameLift resources. For more information about the AWS CDK, see the [AWS Cloud Development Kit (AWS CDK) Developer Guide](https://docs.aws.amazon.com/cdk/v2/guide/). +Amazon GameLift Servers supports the use of AWS CloudFormation templates for any deployment-specific configurations. You can also use the AWS Cloud Development Kit (AWS CDK) to define your Amazon GameLift Servers resources. For more information about the AWS CDK, see the [AWS Cloud Development Kit (AWS CDK) Developer Guide](https://docs.aws.amazon.com/cdk/v2/guide/). @@ -171 +171 @@ To manage the deployment of your AWS CloudFormation stacks, we recommend using c - * Upload the binary to Amazon GameLift. + * Upload the binary to Amazon GameLift Servers. @@ -190 +190 @@ Anywhere development roadmap -Preparing games for Amazon GameLift +Preparing games for Amazon GameLift Servers