com.amazonaws.services.gamelift.model

Class CreateFleetRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.CreateFleetRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Represents the input for a request action.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateFleetRequest()

Method Summary

Modifier and Type	Method and Description
CreateFleetRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getBuildId() Unique identifier for a build to be deployed on the new fleet.
String	getDescription() Human-readable description of a fleet.
List<IpPermission>	getEC2InboundPermissions() Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet.
String	getEC2InstanceType() Name of an EC2 instance type that is supported in Amazon GameLift.
List<String>	getLogPaths() This parameter is no longer used.
List<String>	getMetricGroups() Names of metric groups to add this fleet to.
String	getName() Descriptive label that is associated with a fleet.
String	getNewGameSessionProtectionPolicy() Game session protection policy to apply to all instances in this fleet.
String	getPeerVpcAwsAccountId() Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with.
String	getPeerVpcId() Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.
ResourceCreationLimitPolicy	getResourceCreationLimitPolicy() Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
RuntimeConfiguration	getRuntimeConfiguration() Instructions for launching server processes on each instance in the fleet.
String	getServerLaunchParameters() This parameter is no longer used.
String	getServerLaunchPath() This parameter is no longer used.
int	hashCode()
void	setBuildId(String buildId) Unique identifier for a build to be deployed on the new fleet.
void	setDescription(String description) Human-readable description of a fleet.
void	setEC2InboundPermissions(Collection<IpPermission> eC2InboundPermissions) Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet.
void	setEC2InstanceType(EC2InstanceType eC2InstanceType) Name of an EC2 instance type that is supported in Amazon GameLift.
void	setEC2InstanceType(String eC2InstanceType) Name of an EC2 instance type that is supported in Amazon GameLift.
void	setLogPaths(Collection<String> logPaths) This parameter is no longer used.
void	setMetricGroups(Collection<String> metricGroups) Names of metric groups to add this fleet to.
void	setName(String name) Descriptive label that is associated with a fleet.
void	setNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy) Game session protection policy to apply to all instances in this fleet.
void	setNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy) Game session protection policy to apply to all instances in this fleet.
void	setPeerVpcAwsAccountId(String peerVpcAwsAccountId) Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with.
void	setPeerVpcId(String peerVpcId) Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.
void	setResourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy) Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
void	setRuntimeConfiguration(RuntimeConfiguration runtimeConfiguration) Instructions for launching server processes on each instance in the fleet.
void	setServerLaunchParameters(String serverLaunchParameters) This parameter is no longer used.
void	setServerLaunchPath(String serverLaunchPath) This parameter is no longer used.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateFleetRequest	withBuildId(String buildId) Unique identifier for a build to be deployed on the new fleet.
CreateFleetRequest	withDescription(String description) Human-readable description of a fleet.
CreateFleetRequest	withEC2InboundPermissions(Collection<IpPermission> eC2InboundPermissions) Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet.
CreateFleetRequest	withEC2InboundPermissions(IpPermission... eC2InboundPermissions) Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet.
CreateFleetRequest	withEC2InstanceType(EC2InstanceType eC2InstanceType) Name of an EC2 instance type that is supported in Amazon GameLift.
CreateFleetRequest	withEC2InstanceType(String eC2InstanceType) Name of an EC2 instance type that is supported in Amazon GameLift.
CreateFleetRequest	withLogPaths(Collection<String> logPaths) This parameter is no longer used.
CreateFleetRequest	withLogPaths(String... logPaths) This parameter is no longer used.
CreateFleetRequest	withMetricGroups(Collection<String> metricGroups) Names of metric groups to add this fleet to.
CreateFleetRequest	withMetricGroups(String... metricGroups) Names of metric groups to add this fleet to.
CreateFleetRequest	withName(String name) Descriptive label that is associated with a fleet.
CreateFleetRequest	withNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy) Game session protection policy to apply to all instances in this fleet.
CreateFleetRequest	withNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy) Game session protection policy to apply to all instances in this fleet.
CreateFleetRequest	withPeerVpcAwsAccountId(String peerVpcAwsAccountId) Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with.
CreateFleetRequest	withPeerVpcId(String peerVpcId) Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.
CreateFleetRequest	withResourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy) Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
CreateFleetRequest	withRuntimeConfiguration(RuntimeConfiguration runtimeConfiguration) Instructions for launching server processes on each instance in the fleet.
CreateFleetRequest	withServerLaunchParameters(String serverLaunchParameters) This parameter is no longer used.
CreateFleetRequest	withServerLaunchPath(String serverLaunchPath) This parameter is no longer used.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateFleetRequest

