Interface CfnStreamGroupProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnStreamGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)", date="2026-02-09T14:39:11.750Z") @Stability(Stable) public interface CfnStreamGroupProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnStreamGroup.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.gameliftstreams.*;
 CfnStreamGroupProps cfnStreamGroupProps = CfnStreamGroupProps.builder()
         .description("description")
         .locationConfigurations(List.of(LocationConfigurationProperty.builder()
                 .locationName("locationName")
                 // the properties below are optional
                 .alwaysOnCapacity(123)
                 .maximumCapacity(123)
                 .onDemandCapacity(123)
                 .targetIdleCapacity(123)
                 .build()))
         .streamClass("streamClass")
         // the properties below are optional
         .defaultApplication(DefaultApplicationProperty.builder()
                 .arn("arn")
                 .id("id")
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:
  • Method Details

    • getDescription

      @Stability(Stable) @NotNull String getDescription()
      A descriptive label for the stream group.

      See Also:
    • getLocationConfigurations

      @Stability(Stable) @NotNull Object getLocationConfigurations()
      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.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnStreamGroup.LocationConfigurationProperty>

      See Also:
    • getStreamClass

      @Stability(Stable) @NotNull String getStreamClass()
      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

      See Also:
    • getDefaultApplication

      @Stability(Stable) @Nullable default Object getDefaultApplication()
      Object that identifies the Amazon GameLift Streams application to stream with this stream group.

      Returns union: either IResolvable or CfnStreamGroup.DefaultApplicationProperty

      See Also:
    • getTags

      @Stability(Stable) @Nullable default Map<String,String> getTags()
      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 in the AWS General Reference .

      See Also:
    • builder

      @Stability(Stable) static CfnStreamGroupProps.Builder builder()
      Returns:
      a CfnStreamGroupProps.Builder of CfnStreamGroupProps