# CfnStreamGroup

The `AWS::GameLiftStreams::StreamGroup` resource defines a group of compute resources that will be running and streaming your game.

When you create a stream group, you specify the hardware configuration (CPU, GPU, RAM) that will run your game (known as the *stream class* ), the geographical locations where your game can run, and the number of streams that can run simultaneously in each location (known as *stream capacity* ). Stream groups manage how Amazon GameLift Streams allocates resources and handles concurrent streams, allowing you to effectively manage capacity and costs.

There are two types of stream capacity: always-on and on-demand.

- *Always-on* : The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. Default is 1 (2 for high stream classes) when creating a stream group or adding a location.
- *On-demand* : The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). Default is 0 when creating a stream group or adding a location.

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

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

Extends: Construct › CfnElement › CfnRefElement › CfnResource › CfnStreamGroup
Implements: IInspectable, ITaggableV2, IEnvironmentAware, IStreamGroupRef, IConstruct, IDependable

- CloudFormation: [`AWS::GameLiftStreams::StreamGroup`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-gameliftstreams-streamgroup.html)
- Source: Generated code
- Type last changed: v2.252.0 · 30 Apr 2026

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_gameliftstreams as gameliftstreams } from 'aws-cdk-lib';
const cfnStreamGroup = new gameliftstreams.CfnStreamGroup(this, 'MyCfnStreamGroup', {
  description: 'description',
  locationConfigurations: [{
    locationName: 'locationName',

    // the properties below are optional
    alwaysOnCapacity: 123,
    maximumCapacity: 123,
    onDemandCapacity: 123,
    targetIdleCapacity: 123,
    vpcTransitConfiguration: {
      ipv4CidrBlocks: ['ipv4CidrBlocks'],
      vpcId: 'vpcId',
    },
  }],
  streamClass: 'streamClass',

  // the properties below are optional
  defaultApplication: {
    arn: 'arn',
    id: 'id',
  },
  tags: {
    tagsKey: 'tags',
  },
});
```

## Initializer

```ts
new CfnStreamGroup(scope: Construct, id: string, props: CfnStreamGroupProps)
```

## Construct Props

- `defaultApplication`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnStreamGroup.DefaultApplicationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_gameliftstreams.CfnStreamGroup.DefaultApplicationProperty.html) — Object that identifies the Amazon GameLift Streams application to stream with this stream group.

- `description`: string (required) — A descriptive label for the stream group.

- `locationConfigurations`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnStreamGroup.LocationConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_gameliftstreams.CfnStreamGroup.LocationConfigurationProperty.html)[] (required) — 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 AWS Region where you are specifying this resource.

- `streamClass`: string (required) — 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

- `tags`: { [key: string]: string } — A list of labels to assign to the new stream group resource.

  Tags are developer-defined key-value pairs. Tagging AWS resources is useful for resource management, access management and cost allocation. See [Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *AWS General Reference* .

## Properties

- `attrArn`: string (required) — An [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) that uniquely identifies the stream group resource. For example: `arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4` .

- `attrId`: string (required) — An ID that uniquely identifies the stream group resource.

  For example: `sg-1AB2C3De4` .

- `cdkTagManager`: [TagManager](/cdk/api/v2/docs/aws-cdk-lib.TagManager.html) (required) — Tag Manager which manages the tags for this resource.

- `CFN_RESOURCE_TYPE_NAME`: string (required) (static) — The CloudFormation resource type name for this resource class.

- `cfnOptions`: [ICfnResourceOptions](/cdk/api/v2/docs/aws-cdk-lib.ICfnResourceOptions.html) (required) — Options for this resource, such as condition, update policy etc.

- `cfnResourceType`: string (required) — AWS resource type.

- `creationStack`: string[] (required)

- `defaultApplication`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnStreamGroup.DefaultApplicationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_gameliftstreams.CfnStreamGroup.DefaultApplicationProperty.html) — Object that identifies the Amazon GameLift Streams application to stream with this stream group.

- `description`: string (required) — A descriptive label for the stream group.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required)

- `locationConfigurations`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnStreamGroup.LocationConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_gameliftstreams.CfnStreamGroup.LocationConfigurationProperty.html)[] (required) — A set of one or more locations and the streaming capacity for each location.

- `logicalId`: string (required) — The logical ID for this CloudFormation stack element.

  The logical ID of the element
  is calculated from the path of the resource node in the construct tree.

  To override this value, use `overrideLogicalId(newLogicalId)`.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node.

- `ref`: string (required) — Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

  If, by any chance, the intrinsic reference of a resource is not a string, you could
  coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this element is defined.

  CfnElements must be defined within a stack scope (directly or indirectly).

- `streamClass`: string (required) — The target stream quality for sessions that are hosted in this stream group.

- `streamGroupRef`: [StreamGroupReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_gameliftstreams.StreamGroupReference.html) (required) — A reference to a StreamGroup resource.

- `tags`: { [key: string]: string } — A list of labels to assign to the new stream group resource.

## Methods

- `addDeletionOverride(path: string): void` — Syntactic sugar for `addOverride(path, undefined)`.

  **Parameters**

  - `path` — The path of the value to delete.

- `addDependency(target: CfnResource): void` — Use `addResourceDependency` instead.

  This method has been renamed to `addResourceDependency` to more clearly
  set it apart from `construct.node.addDependency`. See the documentation
  of that function for more details.

- `addDependsOn(target: CfnResource): void` — Use `addResourceDependency` instead.

  This can be used for resources across stacks (or nested stack) boundaries
  and the dependency will automatically be transferred to the relevant scope.

  This method has been renamed to `addResourceDependency`, which makes it
  more clear that this method operates at a different level from the
  construct-level `construct.node.addDependency()` mechanism.

- `addMetadata(key: string, value: any): void` — Add a value to the CloudFormation Resource Metadata.

- `addOverride(path: string, value: any): void` — Adds an override to the synthesized CloudFormation resource.

  To add a
  property override, either use `addPropertyOverride` or prefix `path` with
  "Properties." (i.e. `Properties.TopicName`).

  If the override is nested, separate each nested level using a dot (.) in the path parameter.
  If there is an array as part of the nesting, specify the index in the path.

  To include a literal `.` in the property name, prefix with a `\`. In most
  programming languages you will need to write this as `"\\."` because the
  `\` itself will need to be escaped.

  For example,
  ```typescript
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
  ```
  would add the overrides
  ```json
  "Properties": {
    "GlobalSecondaryIndexes": [
      {
        "Projection": {
          "NonKeyAttributes": [ "myattribute" ]
          ...
        }
        ...
      },
      {
        "ProjectionType": "INCLUDE"
        ...
      },
    ]
    ...
  }
  ```

  The `value` argument to `addOverride` will not be processed or translated
  in any way. Pass raw JSON values in here with the correct capitalization
  for CloudFormation. If you pass CDK classes or structs, they will be
  rendered with lowercased key names, and CloudFormation will reject the
  template.

  **Parameters**

  - `path` — - The path of the property, you can use dot notation to override values in complex types.
  - `value` — - The value.

- `addPropertyDeletionOverride(propertyPath: string): void` — Adds an override that deletes the value of a property from the resource definition.

  **Parameters**

  - `propertyPath` — The path to the property.

- `addPropertyOverride(propertyPath: string, value: any): void` — Adds an override to a resource property.

  Syntactic sugar for `addOverride("Properties.<...>", value)`.

  **Parameters**

  - `propertyPath` — The path of the property.
  - `value` — The value.

- `addResourceDependency(target: CfnResource, reason?: string): void` — Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

  This can be used for resources across stacks (or nested stack) boundaries
  and the dependency will automatically be transferred to the relevant scope.

  This method only adds dependencies between L1 resources. If you are
  looking for a generic construct-to-construct dependency mechanism that works
  for all constructs including L2s, use `construct.node.addDependency` instead.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Sets the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  strength instead of the global default from the consuming stack's context.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void` — Sets the deletion policy of the resource based on the removal policy specified.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
  cases, a snapshot can be taken of the resource prior to deletion
  (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
  can be found in the following link:

- `arnForStreamGroup(resource: IStreamGroupRef): string` (static)

- `cfnPropertyName(cdkPropertyName: string): string`

- `getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference` — Returns a token for an runtime attribute of this resource.

  Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
  in case there is no generated attribute.

  **Parameters**

  - `attributeName` — The name of the attribute.

- `getMetadata(key: string): any` — Retrieve a value value from the CloudFormation Resource Metadata.

- `inspect(inspector: TreeInspector): void` — Examines the CloudFormation resource and discloses attributes.

  **Parameters**

  - `inspector` — tree inspector to collect and process attributes.

- `isCfnElement(x: any): boolean` (static) — Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

  Uses duck-typing instead of `instanceof` to allow stack elements from different
  versions of this library to be included in the same stack.

  **Returns:** The construct as a stack element or undefined if it is not a stack element.

- `isCfnResource(x: any): boolean` (static) — Check whether the given object is a CfnResource.

- `isCfnStreamGroup(x: any): boolean` (static) — Checks whether the given object is a CfnStreamGroup.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `obtainDependencies(): Stack | CfnResource[]` — Retrieves an array of resources and stacks this resource depends on.

  For resources depended on directly, returns the `CfnResource` object. For
  dependencies on other stacks, returns the `Stack` object. The order of the
  array is not guaranteed.

- `overrideLogicalId(newLogicalId: string): void` — Overrides the auto-generated logical ID with a specific ID.

  **Parameters**

  - `newLogicalId` — The new logical ID to use for this stack element.

- `removeDependency(target: CfnResource): void` — Use `removeResourceDependency` instead

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `removeResourceDependency(target: CfnResource): void` — Indicates that this resource no longer depends on another resource.

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `replaceDependency(target: CfnResource, newTarget: CfnResource): void` — Replaces one dependency with another.

  **Parameters**

  - `target` — The dependency to replace.
  - `newTarget` — The new dependency to add.

- `toString(): string` — Returns a string representation of this construct.

  **Returns:** a string representation of this resource

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.