@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateFleetRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input for a request operation.
NOOP
Constructor and Description |
---|
CreateFleetRequest() |
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()
The unique identifier for a custom game server build to be deployed on fleet instances.
|
CertificateConfiguration |
getCertificateConfiguration()
Prompts GameLift to generate a TLS/SSL certificate for the fleet.
|
String |
getDescription()
A human-readable description of the fleet.
|
List<IpPermission> |
getEC2InboundPermissions()
The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.
|
String |
getEC2InstanceType()
The GameLift-supported Amazon EC2 instance type to use for all fleet instances.
|
String |
getFleetType()
Indicates whether to use On-Demand or Spot instances for this fleet.
|
String |
getInstanceRoleArn()
A unique identifier for an IAM role that manages access to your Amazon Web Services services.
|
List<LocationConfiguration> |
getLocations()
A set of remote locations to deploy additional instances to and manage as part of the fleet.
|
List<String> |
getLogPaths()
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> |
getMetricGroups()
The name of an Amazon Web Services CloudWatch metric group to add this fleet to.
|
String |
getName()
A descriptive label that is associated with a fleet.
|
String |
getNewGameSessionProtectionPolicy()
The status of termination protection for active game sessions on the fleet.
|
String |
getPeerVpcAwsAccountId()
Used when peering your GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that
owns the VPC.
|
String |
getPeerVpcId()
A unique identifier for a VPC with resources to be accessed by your GameLift fleet.
|
ResourceCreationLimitPolicy |
getResourceCreationLimitPolicy()
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 |
getRuntimeConfiguration()
Instructions for how to launch and maintain server processes on instances in the fleet.
|
String |
getScriptId()
The unique identifier for a Realtime configuration script to be deployed on fleet instances.
|
String |
getServerLaunchParameters()
This parameter is no longer used. Specify server launch parameters using the
RuntimeConfiguration parameter. |
String |
getServerLaunchPath()
This parameter is no longer used. Specify a server launch path using the
RuntimeConfiguration
parameter. |
List<Tag> |
getTags()
A list of labels to assign to the new fleet resource.
|
int |
hashCode() |
void |
setBuildId(String buildId)
The unique identifier for a custom game server build to be deployed on fleet instances.
|
void |
setCertificateConfiguration(CertificateConfiguration certificateConfiguration)
Prompts GameLift to generate a TLS/SSL certificate for the fleet.
|
void |
setDescription(String description)
A human-readable description of the fleet.
|
void |
setEC2InboundPermissions(Collection<IpPermission> eC2InboundPermissions)
The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.
|
void |
setEC2InstanceType(EC2InstanceType eC2InstanceType)
The GameLift-supported Amazon EC2 instance type to use for all fleet instances.
|
void |
setEC2InstanceType(String eC2InstanceType)
The GameLift-supported Amazon EC2 instance type to use for all fleet instances.
|
void |
setFleetType(FleetType fleetType)
Indicates whether to use On-Demand or Spot instances for this fleet.
|
void |
setFleetType(String fleetType)
Indicates whether to use On-Demand or Spot instances for this fleet.
|
void |
setInstanceRoleArn(String instanceRoleArn)
A unique identifier for an IAM role that manages access to your Amazon Web Services services.
|
void |
setLocations(Collection<LocationConfiguration> locations)
A set of remote locations to deploy additional instances to and manage as part of the fleet.
|
void |
setLogPaths(Collection<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 . |
void |
setMetricGroups(Collection<String> metricGroups)
The name of an Amazon Web Services CloudWatch metric group to add this fleet to.
|
void |
setName(String name)
A descriptive label that is associated with a fleet.
|
void |
setNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy)
The status of termination protection for active game sessions on the fleet.
|
void |
setNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)
The status of termination protection for active game sessions on the fleet.
|
void |
setPeerVpcAwsAccountId(String peerVpcAwsAccountId)
Used when peering your GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that
owns the VPC.
|
void |
setPeerVpcId(String peerVpcId)
A unique identifier for a VPC with resources to be accessed by your GameLift fleet.
|
void |
setResourceCreationLimitPolicy(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.
|
void |
setRuntimeConfiguration(RuntimeConfiguration runtimeConfiguration)
Instructions for how to launch and maintain server processes on instances in the fleet.
|
void |
setScriptId(String scriptId)
The unique identifier for a Realtime configuration script to be deployed on fleet instances.
|
void |
setServerLaunchParameters(String serverLaunchParameters)
This parameter is no longer used. Specify server launch parameters using the
RuntimeConfiguration parameter. |
void |
setServerLaunchPath(String serverLaunchPath)
This parameter is no longer used. Specify a server launch path using the
RuntimeConfiguration
parameter. |
void |
setTags(Collection<Tag> tags)
A list of labels to assign to the new fleet resource.
|
String |
toString()
Returns a string representation of this object.
|
CreateFleetRequest |
withBuildId(String buildId)
The unique identifier for a custom game server build to be deployed on fleet instances.
|
CreateFleetRequest |
withCertificateConfiguration(CertificateConfiguration certificateConfiguration)
Prompts GameLift to generate a TLS/SSL certificate for the fleet.
|
CreateFleetRequest |
withDescription(String description)
A human-readable description of the fleet.
|
CreateFleetRequest |
withEC2InboundPermissions(Collection<IpPermission> eC2InboundPermissions)
The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.
|
CreateFleetRequest |
withEC2InboundPermissions(IpPermission... eC2InboundPermissions)
The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.
|
CreateFleetRequest |
withEC2InstanceType(EC2InstanceType eC2InstanceType)
The GameLift-supported Amazon EC2 instance type to use for all fleet instances.
|
CreateFleetRequest |
withEC2InstanceType(String eC2InstanceType)
The GameLift-supported Amazon EC2 instance type to use for all fleet instances.
|
CreateFleetRequest |
withFleetType(FleetType fleetType)
Indicates whether to use On-Demand or Spot instances for this fleet.
|
CreateFleetRequest |
withFleetType(String fleetType)
Indicates whether to use On-Demand or Spot instances for this fleet.
|
CreateFleetRequest |
withInstanceRoleArn(String instanceRoleArn)
A unique identifier for an IAM role that manages access to your Amazon Web Services services.
|
CreateFleetRequest |
withLocations(Collection<LocationConfiguration> locations)
A set of remote locations to deploy additional instances to and manage as part of the fleet.
|
CreateFleetRequest |
withLocations(LocationConfiguration... locations)
A set of remote locations to deploy additional instances to and manage as part of the fleet.
|
CreateFleetRequest |
withLogPaths(Collection<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 . |
CreateFleetRequest |
withLogPaths(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 . |
CreateFleetRequest |
withMetricGroups(Collection<String> metricGroups)
The name of an Amazon Web Services CloudWatch metric group to add this fleet to.
|
CreateFleetRequest |
withMetricGroups(String... metricGroups)
The name of an Amazon Web Services CloudWatch metric group to add this fleet to.
|
CreateFleetRequest |
withName(String name)
A descriptive label that is associated with a fleet.
|
CreateFleetRequest |
withNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy)
The status of termination protection for active game sessions on the fleet.
|
CreateFleetRequest |
withNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)
The status of termination protection for active game sessions on the fleet.
|
CreateFleetRequest |
withPeerVpcAwsAccountId(String peerVpcAwsAccountId)
Used when peering your GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that
owns the VPC.
|
CreateFleetRequest |
withPeerVpcId(String peerVpcId)
A unique identifier for a VPC with resources to be accessed by your GameLift fleet.
|
CreateFleetRequest |
withResourceCreationLimitPolicy(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.
|
CreateFleetRequest |
withRuntimeConfiguration(RuntimeConfiguration runtimeConfiguration)
Instructions for how to launch and maintain server processes on instances in the fleet.
|
CreateFleetRequest |
withScriptId(String scriptId)
The unique identifier for a Realtime configuration script to be deployed on fleet instances.
|
CreateFleetRequest |
withServerLaunchParameters(String serverLaunchParameters)
This parameter is no longer used. Specify server launch parameters using the
RuntimeConfiguration parameter. |
CreateFleetRequest |
withServerLaunchPath(String serverLaunchPath)
This parameter is no longer used. Specify a server launch path using the
RuntimeConfiguration
parameter. |
CreateFleetRequest |
withTags(Collection<Tag> tags)
A list of labels to assign to the new fleet resource.
|
CreateFleetRequest |
withTags(Tag... tags)
A list of labels to assign to the new fleet resource.
|
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
public void setName(String name)
A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
name
- A descriptive label that is associated with a fleet. Fleet names do not need to be unique.public String getName()
A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
public CreateFleetRequest withName(String name)
A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
name
- A descriptive label that is associated with a fleet. Fleet names do not need to be unique.public void setDescription(String description)
A human-readable description of the fleet.
description
- A human-readable description of the fleet.public String getDescription()
A human-readable description of the fleet.
public CreateFleetRequest withDescription(String description)
A human-readable description of the fleet.
description
- A human-readable description of the fleet.public void setBuildId(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.
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.public String getBuildId()
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 CreateFleetRequest withBuildId(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.
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.public void setScriptId(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.
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 String getScriptId()
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 CreateFleetRequest withScriptId(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.
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 void setServerLaunchPath(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.
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.public String getServerLaunchPath()
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 CreateFleetRequest withServerLaunchPath(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.
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.public void setServerLaunchParameters(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.
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.public String getServerLaunchParameters()
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 CreateFleetRequest withServerLaunchParameters(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.
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.public List<String> getLogPaths()
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.
ProcessReady()
and specify one or more
directory paths in logParameters
. See more information in the Server API Reference.public void setLogPaths(Collection<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.
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.public CreateFleetRequest withLogPaths(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.
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.
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.public CreateFleetRequest withLogPaths(Collection<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.
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.public void setEC2InstanceType(String 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.
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.EC2InstanceType
public String getEC2InstanceType()
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.
EC2InstanceType
public CreateFleetRequest withEC2InstanceType(String 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.
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.EC2InstanceType
public void setEC2InstanceType(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.
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.EC2InstanceType
public CreateFleetRequest withEC2InstanceType(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.
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.EC2InstanceType
public List<IpPermission> getEC2InboundPermissions()
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.
public void setEC2InboundPermissions(Collection<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.
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.public CreateFleetRequest withEC2InboundPermissions(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.
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.
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.public CreateFleetRequest withEC2InboundPermissions(Collection<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.
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.public void setNewGameSessionProtectionPolicy(String 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.
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.
ProtectionPolicy
public String getNewGameSessionProtectionPolicy()
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.
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.
ProtectionPolicy
public CreateFleetRequest withNewGameSessionProtectionPolicy(String 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.
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.
ProtectionPolicy
public void setNewGameSessionProtectionPolicy(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.
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.
ProtectionPolicy
public CreateFleetRequest withNewGameSessionProtectionPolicy(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.
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.
ProtectionPolicy
public void setRuntimeConfiguration(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.
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.
public RuntimeConfiguration getRuntimeConfiguration()
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 CreateFleetRequest withRuntimeConfiguration(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.
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.
public void setResourceCreationLimitPolicy(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.
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 ResourceCreationLimitPolicy getResourceCreationLimitPolicy()
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 CreateFleetRequest withResourceCreationLimitPolicy(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.
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 List<String> getMetricGroups()
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.
public void setMetricGroups(Collection<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.
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.public CreateFleetRequest withMetricGroups(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.
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.
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.public CreateFleetRequest withMetricGroups(Collection<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.
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.public void setPeerVpcAwsAccountId(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.
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 String getPeerVpcAwsAccountId()
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 CreateFleetRequest withPeerVpcAwsAccountId(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.
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 void setPeerVpcId(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.
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 String getPeerVpcId()
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 CreateFleetRequest withPeerVpcId(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.
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 void setFleetType(String 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.
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.FleetType
public String getFleetType()
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.
ON_DEMAND
. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.FleetType
public CreateFleetRequest withFleetType(String 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.
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.FleetType
public void setFleetType(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.
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.FleetType
public CreateFleetRequest withFleetType(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.
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.FleetType
public void setInstanceRoleArn(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.
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 String getInstanceRoleArn()
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 CreateFleetRequest withInstanceRoleArn(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.
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 void setCertificateConfiguration(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
- 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.
public CertificateConfiguration getCertificateConfiguration()
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 CreateFleetRequest withCertificateConfiguration(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
- 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.
public List<LocationConfiguration> getLocations()
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.
us-west-2
. To create a fleet with
instances in the home Region only, omit this parameter.public void setLocations(Collection<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.
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.public CreateFleetRequest withLocations(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.
NOTE: This method appends the values to the existing list (if any). Use
setLocations(java.util.Collection)
or withLocations(java.util.Collection)
if you want to
override the existing values.
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.public CreateFleetRequest withLocations(Collection<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.
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.public List<Tag> getTags()
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.
public void setTags(Collection<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.
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.public CreateFleetRequest withTags(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.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
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.public CreateFleetRequest withTags(Collection<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.
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.public String toString()
toString
in class Object
Object.toString()
public CreateFleetRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()