create-stream-group¶

Description¶

Stream groups manage how Amazon GameLift Streams allocates resources and handles concurrent streams, allowing you to effectively manage capacity and costs. Within a stream group, you specify an application to stream, streaming locations and their capacity, and the stream class you want to use when streaming applications to your end-users. A stream class defines the hardware configuration of the compute resources that Amazon GameLift Streams will use when streaming, such as the CPU, GPU, and memory.

Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of 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.

To adjust the capacity of any ACTIVE stream group, call UpdateStreamGroup .

If the CreateStreamGroup request is successful, Amazon GameLift Streams assigns a unique ID to the stream group resource and sets the status to ACTIVATING . It can take a few minutes for Amazon GameLift Streams to finish creating the stream group while it searches for unallocated compute resources and provisions them. When complete, the stream group status will be ACTIVE and you can start stream sessions by using StartStreamSession . To check the stream group’s status, call GetStreamGroup .

Stream groups should be recreated every 3-4 weeks to pick up important service updates and fixes. Stream groups that are older than 180 days can no longer be updated with new application associations. Stream groups expire when they are 365 days old, at which point they can no longer stream sessions. The exact expiration date is indicated by the date value in the ExpiresAt field.

Synopsis¶

  create-stream-group
--description <value>
--stream-class <value>
[--default-application-identifier <value>]
[--location-configurations <value>]
[--tags <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--description (string) [required]

A descriptive label for the stream group.

Constraints:

min: 1

max: 80

pattern: [a-zA-Z0-9-_.!+@/][a-zA-Z0-9-_.!+@/ ]*

--stream-class (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:

``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

Possible values:

gen4n_high

gen4n_ultra

gen4n_win2022

gen5n_high

gen5n_ultra

gen5n_win2022

--default-application-identifier (string)

The unique identifier of the Amazon GameLift Streams application that you want to set as the default application in a stream group. The application that you specify must be in READY status. The default application is pre-cached on always-on compute resources, reducing stream startup times. Other applications are automatically cached as needed.

If you do not link an application when you create a stream group, you will need to link one later, before you can start streaming, using AssociateApplications .

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 .

Constraints:

min: 1

max: 128

pattern: (^[a-zA-Z0-9-]+$)|(^arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)$)

--location-configurations (list)

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

Constraints:

min: 1

max: 100

(structure)

Configuration settings that define a stream group’s stream capacity for a location. When configuring a location for the first time, you must specify a numeric value for at least one of the two capacity types. To update the capacity for an existing stream group, call UpdateStreamGroup . To add a new location and specify its capacity, call AddStreamGroupLocations .

LocationName -> (string) [required]

A location’s name. For example, us-east-1 . For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide .

Constraints:

min: 1

max: 20

pattern: [a-zA-Z0-9-]+

AlwaysOnCapacity -> (integer)

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.

Constraints:

min: 0

OnDemandCapacity -> (integer)

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.

Constraints:

min: 0

Shorthand Syntax:

LocationName=string,AlwaysOnCapacity=integer,OnDemandCapacity=integer ...

JSON Syntax:

[
  {
    "LocationName": "string",
    "AlwaysOnCapacity": integer,
    "OnDemandCapacity": integer
  }
  ...
]

--tags (map)

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.

Constraints:

min: 1

max: 50

key -> (string)

Constraints:

min: 1

max: 128

value -> (string)

Constraints:

min: 0

max: 256

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--client-token (string)

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.

Constraints:

min: 32

max: 128

pattern: [\x21-\x7E]+

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

Arn -> (string)

The Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies the group across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID] .

Constraints:

min: 1

max: 128

pattern: (^[a-zA-Z0-9-]+$)|(^arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)$)

Description -> (string)

A descriptive label for the stream group.

Constraints:

min: 1

max: 80

pattern: [a-zA-Z0-9-_.!+@/][a-zA-Z0-9-_.!+@/ ]*

DefaultApplication -> (structure)

The default Amazon GameLift Streams application that is associated with this stream group.

Id -> (string)

An ID that uniquely identifies the application resource. Example ID: a-9ZY8X7Wv6 .

Constraints:

min: 1

max: 32

pattern: [a-zA-Z0-9-]+

Arn -> (string)

An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 .

Constraints:

