AWS gameliftstreams documentation change
Summary
Updated documentation for stream group management including terminology clarifications (e.g., 'remote locations'), removed redundant 'Topics' section, updated Unreal Engine version support from 5.4 to 5.5 in stream class specifications, improved CLI command examples with ARN/ID formats, and general documentation restructuring
Security assessment
Changes focus on documentation clarity, feature updates, and API usage examples. No security vulnerabilities or mitigations are mentioned. The anti-cheat technology reference remains unchanged from previous documentation.
Diff
diff --git a/gameliftstreams/latest/developerguide/stream-groups.md b/gameliftstreams/latest/developerguide/stream-groups.md index e1449f827..e6fd00d5c 100644 --- a//gameliftstreams/latest/developerguide/stream-groups.md +++ b//gameliftstreams/latest/developerguide/stream-groups.md @@ -11 +11 @@ After you set up an Amazon GameLift Streams application, you're ready to manage -Amazon GameLift Streams allocates compute resources in the AWS Region where you create a stream group. You can also add locations to a stream group and manage capacity per location. It's a best practice to host stream sessions in locations that are geographically near your end users. This helps minimize latency and improve stream quality. For more information, refer to [AWS Regions and remote locations supported by Amazon GameLift Streams](./regions-quotas-rande.html). +Amazon GameLift Streams allocates compute resources in the AWS Region where you create a stream group. You can also add remote locations to a stream group and manage capacity per location. It's a best practice to host stream sessions in locations that are geographically near your end users. This helps minimize latency and improve stream quality. For more information, refer to [AWS Regions and remote locations supported by Amazon GameLift Streams](./regions-quotas-rande.html). @@ -19,25 +18,0 @@ How you relate your stream groups and applications together depends on your use -###### Topics - - * About stream capacity - - * About locations - - * Create a stream group - - * Edit general settings - - * Edit capacity - - * Add locations in a stream group - - * Delete locations in a stream group - - * Delete a stream group - - * Linked applications - - * Stream group maintenenace - - - - @@ -59 +34 @@ Scaling the capacity reflects in your total cost for the stream group. Ensure th -To request a capacity change, edit your stream group settings and enter new values for always-on capacity and/or on-demand capacity. When Amazon GameLift Streams receives this request, the service begins working to make allocated stream capacity match the new requested stream capacity. It does this by provisioning new hosting resources or shutting down existing ones. The process of increasing resources can take some time, because Amazon GameLift Streams might have to wait for on-demand resources to become available before allocating them to your stream group. +To request a capacity change, edit your stream group settings and enter new values for always-on capacity and/or on-demand capacity. When Amazon GameLift Streams receives this request, the service begins working to make allocated stream capacity match the new requested stream capacity. It does this by provisioning new hosting resources or shutting down existing ones. The process of increasing resources can take some time, because Amazon GameLift Streams might have to wait for resources to become available before allocating them to your stream group. @@ -67 +42 @@ For a complete list of supported locations, refer to [AWS Regions and remote loc -**Multi-location stream groups** +**Multi-location stream group** @@ -70 +45 @@ For a complete list of supported locations, refer to [AWS Regions and remote loc -A stream group that's configured to host applications and stream sessions from multiple locations, in addition to the primary location (the AWS Region where you created the stream group). You manage capacity per location. +A stream group that's configured to host applications and stream sessions from multiple locations, in addition to the primary location (the AWS Region where you created the stream group). You manage capacity for each location. @@ -101 +76 @@ Stream class | Description -`gen5n_win2022` | (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12 and DirectX 11. Supports Unreal Engine up through version 5.4, 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU. Resources per application: vCPUs: 8. VRAM: 24 GB. RAM: 32 GB. Tenancy: Supports one concurrent stream session. +`gen5n_win2022` | (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12 and DirectX 11. Supports Unreal Engine up through version 5.5, 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU. Resources per application: vCPUs: 8. VRAM: 24 GB. RAM: 32 GB. Tenancy: Supports one concurrent stream session. @@ -104 +79 @@ Stream class | Description -`gen4n_win2022` | (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12 and DirectX 11. Supports Unreal Engine up through version 5.4, 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU. Resources per application: vCPUs: 8. VRAM: 16 GB. RAM: 32 GB. Tenancy: Supports one concurrent stream session. +`gen4n_win2022` | (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12 and DirectX 11. Supports Unreal Engine up through version 5.5, 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU. Resources per application: vCPUs: 8. VRAM: 16 GB. RAM: 32 GB. Tenancy: Supports one concurrent stream session. @@ -144 +119 @@ CLI -You must configure the AWS CLI with your user credentials and your chosen AWS Region. For more information, refer to [Download the AWS CLI](./setting-up.html#setting-up-prereqs). +You must configure the AWS CLI with your user credentials and your chosen AWS Region. For setup instructions, refer to [Download the AWS CLI](./setting-up.html#setting-up-prereqs). @@ -148 +123 @@ You must configure the AWS CLI with your user credentials and your chosen AWS Re -Open a command line with the AWS CLI installed. Then, enter the following command, customized for your content. +In your AWS CLI use the [CreateStreamGroup](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_CreateStreamGroup.html) command, customized for your content. @@ -153 +128 @@ Open a command line with the AWS CLI installed. Then, enter the following comman - --default-application-identifier arn:aws:gameliftstreams:us-west-2:123456789012:application/1AB2C3De4 \ + --default-application-identifier arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6 \ @@ -159 +134 @@ where -`description` +`description`: @@ -167 +142,5 @@ A human-readable label for your stream group. This value doesn't have to be uniq -The ARN value assigned to an Amazon GameLift Streams application resource. The application must be in `READY` status. Example: `arn:aws:gameliftstreams:us-east-2::application/HLYTnpHa1` +The [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) value or ID assigned to an Amazon GameLift Streams application resource. The application must be in `READY` status. + +ARN example: `arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6` + +ID example: `a-9ZY8X7Wv6` @@ -179 +158 @@ Stream class | Description -`gen5n_win2022` | (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12 and DirectX 11. Supports Unreal Engine up through version 5.4, 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU. Resources per application: vCPUs: 8. VRAM: 24 GB. RAM: 32 GB. Tenancy: Supports one concurrent stream session. +`gen5n_win2022` | (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12 and DirectX 11. Supports Unreal Engine up through version 5.5, 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU. Resources per application: vCPUs: 8. VRAM: 24 GB. RAM: 32 GB. Tenancy: Supports one concurrent stream session. @@ -182 +161 @@ Stream class | Description -`gen4n_win2022` | (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12 and DirectX 11. Supports Unreal Engine up through version 5.4, 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU. Resources per application: vCPUs: 8. VRAM: 16 GB. RAM: 32 GB. Tenancy: Supports one concurrent stream session. +`gen4n_win2022` | (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12 and DirectX 11. Supports Unreal Engine up through version 5.5, 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU. Resources per application: vCPUs: 8. VRAM: 16 GB. RAM: 32 GB. Tenancy: Supports one concurrent stream session. @@ -204,2 +183,2 @@ If the request is successful, then Amazon GameLift Streams returns a response si - "Arn": "arn:aws:gameliftstreams:us-east-2::streamgroup/NOaUjz360", - "Description": "myGame 02_23beta event", + "Arn": "arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4", + "Description": "Test_gen4_high", @@ -207 +186 @@ If the request is successful, then Amazon GameLift Streams returns a response si - "Id": "HLYTnpHa1" + "Id": "a-9ZY8X7Wv6" @@ -210 +189 @@ If the request is successful, then Amazon GameLift Streams returns a response si - "Id": "NOaUjz360", + "Id": "sg-1AB2C3De4", @@ -224,6 +203 @@ When the stream group is in **Active** status, it's ready to deploy resources fo -You can update the following general settings for any stream group in **Active** status. To change any other settings in **Stream group settings** , you must create a new stream group and migrate end-user traffic to stream from the new stream group. - - * Description - - - +Amazon GameLift Streams groups the following settings together in the console under **Stream group settings** : **Status** , **Stream group ID** , **Description** , **Stream group ARN** , and **Stream class**. Of these, the only one that you can update without creating a new stream group is **Description**. @@ -250 +224 @@ CLI -You must configure the AWS CLI with your user credentials and your chosen AWS Region. For more information, refer to [Download the AWS CLI](./setting-up.html#setting-up-prereqs). +You must configure the AWS CLI with your user credentials and your chosen AWS Region. For setup instructions, refer to [Download the AWS CLI](./setting-up.html#setting-up-prereqs). @@ -252 +226 @@ You must configure the AWS CLI with your user credentials and your chosen AWS Re -**To edit a stream group using the AWS CLI** +**To edit a stream group's description using the AWS CLI** @@ -254 +228 @@ You must configure the AWS CLI with your user credentials and your chosen AWS Re -Open a command line with the AWS CLI installed. Then, enter the following command, customized for your content. +In your AWS CLI use the [UpdateStreamGroup](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UpdateStreamGroup.html) command, customized for your content. @@ -258 +232 @@ Open a command line with the AWS CLI installed. Then, enter the following comman - --identifier arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 \ + --identifier arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 \ @@ -266 +240,5 @@ where -An Amazon Resource Name (ARN) or an ID that uniquely identifies the stream group resource. Format example: ARN—`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4` or ID—`1AB2C3De4`. +An [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) or ID that uniquely identifies the stream group resource. + +ARN example: `arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4` + +ID example: `sg-1AB2C3De4` @@ -277 +255 @@ Scale your stream groups by adjusting the capacity for each location. -Refer to [Amazon GameLift Streams service quotas](./quotas.html) for stream group capacity limits per AWS account, per location. Contact your account manager about options for increasing your quota. +Refer to [Amazon GameLift Streams service quotas](./quotas.html) to learn more about stream group capacity quotas per AWS account, per location, and how to increase these quotas. @@ -306 +284 @@ CLI -You must configure the AWS CLI with your user credentials and your chosen AWS Region. Refer to [Download the AWS CLI](./setting-up.html#setting-up-prereqs). +You must configure the AWS CLI with your user credentials and your chosen AWS Region. For setup instructions, refer to [Download the AWS CLI](./setting-up.html#setting-up-prereqs). @@ -310,3 +288 @@ You must configure the AWS CLI with your user credentials and your chosen AWS Re -Open a command line with the AWS CLI installed. Enter the following command, customized for your content. - -###### Example : `update-stream-group` +In your AWS CLI use the [UpdateStreamGroup](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UpdateStreamGroup.html) command, customized for your content. @@ -316 +292 @@ Open a command line with the AWS CLI installed. Enter the following command, cus - --identifier arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 \ + --identifier arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 \ @@ -325 +301,5 @@ where -An Amazon Resource Name (ARN) or an ID that uniquely identifies the stream group resource. Format example: ARN—`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4` or ID—`1AB2C3De4`. +An [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) or ID that uniquely identifies the stream group resource. + +ARN example: `arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4` + +ID example: `sg-1AB2C3De4` @@ -374 +354 @@ CLI -You must configure the AWS CLI with your user credentials and your chosen AWS Region. Refer to [Download the AWS CLI](./setting-up.html#setting-up-prereqs). +You must configure the AWS CLI with your user credentials and your chosen AWS Region. For setup instructions, refer to [Download the AWS CLI](./setting-up.html#setting-up-prereqs). @@ -378 +358 @@ You must configure the AWS CLI with your user credentials and your chosen AWS Re -Enter the following command, customized for your content: +In your AWS CLI use the [AddStreamGroupLocations](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_AddStreamGroupLocations.html) command, customized for your content. @@ -382 +362 @@ Enter the following command, customized for your content: - --identifier arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 + --identifier arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 @@ -390 +370,5 @@ where -An Amazon Resource Name (ARN) or an ID that uniquely identifies the stream group resource. Format example: ARN—`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4` or ID—`1AB2C3De4`. +An [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) or ID that uniquely identifies the stream group resource. + +ARN example: `arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4` + +ID example: `sg-1AB2C3De4` @@ -441 +425 @@ CLI -You must configure the AWS CLI with your user credentials and your chosen AWS Region. Refer to [Download the AWS CLI](./setting-up.html#setting-up-prereqs). +You must configure the AWS CLI with your user credentials and your chosen AWS Region. For setup instructions, refer to [Download the AWS CLI](./setting-up.html#setting-up-prereqs). @@ -445 +429 @@ You must configure the AWS CLI with your user credentials and your chosen AWS Re -Enter the following command, customized for your content: +In your AWS CLI use the [RemoveStreamGroupLocations](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_RemoveStreamGroupLocations.html) command, customized for your content. @@ -449 +433 @@ Enter the following command, customized for your content: - --identifier arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 + --identifier arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 @@ -457 +441,5 @@ where -An Amazon Resource Name (ARN) or an ID that uniquely identifies the stream group resource. Format example: ARN—`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4` or ID—`1AB2C3De4`. +An [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) or ID that uniquely identifies the stream group resource. + +ARN example: `arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4` + +ID example: `sg-1AB2C3De4` @@ -493 +481 @@ CLI -You must configure the AWS CLI with your user credentials and your chosen AWS Region. For more information, refer to [Download the AWS CLI](./setting-up.html#setting-up-prereqs). +You must configure the AWS CLI with your user credentials and your chosen AWS Region. For setup instructions, refer to [Download the AWS CLI](./setting-up.html#setting-up-prereqs). @@ -497 +485 @@ You must configure the AWS CLI with your user credentials and your chosen AWS Re -Open a command line with the AWS CLI installed. Then, enter the following command, customized for your game stream: +In your AWS CLI use the [DeleteStreamGroup](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_DeleteStreamGroup.html) command, customized for your content. @@ -501 +489 @@ Open a command line with the AWS CLI installed. Then, enter the following comman - --identifier arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 + --identifier arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 @@ -508 +496,5 @@ where -An Amazon Resource Name (ARN) or an ID that uniquely identifies the stream group resource. Format example: ARN—`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4` or ID—`1AB2C3De4`. +An [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) or ID that uniquely identifies the stream group resource. + +ARN example: `arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4` + +ID example: `sg-1AB2C3De4`