RuntimeConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.gamelift.model.RuntimeConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RuntimeConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A collection of server process configurations that describe what processes to run on each instance in a fleet. All fleets must have a run-time configuration. Each instance in the fleet launches the server processes specified in the run-time configuration and launches new ones as existing processes end. Each instance regularly checks for an updated run-time configuration and follows the new instructions.

The run-time configuration enables the instances in a fleet to run multiple processes simultaneously. Potential scenarios are as follows: (1) Run multiple processes of a single game server executable to maximize usage of your hosting resources. (2) Run one or more processes of different build executables, such as your game server executable and a related program, or two or more different versions of a game server. (3) Run multiple processes of a single game server but with different launch parameters, for example to run one process on each instance in debug mode.

A Amazon GameLift instance is limited to 50 processes running simultaneously. A run-time configuration must specify fewer than this limit. To calculate the total number of processes specified in a run-time configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object in the run-time configuration.

Fleet-related operations include:
- CreateFleet
- ListFleets
- Describe fleets:
- Update fleets:
- Manage fleet capacity:
  - DescribeFleetCapacity
  - UpdateFleetCapacity
  - PutScalingPolicy (automatic scaling)
  - DescribeScalingPolicies (automatic scaling)
  - DeleteScalingPolicy (automatic scaling)
  - DescribeEC2InstanceLimits
- DeleteFleet
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RuntimeConfiguration()

Constructors
Constructor and Description
`RuntimeConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RuntimeConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getGameSessionActivationTimeoutSeconds()` Maximum amount of time (in seconds) that a game session can remain in status `ACTIVATING`.
`Integer`	`getMaxConcurrentGameSessionActivations()` Maximum number of game sessions with status `ACTIVATING` to allow on an instance simultaneously.
`List<ServerProcess>`	`getServerProcesses()` Collection of server process configurations that describe which server processes to run on each instance in a fleet.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setGameSessionActivationTimeoutSeconds(Integer gameSessionActivationTimeoutSeconds)` Maximum amount of time (in seconds) that a game session can remain in status `ACTIVATING`.
`void`	`setMaxConcurrentGameSessionActivations(Integer maxConcurrentGameSessionActivations)` Maximum number of game sessions with status `ACTIVATING` to allow on an instance simultaneously.
`void`	`setServerProcesses(Collection<ServerProcess> serverProcesses)` Collection of server process configurations that describe which server processes to run on each instance in a fleet.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`RuntimeConfiguration`	`withGameSessionActivationTimeoutSeconds(Integer gameSessionActivationTimeoutSeconds)` Maximum amount of time (in seconds) that a game session can remain in status `ACTIVATING`.
`RuntimeConfiguration`	`withMaxConcurrentGameSessionActivations(Integer maxConcurrentGameSessionActivations)` Maximum number of game sessions with status `ACTIVATING` to allow on an instance simultaneously.
`RuntimeConfiguration`	`withServerProcesses(Collection<ServerProcess> serverProcesses)` Collection of server process configurations that describe which server processes to run on each instance in a fleet.
`RuntimeConfiguration`	`withServerProcesses(ServerProcess... serverProcesses)` Collection of server process configurations that describe which server processes to run on each instance in a fleet.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RuntimeConfiguration
```
public RuntimeConfiguration()
```
- Method Detail
  - getServerProcesses
```
public List<ServerProcess> getServerProcesses()
```
    Collection of server process configurations that describe which server processes to run on each instance in a fleet.
    
    Returns:
    
    Collection of server process configurations that describe which server processes to run on each instance in a fleet.
  - setServerProcesses
```
public void setServerProcesses(Collection<ServerProcess> serverProcesses)
```
    Collection of server process configurations that describe which server processes to run on each instance in a fleet.
    
    Parameters:
    
    serverProcesses - Collection of server process configurations that describe which server processes to run on each instance in a fleet.
  - withServerProcesses
```
public RuntimeConfiguration withServerProcesses(ServerProcess... serverProcesses)
```
    Collection of server process configurations that describe which server processes to run on each instance in a fleet.
    
    NOTE: This method appends the values to the existing list (if any). Use setServerProcesses(java.util.Collection) or withServerProcesses(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    serverProcesses - Collection of server process configurations that describe which server processes to run on each instance in a fleet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withServerProcesses
```
public RuntimeConfiguration withServerProcesses(Collection<ServerProcess> serverProcesses)
```
    Collection of server process configurations that describe which server processes to run on each instance in a fleet.
    
    Parameters:
    
    serverProcesses - Collection of server process configurations that describe which server processes to run on each instance in a fleet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxConcurrentGameSessionActivations
```
public void setMaxConcurrentGameSessionActivations(Integer maxConcurrentGameSessionActivations)
```
    Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
    
    Parameters:
    
    maxConcurrentGameSessionActivations - Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
  - getMaxConcurrentGameSessionActivations
```
public Integer getMaxConcurrentGameSessionActivations()
```
    Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
    
    Returns:
    
    Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
  - withMaxConcurrentGameSessionActivations
```
public RuntimeConfiguration withMaxConcurrentGameSessionActivations(Integer maxConcurrentGameSessionActivations)
```
    Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
    
    Parameters:
    
    maxConcurrentGameSessionActivations - Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGameSessionActivationTimeoutSeconds
```
public void setGameSessionActivationTimeoutSeconds(Integer gameSessionActivationTimeoutSeconds)
```
    Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
    
    Parameters:
    
    gameSessionActivationTimeoutSeconds - Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
  - getGameSessionActivationTimeoutSeconds
```
public Integer getGameSessionActivationTimeoutSeconds()
```
    Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
    
    Returns:
    
    Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
  - withGameSessionActivationTimeoutSeconds
```
public RuntimeConfiguration withGameSessionActivationTimeoutSeconds(Integer gameSessionActivationTimeoutSeconds)
```
    Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
    
    Parameters:
    
    gameSessionActivationTimeoutSeconds - Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public RuntimeConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class RuntimeConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RuntimeConfiguration

Method Detail

getServerProcesses

setServerProcesses

withServerProcesses

withServerProcesses

setMaxConcurrentGameSessionActivations

getMaxConcurrentGameSessionActivations

withMaxConcurrentGameSessionActivations

setGameSessionActivationTimeoutSeconds

getGameSessionActivationTimeoutSeconds

withGameSessionActivationTimeoutSeconds

toString

equals

hashCode

clone

marshall