AWS gameliftservers documentation change
Summary
Updated documentation to replace 'AWS CloudFormation' with 'CloudFormation' throughout the file, removing redundant 'AWS' branding from CloudFormation references.
Security assessment
The changes are purely terminological, standardizing references to CloudFormation without altering any security-related content. No security vulnerabilities, mitigations, or new security features are mentioned or implied in the diff.
Diff
diff --git a/gameliftservers/latest/developerguide/resources-cloudformation.md b/gameliftservers/latest/developerguide/resources-cloudformation.md index e39c6f5e4..b3773e907 100644 --- a//gameliftservers/latest/developerguide/resources-cloudformation.md +++ b//gameliftservers/latest/developerguide/resources-cloudformation.md @@ -5 +5 @@ -Best practicesUsing AWS CloudFormation stacksUpdating builds +Best practicesUsing CloudFormation stacksUpdating builds @@ -7 +7 @@ Best practicesUsing AWS CloudFormation stacksUpdating builds -# Manage Amazon GameLift Servers hosting resources using AWS CloudFormation +# Manage Amazon GameLift Servers hosting resources using CloudFormation @@ -9 +9 @@ Best practicesUsing AWS CloudFormation stacksUpdating builds -You can use AWS CloudFormation to manage your Amazon GameLift Servers resources. In AWS CloudFormation, you create a template that models each resource and then use the template to create your resources. To update resources, you make the changes to your template and use AWS CloudFormation to implement the updates. You can organize your resources into logical groups, called stacks and stack sets. +You can use CloudFormation to manage your Amazon GameLift Servers resources. In CloudFormation, you create a template that models each resource and then use the template to create your resources. To update resources, you make the changes to your template and use CloudFormation to implement the updates. You can organize your resources into logical groups, called stacks and stack sets. @@ -11 +11 @@ You can use AWS CloudFormation to manage your Amazon GameLift Servers resources. -Using AWS CloudFormation to maintain your Amazon GameLift Servers hosting resources offers a more efficient way to manage sets of AWS resources. You can use version control to track template changes over time and coordinate updates made by multiple team members. You can also reuse templates. For example, when deploying a game across multiple Regions, you might use the same template to create identical resources in each Region. You can also use these templates to deploy the same sets of resources in another partition. +Using CloudFormation to maintain your Amazon GameLift Servers hosting resources offers a more efficient way to manage sets of AWS resources. You can use version control to track template changes over time and coordinate updates made by multiple team members. You can also reuse templates. For example, when deploying a game across multiple Regions, you might use the same template to create identical resources in each Region. You can also use these templates to deploy the same sets of resources in another partition. @@ -13 +13 @@ Using AWS CloudFormation to maintain your Amazon GameLift Servers hosting resour -For more information about AWS CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/). To view template information for Amazon GameLift Servers resources, see the [Amazon GameLift Servers resource type reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_GameLift.html). +For more information about CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/). To view template information for Amazon GameLift Servers resources, see the [Amazon GameLift Servers resource type reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_GameLift.html). @@ -17 +17 @@ For more information about AWS CloudFormation, see the [AWS CloudFormation User -For detailed guidance on using AWS CloudFormation, see the [AWS CloudFormation best practices](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/best-practices.html) in the _AWS CloudFormation User Guide_. In addition, these best practices have special relevance with Amazon GameLift Servers. +For detailed guidance on using CloudFormation, see the [CloudFormation best practices](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/best-practices.html) in the _AWS CloudFormation User Guide_. In addition, these best practices have special relevance with Amazon GameLift Servers. @@ -19 +19 @@ For detailed guidance on using AWS CloudFormation, see the [AWS CloudFormation b - * **Consistently manage your resources through AWS CloudFormation.** If you change your resources outside of AWS CloudFormation your resources will get out of sync with your resource templates. + * **Consistently manage your resources through CloudFormation.** If you change your resources outside of CloudFormation your resources will get out of sync with your resource templates. @@ -21 +21 @@ For detailed guidance on using AWS CloudFormation, see the [AWS CloudFormation b - * **Use AWS CloudFormation stacks and stack sets to efficiently manage multiple resources.** + * **Use CloudFormation stacks and stack sets to efficiently manage multiple resources.** @@ -23 +23 @@ For detailed guidance on using AWS CloudFormation, see the [AWS CloudFormation b - * Use stacks to manage groups of connected resources. For example, a stack that contains a build, a fleet that references the build, and an alias that references the fleet. If you update your template to replace a build, AWS CloudFormation replaces the fleets connected to the build. AWS CloudFormation then updates the existing aliases to point to the new fleets. For more information, see [Working with stacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) in the _AWS CloudFormation User Guide_. + * Use stacks to manage groups of connected resources. For example, a stack that contains a build, a fleet that references the build, and an alias that references the fleet. If you update your template to replace a build, CloudFormation replaces the fleets connected to the build. CloudFormation then updates the existing aliases to point to the new fleets. For more information, see [Working with stacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) in the _AWS CloudFormation User Guide_. @@ -25 +25 @@ For detailed guidance on using AWS CloudFormation, see the [AWS CloudFormation b - * Use AWS CloudFormation stack sets if you're deploying identical stacks across multiple regions or AWS accounts. For more information, see [Working with stack sets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html) in the _AWS CloudFormation User Guide_. + * Use CloudFormation stack sets if you're deploying identical stacks across multiple regions or AWS accounts. For more information, see [Working with stack sets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html) in the _AWS CloudFormation User Guide_. @@ -40 +40 @@ For detailed guidance on using AWS CloudFormation, see the [AWS CloudFormation b -## Using AWS CloudFormation stacks +## Using CloudFormation stacks @@ -42 +42 @@ For detailed guidance on using AWS CloudFormation, see the [AWS CloudFormation b -We recommend the following structures to use when setting up AWS CloudFormation stacks for Amazon GameLift Servers resources. Your optimal stack structure varies depending on if you are deploying your game in one location or multiple locations. +We recommend the following structures to use when setting up CloudFormation stacks for Amazon GameLift Servers resources. Your optimal stack structure varies depending on if you are deploying your game in one location or multiple locations. @@ -50 +50 @@ To manage Amazon GameLift Servers resources in a single location, we recommend a - * **Amazon GameLift Servers stack** – This stack contains all of your Amazon GameLift Servers resources, including the build or script, a set of fleets, aliases, and game session queue. AWS CloudFormation creates a build or script resource with files stored in the S3 bucket location and deploys the build or script to one or more fleet resources. Each fleet should have a corresponding alias. The game session queue references some or all of the fleet aliases. If you are using FlexMatch for matchmaking, this stack also contains a matchmaking configuration and rule set. + * **Amazon GameLift Servers stack** – This stack contains all of your Amazon GameLift Servers resources, including the build or script, a set of fleets, aliases, and game session queue. CloudFormation creates a build or script resource with files stored in the S3 bucket location and deploys the build or script to one or more fleet resources. Each fleet should have a corresponding alias. The game session queue references some or all of the fleet aliases. If you are using FlexMatch for matchmaking, this stack also contains a matchmaking configuration and rule set. @@ -57 +57 @@ The diagram below illustrates a two-stack structure for deploying resources in a - + @@ -65 +65 @@ When deploying your game in more than one Region, keep in mind how resources can - * **Regional Amazon GameLift Servers stacks** –This stack contains the Amazon GameLift Servers resources that must exist in each region where your game is being deployed, including the build or script, a set of fleets, and aliases. AWS CloudFormation creates a build or script resource with files in an S3 bucket location, and deploys the build or script to one or more fleet resources. Each fleet should have a corresponding alias. The game session queue references some or all of the fleet aliases. You can maintain one template to describe this type of stack and use it to create identical sets of resources in every Region. + * **Regional Amazon GameLift Servers stacks** –This stack contains the Amazon GameLift Servers resources that must exist in each region where your game is being deployed, including the build or script, a set of fleets, and aliases. CloudFormation creates a build or script resource with files in an S3 bucket location, and deploys the build or script to one or more fleet resources. Each fleet should have a corresponding alias. The game session queue references some or all of the fleet aliases. You can maintain one template to describe this type of stack and use it to create identical sets of resources in every Region. @@ -74 +74 @@ The diagrams below illustrates a multistack structure for deploying resources in - + @@ -76 +76 @@ The diagrams below illustrates a multistack structure for deploying resources in - + @@ -95 +95 @@ For more information, see [ Update behaviors of stack resources](https://docs.aw -When updating a stack containing related build, fleet and alias resources, the default AWS CloudFormation behavior is to automatically perform these steps in sequence. You trigger this update by first uploading the new build files to a new S3 location. Then you modify your AWS CloudFormation build template to point to the new S3 location. When you update your stack with the new S3 location, this triggers the following AWS CloudFormation sequence: +When updating a stack containing related build, fleet and alias resources, the default CloudFormation behavior is to automatically perform these steps in sequence. You trigger this update by first uploading the new build files to a new S3 location. Then you modify your CloudFormation build template to point to the new S3 location. When you update your stack with the new S3 location, this triggers the following CloudFormation sequence: @@ -112 +112 @@ If your game session queue uses fleet aliases, player traffic is automatically s -You can also have AWS CloudFormation retain resources instead of deleting them. For more information, see [RetainResources](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeleteStack.html) in the _AWS CloudFormation API Reference_. +You can also have CloudFormation retain resources instead of deleting them. For more information, see [RetainResources](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeleteStack.html) in the _AWS CloudFormation API Reference_. @@ -116 +116 @@ You can also have AWS CloudFormation retain resources instead of deleting them. -If you want to have more control over when new fleets go live for players, you have some options. You can choose to manage aliases manually using the Amazon GameLift Servers console or the CLI. Alternatively, instead of updating your build template to replace the build and fleets, you can add a second set of build and fleet definitions to your template. When you update the template, AWS CloudFormation creates a second build resource and corresponding fleets. Since the existing resources are not replaced, they are not deleted, and the aliases remain pointing at original fleets. +If you want to have more control over when new fleets go live for players, you have some options. You can choose to manage aliases manually using the Amazon GameLift Servers console or the CLI. Alternatively, instead of updating your build template to replace the build and fleets, you can add a second set of build and fleet definitions to your template. When you update the template, CloudFormation creates a second build resource and corresponding fleets. Since the existing resources are not replaced, they are not deleted, and the aliases remain pointing at original fleets. @@ -122 +122 @@ The following diagram illustrates this process. - + @@ -126 +126 @@ The following diagram illustrates this process. -When executing a resource update, if any step is not completed successfully, AWS CloudFormation automatically initiates a rollback. This process reverses each step in sequence, deleting the newly created resources. +When executing a resource update, if any step is not completed successfully, CloudFormation automatically initiates a rollback. This process reverses each step in sequence, deleting the newly created resources.