@Generated(value="software.amazon.awssdk:codegen") public final class CreateFleetRequest extends GameLiftRequest implements ToCopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>
Represents the input for a request action.
Modifier and Type | Class and Description |
---|---|
static interface |
CreateFleetRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static CreateFleetRequest.Builder |
builder() |
String |
buildId()
Unique identifier for a build to be deployed on the new fleet.
|
String |
description()
Human-readable description of a fleet.
|
List<IpPermission> |
ec2InboundPermissions()
Range of IP addresses and port settings that permit inbound traffic to access server processes running on the
fleet.
|
EC2InstanceType |
ec2InstanceType()
Name of an EC2 instance type that is supported in Amazon GameLift.
|
String |
ec2InstanceTypeAsString()
Name of an EC2 instance type that is supported in Amazon GameLift.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
List<String> |
logPaths()
This parameter is no longer used.
|
List<String> |
metricGroups()
Names of metric groups to add this fleet to.
|
String |
name()
Descriptive label that is associated with a fleet.
|
ProtectionPolicy |
newGameSessionProtectionPolicy()
Game session protection policy to apply to all instances in this fleet.
|
String |
newGameSessionProtectionPolicyAsString()
Game session protection policy to apply to all instances in this fleet.
|
String |
peerVpcAwsAccountId()
Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with.
|
String |
peerVpcId()
Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.
|
ResourceCreationLimitPolicy |
resourceCreationLimitPolicy()
Policy that limits the number of game sessions an individual player can create over a span of time for this
fleet.
|
RuntimeConfiguration |
runtimeConfiguration()
Instructions for launching server processes on each instance in the fleet.
|
static Class<? extends CreateFleetRequest.Builder> |
serializableBuilderClass() |
String |
serverLaunchParameters()
This parameter is no longer used.
|
String |
serverLaunchPath()
This parameter is no longer used.
|
CreateFleetRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public String name()
Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
public String description()
Human-readable description of a fleet.
public 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.
READY
status. This fleet setting cannot be changed
once the fleet is created.public 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.)
RuntimeConfiguration
parameter. (Requests that specify a server launch path and launch
parameters instead of a run-time configuration will continue to work.)public 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.)
RuntimeConfiguration
parameter. (Requests that specify a server launch path and launch
parameters instead of a run-time configuration will continue to work.)public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
ProcessReady()
and specify one
or more directory paths in logParameters
. See more information in the Server API Reference.public 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.
If the service returns an enum value that is not available in the current SDK version, ec2InstanceType
will return EC2InstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from ec2InstanceTypeAsString()
.
EC2InstanceType
public String ec2InstanceTypeAsString()
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.
If the service returns an enum value that is not available in the current SDK version, ec2InstanceType
will return EC2InstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from ec2InstanceTypeAsString()
.
EC2InstanceType
public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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.
If the service returns an enum value that is not available in the current SDK version,
newGameSessionProtectionPolicy
will return ProtectionPolicy.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from newGameSessionProtectionPolicyAsString()
.
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.
ProtectionPolicy
public String newGameSessionProtectionPolicyAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
newGameSessionProtectionPolicy
will return ProtectionPolicy.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from newGameSessionProtectionPolicyAsString()
.
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.
ProtectionPolicy
public 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.)
ServerLaunchPath
and ServerLaunchParameters
; requests that
contain values for these parameters instead of a run-time configuration will continue to work.)public ResourceCreationLimitPolicy resourceCreationLimitPolicy()
Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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.
public 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.
public CreateFleetRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>
toBuilder
in class GameLiftRequest
public static CreateFleetRequest.Builder builder()
public static Class<? extends CreateFleetRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.