AWS gameliftstreams documentation change
Summary
Restructured documentation with added application limitations table, updated S3 bucket examples, removed redundant warnings, and clarified application management processes
Security assessment
Changes focus on documentation structure, service limitations, and example updates rather than addressing security vulnerabilities. The S3 bucket policy example modification uses a different bucket name but doesn't introduce new security concepts. Removed warnings were about operational efficiency, not security risks.
Diff
diff --git a/gameliftstreams/latest/developerguide/applications.md b/gameliftstreams/latest/developerguide/applications.md index 3e6245fe7..d2cf69705 100644 --- a/gameliftstreams/latest/developerguide/applications.md +++ b/gameliftstreams/latest/developerguide/applications.md @@ -5 +5 @@ -Upload your application to an Amazon S3 bucketCreate an applicationEdit an applicationDelete an applicationLinked stream groups +Before you uploadUpload your application to an Amazon S3 bucketCreate an applicationEdit an applicationDelete an applicationLinked stream groups @@ -9 +9 @@ Upload your application to an Amazon S3 bucketCreate an applicationEdit an appli -To set up streaming with Amazon GameLift Streams, you first upload and configure the application content files you plan to stream by creating an application resource. an application contains a set of files (executable and any supporting files) and a configuration that instructs Amazon GameLift Streams about how to run it for streaming. +To set up streaming with Amazon GameLift Streams, first you upload the game or other application that you want to stream, then you configure an application resource within Amazon GameLift Streams to define metadata about your game. An Amazon GameLift Streams application consists of the files you uploaded (executable and any supporting files) and a configuration that instructs Amazon GameLift Streams what executable to run when streaming. @@ -11 +11 @@ To set up streaming with Amazon GameLift Streams, you first upload and configure -Each application represents a single version of your content. If you have multiple versions, create a separate application for each. After you create an application, you cannot update the files. If you need to update the executable or any supporting files, you must recreate the application. +Each Amazon GameLift Streams application represents a single version of your content. If you have multiple versions, you must create a separate application for each version. After you create an application, you cannot update the files. If you need to update the executable or any supporting files, you must create a new Amazon GameLift Streams application. @@ -13 +13 @@ Each application represents a single version of your content. If you have multip -###### Topics +## Before you upload @@ -15 +15 @@ Each application represents a single version of your content. If you have multip - * Upload your application to an Amazon S3 bucket +Before you create an Amazon GameLift Streams application, verify that your game adheres to the following limitations. @@ -17,7 +17,5 @@ Each application represents a single version of your content. If you have multip - * Create an application - - * Edit an application - - * Delete an application - - * Linked stream groups +Name | Default | Adjustable | Description +---|---|---|--- +Files per application | 30,000 files | No* | The maximum number of files that you can have in an application, in this account. +Single file size | 80 GiB | No | The maximum size of a single file in an application. Note that a gibibyte (GiB) equals 1024*1024*1024 bytes. +Application size | 100 GiB | No* | The maximum total size of an Amazon GameLift Streams application, in this account. Note that a gibibyte (GiB) equals 1024*1024*1024 bytes. @@ -24,0 +23 @@ Each application represents a single version of your content. If you have multip +*To request an increase, reach out to your AWS Account Manager. @@ -25,0 +25 @@ Each application represents a single version of your content. If you have multip +###### Note @@ -26,0 +27 @@ Each application represents a single version of your content. If you have multip +To save yourself time and effort, verify that the files you are ready to upload are the correct version of your application. While you can upload new versions later, you will need to repeat the Create an application and [Create a stream group](./stream-groups.html#stream-groups-create) steps for each version. @@ -30 +31 @@ Each application represents a single version of your content. If you have multip -Before you can create an application, get your set of files ready and upload it to an Amazon Simple Storage Service (Amazon S3) bucket in your AWS account. +Now that you have prepared your game for Amazon GameLift Streams, it's time to upload it to an Amazon Simple Storage Service (Amazon S3) bucket in your AWS account. @@ -38,10 +38,0 @@ To optimize storage cost, you can delete the application from your S3 bucket aft -The following limitations apply to your application files in a single Amazon S3 bucket. - -Description | Limitation ----|--- -Max number of files | 30,000 files -Max size of a single file | 80 GiB -Max total size | 100 GiB - -**Example** Suppose your application folder contains a total of 142 files, where the largest file size is 317 MiB, and the total file size is 1.2 GiB. This is a valid set of files to create an Amazon GameLift Streams application with. - @@ -52 +43 @@ Max total size | 100 GiB - 2. Create an Amazon S3 bucket. Enter a bucket name and select an AWS Region. This region must be the same as the application and stream group that you will create later. See [AWS Regions supported by Amazon GameLift Streams](./regions-quotas-rande.html) for a list of AWS Regions where Amazon GameLift Streams is available. For the remaining fields, keep the default settings. + 2. Create an Amazon S3 bucket. Enter a bucket name and select an AWS Region. This region must be the same as the application and stream group that you will create later. See [AWS Regions and remote locations supported by Amazon GameLift Streams](./regions-quotas-rande.html) for a list of AWS Regions where Amazon GameLift Streams is available. For the remaining fields, keep the default settings. @@ -65,4 +55,0 @@ You must upload your application files as an uncompressed folder. Don't upload a -###### Warning - -Ensure that the files you uploaded is the correct one you want and is within the application size limitations. If you want to update your files later, you will need to repeat Create an application and [Create a stream group](./stream-groups.html#stream-groups-create). Uploading the correct version of your application from the start can save you time and effort. - @@ -71 +58 @@ Ensure that the files you uploaded is the correct one you want and is within the -An application is a resource that contains the game or other software you want to stream and the settings to run it. When you create an application, you provide the path to the application files you uploaded in your Amazon S3 bucket. The bucket must have permission for Amazon GameLift Streams to access it. +An Amazon GameLift Streams application is a resource that contains the game or other software you want to stream and the settings to run it. When you create an application, you provide the path to the application files you uploaded in your Amazon S3 bucket. @@ -73 +60 @@ An application is a resource that contains the game or other software you want t -Amazon GameLift Streams does not auto-sync your application files. If you want to update your application files, you must create a new application. +Amazon GameLift Streams does not auto-sync your game files from the Amazon S3 bucket you created. If you want to update your game files, you must create a new Amazon GameLift Streams application. @@ -94 +81,3 @@ This is the Amazon S3 URI to your application's root folder in the Amazon S3 buc -A valid URI is the bucket prefix that contains all the files needed to run and stream the application. For example, a bucket called `mygamebuild` contains three complete versions of the game build files, each in a separate folder. You want to stream the build in the folder `mygamebuild-EN101`. In this example, the URI is `s3://mygamebuild/mygamebuild-EN101`. **You cannot edit this field after the creation workflow.** +A valid URI is the bucket prefix that contains all the files needed to run and stream the application. For example, a bucket called `mygamebuild` contains three complete versions of the game build files, each in a separate folder. You want to stream the build in the folder `mygamebuild-EN101`. In this example, the URI is `s3://amzn-s3-demo-bucket/mygamebuild-EN101`. + +**You cannot edit this field after the creation workflow.** @@ -98 +87,3 @@ A valid URI is the bucket prefix that contains all the files needed to run and s -This is the Amazon S3 URI to the executable file that Amazon GameLift Streams will stream. The file must be contained within the application's root folder. **You cannot edit this field after the creation workflow.** +This is the Amazon S3 URI to the executable file that Amazon GameLift Streams will stream. The file must be contained within the application's root folder. + +**You cannot edit this field after the creation workflow.** @@ -142 +133 @@ To save log files on your behalf, Amazon GameLift Streams must be given permissi -Copy the following policy code and apply it to the bucket that you want to use for application logs. Be sure to replace **log-bucket-name** with the name of your existing S3 bucket. +Copy the following policy code and apply it to the bucket that you want to use for application logs. Be sure to replace **amzn-s3-demo-bucket** with the name of your existing S3 bucket. @@ -156 +147 @@ Copy the following policy code and apply it to the bucket that you want to use f - "Resource": "arn:aws:s3:::log-bucket-name/*" + "Resource": "arn:aws:s3:::amzn-s3-demo-bucket/*" @@ -191 +182 @@ In your AWS CLI enter the following command, customized for your settings. - --application-source-uri ""s3://example-games/example"" + --application-source-uri ""s3://amzn-s3-demo-bucket/example"" @@ -224 +215,3 @@ This is the Amazon S3 URI to your application's root folder in the Amazon S3 buc -A valid URI is the bucket prefix that contains all the files needed to run and stream the application. For example, a bucket called `mygamebuild` contains three complete versions of the game build files, each in a separate folder. You want to stream the build in the folder `mygamebuild-EN101`. In this example, the URI is `s3://mygamebuild/mygamebuild-EN101`. **You cannot edit this field after the creation workflow.** +A valid URI is the bucket prefix that contains all the files needed to run and stream the application. For example, a bucket called `mygamebuild` contains three complete versions of the game build files, each in a separate folder. You want to stream the build in the folder `mygamebuild-EN101`. In this example, the URI is `s3://amzn-s3-demo-bucket/mygamebuild-EN101`. + +**You cannot edit this field after the creation workflow.** @@ -228 +221,3 @@ A valid URI is the bucket prefix that contains all the files needed to run and s -This is the Amazon S3 URI to the executable file that Amazon GameLift Streams will stream. The file must be contained within the application's root folder. Enter the path relative to the `application-source-uri`. **You cannot edit this field after the creation workflow.** +This is the Amazon S3 URI to the executable file that Amazon GameLift Streams will stream. The file must be contained within the application's root folder. Enter the path relative to the `application-source-uri`. + +**You cannot edit this field after the creation workflow.** @@ -244 +239 @@ If the request is successful, Amazon GameLift Streams returns a response similar - "ApplicationSourceUri": "s3://example-games/example", + "ApplicationSourceUri": "s3://amzn-s3-demo-bucket/example", @@ -261 +256 @@ Amazon GameLift Streams takes a few minutes to prepare your application. During -If the request returns an error, or if the application is created but placed in an **Error** status, check if it's related to a permissions issue. The Amazon S3 bucket must have the proper permissions, as described in Upload your application to an Amazon S3 bucket. In addition, make sure that you're working with user credentials that include access to both Amazon S3 and Amazon GameLift Streams. +If the request returns an error, or if the application is created but placed in an **Error** status, make sure that you're working with user credentials that include access to both Amazon S3 and Amazon GameLift Streams. @@ -333 +328 @@ In your AWS CLI enter the following command, customized for your settings. - --application-log-output-uri "s3://mylogbucket/mygame" + --application-log-output-uri "s3://amzn-s3-demo-bucket/mygame"