@Generated(value="software.amazon.awssdk:codegen") public final class CreateFleetRequest extends GameLiftRequest implements ToCopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>
Represents the input for a request operation.
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateFleetRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CreateFleetRequest.Builder |
builder() |
String |
buildId()
The unique identifier for a custom game server build to be deployed on fleet instances.
|
CertificateConfiguration |
certificateConfiguration()
Prompts GameLift to generate a TLS/SSL certificate for the fleet.
|
String |
description()
A human-readable description of the fleet.
|
List<IpPermission> |
ec2InboundPermissions()
The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.
|
EC2InstanceType |
ec2InstanceType()
The GameLift-supported Amazon EC2 instance type to use for all fleet instances.
|
String |
ec2InstanceTypeAsString()
The GameLift-supported Amazon EC2 instance type to use for all fleet instances.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
FleetType |
fleetType()
Indicates whether to use On-Demand or Spot instances for this fleet.
|
String |
fleetTypeAsString()
Indicates whether to use On-Demand or Spot instances for this fleet.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasEc2InboundPermissions()
For responses, this returns true if the service returned a value for the EC2InboundPermissions property.
|
int |
hashCode() |
boolean |
hasLocations()
For responses, this returns true if the service returned a value for the Locations property.
|
boolean |
hasLogPaths()
For responses, this returns true if the service returned a value for the LogPaths property.
|
boolean |
hasMetricGroups()
For responses, this returns true if the service returned a value for the MetricGroups property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
String |
instanceRoleArn()
A unique identifier for an IAM role that manages access to your Amazon Web Services services.
|
List<LocationConfiguration> |
locations()
A set of remote locations to deploy additional instances to and manage as part of the fleet.
|
List<String> |
logPaths()
This parameter is no longer used. To specify where GameLift should store log files once a server process
shuts down, use the GameLift server API
ProcessReady() and specify one or more directory paths in
logParameters. |
List<String> |
metricGroups()
The name of an Amazon Web Services CloudWatch metric group to add this fleet to.
|
String |
name()
A descriptive label that is associated with a fleet.
|
ProtectionPolicy |
newGameSessionProtectionPolicy()
The status of termination protection for active game sessions on the fleet.
|
String |
newGameSessionProtectionPolicyAsString()
The status of termination protection for active game sessions on the fleet.
|
String |
peerVpcAwsAccountId()
Used when peering your GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that
owns the VPC.
|
String |
peerVpcId()
A unique identifier for a VPC with resources to be accessed by your GameLift fleet.
|
ResourceCreationLimitPolicy |
resourceCreationLimitPolicy()
A policy that limits the number of game sessions that an individual player can create on instances in this fleet
within a specified span of time.
|
RuntimeConfiguration |
runtimeConfiguration()
Instructions for how to launch and maintain server processes on instances in the fleet.
|
String |
scriptId()
The unique identifier for a Realtime configuration script to be deployed on fleet instances.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateFleetRequest.Builder> |
serializableBuilderClass() |
String |
serverLaunchParameters()
This parameter is no longer used. Specify server launch parameters using the
RuntimeConfiguration parameter. |
String |
serverLaunchPath()
This parameter is no longer used. Specify a server launch path using the
RuntimeConfiguration
parameter. |
List<Tag> |
tags()
A list of labels to assign to the new fleet resource.
|
CreateFleetRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String name()
A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
public final String description()
A human-readable description of the fleet.
public final String buildId()
The unique identifier for a custom game server build to be deployed on fleet instances. You can use either the
build ID or ARN. The build must be uploaded to GameLift and in READY status. This fleet property
cannot be changed later.
READY status. This
fleet property cannot be changed later.public final String scriptId()
The unique identifier for a Realtime configuration script to be deployed on fleet instances. You can use either the script ID or ARN. Scripts must be uploaded to GameLift prior to creating the fleet. This fleet property cannot be changed later.
public final String serverLaunchPath()
This parameter is no longer used. Specify a server launch path using the RuntimeConfiguration
parameter. Requests that use this parameter instead continue to be valid.
RuntimeConfiguration parameter. Requests that use this parameter instead continue to be
valid.public final String serverLaunchParameters()
This parameter is no longer used. Specify server launch parameters using the
RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.
RuntimeConfiguration parameter. Requests that use this parameter instead continue to be
valid.public final boolean hasLogPaths()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<String> logPaths()
This parameter is no longer used. To specify where GameLift should store log files once a server process
shuts down, use the 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasLogPaths() method.
ProcessReady() and specify one or more
directory paths in logParameters. See more information in the Server API Reference.public final EC2InstanceType ec2InstanceType()
The GameLift-supported Amazon EC2 instance type to use for all fleet instances. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.
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().
EC2InstanceTypepublic final String ec2InstanceTypeAsString()
The GameLift-supported Amazon EC2 instance type to use for all fleet instances. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.
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().
EC2InstanceTypepublic final boolean hasEc2InboundPermissions()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<IpPermission> ec2InboundPermissions()
The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet. If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, GameLift automatically sets TCP and UDP ranges.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasEc2InboundPermissions() method.
public final ProtectionPolicy newGameSessionProtectionPolicy()
The status of termination protection for active game sessions on the fleet. By default, this property is set to
NoProtection. You can also set game session protection for an individual game session by calling
UpdateGameSession.
NoProtection - Game sessions can be terminated during active gameplay as a result of a scale-down event.
FullProtection - Game sessions in ACTIVE status 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. You can also set game session protection for an individual game session
by calling UpdateGameSession.
NoProtection - Game sessions can be terminated during active gameplay as a result of a scale-down event.
FullProtection - Game sessions in ACTIVE status cannot be terminated during a
scale-down event.
ProtectionPolicypublic final String newGameSessionProtectionPolicyAsString()
The status of termination protection for active game sessions on the fleet. By default, this property is set to
NoProtection. You can also set game session protection for an individual game session by calling
UpdateGameSession.
NoProtection - Game sessions can be terminated during active gameplay as a result of a scale-down event.
FullProtection - Game sessions in ACTIVE status 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. You can also set game session protection for an individual game session
by calling UpdateGameSession.
NoProtection - Game sessions can be terminated during active gameplay as a result of a scale-down event.
FullProtection - Game sessions in ACTIVE status cannot be terminated during a
scale-down event.
ProtectionPolicypublic final RuntimeConfiguration runtimeConfiguration()
Instructions for how to launch and maintain server processes on instances in the fleet. The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently.
The RuntimeConfiguration parameter is required unless the fleet is being configured using the older
parameters ServerLaunchPath and ServerLaunchParameters, which are still supported for
backward compatibility.
The RuntimeConfiguration parameter is required unless the fleet is being configured using
the older parameters ServerLaunchPath and ServerLaunchParameters, which are
still supported for backward compatibility.
public final ResourceCreationLimitPolicy resourceCreationLimitPolicy()
A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.
public final boolean hasMetricGroups()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> metricGroups()
The name of an Amazon Web Services CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasMetricGroups() method.
public final String peerVpcAwsAccountId()
Used when peering your GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that owns the VPC. You can find your account ID in the Amazon Web Services Management Console under account settings.
public final String peerVpcId()
A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.
public final FleetType fleetType()
Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to
ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.
If the service returns an enum value that is not available in the current SDK version, fleetType will
return FleetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
fleetTypeAsString().
ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.FleetTypepublic final String fleetTypeAsString()
Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to
ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.
If the service returns an enum value that is not available in the current SDK version, fleetType will
return FleetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
fleetTypeAsString().
ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.FleetTypepublic final String instanceRoleArn()
A unique identifier for an IAM role that manages access to your Amazon Web Services services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the Amazon Web Services Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server. This property cannot be changed after the fleet is created.
public final CertificateConfiguration certificateConfiguration()
Prompts GameLift to generate a TLS/SSL certificate for the fleet. TLS certificates are used for encrypting
traffic between game clients and the game servers that are running on GameLift. By default, the
CertificateConfiguration is set to DISABLED. This property cannot be changed after the
fleet is created.
Note: This feature requires the Amazon Web Services Certificate Manager (ACM) service, which is not available in all Amazon Web Services regions. When working in a region that does not support this feature, a fleet creation request with certificate generation fails with a 4xx error.
CertificateConfiguration is set to DISABLED. This property cannot be
changed after the fleet is created.
Note: This feature requires the Amazon Web Services Certificate Manager (ACM) service, which is not available in all Amazon Web Services regions. When working in a region that does not support this feature, a fleet creation request with certificate generation fails with a 4xx error.
public final boolean hasLocations()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<LocationConfiguration> locations()
A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can
only be used when creating fleets in Amazon Web Services Regions that support multiple locations. You can add any
GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region
code such as us-west-2. To create a fleet with instances in the home Region only, omit this
parameter.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasLocations() method.
us-west-2. To create a fleet with
instances in the home Region only, omit this parameter.public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<Tag> tags()
A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. Once the fleet is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
public CreateFleetRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>toBuilder in class GameLiftRequestpublic static CreateFleetRequest.Builder builder()
public static Class<? extends CreateFleetRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2022. All rights reserved.