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 the set of processes to run on each instance in a fleet. Server processes run either an executable in a custom game build or a Realtime Servers script. GameLift launches the configured processes, manages their life cycle, and replaces them as needed. Each instance checks regularly for an updated runtime configuration.

A GameLift instance is limited to 50 processes running concurrently. To calculate the total number of processes in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess. Learn more about Running Multiple Processes on a Fleet.

Related actions

DescribeRuntimeConfiguration | UpdateRuntimeConfiguration

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()` The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players.
`Integer`	`getMaxConcurrentGameSessionActivations()` The number of game sessions in status `ACTIVATING` to allow on an instance.
`List<ServerProcess>`	`getServerProcesses()` A collection of server process configurations that identify what 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)` The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players.
`void`	`setMaxConcurrentGameSessionActivations(Integer maxConcurrentGameSessionActivations)` The number of game sessions in status `ACTIVATING` to allow on an instance.
`void`	`setServerProcesses(Collection<ServerProcess> serverProcesses)` A collection of server process configurations that identify what server processes to run on each instance in a fleet.
`String`	`toString()` Returns a string representation of this object.
`RuntimeConfiguration`	`withGameSessionActivationTimeoutSeconds(Integer gameSessionActivationTimeoutSeconds)` The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players.
`RuntimeConfiguration`	`withMaxConcurrentGameSessionActivations(Integer maxConcurrentGameSessionActivations)` The number of game sessions in status `ACTIVATING` to allow on an instance.
`RuntimeConfiguration`	`withServerProcesses(Collection<ServerProcess> serverProcesses)` A collection of server process configurations that identify what server processes to run on each instance in a fleet.
`RuntimeConfiguration`	`withServerProcesses(ServerProcess... serverProcesses)` A collection of server process configurations that identify what 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()
```
    A collection of server process configurations that identify what server processes to run on each instance in a fleet.
    
    Returns:
    
    A collection of server process configurations that identify what server processes to run on each instance in a fleet.
  - setServerProcesses
```
public void setServerProcesses(Collection<ServerProcess> serverProcesses)
```
    A collection of server process configurations that identify what server processes to run on each instance in a fleet.
    
    Parameters:
    
    serverProcesses - A collection of server process configurations that identify what server processes to run on each instance in a fleet.
  - withServerProcesses
```
public RuntimeConfiguration withServerProcesses(ServerProcess... serverProcesses)
```
    A collection of server process configurations that identify what 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 - A collection of server process configurations that identify what 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)
```
    A collection of server process configurations that identify what server processes to run on each instance in a fleet.
    
    Parameters:
    
    serverProcesses - A collection of server process configurations that identify what 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)
```
    The number of game sessions in status ACTIVATING to allow on an instance. This setting limits the instance resources that can be used for new game activations at any one time.
    
    Parameters:
    
    maxConcurrentGameSessionActivations - The number of game sessions in status ACTIVATING to allow on an instance. This setting limits the instance resources that can be used for new game activations at any one time.
  - getMaxConcurrentGameSessionActivations
```
public Integer getMaxConcurrentGameSessionActivations()
```
    The number of game sessions in status ACTIVATING to allow on an instance. This setting limits the instance resources that can be used for new game activations at any one time.
    
    Returns:
    
    The number of game sessions in status ACTIVATING to allow on an instance. This setting limits the instance resources that can be used for new game activations at any one time.
  - withMaxConcurrentGameSessionActivations
```
public RuntimeConfiguration withMaxConcurrentGameSessionActivations(Integer maxConcurrentGameSessionActivations)
```
    The number of game sessions in status ACTIVATING to allow on an instance. This setting limits the instance resources that can be used for new game activations at any one time.
    
    Parameters:
    
    maxConcurrentGameSessionActivations - The number of game sessions in status ACTIVATING to allow on an instance. This setting limits the 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)
```
    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.
    
    Parameters:
    
    gameSessionActivationTimeoutSeconds - 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.
  - getGameSessionActivationTimeoutSeconds
```
public Integer getGameSessionActivationTimeoutSeconds()
```
    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.
    
    Returns:
    
    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.
  - withGameSessionActivationTimeoutSeconds
```
public RuntimeConfiguration withGameSessionActivationTimeoutSeconds(Integer gameSessionActivationTimeoutSeconds)
```
    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.
    
    Parameters:
    
    gameSessionActivationTimeoutSeconds - 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.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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