AWS::GameLiftStreams::StreamGroup - Amazon CloudFormation
SyntaxPropertiesReturn valuesSee also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::GameLiftStreams::StreamGroup

Stream groups manage how Amazon GameLift Streams allocates resources and handles concurrent streams, allowing you to effectively manage capacity and costs. Within a stream group, you specify an application to stream, streaming locations and their capacity, and the stream class you want to use when streaming applications to your end-users. A stream class defines the hardware configuration of the compute resources that Amazon GameLift Streams will use when streaming, such as the CPU, GPU, and memory.

Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. The following capacity settings are available:

  • Always-on capacity: This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.

  • Maximum capacity: This indicates the maximum capacity that the service can allocate for you. Newly created streams may take a few minutes to start. Capacity is released back to the service when idle. You pay for capacity that is allocated to you until it is released.

  • Target-idle capacity: This indicates idle capacity which the service pre-allocates and holds for you in anticipation of future activity. This helps to insulate your users from capacity-allocation delays. You pay for capacity which is held in this intentional idle state.

Values for capacity must be whole number multiples of the tenancy value of the stream group's stream class.

Note

Application association is not currently supported in Amazon CloudFormation. To link additional applications to a stream group, use the Amazon GameLift Streams console or the Amazon CLI.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::GameLiftStreams::StreamGroup",
  "Properties" : {
      "DefaultApplication" : DefaultApplication,
      "Description" : String,
      "LocationConfigurations" : [ LocationConfiguration, ... ],
      "StreamClass" : String,
      "Tags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::GameLiftStreams::StreamGroup
Properties:
  DefaultApplication: 
    DefaultApplication
  Description: String
  LocationConfigurations: 
    - LocationConfiguration
  StreamClass: String
  Tags: 
    Key: Value

Properties

DefaultApplication

Object that identifies the Amazon GameLift Streams application to stream with this stream group.

Required: No

Type: DefaultApplication

Update requires: No interruption

Description

A descriptive label for the stream group.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9-_.!+@/][a-zA-Z0-9-_.!+@/ ]*$

Minimum: 1

Maximum: 80

Update requires: No interruption

LocationConfigurations

A set of one or more locations and the streaming capacity for each location. One of the locations MUST be your primary location, which is the Amazon Region where you are specifying this resource.

Required: Yes

Type: Array of LocationConfiguration

Minimum: 1

Maximum: 100

Update requires: No interruption

StreamClass

The target stream quality for sessions that are hosted in this stream group. Set a stream class that is appropriate to the type of content that you're streaming. Stream class determines the type of computing resources Amazon GameLift Streams uses and impacts the cost of streaming. The following options are available:

A stream class can be one of the following:

  • gen6n_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core GPU.

    • Reference resolution: 1080p

    • Reference frame rate: 60 fps

    • Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM

    • Tenancy: Supports 1 concurrent stream session

  • gen6n_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Uses dedicated NVIDIA L4 Tensor Core GPU.

    • Reference resolution: 1080p

    • Reference frame rate: 60 fps

    • Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM

    • Tenancy: Supports 1 concurrent stream session

  • gen6n_ultra_win2022 (NVIDIA, ultra) Supports applications with high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core GPU.

    • Reference resolution: 1080p

    • Reference frame rate: 60 fps

    • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

    • Tenancy: Supports 1 concurrent stream session

  • gen6n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA L4 Tensor Core GPU.

    • Reference resolution: 1080p

    • Reference frame rate: 60 fps

    • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

    • Tenancy: Supports 1 concurrent stream session

  • gen6n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU.

    • Reference resolution: 1080p

    • Reference frame rate: 60 fps

    • Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM

    • Tenancy: Supports up to 2 concurrent stream sessions

  • gen6n_medium (NVIDIA, medium) Supports applications with moderate 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU.

    • Reference resolution: 1080p

    • Reference frame rate: 60 fps

    • Workload specifications: 2 vCPUs, 8 GB RAM, 6 GB VRAM

    • Tenancy: Supports up to 4 concurrent stream sessions

  • gen6n_small (NVIDIA, small) Supports applications with lightweight 3D scene complexity and low CPU usage. Uses NVIDIA L4 Tensor Core GPU.

    • Reference resolution: 1080p

    • Reference frame rate: 60 fps

    • Workload specifications: 1 vCPUs, 4 GB RAM, 2 GB VRAM

    • Tenancy: Supports up to 12 concurrent stream sessions

  • gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor Core GPU.

    • Reference resolution: 1080p

    • Reference frame rate: 60 fps

    • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

    • Tenancy: Supports 1 concurrent stream session

  • gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor Core GPU.

    • Reference resolution: 1080p

    • Reference frame rate: 60 fps

    • Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM

    • Tenancy: Supports up to 2 concurrent stream sessions

  • gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor Core GPU.

    • Reference resolution: 1080p

    • Reference frame rate: 60 fps

    • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

    • Tenancy: Supports 1 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. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor Core GPU.

    • Reference resolution: 1080p

    • Reference frame rate: 60 fps

    • Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM

    • Tenancy: Supports 1 concurrent stream session

  • gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor Core GPU.

    • Reference resolution: 1080p

    • Reference frame rate: 60 fps

    • Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM

    • Tenancy: Supports up to 2 concurrent stream sessions

  • gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor Core GPU.

    • Reference resolution: 1080p

    • Reference frame rate: 60 fps

    • Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM

    • Tenancy: Supports 1 concurrent stream session

Required: Yes

Type: String

Minimum: 1

Maximum: 20

Update requires: Replacement

Tags

A list of labels to assign to the new stream group resource. Tags are developer-defined key-value pairs. Tagging Amazon resources is useful for resource management, access management and cost allocation. See Tagging Amazon Resources in the Amazon General Reference.

Required: No

Type: Object of String

Pattern: .+

Minimum: 0

Maximum: 256

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns an Amazon Resource Name (ARN) that uniquely identifies the stream group resource across all Amazon Regions. For example:

arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. For example: arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4.

Id

An ID that uniquely identifies the stream group resource. For example: sg-1AB2C3De4.

See also