Skip to content

LocationConfiguration

Source code in docs_src/capo_gameliftstreams/types/location_configuration.py
class LocationConfiguration(TypedDict, closed=True):
    location_name: "capo_gameliftstreams.types.location_name.LocationName"
    """<p> A location's name. For example, <code>us-east-1</code>. For a complete list of locations that Amazon GameLift Streams supports, refer to <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html">Regions, quotas, and limitations</a> in the <i>Amazon GameLift Streams Developer Guide</i>. </p>"""
    always_on_capacity: NotRequired[
        "capo_gameliftstreams.types.always_on_capacity.AlwaysOnCapacity"
    ]
    """<p>This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.</p>"""
    on_demand_capacity: NotRequired[
        "capo_gameliftstreams.types.on_demand_capacity.OnDemandCapacity"
    ]
    """<p>This field is deprecated. Use <code>MaximumCapacity</code> instead. This parameter cannot be used with <code>MaximumCapacity</code> or <code>TargetIdleCapacity</code> in the same location configuration.</p> <p>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.</p>"""
    target_idle_capacity: NotRequired[
        "capo_gameliftstreams.types.target_idle_capacity.TargetIdleCapacity"
    ]
    """<p>This indicates idle capacity which the service pre-allocates and holds for you in anticipation of future activity. This helps to insulate your users from capacity-allocation delays. You pay for capacity which is held in this intentional idle state.</p>"""
    maximum_capacity: NotRequired[
        "capo_gameliftstreams.types.maximum_capacity.MaximumCapacity"
    ]
    """<p>This indicates the maximum capacity that the service can allocate for you. Newly created streams may take a few minutes to start. Capacity is released back to the service when idle. You pay for capacity that is allocated to you until it is released.</p>"""
    vpc_transit_configuration: NotRequired[
        "capo_gameliftstreams.types.vpc_transit_configuration.VpcTransitConfiguration"
    ]
    """<p>Configuration for connecting the stream group to resources in your Amazon VPC using AWS Transit Gateway. This setting is optional. If specified, Amazon GameLift Streams creates a Transit Gateway to enable private network connectivity between the service VPC and your VPC. The VPC ID cannot be changed after the stream group is created, but you can update the CIDR blocks by calling <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UpdateStreamGroup.html">UpdateStreamGroup</a>.</p>"""

always_on_capacity instance-attribute

always_on_capacity: NotRequired[AlwaysOnCapacity]

This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.

location_name instance-attribute

location_name: LocationName

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.

maximum_capacity instance-attribute

maximum_capacity: NotRequired[MaximumCapacity]

This indicates the maximum capacity that the service can allocate for you. Newly created streams may take a few minutes to start. Capacity is released back to the service when idle. You pay for capacity that is allocated to you until it is released.

on_demand_capacity instance-attribute

on_demand_capacity: NotRequired[OnDemandCapacity]

This field is deprecated. Use MaximumCapacity instead. This parameter cannot be used with MaximumCapacity or TargetIdleCapacity in the same location configuration.

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.

target_idle_capacity instance-attribute

target_idle_capacity: NotRequired[TargetIdleCapacity]

This indicates idle capacity which the service pre-allocates and holds for you in anticipation of future activity. This helps to insulate your users from capacity-allocation delays. You pay for capacity which is held in this intentional idle state.

vpc_transit_configuration instance-attribute

vpc_transit_configuration: NotRequired[VpcTransitConfiguration]

Configuration for connecting the stream group to resources in your Amazon VPC using AWS Transit Gateway. This setting is optional. If specified, Amazon GameLift Streams creates a Transit Gateway to enable private network connectivity between the service VPC and your VPC. The VPC ID cannot be changed after the stream group is created, but you can update the CIDR blocks by calling UpdateStreamGroup.