public CreateFleetRequest()

Method Detail

setName

public void setName(String name)

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Parameters:

name - Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

getName

public String getName()

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Returns:

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

withName

public CreateFleetRequest withName(String name)

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Parameters:

name - Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Returns:

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

setDescription

public void setDescription(String description)

Human-readable description of a fleet.

Parameters:

description - Human-readable description of a fleet.

getDescription

public String getDescription()

Human-readable description of a fleet.

Returns:

Human-readable description of a fleet.

withDescription

public CreateFleetRequest withDescription(String description)

Human-readable description of a fleet.

Parameters:

description - Human-readable description of a fleet.

Returns:

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

setBuildId

public void setBuildId(String buildId)

Unique identifier for a build to be deployed on the new fleet. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.

Parameters:

buildId - Unique identifier for a build to be deployed on the new fleet. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.

getBuildId

public String getBuildId()

Unique identifier for a build to be deployed on the new fleet. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.

Returns:

Unique identifier for a build to be deployed on the new fleet. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.

withBuildId

public CreateFleetRequest withBuildId(String buildId)

Unique identifier for a build to be deployed on the new fleet. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.

Parameters:

buildId - Unique identifier for a build to be deployed on the new fleet. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.

Returns:

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

setServerLaunchPath

public void setServerLaunchPath(String serverLaunchPath)

This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

Parameters:

serverLaunchPath - This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

getServerLaunchPath

public String getServerLaunchPath()

This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

Returns:

This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

withServerLaunchPath

public CreateFleetRequest withServerLaunchPath(String serverLaunchPath)

This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

Parameters:

serverLaunchPath - This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

Returns:

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

setServerLaunchParameters

public void setServerLaunchParameters(String serverLaunchParameters)

This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

Parameters:

serverLaunchParameters - This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

getServerLaunchParameters

public String getServerLaunchParameters()

This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

Returns:

This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

withServerLaunchParameters

public CreateFleetRequest withServerLaunchParameters(String serverLaunchParameters)

This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

Parameters:

serverLaunchParameters - This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

Returns:

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

getLogPaths

public List<String> getLogPaths()

This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference.

Returns:

This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference.

setLogPaths

public void setLogPaths(Collection<String> logPaths)

This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference.

Parameters:

logPaths - This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference.

withLogPaths

public CreateFleetRequest withLogPaths(String... logPaths)

This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference.

NOTE: This method appends the values to the existing list (if any). Use setLogPaths(java.util.Collection) or withLogPaths(java.util.Collection) if you want to override the existing values.

Parameters:

logPaths - This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference.

Returns:

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

withLogPaths

public CreateFleetRequest withLogPaths(Collection<String> logPaths)

This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference.

Parameters:

logPaths - This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference.

Returns:

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

setEC2InstanceType

public void setEC2InstanceType(String eC2InstanceType)

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

Parameters:

eC2InstanceType - Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

See Also:

EC2InstanceType

getEC2InstanceType

public String getEC2InstanceType()

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

Returns:

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

See Also:

EC2InstanceType

withEC2InstanceType

public CreateFleetRequest withEC2InstanceType(String eC2InstanceType)

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

Parameters:

eC2InstanceType - Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

