Class CreateStreamGroupRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.gameliftstreams.model.GameLiftStreamsRequest

software.amazon.awssdk.services.gameliftstreams.model.CreateStreamGroupRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateStreamGroupRequest.Builder,CreateStreamGroupRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateStreamGroupRequest
extends GameLiftStreamsRequest
implements ToCopyableBuilder<CreateStreamGroupRequest.Builder,CreateStreamGroupRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateStreamGroupRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateStreamGroupRequest.Builder	builder()
final String	clientToken()	A unique identifier that represents a client request.
final String	defaultApplicationIdentifier()	The unique identifier of the Amazon GameLift Streams application that you want to associate to a stream group as the default application.
final String	description()	A descriptive label for the stream group.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)	Used to retrieve the value of a field from any class that extends SdkRequest.
final int	hashCode()
final boolean	hasLocationConfigurations()	For responses, this returns true if the service returned a value for the LocationConfigurations property.
final boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
final List<LocationConfiguration>	locationConfigurations()	A set of one or more locations and the streaming capacity for each location.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends CreateStreamGroupRequest.Builder>	serializableBuilderClass()
final StreamClass	streamClass()	The target stream quality for sessions that are hosted in this stream group.
final String	streamClassAsString()	The target stream quality for sessions that are hosted in this stream group.
final Map<String,String>	tags()	A list of labels to assign to the new stream group resource.
CreateStreamGroupRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

clientToken

public final 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.

Returns:

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.

defaultApplicationIdentifier

public final 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.

Returns:

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.

description

public final String description()

A descriptive label for the stream group.

Returns:

A descriptive label for the stream group.

hasLocationConfigurations

public final boolean hasLocationConfigurations()

For responses, this returns true if the service returned a value for the LocationConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

locationConfigurations

public final List<LocationConfiguration> locationConfigurations()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLocationConfigurations() method.

Returns:

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

streamClass

public final 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

If the service returns an enum value that is not available in the current SDK version, streamClass will return StreamClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from streamClassAsString().

Returns:

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

See Also:

• StreamClass

streamClassAsString

public final String streamClassAsString()

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

If the service returns an enum value that is not available in the current SDK version, streamClass will return StreamClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from streamClassAsString().

Returns:

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

See Also:

• StreamClass

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

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.

toBuilder

public CreateStreamGroupRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateStreamGroupRequest.Builder,CreateStreamGroupRequest>

Specified by:

toBuilder in class GameLiftStreamsRequest

Returns:

a builder for type T

builder

public static CreateStreamGroupRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateStreamGroupRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
 Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.