com.amazonaws.services.gamelift.model

Class ResourceCreationLimitPolicy

java.lang.Object

com.amazonaws.services.gamelift.model.ResourceCreationLimitPolicy

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ResourceCreationLimitPolicy
extends Object
implements Serializable, Cloneable, StructuredPojo

A policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period".

The policy is evaluated when a player tries to create a new game session. For example: Assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ResourceCreationLimitPolicy()

Method Summary

Modifier and Type	Method and Description
ResourceCreationLimitPolicy	clone()
boolean	equals(Object obj)
Integer	getNewGameSessionsPerCreator() The maximum number of game sessions that an individual can create during the policy period.
Integer	getPolicyPeriodInMinutes() The time span used in evaluating the resource creation limit policy.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setNewGameSessionsPerCreator(Integer newGameSessionsPerCreator) The maximum number of game sessions that an individual can create during the policy period.
void	setPolicyPeriodInMinutes(Integer policyPeriodInMinutes) The time span used in evaluating the resource creation limit policy.
String	toString() Returns a string representation of this object.
ResourceCreationLimitPolicy	withNewGameSessionsPerCreator(Integer newGameSessionsPerCreator) The maximum number of game sessions that an individual can create during the policy period.
ResourceCreationLimitPolicy	withPolicyPeriodInMinutes(Integer policyPeriodInMinutes) The time span used in evaluating the resource creation limit policy.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ResourceCreationLimitPolicy

public ResourceCreationLimitPolicy()

Method Detail

setNewGameSessionsPerCreator

public void setNewGameSessionsPerCreator(Integer newGameSessionsPerCreator)

The maximum number of game sessions that an individual can create during the policy period.

Parameters:

newGameSessionsPerCreator - The maximum number of game sessions that an individual can create during the policy period.

getNewGameSessionsPerCreator

public Integer getNewGameSessionsPerCreator()

The maximum number of game sessions that an individual can create during the policy period.

Returns:

The maximum number of game sessions that an individual can create during the policy period.

withNewGameSessionsPerCreator

public ResourceCreationLimitPolicy withNewGameSessionsPerCreator(Integer newGameSessionsPerCreator)

The maximum number of game sessions that an individual can create during the policy period.

Parameters:

newGameSessionsPerCreator - The maximum number of game sessions that an individual can create during the policy period.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPolicyPeriodInMinutes

public void setPolicyPeriodInMinutes(Integer policyPeriodInMinutes)

The time span used in evaluating the resource creation limit policy.

Parameters:

policyPeriodInMinutes - The time span used in evaluating the resource creation limit policy.

getPolicyPeriodInMinutes

public Integer getPolicyPeriodInMinutes()

The time span used in evaluating the resource creation limit policy.

Returns:

The time span used in evaluating the resource creation limit policy.

withPolicyPeriodInMinutes

public ResourceCreationLimitPolicy withPolicyPeriodInMinutes(Integer policyPeriodInMinutes)

The time span used in evaluating the resource creation limit policy.

Parameters:

policyPeriodInMinutes - The time span used in evaluating the resource creation limit policy.

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 ResourceCreationLimitPolicy 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.