Returns:

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

See Also:

EC2InstanceType

setEC2InstanceType

public void setEC2InstanceType(EC2InstanceType eC2InstanceType)

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

Parameters:

eC2InstanceType - Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

See Also:

EC2InstanceType

withEC2InstanceType

public CreateFleetRequest withEC2InstanceType(EC2InstanceType eC2InstanceType)

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

Parameters:

eC2InstanceType - Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

Returns:

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

See Also:

EC2InstanceType

getEC2InboundPermissions

public List<IpPermission> getEC2InboundPermissions()

Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.

Returns:

Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.

setEC2InboundPermissions

public void setEC2InboundPermissions(Collection<IpPermission> eC2InboundPermissions)

Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.

Parameters:

eC2InboundPermissions - Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.

withEC2InboundPermissions

public CreateFleetRequest withEC2InboundPermissions(IpPermission... eC2InboundPermissions)

Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.

NOTE: This method appends the values to the existing list (if any). Use setEC2InboundPermissions(java.util.Collection) or withEC2InboundPermissions(java.util.Collection) if you want to override the existing values.

Parameters:

eC2InboundPermissions - Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.

Returns:

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

withEC2InboundPermissions

public CreateFleetRequest withEC2InboundPermissions(Collection<IpPermission> eC2InboundPermissions)

Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.

Parameters:

eC2InboundPermissions - Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.

Returns:

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

setNewGameSessionProtectionPolicy

public void setNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)

Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.

• NoProtection -- The game session can be terminated during a scale-down event.

• FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Parameters:

newGameSessionProtectionPolicy - Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.

• NoProtection -- The game session can be terminated during a scale-down event.

• FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

See Also:

ProtectionPolicy

getNewGameSessionProtectionPolicy

public String getNewGameSessionProtectionPolicy()

Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.

• NoProtection -- The game session can be terminated during a scale-down event.

• FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Returns:

Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.

• NoProtection -- The game session can be terminated during a scale-down event.

• FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

See Also:

ProtectionPolicy

withNewGameSessionProtectionPolicy

public CreateFleetRequest withNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)

Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.

• NoProtection -- The game session can be terminated during a scale-down event.

• FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Parameters:

newGameSessionProtectionPolicy - Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.

• NoProtection -- The game session can be terminated during a scale-down event.

• FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Returns:

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

See Also:

ProtectionPolicy

setNewGameSessionProtectionPolicy

public void setNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy)

Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.

• NoProtection -- The game session can be terminated during a scale-down event.

• FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Parameters:

newGameSessionProtectionPolicy - Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.

• NoProtection -- The game session can be terminated during a scale-down event.

• FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

See Also:

ProtectionPolicy

withNewGameSessionProtectionPolicy

public CreateFleetRequest withNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy)

Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.

• NoProtection -- The game session can be terminated during a scale-down event.

• FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Parameters:

newGameSessionProtectionPolicy - Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.

• NoProtection -- The game session can be terminated during a scale-down event.

• FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Returns:

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

See Also:

ProtectionPolicy

setRuntimeConfiguration

public void setRuntimeConfiguration(RuntimeConfiguration runtimeConfiguration)

Instructions for launching server processes on each instance in the fleet. The run-time configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance. A CreateFleet request must include a run-time configuration with at least one server process configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters; requests that contain values for these parameters instead of a run-time configuration will continue to work.)

Parameters:

runtimeConfiguration - Instructions for launching server processes on each instance in the fleet. The run-time configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance. A CreateFleet request must include a run-time configuration with at least one server process configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters; requests that contain values for these parameters instead of a run-time configuration will continue to work.)

getRuntimeConfiguration

public RuntimeConfiguration getRuntimeConfiguration()

Instructions for launching server processes on each instance in the fleet. The run-time configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance. A CreateFleet request must include a run-time configuration with at least one server process configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters; requests that contain values for these parameters instead of a run-time configuration will continue to work.)

Returns:

