@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class FleetAttributes extends Object implements Serializable, Cloneable, StructuredPojo
Describes a GameLift fleet of game hosting resources.
Related actions
Constructor and Description |
---|
FleetAttributes() |
Modifier and Type | Method and Description |
---|---|
FleetAttributes |
clone() |
boolean |
equals(Object obj) |
AnywhereConfiguration |
getAnywhereConfiguration() |
String |
getBuildArn()
The Amazon Resource Name (ARN)
associated with the GameLift build resource that is deployed on instances in this fleet.
|
String |
getBuildId()
A unique identifier for the build resource that is deployed on instances in this fleet.
|
CertificateConfiguration |
getCertificateConfiguration() |
String |
getComputeType()
The type of compute resource used to host your game servers.
|
Date |
getCreationTime()
A time stamp indicating when this data object was created.
|
String |
getDescription()
A human-readable description of the fleet.
|
String |
getFleetArn()
The Amazon Resource Name (ARN)
that is assigned to a GameLift fleet resource and uniquely identifies it.
|
String |
getFleetId()
A unique identifier for the fleet.
|
String |
getFleetType()
Indicates whether to use On-Demand or Spot instances for this fleet.
|
String |
getInstanceRoleArn()
A unique identifier for an IAM role that manages access to your Amazon Web Services services.
|
String |
getInstanceType()
The Amazon EC2 instance type that determines the computing resources of each instance in the fleet.
|
List<String> |
getLogPaths()
This parameter is no longer used. Game session log paths are now defined using the GameLift server API
ProcessReady() logParameters . |
List<String> |
getMetricGroups()
Name of a metric group that metrics for this fleet are added to.
|
String |
getName()
A descriptive label that is associated with a fleet.
|
String |
getNewGameSessionProtectionPolicy()
The type of game session protection to set on all new instances that are started in the fleet.
|
String |
getOperatingSystem()
The operating system of the fleet's computing resources.
|
ResourceCreationLimitPolicy |
getResourceCreationLimitPolicy() |
String |
getScriptArn()
The Amazon Resource Name (ARN)
associated with the GameLift script resource that is deployed on instances in this fleet.
|
String |
getScriptId()
A unique identifier for the Realtime script resource that is deployed on instances in this fleet.
|
String |
getServerLaunchParameters()
This parameter is no longer used. Server launch parameters are now defined using the fleet's runtime
configuration .
|
String |
getServerLaunchPath()
This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration .
|
String |
getStatus()
Current status of the fleet.
|
List<String> |
getStoppedActions()
A list of fleet activity that has been suspended using StopFleetActions .
|
Date |
getTerminationTime()
A time stamp indicating when this data object was terminated.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAnywhereConfiguration(AnywhereConfiguration anywhereConfiguration) |
void |
setBuildArn(String buildArn)
The Amazon Resource Name (ARN)
associated with the GameLift build resource that is deployed on instances in this fleet.
|
void |
setBuildId(String buildId)
A unique identifier for the build resource that is deployed on instances in this fleet.
|
void |
setCertificateConfiguration(CertificateConfiguration certificateConfiguration) |
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 |
setCreationTime(Date creationTime)
A time stamp indicating when this data object was created.
|
void |
setDescription(String description)
A human-readable description of the fleet.
|
void |
setFleetArn(String fleetArn)
The Amazon Resource Name (ARN)
that is assigned to a GameLift fleet resource and uniquely identifies it.
|
void |
setFleetId(String fleetId)
A unique identifier for the fleet.
|
void |
setFleetType(FleetType fleetType)
Indicates whether to use On-Demand or Spot instances for this fleet.
|
void |
setFleetType(String fleetType)
Indicates whether to use On-Demand or Spot instances for this fleet.
|
void |
setInstanceRoleArn(String instanceRoleArn)
A unique identifier for an IAM role that manages access to your Amazon Web Services services.
|
void |
setInstanceType(EC2InstanceType instanceType)
The Amazon EC2 instance type that determines the computing resources of each instance in the fleet.
|
void |
setInstanceType(String instanceType)
The Amazon EC2 instance type that determines the computing resources of each instance in the fleet.
|
void |
setLogPaths(Collection<String> logPaths)
This parameter is no longer used. Game session log paths are now defined using the GameLift server API
ProcessReady() logParameters . |
void |
setMetricGroups(Collection<String> metricGroups)
Name of a metric group that metrics for this fleet are added to.
|
void |
setName(String name)
A descriptive label that is associated with a fleet.
|
void |
setNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy)
The type of game session protection to set on all new instances that are started in the fleet.
|
void |
setNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)
The type of game session protection to set on all new instances that are started in the fleet.
|
void |
setOperatingSystem(OperatingSystem operatingSystem)
The operating system of the fleet's computing resources.
|
void |
setOperatingSystem(String operatingSystem)
The operating system of the fleet's computing resources.
|
void |
setResourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy) |
void |
setScriptArn(String scriptArn)
The Amazon Resource Name (ARN)
associated with the GameLift script resource that is deployed on instances in this fleet.
|
void |
setScriptId(String scriptId)
A unique identifier for the Realtime script resource that is deployed on instances in this fleet.
|
void |
setServerLaunchParameters(String serverLaunchParameters)
This parameter is no longer used. Server launch parameters are now defined using the fleet's runtime
configuration .
|
void |
setServerLaunchPath(String serverLaunchPath)
This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration .
|
void |
setStatus(FleetStatus status)
Current status of the fleet.
|
void |
setStatus(String status)
Current status of the fleet.
|
void |
setStoppedActions(Collection<String> stoppedActions)
A list of fleet activity that has been suspended using StopFleetActions .
|
void |
setTerminationTime(Date terminationTime)
A time stamp indicating when this data object was terminated.
|
String |
toString()
Returns a string representation of this object.
|
FleetAttributes |
withAnywhereConfiguration(AnywhereConfiguration anywhereConfiguration) |
FleetAttributes |
withBuildArn(String buildArn)
The Amazon Resource Name (ARN)
associated with the GameLift build resource that is deployed on instances in this fleet.
|
FleetAttributes |
withBuildId(String buildId)
A unique identifier for the build resource that is deployed on instances in this fleet.
|
FleetAttributes |
withCertificateConfiguration(CertificateConfiguration certificateConfiguration) |
FleetAttributes |
withComputeType(ComputeType computeType)
The type of compute resource used to host your game servers.
|
FleetAttributes |
withComputeType(String computeType)
The type of compute resource used to host your game servers.
|
FleetAttributes |
withCreationTime(Date creationTime)
A time stamp indicating when this data object was created.
|
FleetAttributes |
withDescription(String description)
A human-readable description of the fleet.
|
FleetAttributes |
withFleetArn(String fleetArn)
The Amazon Resource Name (ARN)
that is assigned to a GameLift fleet resource and uniquely identifies it.
|
FleetAttributes |
withFleetId(String fleetId)
A unique identifier for the fleet.
|
FleetAttributes |
withFleetType(FleetType fleetType)
Indicates whether to use On-Demand or Spot instances for this fleet.
|
FleetAttributes |
withFleetType(String fleetType)
Indicates whether to use On-Demand or Spot instances for this fleet.
|
FleetAttributes |
withInstanceRoleArn(String instanceRoleArn)
A unique identifier for an IAM role that manages access to your Amazon Web Services services.
|
FleetAttributes |
withInstanceType(EC2InstanceType instanceType)
The Amazon EC2 instance type that determines the computing resources of each instance in the fleet.
|
FleetAttributes |
withInstanceType(String instanceType)
The Amazon EC2 instance type that determines the computing resources of each instance in the fleet.
|
FleetAttributes |
withLogPaths(Collection<String> logPaths)
This parameter is no longer used. Game session log paths are now defined using the GameLift server API
ProcessReady() logParameters . |
FleetAttributes |
withLogPaths(String... logPaths)
This parameter is no longer used. Game session log paths are now defined using the GameLift server API
ProcessReady() logParameters . |
FleetAttributes |
withMetricGroups(Collection<String> metricGroups)
Name of a metric group that metrics for this fleet are added to.
|
FleetAttributes |
withMetricGroups(String... metricGroups)
Name of a metric group that metrics for this fleet are added to.
|
FleetAttributes |
withName(String name)
A descriptive label that is associated with a fleet.
|
FleetAttributes |
withNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy)
The type of game session protection to set on all new instances that are started in the fleet.
|
FleetAttributes |
withNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)
The type of game session protection to set on all new instances that are started in the fleet.
|
FleetAttributes |
withOperatingSystem(OperatingSystem operatingSystem)
The operating system of the fleet's computing resources.
|
FleetAttributes |
withOperatingSystem(String operatingSystem)
The operating system of the fleet's computing resources.
|
FleetAttributes |
withResourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy) |
FleetAttributes |
withScriptArn(String scriptArn)
The Amazon Resource Name (ARN)
associated with the GameLift script resource that is deployed on instances in this fleet.
|
FleetAttributes |
withScriptId(String scriptId)
A unique identifier for the Realtime script resource that is deployed on instances in this fleet.
|
FleetAttributes |
withServerLaunchParameters(String serverLaunchParameters)
This parameter is no longer used. Server launch parameters are now defined using the fleet's runtime
configuration .
|
FleetAttributes |
withServerLaunchPath(String serverLaunchPath)
This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration .
|
FleetAttributes |
withStatus(FleetStatus status)
Current status of the fleet.
|
FleetAttributes |
withStatus(String status)
Current status of the fleet.
|
FleetAttributes |
withStoppedActions(Collection<String> stoppedActions)
A list of fleet activity that has been suspended using StopFleetActions .
|
FleetAttributes |
withStoppedActions(FleetAction... stoppedActions)
A list of fleet activity that has been suspended using StopFleetActions .
|
FleetAttributes |
withStoppedActions(String... stoppedActions)
A list of fleet activity that has been suspended using StopFleetActions .
|
FleetAttributes |
withTerminationTime(Date terminationTime)
A time stamp indicating when this data object was terminated.
|
public void setFleetId(String fleetId)
A unique identifier for the fleet.
fleetId
- A unique identifier for the fleet.public String getFleetId()
A unique identifier for the fleet.
public FleetAttributes withFleetId(String fleetId)
A unique identifier for the fleet.
fleetId
- A unique identifier for the fleet.public void setFleetArn(String fleetArn)
The Amazon Resource Name (ARN)
that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions.
Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912
. In a
GameLift fleet ARN, the resource ID matches the FleetId
value.
fleetArn
- The Amazon Resource Name (ARN) that is assigned to a
GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is
arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912
. In a
GameLift fleet ARN, the resource ID matches the FleetId
value.public String getFleetArn()
The Amazon Resource Name (ARN)
that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions.
Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912
. In a
GameLift fleet ARN, the resource ID matches the FleetId
value.
arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912
. In a
GameLift fleet ARN, the resource ID matches the FleetId
value.public FleetAttributes withFleetArn(String fleetArn)
The Amazon Resource Name (ARN)
that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions.
Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912
. In a
GameLift fleet ARN, the resource ID matches the FleetId
value.
fleetArn
- The Amazon Resource Name (ARN) that is assigned to a
GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is
arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912
. In a
GameLift fleet ARN, the resource ID matches the FleetId
value.public void setFleetType(String fleetType)
Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to
ON_DEMAND
. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.
fleetType
- Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to
ON_DEMAND
. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.FleetType
public String getFleetType()
Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to
ON_DEMAND
. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.
ON_DEMAND
. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.FleetType
public FleetAttributes withFleetType(String fleetType)
Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to
ON_DEMAND
. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.
fleetType
- Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to
ON_DEMAND
. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.FleetType
public void setFleetType(FleetType fleetType)
Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to
ON_DEMAND
. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.
fleetType
- Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to
ON_DEMAND
. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.FleetType
public FleetAttributes withFleetType(FleetType fleetType)
Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to
ON_DEMAND
. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.
fleetType
- Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to
ON_DEMAND
. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.FleetType
public void setInstanceType(String instanceType)
The Amazon EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.
instanceType
- The Amazon EC2 instance type that determines the computing resources of each instance in the fleet.
Instance type defines the CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for
detailed descriptions.EC2InstanceType
public String getInstanceType()
The Amazon EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.
EC2InstanceType
public FleetAttributes withInstanceType(String instanceType)
The Amazon EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.
instanceType
- The Amazon EC2 instance type that determines the computing resources of each instance in the fleet.
Instance type defines the CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for
detailed descriptions.EC2InstanceType
public void setInstanceType(EC2InstanceType instanceType)
The Amazon EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.
instanceType
- The Amazon EC2 instance type that determines the computing resources of each instance in the fleet.
Instance type defines the CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for
detailed descriptions.EC2InstanceType
public FleetAttributes withInstanceType(EC2InstanceType instanceType)
The Amazon EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.
instanceType
- The Amazon EC2 instance type that determines the computing resources of each instance in the fleet.
Instance type defines the CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for
detailed descriptions.EC2InstanceType
public void setDescription(String description)
A human-readable description of the fleet.
description
- A human-readable description of the fleet.public String getDescription()
A human-readable description of the fleet.
public FleetAttributes withDescription(String description)
A human-readable description of the fleet.
description
- A human-readable description of the fleet.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 FleetAttributes 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 setCreationTime(Date creationTime)
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as
milliseconds (for example "1469498468.057"
).
creationTime
- A time stamp indicating when this data object was created. Format is a number expressed in Unix time as
milliseconds (for example "1469498468.057"
).public Date getCreationTime()
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as
milliseconds (for example "1469498468.057"
).
"1469498468.057"
).public FleetAttributes withCreationTime(Date creationTime)
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as
milliseconds (for example "1469498468.057"
).
creationTime
- A time stamp indicating when this data object was created. Format is a number expressed in Unix time as
milliseconds (for example "1469498468.057"
).public void setTerminationTime(Date terminationTime)
A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as
milliseconds (for example "1469498468.057"
).
terminationTime
- A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as
milliseconds (for example "1469498468.057"
).public Date getTerminationTime()
A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as
milliseconds (for example "1469498468.057"
).
"1469498468.057"
).public FleetAttributes withTerminationTime(Date terminationTime)
A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as
milliseconds (for example "1469498468.057"
).
terminationTime
- A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as
milliseconds (for example "1469498468.057"
).public void setStatus(String status)
Current status of the fleet. Possible fleet statuses include the following:
NEW -- A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.
ACTIVE -- Hosts can now accept game sessions.
ERROR -- An error occurred when downloading, validating, building, or activating the fleet.
DELETING -- Hosts are responding to a delete fleet request.
TERMINATED -- The fleet no longer exists.
status
- Current status of the fleet. Possible fleet statuses include the following:
NEW -- A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.
ACTIVE -- Hosts can now accept game sessions.
ERROR -- An error occurred when downloading, validating, building, or activating the fleet.
DELETING -- Hosts are responding to a delete fleet request.
TERMINATED -- The fleet no longer exists.
FleetStatus
public String getStatus()
Current status of the fleet. Possible fleet statuses include the following:
NEW -- A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.
ACTIVE -- Hosts can now accept game sessions.
ERROR -- An error occurred when downloading, validating, building, or activating the fleet.
DELETING -- Hosts are responding to a delete fleet request.
TERMINATED -- The fleet no longer exists.
NEW -- A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.
ACTIVE -- Hosts can now accept game sessions.
ERROR -- An error occurred when downloading, validating, building, or activating the fleet.
DELETING -- Hosts are responding to a delete fleet request.
TERMINATED -- The fleet no longer exists.
FleetStatus
public FleetAttributes withStatus(String status)
Current status of the fleet. Possible fleet statuses include the following:
NEW -- A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.
ACTIVE -- Hosts can now accept game sessions.
ERROR -- An error occurred when downloading, validating, building, or activating the fleet.
DELETING -- Hosts are responding to a delete fleet request.
TERMINATED -- The fleet no longer exists.
status
- Current status of the fleet. Possible fleet statuses include the following:
NEW -- A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.
ACTIVE -- Hosts can now accept game sessions.
ERROR -- An error occurred when downloading, validating, building, or activating the fleet.
DELETING -- Hosts are responding to a delete fleet request.
TERMINATED -- The fleet no longer exists.
FleetStatus
public void setStatus(FleetStatus status)
Current status of the fleet. Possible fleet statuses include the following:
NEW -- A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.
ACTIVE -- Hosts can now accept game sessions.
ERROR -- An error occurred when downloading, validating, building, or activating the fleet.
DELETING -- Hosts are responding to a delete fleet request.
TERMINATED -- The fleet no longer exists.
status
- Current status of the fleet. Possible fleet statuses include the following:
NEW -- A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.
ACTIVE -- Hosts can now accept game sessions.
ERROR -- An error occurred when downloading, validating, building, or activating the fleet.
DELETING -- Hosts are responding to a delete fleet request.
TERMINATED -- The fleet no longer exists.
FleetStatus
public FleetAttributes withStatus(FleetStatus status)
Current status of the fleet. Possible fleet statuses include the following:
NEW -- A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.
ACTIVE -- Hosts can now accept game sessions.
ERROR -- An error occurred when downloading, validating, building, or activating the fleet.
DELETING -- Hosts are responding to a delete fleet request.
TERMINATED -- The fleet no longer exists.
status
- Current status of the fleet. Possible fleet statuses include the following:
NEW -- A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.
ACTIVE -- Hosts can now accept game sessions.
ERROR -- An error occurred when downloading, validating, building, or activating the fleet.
DELETING -- Hosts are responding to a delete fleet request.
TERMINATED -- The fleet no longer exists.
FleetStatus
public void setBuildId(String buildId)
A unique identifier for the build resource that is deployed on instances in this fleet.
buildId
- A unique identifier for the build resource that is deployed on instances in this fleet.public String getBuildId()
A unique identifier for the build resource that is deployed on instances in this fleet.
public FleetAttributes withBuildId(String buildId)
A unique identifier for the build resource that is deployed on instances in this fleet.
buildId
- A unique identifier for the build resource that is deployed on instances in this fleet.public void setBuildArn(String buildArn)
The Amazon Resource Name (ARN)
associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN,
the resource ID matches the BuildId
value.
buildArn
- The Amazon Resource Name (ARN) associated with the
GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource
ID matches the BuildId
value.public String getBuildArn()
The Amazon Resource Name (ARN)
associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN,
the resource ID matches the BuildId
value.
BuildId
value.public FleetAttributes withBuildArn(String buildArn)
The Amazon Resource Name (ARN)
associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN,
the resource ID matches the BuildId
value.
buildArn
- The Amazon Resource Name (ARN) associated with the
GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource
ID matches the BuildId
value.public void setScriptId(String scriptId)
A unique identifier for the Realtime script resource that is deployed on instances in this fleet.
scriptId
- A unique identifier for the Realtime script resource that is deployed on instances in this fleet.public String getScriptId()
A unique identifier for the Realtime script resource that is deployed on instances in this fleet.
public FleetAttributes withScriptId(String scriptId)
A unique identifier for the Realtime script resource that is deployed on instances in this fleet.
scriptId
- A unique identifier for the Realtime script resource that is deployed on instances in this fleet.public void setScriptArn(String scriptArn)
The Amazon Resource Name (ARN)
associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script
ARN, the resource ID matches the ScriptId
value.
scriptArn
- The Amazon Resource Name (ARN) associated with the
GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the
resource ID matches the ScriptId
value.public String getScriptArn()
The Amazon Resource Name (ARN)
associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script
ARN, the resource ID matches the ScriptId
value.
ScriptId
value.public FleetAttributes withScriptArn(String scriptArn)
The Amazon Resource Name (ARN)
associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script
ARN, the resource ID matches the ScriptId
value.
scriptArn
- The Amazon Resource Name (ARN) associated with the
GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the
resource ID matches the ScriptId
value.public void setServerLaunchPath(String serverLaunchPath)
This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration . Requests that use this parameter instead continue to be valid.
serverLaunchPath
- This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration . Requests that use this parameter instead continue to be valid.public String getServerLaunchPath()
This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration . Requests that use this parameter instead continue to be valid.
public FleetAttributes withServerLaunchPath(String serverLaunchPath)
This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration . Requests that use this parameter instead continue to be valid.
serverLaunchPath
- This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration . Requests that use this parameter instead continue to be valid.public void setServerLaunchParameters(String serverLaunchParameters)
This parameter is no longer used. Server launch parameters are now defined using the fleet's runtime configuration . Requests that use this parameter instead continue to be valid.
serverLaunchParameters
- This parameter is no longer used. Server launch parameters are now defined using the fleet's
runtime configuration . Requests that use this parameter instead continue to be valid.public String getServerLaunchParameters()
This parameter is no longer used. Server launch parameters are now defined using the fleet's runtime configuration . Requests that use this parameter instead continue to be valid.
public FleetAttributes withServerLaunchParameters(String serverLaunchParameters)
This parameter is no longer used. Server launch parameters are now defined using the fleet's runtime configuration . Requests that use this parameter instead continue to be valid.
serverLaunchParameters
- This parameter is no longer used. Server launch parameters are now defined using the fleet's
runtime configuration . Requests that use this parameter instead continue to be valid.public List<String> getLogPaths()
This parameter is no longer used. Game session log paths are now defined using the GameLift server API
ProcessReady()
logParameters
. See more information in the Server API Reference.
ProcessReady()
logParameters
. See more information in the Server API Reference.public void setLogPaths(Collection<String> logPaths)
This parameter is no longer used. Game session log paths are now defined using the GameLift server API
ProcessReady()
logParameters
. See more information in the Server API Reference.
logPaths
- This parameter is no longer used. Game session log paths are now defined using the GameLift server
API ProcessReady()
logParameters
. See more information in the Server API Reference.public FleetAttributes withLogPaths(String... logPaths)
This parameter is no longer used. Game session log paths are now defined using the GameLift server API
ProcessReady()
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. Game session log paths are now defined using the GameLift server
API ProcessReady()
logParameters
. See more information in the Server API Reference.public FleetAttributes withLogPaths(Collection<String> logPaths)
This parameter is no longer used. Game session log paths are now defined using the GameLift server API
ProcessReady()
logParameters
. See more information in the Server API Reference.
logPaths
- This parameter is no longer used. Game session log paths are now defined using the GameLift server
API ProcessReady()
logParameters
. See more information in the Server API Reference.public void setNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)
The type of game session protection to set on all new instances that are started in the fleet.
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
- The type of game session protection to set on all new instances that are started in the fleet.
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()
The type of game session protection to set on all new instances that are started in the fleet.
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 FleetAttributes withNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)
The type of game session protection to set on all new instances that are started in the fleet.
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
- The type of game session protection to set on all new instances that are started in the fleet.
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)
The type of game session protection to set on all new instances that are started in the fleet.
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
- The type of game session protection to set on all new instances that are started in the fleet.
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 FleetAttributes withNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy)
The type of game session protection to set on all new instances that are started in the fleet.
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
- The type of game session protection to set on all new instances that are started in the fleet.
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 setOperatingSystem(String operatingSystem)
The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet.
operatingSystem
- The operating system of the fleet's computing resources. A fleet's operating system is determined by the
OS of the build or script that is deployed on this fleet.OperatingSystem
public String getOperatingSystem()
The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet.
OperatingSystem
public FleetAttributes withOperatingSystem(String operatingSystem)
The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet.
operatingSystem
- The operating system of the fleet's computing resources. A fleet's operating system is determined by the
OS of the build or script that is deployed on this fleet.OperatingSystem
public void setOperatingSystem(OperatingSystem operatingSystem)
The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet.
operatingSystem
- The operating system of the fleet's computing resources. A fleet's operating system is determined by the
OS of the build or script that is deployed on this fleet.OperatingSystem
public FleetAttributes withOperatingSystem(OperatingSystem operatingSystem)
The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet.
operatingSystem
- The operating system of the fleet's computing resources. A fleet's operating system is determined by the
OS of the build or script that is deployed on this fleet.OperatingSystem
public void setResourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy)
resourceCreationLimitPolicy
- public ResourceCreationLimitPolicy getResourceCreationLimitPolicy()
public FleetAttributes withResourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy)
resourceCreationLimitPolicy
- public List<String> getMetricGroups()
Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group at a time.
public void setMetricGroups(Collection<String> metricGroups)
Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group at a time.
metricGroups
- Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view
aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group
at a time.public FleetAttributes withMetricGroups(String... metricGroups)
Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a 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
- Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view
aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group
at a time.public FleetAttributes withMetricGroups(Collection<String> metricGroups)
Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group at a time.
metricGroups
- Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view
aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group
at a time.public List<String> getStoppedActions()
A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.
FleetAction
public void setStoppedActions(Collection<String> stoppedActions)
A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.
stoppedActions
- A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.FleetAction
public FleetAttributes withStoppedActions(String... stoppedActions)
A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.
NOTE: This method appends the values to the existing list (if any). Use
setStoppedActions(java.util.Collection)
or withStoppedActions(java.util.Collection)
if you want
to override the existing values.
stoppedActions
- A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.FleetAction
public FleetAttributes withStoppedActions(Collection<String> stoppedActions)
A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.
stoppedActions
- A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.FleetAction
public FleetAttributes withStoppedActions(FleetAction... stoppedActions)
A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.
stoppedActions
- A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.FleetAction
public void setInstanceRoleArn(String instanceRoleArn)
A unique identifier for an IAM role that manages access to your Amazon Web Services services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the Amazon Web Services Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.
instanceRoleArn
- A unique identifier for an IAM role that manages access to your Amazon Web Services services. With an
instance role ARN set, any application that runs on an instance in this fleet can assume the role,
including install scripts, server processes, and daemons (background processes). Create a role or look up
a role's ARN by using the IAM dashboard in the Amazon
Web Services Management Console. Learn more about using on-box credentials for your game servers at
Access external resources from a game server.public String getInstanceRoleArn()
A unique identifier for an IAM role that manages access to your Amazon Web Services services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the Amazon Web Services Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.
public FleetAttributes withInstanceRoleArn(String instanceRoleArn)
A unique identifier for an IAM role that manages access to your Amazon Web Services services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the Amazon Web Services Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.
instanceRoleArn
- A unique identifier for an IAM role that manages access to your Amazon Web Services services. With an
instance role ARN set, any application that runs on an instance in this fleet can assume the role,
including install scripts, server processes, and daemons (background processes). Create a role or look up
a role's ARN by using the IAM dashboard in the Amazon
Web Services Management Console. Learn more about using on-box credentials for your game servers at
Access external resources from a game server.public void setCertificateConfiguration(CertificateConfiguration certificateConfiguration)
certificateConfiguration
- public CertificateConfiguration getCertificateConfiguration()
public FleetAttributes withCertificateConfiguration(CertificateConfiguration certificateConfiguration)
certificateConfiguration
- public void setComputeType(String computeType)
The type of compute resource used to host your game servers. You can use your own compute resources with GameLift Anywhere or use Amazon EC2 instances with managed GameLift.
computeType
- The type of compute resource used to host your game servers. You can use your own compute resources with
GameLift Anywhere or use Amazon EC2 instances with managed GameLift.ComputeType
public String getComputeType()
The type of compute resource used to host your game servers. You can use your own compute resources with GameLift Anywhere or use Amazon EC2 instances with managed GameLift.
ComputeType
public FleetAttributes withComputeType(String computeType)
The type of compute resource used to host your game servers. You can use your own compute resources with GameLift Anywhere or use Amazon EC2 instances with managed GameLift.
computeType
- The type of compute resource used to host your game servers. You can use your own compute resources with
GameLift Anywhere or use Amazon EC2 instances with managed GameLift.ComputeType
public void setComputeType(ComputeType computeType)
The type of compute resource used to host your game servers. You can use your own compute resources with GameLift Anywhere or use Amazon EC2 instances with managed GameLift.
computeType
- The type of compute resource used to host your game servers. You can use your own compute resources with
GameLift Anywhere or use Amazon EC2 instances with managed GameLift.ComputeType
public FleetAttributes withComputeType(ComputeType computeType)
The type of compute resource used to host your game servers. You can use your own compute resources with GameLift Anywhere or use Amazon EC2 instances with managed GameLift.
computeType
- The type of compute resource used to host your game servers. You can use your own compute resources with
GameLift Anywhere or use Amazon EC2 instances with managed GameLift.ComputeType
public void setAnywhereConfiguration(AnywhereConfiguration anywhereConfiguration)
anywhereConfiguration
- public AnywhereConfiguration getAnywhereConfiguration()
public FleetAttributes withAnywhereConfiguration(AnywhereConfiguration anywhereConfiguration)
anywhereConfiguration
- public String toString()
toString
in class Object
Object.toString()
public FleetAttributes clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.