Skip to content

UpdateStreamGroupInput

Source code in docs_src/capo_gameliftstreams/types/update_stream_group_input.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
class UpdateStreamGroupInput(TypedDict, closed=True):
    identifier: "capo_gameliftstreams.types.identifier.Identifier"
    """<p>An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. Example ID: <code>sg-1AB2C3De4</code>. </p>"""
    location_configurations: NotRequired[
        "capo_gameliftstreams.types.location_configurations.LocationConfigurations"
    ]
    """<p> A set of one or more locations and the streaming capacity for each location. </p>"""
    description: NotRequired["capo_gameliftstreams.types.description.Description"]
    """<p>A descriptive label for the stream group.</p>"""
    default_application_identifier: NotRequired[
        "capo_gameliftstreams.types.identifier.Identifier"
    ]
    """<p>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 <code>READY</code> status. The default application is pre-cached on always-on compute resources, reducing stream startup times. Other applications are automatically cached as needed.</p> <p>Note that this parameter only sets the default application in a stream group. To associate a new application to an existing stream group, you must use <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_AssociateApplications.html">AssociateApplications</a>.</p> <p>When you switch default applications in a stream group, it can take up to a few hours for the new default application to be pre-cached.</p> <p>This value is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the application resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</code>. Example ID: <code>a-9ZY8X7Wv6</code>. </p>"""

default_application_identifier instance-attribute 

default_application_identifier: NotRequired[Identifier]

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.

Note that this parameter only sets the default application in a stream group. To associate a new application to an existing stream group, you must use AssociateApplications.

When you switch default applications in a stream group, it can take up to a few hours for the new default application to be pre-cached.

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 instance-attribute 

description: NotRequired[Description]

A descriptive label for the stream group.

identifier instance-attribute 

identifier: Identifier

An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.

location_configurations instance-attribute 

location_configurations: NotRequired[LocationConfigurations]

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