@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateFleetRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
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) |
AnywhereConfiguration |
getAnywhereConfiguration()
Amazon GameLift Anywhere configuration options.
|
String |
getBuildId()
The unique identifier for a custom game server build to be deployed to a fleet with compute type
EC2
. |
CertificateConfiguration |
getCertificateConfiguration()
Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.
|
String |
getComputeType()
The type of compute resource used to host your game servers.
|
ContainerGroupsConfiguration |
getContainerGroupsConfiguration()
The container groups to deploy to instances in the container fleet and other fleet-level configuration settings.
|
String |
getDescription()
A description for the fleet.
|
List<IpPermission> |
getEC2InboundPermissions()
The IP address ranges and port settings that allow inbound traffic to access game server processes and other
processes on this fleet.
|
String |
getEC2InstanceType()
The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets.
|
String |
getFleetType()
Indicates whether to use On-Demand or Spot instances for this fleet.
|
String |
getInstanceRoleArn()
A unique identifier for an IAM role with access permissions to other Amazon Web Services services.
|
String |
getInstanceRoleCredentialsProvider()
Prompts Amazon GameLift to generate a shared credentials file for the IAM role that's defined in
InstanceRoleArn . |
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 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 . |
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 Amazon 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 Amazon 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 run server processes on the fleet.
|
String |
getScriptId()
The unique identifier for a Realtime configuration script to be deployed to a fleet with compute type
EC2 . |
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 |
setAnywhereConfiguration(AnywhereConfiguration anywhereConfiguration)
Amazon GameLift Anywhere configuration options.
|
void |
setBuildId(String buildId)
The unique identifier for a custom game server build to be deployed to a fleet with compute type
EC2
. |
void |
setCertificateConfiguration(CertificateConfiguration certificateConfiguration)
Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.
|
void |
setComputeType(ComputeType computeType)
The type of compute resource used to host your game servers.
|
void |
setComputeType(String computeType)
The type of compute resource used to host your game servers.
|
void |
setContainerGroupsConfiguration(ContainerGroupsConfiguration containerGroupsConfiguration)
The container groups to deploy to instances in the container fleet and other fleet-level configuration settings.
|
void |
setDescription(String description)
A description for the fleet.
|
void |
setEC2InboundPermissions(Collection<IpPermission> eC2InboundPermissions)
The IP address ranges and port settings that allow inbound traffic to access game server processes and other
processes on this fleet.
|
void |
setEC2InstanceType(EC2InstanceType eC2InstanceType)
The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets.
|
void |
setEC2InstanceType(String eC2InstanceType)
The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets.
|
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 with access permissions to other Amazon Web Services services.
|
void |
setInstanceRoleCredentialsProvider(InstanceRoleCredentialsProvider instanceRoleCredentialsProvider)
Prompts Amazon GameLift to generate a shared credentials file for the IAM role that's defined in
InstanceRoleArn . |
void |
setInstanceRoleCredentialsProvider(String instanceRoleCredentialsProvider)
Prompts Amazon GameLift to generate a shared credentials file for the IAM role that's defined in
InstanceRoleArn . |
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 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 . |
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 Amazon 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 Amazon 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 run server processes on the fleet.
|
void |
setScriptId(String scriptId)
The unique identifier for a Realtime configuration script to be deployed to a fleet with compute type
EC2 . |
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 |
withAnywhereConfiguration(AnywhereConfiguration anywhereConfiguration)
Amazon GameLift Anywhere configuration options.
|
CreateFleetRequest |
withBuildId(String buildId)
The unique identifier for a custom game server build to be deployed to a fleet with compute type
EC2
. |
CreateFleetRequest |
withCertificateConfiguration(CertificateConfiguration certificateConfiguration)
Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.
|
CreateFleetRequest |
withComputeType(ComputeType computeType)
The type of compute resource used to host your game servers.
|
CreateFleetRequest |
withComputeType(String computeType)
The type of compute resource used to host your game servers.
|
CreateFleetRequest |
withContainerGroupsConfiguration(ContainerGroupsConfiguration containerGroupsConfiguration)
The container groups to deploy to instances in the container fleet and other fleet-level configuration settings.
|
CreateFleetRequest |
withDescription(String description)
A description for the fleet.
|
CreateFleetRequest |
withEC2InboundPermissions(Collection<IpPermission> eC2InboundPermissions)
The IP address ranges and port settings that allow inbound traffic to access game server processes and other
processes on this fleet.
|
CreateFleetRequest |
withEC2InboundPermissions(IpPermission... eC2InboundPermissions)
The IP address ranges and port settings that allow inbound traffic to access game server processes and other
processes on this fleet.
|
CreateFleetRequest |
withEC2InstanceType(EC2InstanceType eC2InstanceType)
The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets.
|
CreateFleetRequest |
withEC2InstanceType(String eC2InstanceType)
The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets.
|
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 with access permissions to other Amazon Web Services services.
|
CreateFleetRequest |
withInstanceRoleCredentialsProvider(InstanceRoleCredentialsProvider instanceRoleCredentialsProvider)
Prompts Amazon GameLift to generate a shared credentials file for the IAM role that's defined in
InstanceRoleArn . |
CreateFleetRequest |
withInstanceRoleCredentialsProvider(String instanceRoleCredentialsProvider)
Prompts Amazon GameLift to generate a shared credentials file for the IAM role that's defined in
InstanceRoleArn . |
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 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 . |
CreateFleetRequest |
withLogPaths(String... logPaths)
This parameter is no longer used. 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 . |
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 Amazon 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 Amazon 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 run server processes on the fleet.
|
CreateFleetRequest |
withScriptId(String scriptId)
The unique identifier for a Realtime configuration script to be deployed to a fleet with compute type
EC2 . |
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 description for the fleet.
description
- A description for the fleet.public String getDescription()
A description for the fleet.
public CreateFleetRequest withDescription(String description)
A description for the fleet.
description
- A description for the fleet.public void setBuildId(String buildId)
The unique identifier for a custom game server build to be deployed to a fleet with compute type EC2
. You can use either the build ID or ARN. The build must be uploaded to Amazon GameLift and in READY
status. This fleet property can't be changed after the fleet is created.
buildId
- The unique identifier for a custom game server build to be deployed to a fleet with compute type
EC2
. You can use either the build ID or ARN. The build must be uploaded to Amazon GameLift
and in READY
status. This fleet property can't be changed after the fleet is created.public String getBuildId()
The unique identifier for a custom game server build to be deployed to a fleet with compute type EC2
. You can use either the build ID or ARN. The build must be uploaded to Amazon GameLift and in READY
status. This fleet property can't be changed after the fleet is created.
EC2
. You can use either the build ID or ARN. The build must be uploaded to Amazon GameLift
and in READY
status. This fleet property can't be changed after the fleet is created.public CreateFleetRequest withBuildId(String buildId)
The unique identifier for a custom game server build to be deployed to a fleet with compute type EC2
. You can use either the build ID or ARN. The build must be uploaded to Amazon GameLift and in READY
status. This fleet property can't be changed after the fleet is created.
buildId
- The unique identifier for a custom game server build to be deployed to a fleet with compute type
EC2
. You can use either the build ID or ARN. The build must be uploaded to Amazon GameLift
and in READY
status. This fleet property can't be changed after the fleet is created.public void setScriptId(String scriptId)
The unique identifier for a Realtime configuration script to be deployed to a fleet with compute type
EC2
. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift prior to
creating the fleet. This fleet property can't be changed after the fleet is created.
scriptId
- The unique identifier for a Realtime configuration script to be deployed to a fleet with compute type
EC2
. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift
prior to creating the fleet. This fleet property can't be changed after the fleet is created.public String getScriptId()
The unique identifier for a Realtime configuration script to be deployed to a fleet with compute type
EC2
. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift prior to
creating the fleet. This fleet property can't be changed after the fleet is created.
EC2
. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift
prior to creating the fleet. This fleet property can't be changed after the fleet is created.public CreateFleetRequest withScriptId(String scriptId)
The unique identifier for a Realtime configuration script to be deployed to a fleet with compute type
EC2
. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift prior to
creating the fleet. This fleet property can't be changed after the fleet is created.
scriptId
- The unique identifier for a Realtime configuration script to be deployed to a fleet with compute type
EC2
. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift
prior to creating the fleet. This fleet property can't be changed after the fleet is created.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 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
. For more information, see Initialize the server process in the Amazon GameLift Developer Guide.
ProcessReady()
and specify one
or more directory paths in logParameters
. For more information, see Initialize the server process in the Amazon GameLift Developer Guide.public void setLogPaths(Collection<String> logPaths)
This parameter is no longer used. 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
. For more information, see Initialize the server process in the Amazon GameLift Developer Guide.
logPaths
- This parameter is no longer used. 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
. For more information, see Initialize the server process in the Amazon GameLift Developer Guide.public CreateFleetRequest withLogPaths(String... logPaths)
This parameter is no longer used. 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
. For more information, see Initialize the server process in the Amazon GameLift Developer Guide.
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 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
. For more information, see Initialize the server process in the Amazon GameLift Developer Guide.public CreateFleetRequest withLogPaths(Collection<String> logPaths)
This parameter is no longer used. 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
. For more information, see Initialize the server process in the Amazon GameLift Developer Guide.
logPaths
- This parameter is no longer used. 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
. For more information, see Initialize the server process in the Amazon GameLift Developer Guide.public void setEC2InstanceType(String eC2InstanceType)
The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets. 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 Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets. 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 Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets. 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 Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets. 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 Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets. 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 Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets. 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 Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets. 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 Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets. 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 Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets. 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 IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. Set this parameter for EC2 and container fleets. You can leave this parameter empty when creating the fleet, but you must call UpdateFleetPortSettings to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.
To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.
To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.
public void setEC2InboundPermissions(Collection<IpPermission> eC2InboundPermissions)
The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. Set this parameter for EC2 and container fleets. You can leave this parameter empty when creating the fleet, but you must call UpdateFleetPortSettings to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.
To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.
eC2InboundPermissions
- The IP address ranges and port settings that allow inbound traffic to access game server processes and
other processes on this fleet. Set this parameter for EC2 and container fleets. You can leave this
parameter empty when creating the fleet, but you must call UpdateFleetPortSettings to set it before
players can connect to game sessions. As a best practice, we recommend opening ports for remote access
only when you need them and closing them when you're finished. For Realtime Servers fleets, Amazon
GameLift automatically sets TCP and UDP ranges.
To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.
public CreateFleetRequest withEC2InboundPermissions(IpPermission... eC2InboundPermissions)
The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. Set this parameter for EC2 and container fleets. You can leave this parameter empty when creating the fleet, but you must call UpdateFleetPortSettings to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.
To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.
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 IP address ranges and port settings that allow inbound traffic to access game server processes and
other processes on this fleet. Set this parameter for EC2 and container fleets. You can leave this
parameter empty when creating the fleet, but you must call UpdateFleetPortSettings to set it before
players can connect to game sessions. As a best practice, we recommend opening ports for remote access
only when you need them and closing them when you're finished. For Realtime Servers fleets, Amazon
GameLift automatically sets TCP and UDP ranges.
To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.
public CreateFleetRequest withEC2InboundPermissions(Collection<IpPermission> eC2InboundPermissions)
The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. Set this parameter for EC2 and container fleets. You can leave this parameter empty when creating the fleet, but you must call UpdateFleetPortSettings to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.
To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.
eC2InboundPermissions
- The IP address ranges and port settings that allow inbound traffic to access game server processes and
other processes on this fleet. Set this parameter for EC2 and container fleets. You can leave this
parameter empty when creating the fleet, but you must call UpdateFleetPortSettings to set it before
players can connect to game sessions. As a best practice, we recommend opening ports for remote access
only when you need them and closing them when you're finished. For Realtime Servers fleets, Amazon
GameLift automatically sets TCP and UDP ranges.
To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.
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 run server processes on the fleet. Set runtime configuration for EC2 fleets and container fleets. For an Anywhere fleets, set this parameter only if the fleet is running the Amazon GameLift Agent. The runtime configuration defines one or more server process configurations. Each server process identifies a game executable or Realtime script file and the number of processes to run concurrently.
This parameter replaces the parameters ServerLaunchPath
and ServerLaunchParameters
,
which are still supported for backward compatibility.
runtimeConfiguration
- Instructions for how to launch and run server processes on the fleet. Set runtime configuration for EC2
fleets and container fleets. For an Anywhere fleets, set this parameter only if the fleet is running the
Amazon GameLift Agent. The runtime configuration defines one or more server process configurations. Each
server process identifies a game executable or Realtime script file and the number of processes to run
concurrently.
This parameter replaces the parameters ServerLaunchPath
and
ServerLaunchParameters
, which are still supported for backward compatibility.
public RuntimeConfiguration getRuntimeConfiguration()
Instructions for how to launch and run server processes on the fleet. Set runtime configuration for EC2 fleets and container fleets. For an Anywhere fleets, set this parameter only if the fleet is running the Amazon GameLift Agent. The runtime configuration defines one or more server process configurations. Each server process identifies a game executable or Realtime script file and the number of processes to run concurrently.
This parameter replaces the parameters ServerLaunchPath
and ServerLaunchParameters
,
which are still supported for backward compatibility.
This parameter replaces the parameters ServerLaunchPath
and
ServerLaunchParameters
, which are still supported for backward compatibility.
public CreateFleetRequest withRuntimeConfiguration(RuntimeConfiguration runtimeConfiguration)
Instructions for how to launch and run server processes on the fleet. Set runtime configuration for EC2 fleets and container fleets. For an Anywhere fleets, set this parameter only if the fleet is running the Amazon GameLift Agent. The runtime configuration defines one or more server process configurations. Each server process identifies a game executable or Realtime script file and the number of processes to run concurrently.
This parameter replaces the parameters ServerLaunchPath
and ServerLaunchParameters
,
which are still supported for backward compatibility.
runtimeConfiguration
- Instructions for how to launch and run server processes on the fleet. Set runtime configuration for EC2
fleets and container fleets. For an Anywhere fleets, set this parameter only if the fleet is running the
Amazon GameLift Agent. The runtime configuration defines one or more server process configurations. Each
server process identifies a game executable or Realtime script file and the number of processes to run
concurrently.
This parameter replaces the 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 Amazon 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 Amazon 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 Amazon 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 Amazon 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 Amazon 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 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 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 fleet property can't 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 fleet property can't 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 fleet property can't be changed after the fleet is created.
ON_DEMAND
. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't 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 fleet property can't 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 fleet property can't 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 fleet property can't 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 fleet property can't 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 fleet property can't 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 fleet property can't be changed after the fleet is created.FleetType
public void setInstanceRoleArn(String instanceRoleArn)
A unique identifier for an IAM role with access permissions to other Amazon Web Services services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to. For more information about using the role with your game server builds, see Communicate with other Amazon Web Services resources from your fleets. This fleet property can't be changed after the fleet is created.
instanceRoleArn
- A unique identifier for an IAM role with access permissions to other Amazon Web Services services. Any
application that runs on an instance in the fleet--including install scripts, server processes, and other
processes--can use these permissions to interact with Amazon Web Services resources that you own or have
access to. For more information about using the role with your game server builds, see
Communicate with other Amazon Web Services resources from your fleets. This fleet property can't be
changed after the fleet is created.public String getInstanceRoleArn()
A unique identifier for an IAM role with access permissions to other Amazon Web Services services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to. For more information about using the role with your game server builds, see Communicate with other Amazon Web Services resources from your fleets. This fleet property can't be changed after the fleet is created.
public CreateFleetRequest withInstanceRoleArn(String instanceRoleArn)
A unique identifier for an IAM role with access permissions to other Amazon Web Services services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to. For more information about using the role with your game server builds, see Communicate with other Amazon Web Services resources from your fleets. This fleet property can't be changed after the fleet is created.
instanceRoleArn
- A unique identifier for an IAM role with access permissions to other Amazon Web Services services. Any
application that runs on an instance in the fleet--including install scripts, server processes, and other
processes--can use these permissions to interact with Amazon Web Services resources that you own or have
access to. For more information about using the role with your game server builds, see
Communicate with other Amazon Web Services resources from your fleets. This fleet property can't be
changed after the fleet is created.public void setCertificateConfiguration(CertificateConfiguration certificateConfiguration)
Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. Amazon GameLift uses the certificates to
encrypt traffic between game clients and the game servers running on Amazon GameLift. By default, the
CertificateConfiguration
is DISABLED
. You can't change this property after you create
the fleet.
Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.
ACM isn't available in all Amazon Web Services regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the Certificate Manager User Guide.
certificateConfiguration
- Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. Amazon GameLift uses the
certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. By
default, the CertificateConfiguration
is DISABLED
. You can't change this
property after you create the fleet.
Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.
ACM isn't available in all Amazon Web Services regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the Certificate Manager User Guide.
public CertificateConfiguration getCertificateConfiguration()
Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. Amazon GameLift uses the certificates to
encrypt traffic between game clients and the game servers running on Amazon GameLift. By default, the
CertificateConfiguration
is DISABLED
. You can't change this property after you create
the fleet.
Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.
ACM isn't available in all Amazon Web Services regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the Certificate Manager User Guide.
CertificateConfiguration
is DISABLED
. You can't change this
property after you create the fleet.
Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.
ACM isn't available in all Amazon Web Services regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the Certificate Manager User Guide.
public CreateFleetRequest withCertificateConfiguration(CertificateConfiguration certificateConfiguration)
Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. Amazon GameLift uses the certificates to
encrypt traffic between game clients and the game servers running on Amazon GameLift. By default, the
CertificateConfiguration
is DISABLED
. You can't change this property after you create
the fleet.
Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.
ACM isn't available in all Amazon Web Services regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the Certificate Manager User Guide.
certificateConfiguration
- Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. Amazon GameLift uses the
certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. By
default, the CertificateConfiguration
is DISABLED
. You can't change this
property after you create the fleet.
Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.
ACM isn't available in all Amazon Web Services regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the Certificate Manager User Guide.
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
Amazon 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
or Local Zone code. To create a fleet with instances in the home
Region only, don't set this parameter.
When using this parameter, Amazon GameLift requires you to include your home location in the request.
us-west-2
or Local Zone code. To
create a fleet with instances in the home Region only, don't set this parameter.
When using this parameter, Amazon GameLift requires you to include your home location in the request.
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
Amazon 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
or Local Zone code. To create a fleet with instances in the home
Region only, don't set this parameter.
When using this parameter, Amazon GameLift requires you to include your home location in the request.
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 Amazon 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
or Local Zone code. To
create a fleet with instances in the home Region only, don't set this parameter.
When using this parameter, Amazon GameLift requires you to include your home location in the request.
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
Amazon 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
or Local Zone code. To create a fleet with instances in the home
Region only, don't set this parameter.
When using this parameter, Amazon GameLift requires you to include your home location in the request.
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 Amazon 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
or Local Zone code. To
create a fleet with instances in the home Region only, don't set this parameter.
When using this parameter, Amazon GameLift requires you to include your home location in the request.
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
Amazon 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
or Local Zone code. To create a fleet with instances in the home
Region only, don't set this parameter.
When using this parameter, Amazon GameLift requires you to include your home location in the request.
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 Amazon 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
or Local Zone code. To
create a fleet with instances in the home Region only, don't set this parameter.
When using this parameter, Amazon GameLift requires you to include your home location in the request.
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.
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.
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.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.
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.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.
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.public void setComputeType(String computeType)
The type of compute resource used to host your game servers.
EC2
– The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the
default setting.
CONTAINER
– Container images with your game server build and supporting software are deployed to
Amazon EC2 instances for cloud hosting. With this compute type, you must specify the
ContainerGroupsConfiguration
parameter.
ANYWHERE
– Game servers or container images with your game server and supporting software are
deployed to compute resources that are provided and managed by you. With this compute type, you can also set the
AnywhereConfiguration
parameter.
computeType
- The type of compute resource used to host your game servers.
EC2
– The game server build is deployed to Amazon EC2 instances for cloud hosting. This is
the default setting.
CONTAINER
– Container images with your game server build and supporting software are deployed
to Amazon EC2 instances for cloud hosting. With this compute type, you must specify the
ContainerGroupsConfiguration
parameter.
ANYWHERE
– Game servers or container images with your game server and supporting software are
deployed to compute resources that are provided and managed by you. With this compute type, you can also
set the AnywhereConfiguration
parameter.
ComputeType
public String getComputeType()
The type of compute resource used to host your game servers.
EC2
– The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the
default setting.
CONTAINER
– Container images with your game server build and supporting software are deployed to
Amazon EC2 instances for cloud hosting. With this compute type, you must specify the
ContainerGroupsConfiguration
parameter.
ANYWHERE
– Game servers or container images with your game server and supporting software are
deployed to compute resources that are provided and managed by you. With this compute type, you can also set the
AnywhereConfiguration
parameter.
EC2
– The game server build is deployed to Amazon EC2 instances for cloud hosting. This is
the default setting.
CONTAINER
– Container images with your game server build and supporting software are
deployed to Amazon EC2 instances for cloud hosting. With this compute type, you must specify the
ContainerGroupsConfiguration
parameter.
ANYWHERE
– Game servers or container images with your game server and supporting software
are deployed to compute resources that are provided and managed by you. With this compute type, you can
also set the AnywhereConfiguration
parameter.
ComputeType
public CreateFleetRequest withComputeType(String computeType)
The type of compute resource used to host your game servers.
EC2
– The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the
default setting.
CONTAINER
– Container images with your game server build and supporting software are deployed to
Amazon EC2 instances for cloud hosting. With this compute type, you must specify the
ContainerGroupsConfiguration
parameter.
ANYWHERE
– Game servers or container images with your game server and supporting software are
deployed to compute resources that are provided and managed by you. With this compute type, you can also set the
AnywhereConfiguration
parameter.
computeType
- The type of compute resource used to host your game servers.
EC2
– The game server build is deployed to Amazon EC2 instances for cloud hosting. This is
the default setting.
CONTAINER
– Container images with your game server build and supporting software are deployed
to Amazon EC2 instances for cloud hosting. With this compute type, you must specify the
ContainerGroupsConfiguration
parameter.
ANYWHERE
– Game servers or container images with your game server and supporting software are
deployed to compute resources that are provided and managed by you. With this compute type, you can also
set the AnywhereConfiguration
parameter.
ComputeType
public void setComputeType(ComputeType computeType)
The type of compute resource used to host your game servers.
EC2
– The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the
default setting.
CONTAINER
– Container images with your game server build and supporting software are deployed to
Amazon EC2 instances for cloud hosting. With this compute type, you must specify the
ContainerGroupsConfiguration
parameter.
ANYWHERE
– Game servers or container images with your game server and supporting software are
deployed to compute resources that are provided and managed by you. With this compute type, you can also set the
AnywhereConfiguration
parameter.
computeType
- The type of compute resource used to host your game servers.
EC2
– The game server build is deployed to Amazon EC2 instances for cloud hosting. This is
the default setting.
CONTAINER
– Container images with your game server build and supporting software are deployed
to Amazon EC2 instances for cloud hosting. With this compute type, you must specify the
ContainerGroupsConfiguration
parameter.
ANYWHERE
– Game servers or container images with your game server and supporting software are
deployed to compute resources that are provided and managed by you. With this compute type, you can also
set the AnywhereConfiguration
parameter.
ComputeType
public CreateFleetRequest withComputeType(ComputeType computeType)
The type of compute resource used to host your game servers.
EC2
– The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the
default setting.
CONTAINER
– Container images with your game server build and supporting software are deployed to
Amazon EC2 instances for cloud hosting. With this compute type, you must specify the
ContainerGroupsConfiguration
parameter.
ANYWHERE
– Game servers or container images with your game server and supporting software are
deployed to compute resources that are provided and managed by you. With this compute type, you can also set the
AnywhereConfiguration
parameter.
computeType
- The type of compute resource used to host your game servers.
EC2
– The game server build is deployed to Amazon EC2 instances for cloud hosting. This is
the default setting.
CONTAINER
– Container images with your game server build and supporting software are deployed
to Amazon EC2 instances for cloud hosting. With this compute type, you must specify the
ContainerGroupsConfiguration
parameter.
ANYWHERE
– Game servers or container images with your game server and supporting software are
deployed to compute resources that are provided and managed by you. With this compute type, you can also
set the AnywhereConfiguration
parameter.
ComputeType
public void setAnywhereConfiguration(AnywhereConfiguration anywhereConfiguration)
Amazon GameLift Anywhere configuration options.
anywhereConfiguration
- Amazon GameLift Anywhere configuration options.public AnywhereConfiguration getAnywhereConfiguration()
Amazon GameLift Anywhere configuration options.
public CreateFleetRequest withAnywhereConfiguration(AnywhereConfiguration anywhereConfiguration)
Amazon GameLift Anywhere configuration options.
anywhereConfiguration
- Amazon GameLift Anywhere configuration options.public void setInstanceRoleCredentialsProvider(String instanceRoleCredentialsProvider)
Prompts Amazon GameLift to generate a shared credentials file for the IAM role that's defined in
InstanceRoleArn
. The shared credentials file is stored on each fleet instance and refreshed as
needed. Use shared credentials for applications that are deployed along with the game server executable, if the
game server is integrated with server SDK version 5.x. For more information about using shared credentials, see
Communicate with other Amazon Web Services resources from your fleets.
instanceRoleCredentialsProvider
- Prompts Amazon GameLift to generate a shared credentials file for the IAM role that's defined in
InstanceRoleArn
. The shared credentials file is stored on each fleet instance and refreshed
as needed. Use shared credentials for applications that are deployed along with the game server
executable, if the game server is integrated with server SDK version 5.x. For more information about using
shared credentials, see
Communicate with other Amazon Web Services resources from your fleets.InstanceRoleCredentialsProvider
public String getInstanceRoleCredentialsProvider()
Prompts Amazon GameLift to generate a shared credentials file for the IAM role that's defined in
InstanceRoleArn
. The shared credentials file is stored on each fleet instance and refreshed as
needed. Use shared credentials for applications that are deployed along with the game server executable, if the
game server is integrated with server SDK version 5.x. For more information about using shared credentials, see
Communicate with other Amazon Web Services resources from your fleets.
InstanceRoleArn
. The shared credentials file is stored on each fleet instance and refreshed
as needed. Use shared credentials for applications that are deployed along with the game server
executable, if the game server is integrated with server SDK version 5.x. For more information about
using shared credentials, see
Communicate with other Amazon Web Services resources from your fleets.InstanceRoleCredentialsProvider
public CreateFleetRequest withInstanceRoleCredentialsProvider(String instanceRoleCredentialsProvider)
Prompts Amazon GameLift to generate a shared credentials file for the IAM role that's defined in
InstanceRoleArn
. The shared credentials file is stored on each fleet instance and refreshed as
needed. Use shared credentials for applications that are deployed along with the game server executable, if the
game server is integrated with server SDK version 5.x. For more information about using shared credentials, see
Communicate with other Amazon Web Services resources from your fleets.
instanceRoleCredentialsProvider
- Prompts Amazon GameLift to generate a shared credentials file for the IAM role that's defined in
InstanceRoleArn
. The shared credentials file is stored on each fleet instance and refreshed
as needed. Use shared credentials for applications that are deployed along with the game server
executable, if the game server is integrated with server SDK version 5.x. For more information about using
shared credentials, see
Communicate with other Amazon Web Services resources from your fleets.InstanceRoleCredentialsProvider
public void setInstanceRoleCredentialsProvider(InstanceRoleCredentialsProvider instanceRoleCredentialsProvider)
Prompts Amazon GameLift to generate a shared credentials file for the IAM role that's defined in
InstanceRoleArn
. The shared credentials file is stored on each fleet instance and refreshed as
needed. Use shared credentials for applications that are deployed along with the game server executable, if the
game server is integrated with server SDK version 5.x. For more information about using shared credentials, see
Communicate with other Amazon Web Services resources from your fleets.
instanceRoleCredentialsProvider
- Prompts Amazon GameLift to generate a shared credentials file for the IAM role that's defined in
InstanceRoleArn
. The shared credentials file is stored on each fleet instance and refreshed
as needed. Use shared credentials for applications that are deployed along with the game server
executable, if the game server is integrated with server SDK version 5.x. For more information about using
shared credentials, see
Communicate with other Amazon Web Services resources from your fleets.InstanceRoleCredentialsProvider
public CreateFleetRequest withInstanceRoleCredentialsProvider(InstanceRoleCredentialsProvider instanceRoleCredentialsProvider)
Prompts Amazon GameLift to generate a shared credentials file for the IAM role that's defined in
InstanceRoleArn
. The shared credentials file is stored on each fleet instance and refreshed as
needed. Use shared credentials for applications that are deployed along with the game server executable, if the
game server is integrated with server SDK version 5.x. For more information about using shared credentials, see
Communicate with other Amazon Web Services resources from your fleets.
instanceRoleCredentialsProvider
- Prompts Amazon GameLift to generate a shared credentials file for the IAM role that's defined in
InstanceRoleArn
. The shared credentials file is stored on each fleet instance and refreshed
as needed. Use shared credentials for applications that are deployed along with the game server
executable, if the game server is integrated with server SDK version 5.x. For more information about using
shared credentials, see
Communicate with other Amazon Web Services resources from your fleets.InstanceRoleCredentialsProvider
public void setContainerGroupsConfiguration(ContainerGroupsConfiguration containerGroupsConfiguration)
The container groups to deploy to instances in the container fleet and other fleet-level configuration settings. Use the CreateContainerGroupDefinition action to create container groups. A container fleet must have exactly one replica container group, and can optionally have one daemon container group. You can't change this property after you create the fleet.
containerGroupsConfiguration
- The container groups to deploy to instances in the container fleet and other fleet-level configuration
settings. Use the CreateContainerGroupDefinition action to create container groups. A container
fleet must have exactly one replica container group, and can optionally have one daemon container group.
You can't change this property after you create the fleet.public ContainerGroupsConfiguration getContainerGroupsConfiguration()
The container groups to deploy to instances in the container fleet and other fleet-level configuration settings. Use the CreateContainerGroupDefinition action to create container groups. A container fleet must have exactly one replica container group, and can optionally have one daemon container group. You can't change this property after you create the fleet.
public CreateFleetRequest withContainerGroupsConfiguration(ContainerGroupsConfiguration containerGroupsConfiguration)
The container groups to deploy to instances in the container fleet and other fleet-level configuration settings. Use the CreateContainerGroupDefinition action to create container groups. A container fleet must have exactly one replica container group, and can optionally have one daemon container group. You can't change this property after you create the fleet.
containerGroupsConfiguration
- The container groups to deploy to instances in the container fleet and other fleet-level configuration
settings. Use the CreateContainerGroupDefinition action to create container groups. A container
fleet must have exactly one replica container group, and can optionally have one daemon container group.
You can't change this property after you create the fleet.public String toString()
toString
in class Object
Object.toString()
public CreateFleetRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()