Package software.amazon.awscdk.cfnpropertymixins.services.gameliftstreams

Class CfnStreamGroupPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.gameliftstreams.CfnStreamGroupPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:59.653Z") @Stability(Stable) public class CfnStreamGroupPropsMixin extends Mixin implements software.constructs.IMixin
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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.gameliftstreams.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnStreamGroupPropsMixin cfnStreamGroupPropsMixin = CfnStreamGroupPropsMixin.Builder.create(CfnStreamGroupMixinProps.builder()
         .defaultApplication(DefaultApplicationProperty.builder()
                 .arn("arn")
                 .id("id")
                 .build())
         .description("description")
         .locationConfigurations(List.of(LocationConfigurationProperty.builder()
                 .alwaysOnCapacity(123)
                 .locationName("locationName")
                 .maximumCapacity(123)
                 .onDemandCapacity(123)
                 .targetIdleCapacity(123)
                 .build()))
         .streamClass("streamClass")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnStreamGroupPropsMixin

      protected CfnStreamGroupPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnStreamGroupPropsMixin

      protected CfnStreamGroupPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnStreamGroupPropsMixin

      @Stability(Stable) public CfnStreamGroupPropsMixin(@NotNull CfnStreamGroupMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::GameLiftStreams::StreamGroup.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnStreamGroupPropsMixin

      @Stability(Stable) public CfnStreamGroupPropsMixin(@NotNull CfnStreamGroupMixinProps props)
      Create a mixin to apply properties to AWS::GameLiftStreams::StreamGroup.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnStreamGroupMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()