{ "$schema": "https://json-structure.org/meta/core/v0/#", "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-gamelift/refs/heads/main/json-structure/gamelift-fleet-attributes-structure.json", "name": "FleetAttributes", "description": "
Describes a Amazon GameLift fleet of game hosting resources.
Related actions
", "type": "object", "properties": { "FleetId": { "allOf": [ { "$ref": "#/components/schemas/FleetId" }, { "description": "A unique identifier for the fleet." } ] }, "FleetArn": { "allOf": [ { "$ref": "#/components/schemas/FleetArn" }, { "description": "The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format isarn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift fleet ARN, the resource ID matches the FleetId value."
}
]
},
"FleetType": {
"allOf": [
{
"$ref": "#/components/schemas/FleetType"
},
{
"description": "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."
}
]
},
"InstanceType": {
"allOf": [
{
"$ref": "#/components/schemas/EC2InstanceType"
},
{
"description": "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."
}
]
},
"Description": {
"allOf": [
{
"$ref": "#/components/schemas/NonZeroAndMaxString"
},
{
"description": "A human-readable description of the fleet."
}
]
},
"Name": {
"allOf": [
{
"$ref": "#/components/schemas/NonZeroAndMaxString"
},
{
"description": "A descriptive label that is associated with a fleet. Fleet names do not need to be unique."
}
]
},
"CreationTime": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\")."
}
]
},
"TerminationTime": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\")."
}
]
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/FleetStatus"
},
{
"description": "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 -- Amazon 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.
BuildId value."
}
]
},
"ScriptId": {
"allOf": [
{
"$ref": "#/components/schemas/ScriptId"
},
{
"description": "A unique identifier for the Realtime script resource that is deployed on instances in this fleet."
}
]
},
"ScriptArn": {
"allOf": [
{
"$ref": "#/components/schemas/ScriptArn"
},
{
"description": " 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."
}
]
},
"ServerLaunchPath": {
"allOf": [
{
"$ref": "#/components/schemas/LaunchPathStringModel"
},
{
"description": " 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."
}
]
},
"ServerLaunchParameters": {
"allOf": [
{
"$ref": "#/components/schemas/LaunchParametersStringModel"
},
{
"description": " 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."
}
]
},
"LogPaths": {
"allOf": [
{
"$ref": "#/components/schemas/StringList"
},
{
"description": " This parameter is no longer used. Game session log paths are now defined using the Amazon GameLift server API ProcessReady() logParameters. See more information in the Server API Reference. "
}
]
},
"NewGameSessionProtectionPolicy": {
"allOf": [
{
"$ref": "#/components/schemas/ProtectionPolicy"
},
{
"description": "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.