Amazon GameLift · JSON Structure

Gamelift Update Fleet Attributes Input Structure

UpdateFleetAttributesInput schema from Amazon GameLift API

Type: object Properties: 7 Required: 1
Cloud ComputingGame ServersGamingMultiplayerMatchmakingFlexMatchFleetIQ

UpdateFleetAttributesInput is a JSON Structure definition published by Amazon GameLift, describing 7 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

FleetId Name Description NewGameSessionProtectionPolicy ResourceCreationLimitPolicy MetricGroups AnywhereConfiguration

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-gamelift/refs/heads/main/json-structure/gamelift-update-fleet-attributes-input-structure.json",
  "name": "UpdateFleetAttributesInput",
  "description": "UpdateFleetAttributesInput schema from Amazon GameLift API",
  "type": "object",
  "properties": {
    "FleetId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FleetIdOrArn"
        },
        {
          "description": "A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonZeroAndMaxString"
        },
        {
          "description": "A descriptive label that is associated with a fleet. Fleet names do not need to be unique."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonZeroAndMaxString"
        },
        {
          "description": "A human-readable description of a fleet."
        }
      ]
    },
    "NewGameSessionProtectionPolicy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProtectionPolicy"
        },
        {
          "description": "<p>The game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html\">UpdateGameSession</a> .</p> <ul> <li> <p> <b>NoProtection</b> -- The game session can be terminated during a scale-down event.</p> </li> <li> <p> <b>FullProtection</b> -- If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</p> </li> </ul>"
        }
      ]
    },
    "ResourceCreationLimitPolicy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceCreationLimitPolicy"
        },
        {
          "description": "Policy settings that limit the number of game sessions an individual player can create over a span of time. "
        }
      ]
    },
    "MetricGroups": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MetricGroupList"
        },
        {
          "description": "The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time."
        }
      ]
    },
    "AnywhereConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AnywhereConfiguration"
        },
        {
          "description": "Amazon GameLift Anywhere configuration options."
        }
      ]
    }
  },
  "required": [
    "FleetId"
  ]
}