CreateFleetRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.gamelift.model.CreateFleetRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable
```
public class CreateFleetRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Represents the input for a request action.

See Also:
Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateFleetRequest()

Constructors
Constructor and Description
`CreateFleetRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`CreateFleetRequest`	`clone()` Creates a shallow clone of this request.
`boolean`	`equals(Object obj)`
`String`	`getBuildId()` Unique identifier for the build you want the new fleet to use.
`String`	`getDescription()` Human-readable description of the fleet.
`List<IpPermission>`	`getEC2InboundPermissions()` Access limits for incoming traffic.
`String`	`getEC2InstanceType()` Type of EC2 instances used in the fleet.
`List<String>`	`getLogPaths()` Path to game-session log files generated by your game server.
`String`	`getName()` Descriptive label associated with this fleet.
`String`	`getNewGameSessionProtectionPolicy()` Game session protection policy to apply to all instances created in this fleet.
`String`	`getServerLaunchParameters()` Parameters required to launch your game server.
`String`	`getServerLaunchPath()` 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`	`setName(String name)` 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.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateFleetRequest`	`withBuildId(String buildId)` Unique identifier for the build you want the new fleet to use.
`CreateFleetRequest`	`withDescription(String description)` Human-readable description of the fleet.
`CreateFleetRequest`	`withEC2InboundPermissions(Collection<IpPermission> eC2InboundPermissions)` Access limits for incoming traffic.
`CreateFleetRequest`	`withEC2InboundPermissions(IpPermission... eC2InboundPermissions)` Access limits for incoming traffic.
`CreateFleetRequest`	`withEC2InstanceType(EC2InstanceType eC2InstanceType)` Type of EC2 instances used in the fleet.
`CreateFleetRequest`	`withEC2InstanceType(String eC2InstanceType)` Type of EC2 instances used in the fleet.
`CreateFleetRequest`	`withLogPaths(Collection<String> logPaths)` Path to game-session log files generated by your game server.
`CreateFleetRequest`	`withLogPaths(String... logPaths)` Path to game-session log files generated by your game server.
`CreateFleetRequest`	`withName(String name)` Descriptive label associated with this fleet.
`CreateFleetRequest`	`withNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy)` Game session protection policy to apply to all instances created in this fleet.
`CreateFleetRequest`	`withNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)` Game session protection policy to apply to all instances created in this fleet.
`CreateFleetRequest`	`withServerLaunchParameters(String serverLaunchParameters)` Parameters required to launch your game server.
`CreateFleetRequest`	`withServerLaunchPath(String serverLaunchPath)` Path to the launch executable for the game server.

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 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
```
public String 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
```
public CreateFleetRequest withName(String name)
```
    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
```
public void setDescription(String description)
```
    Human-readable description of the fleet.
    
    Parameters:
    description - Human-readable description of the fleet.
  - getDescription
```
public String getDescription()
```
    Human-readable description of the fleet.
    
    Returns:
    Human-readable description of the fleet.
  - withDescription
```
public CreateFleetRequest withDescription(String description)
```
    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
```
public void setBuildId(String buildId)
```
    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
```
public String 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
```
public CreateFleetRequest withBuildId(String buildId)
```
    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
```
public void setServerLaunchPath(String serverLaunchPath)
```
    Path to the launch executable for the game server. A game server is built into a C:\game drive. This value must be expressed as C:\game\[launchpath]. Example: If, when built, your game server files are in a folder called "MyGame", your log path should be C:\game\MyGame\server.exe.
    
    Parameters:
    serverLaunchPath - Path to the launch executable for the game server. A game server is built into a C:\game drive. This value must be expressed as C:\game\[launchpath]. Example: If, when built, your game server files are in a folder called "MyGame", your log path should be C:\game\MyGame\server.exe.
  - getServerLaunchPath
