Skip to content

ContainerFleetLocationAttributes

Source code in docs_src/capo_gamelift/types/container_fleet_location_attributes.py
class ContainerFleetLocationAttributes(TypedDict, closed=True):
    location: NotRequired[
        "capo_gamelift.types.location_string_model.LocationStringModel"
    ]
    """<p>A location identifier.</p>"""
    status: NotRequired[
        "capo_gamelift.types.container_fleet_location_status.ContainerFleetLocationStatus"
    ]
    """<p>The status of fleet activity in the location. </p> <ul> <li> <p> <code>PENDING</code> -- A new container fleet has been requested.</p> </li> <li> <p> <code>CREATING</code> -- A new container fleet resource is being created. </p> </li> <li> <p> <code>CREATED</code> -- A new container fleet resource has been created. No fleet instances have been deployed.</p> </li> <li> <p> <code>ACTIVATING</code> -- New container fleet instances are being deployed.</p> </li> <li> <p> <code>ACTIVE</code> -- The container fleet has been deployed and is ready to host game sessions.</p> </li> <li> <p> <code>UPDATING</code> -- The container fleet is being updated. A deployment is in progress.</p> </li> <li> <p> <code>EXPIRED</code> -- The container fleet has been expired. The fleet is scaled down to zero instances and cannot host new game sessions.</p> </li> </ul>"""
    player_gateway_status: NotRequired[
        "capo_gamelift.types.player_gateway_status.PlayerGatewayStatus"
    ]
    """<p>The current status of player gateway in this location for this container fleet. Note, even if a container fleet has PlayerGatewayMode configured as <code>ENABLED</code>, player gateway might not be available in a specific location. For more information about locations where player gateway is supported, see <a href="https://docs.aws.amazon.com/gameliftservers/latest/developerguide/gamelift-regions.html">Amazon GameLift Servers service locations</a>.</p> <p>Possible values include:</p> <ul> <li> <p> <code>ENABLED</code> -- Player gateway is available for this container fleet location.</p> </li> <li> <p> <code>DISABLED</code> -- Player gateway is not available for this container fleet location.</p> </li> </ul>"""

location instance-attribute

location: NotRequired[LocationStringModel]

A location identifier.

player_gateway_status instance-attribute

player_gateway_status: NotRequired[PlayerGatewayStatus]

The current status of player gateway in this location for this container fleet. Note, even if a container fleet has PlayerGatewayMode configured as ENABLED, player gateway might not be available in a specific location. For more information about locations where player gateway is supported, see Amazon GameLift Servers service locations.

Possible values include:

  • ENABLED -- Player gateway is available for this container fleet location.

  • DISABLED -- Player gateway is not available for this container fleet location.

status instance-attribute

status: NotRequired[ContainerFleetLocationStatus]

The status of fleet activity in the location.

  • PENDING -- A new container fleet has been requested.

  • CREATING -- A new container fleet resource is being created.

  • CREATED -- A new container fleet resource has been created. No fleet instances have been deployed.

  • ACTIVATING -- New container fleet instances are being deployed.

  • ACTIVE -- The container fleet has been deployed and is ready to host game sessions.

  • UPDATING -- The container fleet is being updated. A deployment is in progress.

  • EXPIRED -- The container fleet has been expired. The fleet is scaled down to zero instances and cannot host new game sessions.