runtime_configurations

Creates, updates, deletes, gets or lists a runtime_configurations resource.

Overview

Name	runtime_configurations
Type	Resource
Id	aws.gamelift.runtime_configurations

Fields

The following fields are returned by SELECT queries:

describe_runtime_configuration

Name	Datatype	Description
game_session_activation_timeout_seconds	integer	The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players. During this time, the game session is in status ACTIVATING. If the game session does not become active before the timeout, it is ended and the game session status is changed to TERMINATED.
max_concurrent_game_session_activations	integer	The number of game sessions in status ACTIVATING to allow on an instance or compute. This setting limits the instance resources that can be used for new game activations at any one time.
server_processes	array	A collection of server process configurations that identify what server processes to run on fleet computes.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_runtime_configuration	select	region		This API works with the following fleet types: EC2 Retrieves a fleet's runtime configuration settings. The runtime configuration determines which server processes run, and how, on computes in the fleet. For managed EC2 fleets, the runtime configuration describes server processes that run on each fleet instance. You can update a fleet's runtime configuration at any time using UpdateRuntimeConfiguration. To get the current runtime configuration for a fleet, provide the fleet ID. If successful, a RuntimeConfiguration object is returned for the requested fleet. If the requested fleet has been deleted, the result set is empty. Learn more Setting up Amazon GameLift Servers fleets Running multiple processes on a fleet
update_runtime_configuration	update	region, FleetId, RuntimeConfiguration		This API works with the following fleet types: EC2 Updates the runtime configuration for the specified fleet. The runtime configuration tells Amazon GameLift Servers how to launch server processes on computes in managed EC2 and Anywhere fleets. You can update a fleet's runtime configuration at any time after the fleet is created; it does not need to be in ACTIVE status. To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration with an updated set of server process configurations. If successful, the fleet's runtime configuration settings are updated. Fleet computes that run game server processes regularly check for and receive updated runtime configurations. The computes immediately take action to comply with the new configuration by launching new server processes or by not replacing existing processes when they shut down. Updating a fleet's runtime configuration never affects existing server processes. Learn more Setting up Amazon GameLift Servers fleets

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_runtime_configuration

This API works with the following fleet types: EC2 Retrieves a fleet's runtime configuration settings. The runtime configuration determines which server processes run, and how, on computes in the fleet. For managed EC2 fleets, the runtime configuration describes server processes that run on each fleet instance. You can update a fleet's runtime configuration at any time using UpdateRuntimeConfiguration. To get the current runtime configuration for a fleet, provide the fleet ID. If successful, a RuntimeConfiguration object is returned for the requested fleet. If the requested fleet has been deleted, the result set is empty. Learn more Setting up Amazon GameLift Servers fleets Running multiple processes on a fleet

SELECT
game_session_activation_timeout_seconds,
max_concurrent_game_session_activations,
server_processes
FROM aws.gamelift.runtime_configurations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_runtime_configuration

This API works with the following fleet types: EC2 Updates the runtime configuration for the specified fleet. The runtime configuration tells Amazon GameLift Servers how to launch server processes on computes in managed EC2 and Anywhere fleets. You can update a fleet's runtime configuration at any time after the fleet is created; it does not need to be in ACTIVE status. To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration with an updated set of server process configurations. If successful, the fleet's runtime configuration settings are updated. Fleet computes that run game server processes regularly check for and receive updated runtime configurations. The computes immediately take action to comply with the new configuration by launching new server processes or by not replacing existing processes when they shut down. Updating a fleet's runtime configuration never affects existing server processes. Learn more Setting up Amazon GameLift Servers fleets

UPDATE aws.gamelift.runtime_configurations
SET 
FleetId = '{{ FleetId }}',
RuntimeConfiguration = '{{ RuntimeConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND FleetId = '{{ FleetId }}' --required
AND RuntimeConfiguration = '{{ RuntimeConfiguration }}' --required
RETURNING
runtime_configuration;