```
public String 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 as C:\game\[launchpath]. Example: If, when built, your game server files are in a folder called "MyGame", your log path should be C:\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 as C:\game\[launchpath]. Example: If, when built, your game server files are in a folder called "MyGame", your log path should be C:\game\MyGame\server.exe.
  - withServerLaunchPath
```
public CreateFleetRequest withServerLaunchPath(String serverLaunchPath)
```
    Path to the launch executable for the game server. A game server is built into a C:\game drive. This value must be expressed as C:\game\[launchpath]. Example: If, when built, your game server files are in a folder called "MyGame", your log path should be C:\game\MyGame\server.exe.
    
    Parameters:
    serverLaunchPath - Path to the launch executable for the game server. A game server is built into a C:\game drive. This value must be expressed as C:\game\[launchpath]. Example: If, when built, your game server files are in a folder called "MyGame", your log path should be C:\game\MyGame\server.exe.
    
    Returns:
    Returns a reference to this object so that method calls can be chained together.
  - setServerLaunchParameters
```
public void setServerLaunchParameters(String 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".
    
    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
```
public String 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
```
public CreateFleetRequest withServerLaunchParameters(String 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".
    
    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
```
public List<String> 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
```
public void setLogPaths(Collection<String> 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.
    
    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
```
public CreateFleetRequest withLogPaths(String... 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.
    
    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 - 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
```
public CreateFleetRequest withLogPaths(Collection<String> 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.
    
    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
```
public void setEC2InstanceType(String 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.
    
    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:
    EC2InstanceType
  - getEC2InstanceType
```
public String 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:
    EC2InstanceType
  - withEC2InstanceType
```
public CreateFleetRequest withEC2InstanceType(String 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.
    
    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:
    EC2InstanceType
  - setEC2InstanceType
```
public void setEC2InstanceType(EC2InstanceType 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.
    
    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:
    EC2InstanceType
  - withEC2InstanceType
```
public CreateFleetRequest withEC2InstanceType(EC2InstanceType 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.
    
    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:
    EC2InstanceType
  - getEC2InboundPermissions
```
public List<IpPermission> 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
```
public void setEC2InboundPermissions(Collection<IpPermission> 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.
    
    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
```
public CreateFleetRequest withEC2InboundPermissions(IpPermission... 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.
    
    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 - 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
```
public CreateFleetRequest withEC2InboundPermissions(Collection<IpPermission> 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.
    
    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
```
public void setNewGameSessionProtectionPolicy(String 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.
    See Also:
    ProtectionPolicy
  - getNewGameSessionProtectionPolicy
```
public String 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:
    ProtectionPolicy
  - withNewGameSessionProtectionPolicy
```
public CreateFleetRequest withNewGameSessionProtectionPolicy(String 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:
    ProtectionPolicy
  - setNewGameSessionProtectionPolicy
```
public void setNewGameSessionProtectionPolicy(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.
    See Also:
    ProtectionPolicy
  - 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:
    ProtectionPolicy
  - 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 request. Explicitly does not clone the deep structure of the request object.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    Object.clone()

Did this page help you?

Class CreateFleetRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateFleetRequest

Method Detail

setName

getName

withName

setDescription

getDescription

withDescription

setBuildId

getBuildId

withBuildId

setServerLaunchPath

getServerLaunchPath

withServerLaunchPath

setServerLaunchParameters

getServerLaunchParameters

withServerLaunchParameters

getLogPaths

setLogPaths

withLogPaths

withLogPaths

setEC2InstanceType

getEC2InstanceType

withEC2InstanceType

setEC2InstanceType

withEC2InstanceType

getEC2InboundPermissions

setEC2InboundPermissions

withEC2InboundPermissions

withEC2InboundPermissions

setNewGameSessionProtectionPolicy

getNewGameSessionProtectionPolicy

withNewGameSessionProtectionPolicy

setNewGameSessionProtectionPolicy

withNewGameSessionProtectionPolicy

toString

equals

hashCode

clone