Class CreateFleetRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the input for a request action.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
Unique identifier for the build you want the new fleet to use.Human-readable description of the fleet.Access limits for incoming traffic.Type of EC2 instances used in the fleet.Path to game-session log files generated by your game server.getName()
Descriptive label associated with this fleet.Game session protection policy to apply to all instances created in this fleet.Parameters required to launch your game server.Path to the launch executable for the game server.int
hashCode()
void
setBuildId
(String buildId) Unique identifier for the build you want the new fleet to use.void
setDescription
(String description) Human-readable description of the fleet.void
setEC2InboundPermissions
(Collection<IpPermission> eC2InboundPermissions) Access limits for incoming traffic.void
setEC2InstanceType
(EC2InstanceType eC2InstanceType) Type of EC2 instances used in the fleet.void
setEC2InstanceType
(String eC2InstanceType) Type of EC2 instances used in the fleet.void
setLogPaths
(Collection<String> logPaths) Path to game-session log files generated by your game server.void
Descriptive label associated with this fleet.void
setNewGameSessionProtectionPolicy
(ProtectionPolicy newGameSessionProtectionPolicy) Game session protection policy to apply to all instances created in this fleet.void
setNewGameSessionProtectionPolicy
(String newGameSessionProtectionPolicy) Game session protection policy to apply to all instances created in this fleet.void
setServerLaunchParameters
(String serverLaunchParameters) Parameters required to launch your game server.void
setServerLaunchPath
(String serverLaunchPath) Path to the launch executable for the game server.toString()
Returns a string representation of this object; useful for testing and debugging.withBuildId
(String buildId) Unique identifier for the build you want the new fleet to use.withDescription
(String description) Human-readable description of the fleet.withEC2InboundPermissions
(IpPermission... eC2InboundPermissions) Access limits for incoming traffic.withEC2InboundPermissions
(Collection<IpPermission> eC2InboundPermissions) Access limits for incoming traffic.withEC2InstanceType
(EC2InstanceType eC2InstanceType) Type of EC2 instances used in the fleet.withEC2InstanceType
(String eC2InstanceType) Type of EC2 instances used in the fleet.withLogPaths
(String... logPaths) Path to game-session log files generated by your game server.withLogPaths
(Collection<String> logPaths) Path to game-session log files generated by your game server.Descriptive label associated with this fleet.withNewGameSessionProtectionPolicy
(ProtectionPolicy newGameSessionProtectionPolicy) Game session protection policy to apply to all instances created in this fleet.withNewGameSessionProtectionPolicy
(String newGameSessionProtectionPolicy) Game session protection policy to apply to all instances created in this fleet.withServerLaunchParameters
(String serverLaunchParameters) Parameters required to launch your game server.withServerLaunchPath
(String serverLaunchPath) Path to the launch executable for the game server.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
CreateFleetRequest
public CreateFleetRequest()
-
-
Method Details
-
setName
Descriptive label associated with this fleet. Fleet names do not need to be unique.
- Parameters:
name
- Descriptive label associated with this fleet. Fleet names do not need to be unique.
-
getName
Descriptive label associated with this fleet. Fleet names do not need to be unique.
- Returns:
- Descriptive label associated with this fleet. Fleet names do not need to be unique.
-
withName
Descriptive label associated with this fleet. Fleet names do not need to be unique.
- Parameters:
name
- Descriptive label associated with this 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
Human-readable description of the fleet.
- Parameters:
description
- Human-readable description of the fleet.
-
getDescription
Human-readable description of the fleet.
- Returns:
- Human-readable description of the fleet.
-
withDescription
Human-readable description of the fleet.
- Parameters:
description
- Human-readable description of the fleet.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setBuildId
Unique identifier for the build you want the new fleet to use.
- Parameters:
buildId
- Unique identifier for the build you want the new fleet to use.
-
getBuildId
Unique identifier for the build you want the new fleet to use.
- Returns:
- Unique identifier for the build you want the new fleet to use.
-
withBuildId
Unique identifier for the build you want the new fleet to use.
- Parameters:
buildId
- Unique identifier for the build you want the new fleet to use.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setServerLaunchPath
Path to the launch executable for the game server. A game server is built into a
C:\game
drive. This value must be expressed asC:\game\[launchpath]
. Example: If, when built, your game server files are in a folder called "MyGame", your log path should beC:\game\MyGame\server.exe
.- Parameters:
serverLaunchPath
- Path to the launch executable for the game server. A game server is built into aC:\game
drive. This value must be expressed asC:\game\[launchpath]
. Example: If, when built, your game server files are in a folder called "MyGame", your log path should beC:\game\MyGame\server.exe
.
-
getServerLaunchPath
Path to the launch executable for the game server. A game server is built into a
C:\game
drive. This value must be expressed asC:\game\[launchpath]
. Example: If, when built, your game server files are in a folder called "MyGame", your log path should beC:\game\MyGame\server.exe
.- Returns:
- Path to the launch executable for the game server. A game server
is built into a
C:\game
drive. This value must be expressed asC:\game\[launchpath]
. Example: If, when built, your game server files are in a folder called "MyGame", your log path should beC:\game\MyGame\server.exe
.
-
withServerLaunchPath
Path to the launch executable for the game server. A game server is built into a
C:\game
drive. This value must be expressed asC:\game\[launchpath]
. Example: If, when built, your game server files are in a folder called "MyGame", your log path should beC:\game\MyGame\server.exe
.- Parameters:
serverLaunchPath
- Path to the launch executable for the game server. A game server is built into aC:\game
drive. This value must be expressed asC:\game\[launchpath]
. Example: If, when built, your game server files are in a folder called "MyGame", your log path should beC:\game\MyGame\server.exe
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setServerLaunchParameters
Parameters required to launch your game server. These parameters should be expressed as a string of command-line parameters. Example: "+sv_port 33435 +start_lobby".
- Parameters:
serverLaunchParameters
- Parameters required to launch your game server. These parameters should be expressed as a string of command-line parameters. Example: "+sv_port 33435 +start_lobby".
-
getServerLaunchParameters
Parameters required to launch your game server. These parameters should be expressed as a string of command-line parameters. Example: "+sv_port 33435 +start_lobby".
- Returns:
- Parameters required to launch your game server. These parameters should be expressed as a string of command-line parameters. Example: "+sv_port 33435 +start_lobby".
-
withServerLaunchParameters
Parameters required to launch your game server. These parameters should be expressed as a string of command-line parameters. Example: "+sv_port 33435 +start_lobby".
- Parameters:
serverLaunchParameters
- Parameters required to launch your game server. These parameters should be expressed as a string of command-line parameters. Example: "+sv_port 33435 +start_lobby".- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getLogPaths
Path to game-session log files generated by your game server. Once a game session has been terminated, Amazon GameLift captures and stores the logs on Amazon S3. Use the GameLift console to access the stored logs.
- Returns:
- Path to game-session log files generated by your game server. Once a game session has been terminated, Amazon GameLift captures and stores the logs on Amazon S3. Use the GameLift console to access the stored logs.
-
setLogPaths
Path to game-session log files generated by your game server. Once a game session has been terminated, Amazon GameLift captures and stores the logs on Amazon S3. Use the GameLift console to access the stored logs.
- Parameters:
logPaths
- Path to game-session log files generated by your game server. Once a game session has been terminated, Amazon GameLift captures and stores the logs on Amazon S3. Use the GameLift console to access the stored logs.
-
withLogPaths
Path to game-session log files generated by your game server. Once a game session has been terminated, Amazon GameLift captures and stores the logs on Amazon S3. Use the GameLift console to access the stored logs.
NOTE: This method appends the values to the existing list (if any). Use
setLogPaths(java.util.Collection)
orwithLogPaths(java.util.Collection)
if you want to override the existing values.- Parameters:
logPaths
- Path to game-session log files generated by your game server. Once a game session has been terminated, Amazon GameLift captures and stores the logs on Amazon S3. Use the GameLift console to access the stored logs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withLogPaths
Path to game-session log files generated by your game server. Once a game session has been terminated, Amazon GameLift captures and stores the logs on Amazon S3. Use the GameLift console to access the stored logs.
- Parameters:
logPaths
- Path to game-session log files generated by your game server. Once a game session has been terminated, Amazon GameLift captures and stores the logs on Amazon S3. Use the GameLift console to access the stored logs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEC2InstanceType
Type of EC2 instances used in the fleet. EC2 instance types define the CPU, memory, storage, and networking capacity of the fleetaposs hosts. Amazon GameLift supports the EC2 instance types listed below. See Amazon EC2 Instance Types for detailed descriptions of each.
- Parameters:
eC2InstanceType
- Type of EC2 instances used in the fleet. EC2 instance types define the CPU, memory, storage, and networking capacity of the fleetaposs hosts. Amazon GameLift supports the EC2 instance types listed below. See Amazon EC2 Instance Types for detailed descriptions of each.- See Also:
-
getEC2InstanceType
Type of EC2 instances used in the fleet. EC2 instance types define the CPU, memory, storage, and networking capacity of the fleetaposs hosts. Amazon GameLift supports the EC2 instance types listed below. See Amazon EC2 Instance Types for detailed descriptions of each.
- Returns:
- Type of EC2 instances used in the fleet. EC2 instance types define the CPU, memory, storage, and networking capacity of the fleetaposs hosts. Amazon GameLift supports the EC2 instance types listed below. See Amazon EC2 Instance Types for detailed descriptions of each.
- See Also:
-
withEC2InstanceType
Type of EC2 instances used in the fleet. EC2 instance types define the CPU, memory, storage, and networking capacity of the fleetaposs hosts. Amazon GameLift supports the EC2 instance types listed below. See Amazon EC2 Instance Types for detailed descriptions of each.
- Parameters:
eC2InstanceType
- Type of EC2 instances used in the fleet. EC2 instance types define the CPU, memory, storage, and networking capacity of the fleetaposs hosts. Amazon GameLift supports the EC2 instance types listed below. See Amazon EC2 Instance Types for detailed descriptions of each.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setEC2InstanceType
Type of EC2 instances used in the fleet. EC2 instance types define the CPU, memory, storage, and networking capacity of the fleetaposs hosts. Amazon GameLift supports the EC2 instance types listed below. See Amazon EC2 Instance Types for detailed descriptions of each.
- Parameters:
eC2InstanceType
- Type of EC2 instances used in the fleet. EC2 instance types define the CPU, memory, storage, and networking capacity of the fleetaposs hosts. Amazon GameLift supports the EC2 instance types listed below. See Amazon EC2 Instance Types for detailed descriptions of each.- See Also:
-
withEC2InstanceType
Type of EC2 instances used in the fleet. EC2 instance types define the CPU, memory, storage, and networking capacity of the fleetaposs hosts. Amazon GameLift supports the EC2 instance types listed below. See Amazon EC2 Instance Types for detailed descriptions of each.
- Parameters:
eC2InstanceType
- Type of EC2 instances used in the fleet. EC2 instance types define the CPU, memory, storage, and networking capacity of the fleetaposs hosts. Amazon GameLift supports the EC2 instance types listed below. See Amazon EC2 Instance Types for detailed descriptions of each.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
getEC2InboundPermissions
Access limits for incoming traffic. Setting these values limits game server access to incoming traffic using specified IP ranges and port numbers. Some ports in a range may be restricted. You can provide one or more sets of permissions for the fleet.
- Returns:
- Access limits for incoming traffic. Setting these values limits game server access to incoming traffic using specified IP ranges and port numbers. Some ports in a range may be restricted. You can provide one or more sets of permissions for the fleet.
-
setEC2InboundPermissions
Access limits for incoming traffic. Setting these values limits game server access to incoming traffic using specified IP ranges and port numbers. Some ports in a range may be restricted. You can provide one or more sets of permissions for the fleet.
- Parameters:
eC2InboundPermissions
- Access limits for incoming traffic. Setting these values limits game server access to incoming traffic using specified IP ranges and port numbers. Some ports in a range may be restricted. You can provide one or more sets of permissions for the fleet.
-
withEC2InboundPermissions
Access limits for incoming traffic. Setting these values limits game server access to incoming traffic using specified IP ranges and port numbers. Some ports in a range may be restricted. You can provide one or more sets of permissions for the fleet.
NOTE: This method appends the values to the existing list (if any). Use
setEC2InboundPermissions(java.util.Collection)
orwithEC2InboundPermissions(java.util.Collection)
if you want to override the existing values.- Parameters:
eC2InboundPermissions
- Access limits for incoming traffic. Setting these values limits game server access to incoming traffic using specified IP ranges and port numbers. Some ports in a range may be restricted. You can provide one or more sets of permissions for the fleet.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withEC2InboundPermissions
Access limits for incoming traffic. Setting these values limits game server access to incoming traffic using specified IP ranges and port numbers. Some ports in a range may be restricted. You can provide one or more sets of permissions for the fleet.
- Parameters:
eC2InboundPermissions
- Access limits for incoming traffic. Setting these values limits game server access to incoming traffic using specified IP ranges and port numbers. Some ports in a range may be restricted. You can provide one or more sets of permissions for the fleet.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNewGameSessionProtectionPolicy
Game session protection policy to apply to all instances created in this fleet. If this parameter is not set, new instances in this fleet will default to no protection. Protection can be set 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 created in this fleet. If this parameter is not set, new instances in this fleet will default to no protection. Protection can be set 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:
-
getNewGameSessionProtectionPolicy
Game session protection policy to apply to all instances created in this fleet. If this parameter is not set, new instances in this fleet will default to no protection. Protection can be set 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 created
in this fleet. If this parameter is not set, new instances in
this fleet will default to no protection. Protection can be set
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:
-
withNewGameSessionProtectionPolicy
Game session protection policy to apply to all instances created in this fleet. If this parameter is not set, new instances in this fleet will default to no protection. Protection can be set 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 created in this fleet. If this parameter is not set, new instances in this fleet will default to no protection. Protection can be set 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:
-
setNewGameSessionProtectionPolicy
Game session protection policy to apply to all instances created in this fleet. If this parameter is not set, new instances in this fleet will default to no protection. Protection can be set 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 created in this fleet. If this parameter is not set, new instances in this fleet will default to no protection. Protection can be set 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:
-
withNewGameSessionProtectionPolicy
public CreateFleetRequest withNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy) Game session protection policy to apply to all instances created in this fleet. If this parameter is not set, new instances in this fleet will default to no protection. Protection can be set 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 created in this fleet. If this parameter is not set, new instances in this fleet will default to no protection. Protection can be set 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:
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-