min: 1

max: 128

pattern: arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)

LocationStates -> (list)

This value is the set of locations, including their name, current status, and capacities.

A location can be in one of the following states:

ACTIVATING : Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

ACTIVE : The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

ERROR : Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

REMOVING : Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.

(structure)

Represents a location and its corresponding stream capacity and status.

LocationName -> (string)

A location’s name. For example, us-east-1 . For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide .

Constraints:

min: 1

max: 20

pattern: [a-zA-Z0-9-]+

Status -> (string)

This value is set of locations, including their name, current status, and capacities.

A location can be in one of the following states:

ACTIVATING : Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

ACTIVE : The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

ERROR : Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

REMOVING : Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.

Possible values:

ACTIVATING

ACTIVE

ERROR

REMOVING

AlwaysOnCapacity -> (integer)

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.

Constraints:

min: 0

OnDemandCapacity -> (integer)

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.

Constraints:

min: 0

RequestedCapacity -> (integer)

This value is the always-on capacity that you most recently requested for a stream group. You request capacity separately for each location in a stream group. In response to an increase in requested capacity, Amazon GameLift Streams attempts to provision compute resources to make the stream group’s allocated capacity meet requested capacity. When always-on capacity is decreased, it can take a few minutes to deprovision allocated capacity to match the requested capacity.

Constraints:

min: 0

AllocatedCapacity -> (integer)

This value is the stream capacity that Amazon GameLift Streams has provisioned in a stream group that can respond immediately to stream requests. It includes resources that are currently streaming and resources that are idle and ready to respond to stream requests. You pay for this capacity whether it’s in use or not. After making changes to capacity, it can take a few minutes for the allocated capacity count to reflect the change while compute resources are allocated or deallocated. Similarly, when allocated on-demand capacity is no longer needed, it can take a few minutes for Amazon GameLift Streams to spin down the allocated capacity.

Constraints:

min: 0

IdleCapacity -> (integer)

This value is the amount of allocated capacity that is not currently streaming. It represents the stream group’s ability to respond immediately to new stream requests with near-instant startup time.

Constraints:

min: 0

StreamClass -> (string)

The target stream quality for the stream group.

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

Possible values:

gen4n_high

gen4n_ultra

gen4n_win2022

gen5n_high

gen5n_ultra

gen5n_win2022

Id -> (string)

A unique ID value that is assigned to the resource when it’s created. Format example: sg-1AB2C3De4 .

Constraints:

min: 1

max: 32

pattern: [a-zA-Z0-9-]+

Status -> (string)

The current status of the stream group resource. Possible statuses include the following:

ACTIVATING : The stream group is deploying and isn’t ready to host streams.

ACTIVE : The stream group is ready to host streams.

ACTIVE_WITH_ERRORS : One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error.

DELETING : Amazon GameLift Streams is in the process of deleting the stream group.

ERROR : An error occurred when the stream group deployed. See StatusReason (returned by CreateStreamGroup , GetStreamGroup , and UpdateStreamGroup ) for more information.

EXPIRED : The stream group is expired and can no longer host streams. This typically occurs when a stream group is 365 days old, as indicated by the value of ExpiresAt . Create a new stream group to resume streaming capabilities.

UPDATING_LOCATIONS : One or more locations in the stream group are in the process of updating (either activating or deleting).

Possible values:

ACTIVATING

UPDATING_LOCATIONS

ACTIVE

ACTIVE_WITH_ERRORS

ERROR

DELETING

EXPIRED

StatusReason -> (string)

A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:

internalError : The request can’t process right now because of an issue with the server. Try again later.

noAvailableInstances : Amazon GameLift Streams does not currently have enough available on-demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.

Possible values:

internalError

noAvailableInstances

LastUpdatedAt -> (timestamp)

A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).

CreatedAt -> (timestamp)

A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).

ExpiresAt -> (timestamp)

The time at which this stream group expires. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC). After this time, you will no longer be able to update this stream group or use it to start stream sessions. Only Get and Delete operations will work on an expired stream group.

AssociatedApplications -> (list)

A set of applications that this stream group is associated to. You can stream any of these applications by using this stream group.

This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 .

(string)

Constraints:

min: 1

max: 128

pattern: arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)

Table of Contents

Feedback

User Guide