Instructions for launching server processes on each instance in the fleet. The run-time configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance. A CreateFleet request must include a run-time configuration with at least one server process configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters; requests that contain values for these parameters instead of a run-time configuration will continue to work.)

withRuntimeConfiguration

public CreateFleetRequest withRuntimeConfiguration(RuntimeConfiguration runtimeConfiguration)

Instructions for launching server processes on each instance in the fleet. The run-time configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance. A CreateFleet request must include a run-time configuration with at least one server process configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters; requests that contain values for these parameters instead of a run-time configuration will continue to work.)

Parameters:

runtimeConfiguration - Instructions for launching server processes on each instance in the fleet. The run-time configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance. A CreateFleet request must include a run-time configuration with at least one server process configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters; requests that contain values for these parameters instead of a run-time configuration will continue to work.)

Returns:

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

setResourceCreationLimitPolicy

public void setResourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy)

Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

Parameters:

resourceCreationLimitPolicy - Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

getResourceCreationLimitPolicy

public ResourceCreationLimitPolicy getResourceCreationLimitPolicy()

Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

Returns:

Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

withResourceCreationLimitPolicy

public CreateFleetRequest withResourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy)

Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

Parameters:

resourceCreationLimitPolicy - Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

Returns:

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

getMetricGroups

public List<String> getMetricGroups()

Names of metric groups to add this fleet to. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.

Returns:

Names of metric groups to add this fleet to. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.

setMetricGroups

public void setMetricGroups(Collection<String> metricGroups)

Names of metric groups to add this fleet to. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.

Parameters:

metricGroups - Names of metric groups to add this fleet to. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.

withMetricGroups

public CreateFleetRequest withMetricGroups(String... metricGroups)

Names of metric groups to add this fleet to. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.

NOTE: This method appends the values to the existing list (if any). Use setMetricGroups(java.util.Collection) or withMetricGroups(java.util.Collection) if you want to override the existing values.

Parameters:

metricGroups - Names of metric groups to add this fleet to. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.

Returns:

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

withMetricGroups

public CreateFleetRequest withMetricGroups(Collection<String> metricGroups)

Names of metric groups to add this fleet to. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.

Parameters:

metricGroups - Names of metric groups to add this fleet to. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.

Returns:

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

setPeerVpcAwsAccountId

public void setPeerVpcAwsAccountId(String peerVpcAwsAccountId)

Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings.

Parameters:

peerVpcAwsAccountId - Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings.

getPeerVpcAwsAccountId

public String getPeerVpcAwsAccountId()

Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings.

Returns:

Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings.

withPeerVpcAwsAccountId

public CreateFleetRequest withPeerVpcAwsAccountId(String peerVpcAwsAccountId)

Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings.

Parameters:

peerVpcAwsAccountId - Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings.

Returns:

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

setPeerVpcId

public void setPeerVpcId(String peerVpcId)

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. To get VPC information, including IDs, use the Virtual Private Cloud service tools, including the VPC Dashboard in the AWS Management Console.

Parameters:

peerVpcId - Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. To get VPC information, including IDs, use the Virtual Private Cloud service tools, including the VPC Dashboard in the AWS Management Console.

getPeerVpcId

public String getPeerVpcId()

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. To get VPC information, including IDs, use the Virtual Private Cloud service tools, including the VPC Dashboard in the AWS Management Console.

Returns:

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. To get VPC information, including IDs, use the Virtual Private Cloud service tools, including the VPC Dashboard in the AWS Management Console.

withPeerVpcId

public CreateFleetRequest withPeerVpcId(String peerVpcId)

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. To get VPC information, including IDs, use the Virtual Private Cloud service tools, including the VPC Dashboard in the AWS Management Console.

Parameters:

peerVpcId - Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. To get VPC information, including IDs, use the Virtual Private Cloud service tools, including the VPC Dashboard in the AWS Management Console.

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 CreateFleetRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()