@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateFleetRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input for a request action.
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()
A unique identifier for a build to be deployed on the new fleet.
|
CertificateConfiguration |
getCertificateConfiguration()
Indicates whether to generate a TLS/SSL certificate for the new fleet.
|
String |
getDescription()
A human-readable description of a fleet.
|
List<IpPermission> |
getEC2InboundPermissions()
Range of IP addresses and port settings that permit inbound traffic to access game sessions that are running on
the fleet.
|
String |
getEC2InstanceType()
The name of an EC2 instance type that is supported in Amazon GameLift.
|
String |
getFleetType()
Indicates whether to use On-Demand instances or Spot instances for this fleet.
|
String |
getInstanceRoleArn()
A unique identifier for an AWS IAM role that manages access to your AWS services.
|
List<String> |
getLogPaths()
This parameter is no longer used.
|
List<String> |
getMetricGroups()
The name of an Amazon CloudWatch metric group to add this fleet to.
|
String |
getName()
A descriptive label that is associated with a fleet.
|
String |
getNewGameSessionProtectionPolicy()
A game session protection policy to apply to all instances in this fleet.
|
String |
getPeerVpcAwsAccountId()
A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with.
|
String |
getPeerVpcId()
A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.
|
ResourceCreationLimitPolicy |
getResourceCreationLimitPolicy()
A policy that limits the number of game sessions an individual player can create over a span of time for this
fleet.
|
RuntimeConfiguration |
getRuntimeConfiguration()
Instructions for launching server processes on each instance in the fleet.
|
String |
getScriptId()
A unique identifier for a Realtime script to be deployed on the new fleet.
|
String |
getServerLaunchParameters()
This parameter is no longer used.
|
String |
getServerLaunchPath()
This parameter is no longer used.
|
List<Tag> |
getTags()
A list of labels to assign to the new fleet resource.
|
int |
hashCode() |
void |
setBuildId(String buildId)
A unique identifier for a build to be deployed on the new fleet.
|
void |
setCertificateConfiguration(CertificateConfiguration certificateConfiguration)
Indicates whether to generate a TLS/SSL certificate for the new fleet.
|
void |
setDescription(String description)
A human-readable description of a fleet.
|
void |
setEC2InboundPermissions(Collection<IpPermission> eC2InboundPermissions)
Range of IP addresses and port settings that permit inbound traffic to access game sessions that are running on
the fleet.
|
void |
setEC2InstanceType(EC2InstanceType eC2InstanceType)
The name of an EC2 instance type that is supported in Amazon GameLift.
|
void |
setEC2InstanceType(String eC2InstanceType)
The name of an EC2 instance type that is supported in Amazon GameLift.
|
void |
setFleetType(FleetType fleetType)
Indicates whether to use On-Demand instances or Spot instances for this fleet.
|
void |
setFleetType(String fleetType)
Indicates whether to use On-Demand instances or Spot instances for this fleet.
|
void |
setInstanceRoleArn(String instanceRoleArn)
A unique identifier for an AWS IAM role that manages access to your AWS services.
|
void |
setLogPaths(Collection<String> logPaths)
This parameter is no longer used.
|
void |
setMetricGroups(Collection<String> metricGroups)
The name of an Amazon 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)
A game session protection policy to apply to all instances in this fleet.
|
void |
setNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)
A game session protection policy to apply to all instances in this fleet.
|
void |
setPeerVpcAwsAccountId(String peerVpcAwsAccountId)
A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with.
|
void |
setPeerVpcId(String peerVpcId)
A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.
|
void |
setResourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy)
A policy that limits the number of game sessions an individual player can create over a span of time for this
fleet.
|
void |
setRuntimeConfiguration(RuntimeConfiguration runtimeConfiguration)
Instructions for launching server processes on each instance in the fleet.
|
void |
setScriptId(String scriptId)
A unique identifier for a Realtime script to be deployed on the new fleet.
|
void |
setServerLaunchParameters(String serverLaunchParameters)
This parameter is no longer used.
|
void |
setServerLaunchPath(String serverLaunchPath)
This parameter is no longer used.
|
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)
A unique identifier for a build to be deployed on the new fleet.
|
CreateFleetRequest |
withCertificateConfiguration(CertificateConfiguration certificateConfiguration)
Indicates whether to generate a TLS/SSL certificate for the new fleet.
|
CreateFleetRequest |
withDescription(String description)
A human-readable description of a fleet.
|
CreateFleetRequest |
withEC2InboundPermissions(Collection<IpPermission> eC2InboundPermissions)
Range of IP addresses and port settings that permit inbound traffic to access game sessions that are running on
the fleet.
|
CreateFleetRequest |
withEC2InboundPermissions(IpPermission... eC2InboundPermissions)
Range of IP addresses and port settings that permit inbound traffic to access game sessions that are running on
the fleet.
|
CreateFleetRequest |
withEC2InstanceType(EC2InstanceType eC2InstanceType)
The name of an EC2 instance type that is supported in Amazon GameLift.
|
CreateFleetRequest |
withEC2InstanceType(String eC2InstanceType)
The name of an EC2 instance type that is supported in Amazon GameLift.
|
CreateFleetRequest |
withFleetType(FleetType fleetType)
Indicates whether to use On-Demand instances or Spot instances for this fleet.
|
CreateFleetRequest |
withFleetType(String fleetType)
Indicates whether to use On-Demand instances or Spot instances for this fleet.
|
CreateFleetRequest |
withInstanceRoleArn(String instanceRoleArn)
A unique identifier for an AWS IAM role that manages access to your AWS services.
|
CreateFleetRequest |
withLogPaths(Collection<String> logPaths)
This parameter is no longer used.
|
CreateFleetRequest |
withLogPaths(String... logPaths)
This parameter is no longer used.
|
CreateFleetRequest |
withMetricGroups(Collection<String> metricGroups)
The name of an Amazon CloudWatch metric group to add this fleet to.
|
CreateFleetRequest |
withMetricGroups(String... metricGroups)
The name of an Amazon 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)
A game session protection policy to apply to all instances in this fleet.
|
CreateFleetRequest |
withNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)
A game session protection policy to apply to all instances in this fleet.
|
CreateFleetRequest |
withPeerVpcAwsAccountId(String peerVpcAwsAccountId)
A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with.
|
CreateFleetRequest |
withPeerVpcId(String peerVpcId)
A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.
|
CreateFleetRequest |
withResourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy)
A policy that limits the number of game sessions an individual player can create over a span of time for this
fleet.
|
CreateFleetRequest |
withRuntimeConfiguration(RuntimeConfiguration runtimeConfiguration)
Instructions for launching server processes on each instance in the fleet.
|
CreateFleetRequest |
withScriptId(String scriptId)
A unique identifier for a Realtime script to be deployed on the new fleet.
|
CreateFleetRequest |
withServerLaunchParameters(String serverLaunchParameters)
This parameter is no longer used.
|
CreateFleetRequest |
withServerLaunchPath(String serverLaunchPath)
This parameter is no longer used.
|
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 a fleet.
description
- A human-readable description of a fleet.public String getDescription()
A human-readable description of a fleet.
public CreateFleetRequest withDescription(String description)
A human-readable description of a fleet.
description
- A human-readable description of a fleet.public void setBuildId(String buildId)
A unique identifier for a build to be deployed on the new fleet. You can use either the build ID or ARN value.
The custom game server 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.
buildId
- A unique identifier for a build to be deployed on the new fleet. You can use either the build ID or ARN
value. The custom game server 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.public String getBuildId()
A unique identifier for a build to be deployed on the new fleet. You can use either the build ID or ARN value.
The custom game server 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 CreateFleetRequest withBuildId(String buildId)
A unique identifier for a build to be deployed on the new fleet. You can use either the build ID or ARN value.
The custom game server 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.
buildId
- A unique identifier for a build to be deployed on the new fleet. You can use either the build ID or ARN
value. The custom game server 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.public void setScriptId(String scriptId)
A unique identifier for a Realtime script to be deployed on the new fleet. You can use either the script ID or ARN value. The Realtime script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.
scriptId
- A unique identifier for a Realtime script to be deployed on the new fleet. You can use either the script
ID or ARN value. The Realtime script must have been successfully uploaded to Amazon GameLift. This fleet
setting cannot be changed once the fleet is created.public String getScriptId()
A unique identifier for a Realtime script to be deployed on the new fleet. You can use either the script ID or ARN value. The Realtime script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.
public CreateFleetRequest withScriptId(String scriptId)
A unique identifier for a Realtime script to be deployed on the new fleet. You can use either the script ID or ARN value. The Realtime script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.
scriptId
- A unique identifier for a Realtime script to be deployed on the new fleet. You can use either the script
ID or ARN value. The Realtime script must have been successfully uploaded to Amazon GameLift. This fleet
setting cannot be changed once the fleet is created.public void setServerLaunchPath(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 runtime configuration will continue to work.
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 runtime configuration will continue to work.public String getServerLaunchPath()
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 runtime configuration will continue to work.
RuntimeConfiguration
parameter. Requests that specify a server launch path and launch
parameters instead of a runtime configuration will continue to work.public CreateFleetRequest withServerLaunchPath(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 runtime configuration will continue to work.
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 runtime configuration will continue to work.public void setServerLaunchParameters(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 runtime configuration will continue to work.)
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 runtime configuration will continue to work.)public String getServerLaunchParameters()
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 runtime configuration will continue to work.)
RuntimeConfiguration
parameter. (Requests that specify a server launch path and launch
parameters instead of a runtime configuration will continue to work.)public CreateFleetRequest withServerLaunchParameters(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 runtime configuration will continue to work.)
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 runtime configuration will continue to work.)public List<String> getLogPaths()
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.
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. 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.
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.public CreateFleetRequest withLogPaths(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.
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. 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.public CreateFleetRequest withLogPaths(Collection<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.
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.public void setEC2InstanceType(String eC2InstanceType)
The 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.
eC2InstanceType
- The 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.EC2InstanceType
public String getEC2InstanceType()
The 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.
EC2InstanceType
public CreateFleetRequest withEC2InstanceType(String eC2InstanceType)
The 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.
eC2InstanceType
- The 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.EC2InstanceType
public void setEC2InstanceType(EC2InstanceType eC2InstanceType)
The 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.
eC2InstanceType
- The 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.EC2InstanceType
public CreateFleetRequest withEC2InstanceType(EC2InstanceType eC2InstanceType)
The 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.
eC2InstanceType
- The 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.EC2InstanceType
public List<IpPermission> getEC2InboundPermissions()
Range of IP addresses and port settings that permit inbound traffic to access game sessions that are running on the fleet. For fleets using a custom game build, this parameter is required before game sessions running on the fleet can accept connections. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges for use by the Realtime servers. You can specify multiple permission settings or add more by updating the fleet.
public void setEC2InboundPermissions(Collection<IpPermission> eC2InboundPermissions)
Range of IP addresses and port settings that permit inbound traffic to access game sessions that are running on the fleet. For fleets using a custom game build, this parameter is required before game sessions running on the fleet can accept connections. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges for use by the Realtime servers. You can specify multiple permission settings or add more by updating the fleet.
eC2InboundPermissions
- Range of IP addresses and port settings that permit inbound traffic to access game sessions that are
running on the fleet. For fleets using a custom game build, this parameter is required before game
sessions running on the fleet can accept connections. For Realtime Servers fleets, Amazon GameLift
automatically sets TCP and UDP ranges for use by the Realtime servers. You can specify multiple permission
settings or add more by updating the fleet.public CreateFleetRequest withEC2InboundPermissions(IpPermission... eC2InboundPermissions)
Range of IP addresses and port settings that permit inbound traffic to access game sessions that are running on the fleet. For fleets using a custom game build, this parameter is required before game sessions running on the fleet can accept connections. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges for use by the Realtime servers. You can specify multiple permission settings or add more by updating 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.
eC2InboundPermissions
- Range of IP addresses and port settings that permit inbound traffic to access game sessions that are
running on the fleet. For fleets using a custom game build, this parameter is required before game
sessions running on the fleet can accept connections. For Realtime Servers fleets, Amazon GameLift
automatically sets TCP and UDP ranges for use by the Realtime servers. You can specify multiple permission
settings or add more by updating the fleet.public CreateFleetRequest withEC2InboundPermissions(Collection<IpPermission> eC2InboundPermissions)
Range of IP addresses and port settings that permit inbound traffic to access game sessions that are running on the fleet. For fleets using a custom game build, this parameter is required before game sessions running on the fleet can accept connections. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges for use by the Realtime servers. You can specify multiple permission settings or add more by updating the fleet.
eC2InboundPermissions
- Range of IP addresses and port settings that permit inbound traffic to access game sessions that are
running on the fleet. For fleets using a custom game build, this parameter is required before game
sessions running on the fleet can accept connections. For Realtime Servers fleets, Amazon GameLift
automatically sets TCP and UDP ranges for use by the Realtime servers. You can specify multiple permission
settings or add more by updating the fleet.public void setNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)
A 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.
newGameSessionProtectionPolicy
- A 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.
ProtectionPolicy
public String getNewGameSessionProtectionPolicy()
A 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.
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 CreateFleetRequest withNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)
A 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.
newGameSessionProtectionPolicy
- A 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.
ProtectionPolicy
public void setNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy)
A 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.
newGameSessionProtectionPolicy
- A 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.
ProtectionPolicy
public CreateFleetRequest withNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy)
A 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.
newGameSessionProtectionPolicy
- A 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.
ProtectionPolicy
public void setRuntimeConfiguration(RuntimeConfiguration runtimeConfiguration)
Instructions for launching server processes on each instance in the fleet. Server processes run either a custom
game build executable or a Realtime script. The runtime configuration defines the server executables or launch
script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a
fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails
with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath
and
ServerLaunchParameters
, although requests that contain values for these parameters instead of a
runtime configuration will continue to work.) This parameter is required unless the parameters
ServerLaunchPath
and ServerLaunchParameters
are defined. Runtime configuration replaced
these parameters, but fleets that use them will continue to work.
runtimeConfiguration
- Instructions for launching server processes on each instance in the fleet. Server processes run either a
custom game build executable or a Realtime script. The runtime configuration defines the server
executables or launch script file, launch parameters, and the number of processes to run concurrently on
each instance. When creating a fleet, the runtime configuration must have at least one server process
configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the
parameters ServerLaunchPath
and ServerLaunchParameters
, although requests that
contain values for these parameters instead of a runtime configuration will continue to work.) This
parameter is required unless the parameters ServerLaunchPath
and
ServerLaunchParameters
are defined. Runtime configuration replaced these parameters, but
fleets that use them will continue to work.public RuntimeConfiguration getRuntimeConfiguration()
Instructions for launching server processes on each instance in the fleet. Server processes run either a custom
game build executable or a Realtime script. The runtime configuration defines the server executables or launch
script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a
fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails
with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath
and
ServerLaunchParameters
, although requests that contain values for these parameters instead of a
runtime configuration will continue to work.) This parameter is required unless the parameters
ServerLaunchPath
and ServerLaunchParameters
are defined. Runtime configuration replaced
these parameters, but fleets that use them will continue to work.
ServerLaunchPath
and ServerLaunchParameters
, although requests
that contain values for these parameters instead of a runtime configuration will continue to work.) This
parameter is required unless the parameters ServerLaunchPath
and
ServerLaunchParameters
are defined. Runtime configuration replaced these parameters, but
fleets that use them will continue to work.public CreateFleetRequest withRuntimeConfiguration(RuntimeConfiguration runtimeConfiguration)
Instructions for launching server processes on each instance in the fleet. Server processes run either a custom
game build executable or a Realtime script. The runtime configuration defines the server executables or launch
script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a
fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails
with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath
and
ServerLaunchParameters
, although requests that contain values for these parameters instead of a
runtime configuration will continue to work.) This parameter is required unless the parameters
ServerLaunchPath
and ServerLaunchParameters
are defined. Runtime configuration replaced
these parameters, but fleets that use them will continue to work.
runtimeConfiguration
- Instructions for launching server processes on each instance in the fleet. Server processes run either a
custom game build executable or a Realtime script. The runtime configuration defines the server
executables or launch script file, launch parameters, and the number of processes to run concurrently on
each instance. When creating a fleet, the runtime configuration must have at least one server process
configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the
parameters ServerLaunchPath
and ServerLaunchParameters
, although requests that
contain values for these parameters instead of a runtime configuration will continue to work.) This
parameter is required unless the parameters ServerLaunchPath
and
ServerLaunchParameters
are defined. Runtime configuration replaced these parameters, but
fleets that use them will continue to work.public void setResourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy)
A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
resourceCreationLimitPolicy
- A policy that limits the number of game sessions an individual player can create over a span of time for
this fleet.public ResourceCreationLimitPolicy getResourceCreationLimitPolicy()
A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
public CreateFleetRequest withResourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy)
A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
resourceCreationLimitPolicy
- A policy that limits the number of game sessions an individual player can create over a span of time for
this fleet.public List<String> getMetricGroups()
The name of an Amazon CloudWatch metric group to add this fleet to. A metric group aggregates the metrics for all fleets in the group. Specify an existing metric group name, or provide a new name to create a new metric group. A fleet can only be included in one metric group at a time.
public void setMetricGroups(Collection<String> metricGroups)
The name of an Amazon CloudWatch metric group to add this fleet to. A metric group aggregates the metrics for all fleets in the group. Specify an existing metric group name, or provide a new name to create a new metric group. A fleet can only be included in one metric group at a time.
metricGroups
- The name of an Amazon CloudWatch metric group to add this fleet to. A metric group aggregates the metrics
for all fleets in the group. Specify an existing metric group name, or provide a new name to create a new
metric group. A fleet can only be included in one metric group at a time.public CreateFleetRequest withMetricGroups(String... metricGroups)
The name of an Amazon CloudWatch metric group to add this fleet to. A metric group aggregates the metrics for all fleets in the group. Specify an existing metric group name, or provide a new name to create a new metric group. A fleet can only be included in 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 CloudWatch metric group to add this fleet to. A metric group aggregates the metrics
for all fleets in the group. Specify an existing metric group name, or provide a new name to create a new
metric group. A fleet can only be included in one metric group at a time.public CreateFleetRequest withMetricGroups(Collection<String> metricGroups)
The name of an Amazon CloudWatch metric group to add this fleet to. A metric group aggregates the metrics for all fleets in the group. Specify an existing metric group name, or provide a new name to create a new metric group. A fleet can only be included in one metric group at a time.
metricGroups
- The name of an Amazon CloudWatch metric group to add this fleet to. A metric group aggregates the metrics
for all fleets in the group. Specify an existing metric group name, or provide a new name to create a new
metric group. A fleet can only be included in one metric group at a time.public void setPeerVpcAwsAccountId(String peerVpcAwsAccountId)
A 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.
peerVpcAwsAccountId
- A 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 getPeerVpcAwsAccountId()
A 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 CreateFleetRequest withPeerVpcAwsAccountId(String peerVpcAwsAccountId)
A 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.
peerVpcAwsAccountId
- A 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 void setPeerVpcId(String peerVpcId)
A unique identifier for a VPC with resources to be accessed by your Amazon 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 AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.
peerVpcId
- A unique identifier for a VPC with resources to be accessed by your Amazon 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 AWS Management Console. Learn more
about VPC peering in VPC Peering with Amazon
GameLift Fleets.public String getPeerVpcId()
A unique identifier for a VPC with resources to be accessed by your Amazon 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 AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.
public CreateFleetRequest withPeerVpcId(String peerVpcId)
A unique identifier for a VPC with resources to be accessed by your Amazon 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 AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.
peerVpcId
- A unique identifier for a VPC with resources to be accessed by your Amazon 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 AWS Management Console. Learn more
about VPC peering in VPC Peering with Amazon
GameLift Fleets.public void setFleetType(String fleetType)
Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is
ON_DEMAND
. Both categories of instances use identical hardware and configurations based on the
instance type selected for this fleet. Learn more about On-Demand versus Spot Instances.
fleetType
- Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is
ON_DEMAND
. Both categories of instances use identical hardware and configurations based on
the instance type selected for this fleet. Learn more about On-Demand versus Spot Instances.FleetType
public String getFleetType()
Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is
ON_DEMAND
. Both categories of instances use identical hardware and configurations based on the
instance type selected for this fleet. Learn more about On-Demand versus Spot Instances.
ON_DEMAND
. Both categories of instances use identical hardware and configurations based on
the instance type selected for this fleet. Learn more about On-Demand versus Spot Instances.FleetType
public CreateFleetRequest withFleetType(String fleetType)
Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is
ON_DEMAND
. Both categories of instances use identical hardware and configurations based on the
instance type selected for this fleet. Learn more about On-Demand versus Spot Instances.
fleetType
- Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is
ON_DEMAND
. Both categories of instances use identical hardware and configurations based on
the instance type selected for this fleet. Learn more about On-Demand versus Spot Instances.FleetType
public void setFleetType(FleetType fleetType)
Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is
ON_DEMAND
. Both categories of instances use identical hardware and configurations based on the
instance type selected for this fleet. Learn more about On-Demand versus Spot Instances.
fleetType
- Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is
ON_DEMAND
. Both categories of instances use identical hardware and configurations based on
the instance type selected for this fleet. Learn more about On-Demand versus Spot Instances.FleetType
public CreateFleetRequest withFleetType(FleetType fleetType)
Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is
ON_DEMAND
. Both categories of instances use identical hardware and configurations based on the
instance type selected for this fleet. Learn more about On-Demand versus Spot Instances.
fleetType
- Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is
ON_DEMAND
. Both categories of instances use identical hardware and configurations based on
the instance type selected for this fleet. Learn more about On-Demand versus Spot Instances.FleetType
public void setInstanceRoleArn(String instanceRoleArn)
A unique identifier for an AWS IAM role that manages access to your AWS 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 from the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.
instanceRoleArn
- A unique identifier for an AWS IAM role that manages access to your AWS 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 from
the IAM dashboard in the AWS Management Console. Learn
more about using on-box credentials for your game servers at
Access external resources from a game server.public String getInstanceRoleArn()
A unique identifier for an AWS IAM role that manages access to your AWS 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 from the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.
public CreateFleetRequest withInstanceRoleArn(String instanceRoleArn)
A unique identifier for an AWS IAM role that manages access to your AWS 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 from the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.
instanceRoleArn
- A unique identifier for an AWS IAM role that manages access to your AWS 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 from
the IAM dashboard in the AWS Management Console. Learn
more about using on-box credentials for your game servers at
Access external resources from a game server.public void setCertificateConfiguration(CertificateConfiguration certificateConfiguration)
Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not specified, the default value, DISABLED, is used. This fleet setting cannot be changed once the fleet is created. Learn more at Securing Client/Server Communication.
Note: This feature requires the AWS Certificate Manager (ACM) service, which is available in the AWS global partition but not in all other partitions. When working in a partition that does not support this feature, a request for a new fleet with certificate generation results fails with a 4xx unsupported Region error.
Valid values include:
GENERATED - Generate a TLS/SSL certificate for this fleet.
DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
certificateConfiguration
- Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for
encrypting traffic between game clients and game servers running on GameLift. If this parameter is not
specified, the default value, DISABLED, is used. This fleet setting cannot be changed once the fleet is
created. Learn more at Securing Client/Server Communication.
Note: This feature requires the AWS Certificate Manager (ACM) service, which is available in the AWS global partition but not in all other partitions. When working in a partition that does not support this feature, a request for a new fleet with certificate generation results fails with a 4xx unsupported Region error.
Valid values include:
GENERATED - Generate a TLS/SSL certificate for this fleet.
DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
public CertificateConfiguration getCertificateConfiguration()
Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not specified, the default value, DISABLED, is used. This fleet setting cannot be changed once the fleet is created. Learn more at Securing Client/Server Communication.
Note: This feature requires the AWS Certificate Manager (ACM) service, which is available in the AWS global partition but not in all other partitions. When working in a partition that does not support this feature, a request for a new fleet with certificate generation results fails with a 4xx unsupported Region error.
Valid values include:
GENERATED - Generate a TLS/SSL certificate for this fleet.
DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
Note: This feature requires the AWS Certificate Manager (ACM) service, which is available in the AWS global partition but not in all other partitions. When working in a partition that does not support this feature, a request for a new fleet with certificate generation results fails with a 4xx unsupported Region error.
Valid values include:
GENERATED - Generate a TLS/SSL certificate for this fleet.
DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
public CreateFleetRequest withCertificateConfiguration(CertificateConfiguration certificateConfiguration)
Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not specified, the default value, DISABLED, is used. This fleet setting cannot be changed once the fleet is created. Learn more at Securing Client/Server Communication.
Note: This feature requires the AWS Certificate Manager (ACM) service, which is available in the AWS global partition but not in all other partitions. When working in a partition that does not support this feature, a request for a new fleet with certificate generation results fails with a 4xx unsupported Region error.
Valid values include:
GENERATED - Generate a TLS/SSL certificate for this fleet.
DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
certificateConfiguration
- Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for
encrypting traffic between game clients and game servers running on GameLift. If this parameter is not
specified, the default value, DISABLED, is used. This fleet setting cannot be changed once the fleet is
created. Learn more at Securing Client/Server Communication.
Note: This feature requires the AWS Certificate Manager (ACM) service, which is available in the AWS global partition but not in all other partitions. When working in a partition that does not support this feature, a request for a new fleet with certificate generation results fails with a 4xx unsupported Region error.
Valid values include:
GENERATED - Generate a TLS/SSL certificate for this fleet.
DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
public List<Tag> getTags()
A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource 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 AWS 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 AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource 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 AWS 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
AWS resources are useful for resource management, access management and cost allocation. For more
information, see Tagging AWS
Resources in the AWS General Reference. Once the resource 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 AWS 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 AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource 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 AWS 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
AWS resources are useful for resource management, access management and cost allocation. For more
information, see Tagging AWS
Resources in the AWS General Reference. Once the resource 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 AWS 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 AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource 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 AWS 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
AWS resources are useful for resource management, access management and cost allocation. For more
information, see Tagging AWS
Resources in the AWS General Reference. Once the resource 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 AWS 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()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.