Interface CreateStreamGroupRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateStreamGroupRequest.Builder,CreateStreamGroupRequest>, GameLiftStreamsRequest.Builder, SdkBuilder<CreateStreamGroupRequest.Builder,CreateStreamGroupRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateStreamGroupRequest
@Mutable @NotThreadSafe public static interface CreateStreamGroupRequest.Builder extends GameLiftStreamsRequest.Builder, SdkPojo, CopyableBuilder<CreateStreamGroupRequest.Builder,CreateStreamGroupRequest>

  • Method Details

    • clientToken

      CreateStreamGroupRequest.Builder clientToken(String clientToken)

      A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field.

      Parameters:
      clientToken - A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultApplicationIdentifier

      CreateStreamGroupRequest.Builder defaultApplicationIdentifier(String defaultApplicationIdentifier)

      The unique identifier of the Amazon GameLift Streams application that you want to associate to a stream group as the default application. The application must be in READY status. By setting the default application identifier, you will optimize startup performance of this application in your stream group. Once set, this application cannot be disassociated from the stream group, unlike applications that are associated using AssociateApplications. If not set when creating a stream group, you will need to call AssociateApplications later, before you can start streaming.

      This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6. Example ID: a-9ZY8X7Wv6.

      Parameters:
      defaultApplicationIdentifier - The unique identifier of the Amazon GameLift Streams application that you want to associate to a stream group as the default application. The application must be in READY status. By setting the default application identifier, you will optimize startup performance of this application in your stream group. Once set, this application cannot be disassociated from the stream group, unlike applications that are associated using AssociateApplications. If not set when creating a stream group, you will need to call AssociateApplications later, before you can start streaming.

      This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6. Example ID: a-9ZY8X7Wv6.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateStreamGroupRequest.Builder description(String description)

      A descriptive label for the stream group.

      Parameters:
      description - A descriptive label for the stream group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locationConfigurations

      CreateStreamGroupRequest.Builder locationConfigurations(Collection<LocationConfiguration> locationConfigurations)

      A set of one or more locations and the streaming capacity for each location.

      Parameters:
      locationConfigurations - A set of one or more locations and the streaming capacity for each location.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locationConfigurations

      CreateStreamGroupRequest.Builder locationConfigurations(LocationConfiguration... locationConfigurations)

      A set of one or more locations and the streaming capacity for each location.

      Parameters:
      locationConfigurations - A set of one or more locations and the streaming capacity for each location.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locationConfigurations

      CreateStreamGroupRequest.Builder locationConfigurations(Consumer<LocationConfiguration.Builder>... locationConfigurations)

      A set of one or more locations and the streaming capacity for each location.

      This is a convenience method that creates an instance of the LocationConfiguration.Builder avoiding the need to create one manually via LocationConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to locationConfigurations(List<LocationConfiguration>).

      Parameters:
      locationConfigurations - a consumer that will call methods on LocationConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • streamClass

      CreateStreamGroupRequest.Builder streamClass(String 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:

      • 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.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor 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 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 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.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor 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 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 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

      Parameters:
      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:

      • 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.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor 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 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 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.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor 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 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 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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • streamClass

      CreateStreamGroupRequest.Builder streamClass(StreamClass 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:

      • 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.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor 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 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 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.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor 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 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 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

      Parameters:
      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:

      • 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.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor 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 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 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.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor 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 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 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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateStreamGroupRequest.Builder tags(Map<String,String> tags)

      A list of labels to assign to the new stream group resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management and cost allocation. See Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. You can use TagResource to add tags, UntagResource to remove tags, and ListTagsForResource to view tags on existing resources.

      Parameters:
      tags - A list of labels to assign to the new stream group resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management and cost allocation. See Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. You can use TagResource to add tags, UntagResource to remove tags, and ListTagsForResource to view tags on existing resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateStreamGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateStreamGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.