{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-gamelift/refs/heads/main/json-structure/gamelift-create-fleet-input-structure.json",
  "name": "CreateFleetInput",
  "description": "CreateFleetInput schema from Amazon GameLift API",
  "type": "object",
  "properties": {
    "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 description for the fleet."
        }
      ]
    },
    "BuildId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BuildIdOrArn"
        },
        {
          "description": "The unique identifier for a custom game server build to be deployed on fleet instances. You can use either the build ID or ARN. The build must be uploaded to Amazon GameLift and in <code>READY</code> status. This fleet property cannot be changed later."
        }
      ]
    },
    "ScriptId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ScriptIdOrArn"
        },
        {
          "description": "The unique identifier for a Realtime configuration script to be deployed on fleet instances. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift prior to creating the fleet. This fleet property cannot be changed later."
        }
      ]
    },
    "ServerLaunchPath": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LaunchPathStringModel"
        },
        {
          "description": " <b>This parameter is no longer used.</b> Specify a server launch path using the <code>RuntimeConfiguration</code> parameter. Requests that use this parameter instead continue to be valid."
        }
      ]
    },
    "ServerLaunchParameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LaunchParametersStringModel"
        },
        {
          "description": " <b>This parameter is no longer used.</b> Specify server launch parameters using the <code>RuntimeConfiguration</code> parameter. Requests that use this parameter instead continue to be valid."
        }
      ]
    },
    "LogPaths": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StringList"
        },
        {
          "description": " <b>This parameter is no longer used.</b> To specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API <code>ProcessReady()</code> and specify one or more directory paths in <code>logParameters</code>. For more information, see <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-initialize\">Initialize the server process</a> in the <i>Amazon GameLift Developer Guide</i>. "
        }
      ]
    },
    "EC2InstanceType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EC2InstanceType"
        },
        {
          "description": "The Amazon GameLift-supported Amazon EC2 instance type to use for all fleet instances. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon Elastic Compute Cloud Instance Types</a> for detailed descriptions of Amazon EC2 instance types."
        }
      ]
    },
    "EC2InboundPermissions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IpPermissionsList"
        },
        {
          "description": "The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet. If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges. "
        }
      ]
    },
    "NewGameSessionProtectionPolicy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProtectionPolicy"
        },
        {
          "description": "<p>The status of termination protection for active game sessions on the fleet. By default, this property is set to <code>NoProtection</code>. You can also set game session protection for an individual game session by calling <a href=\"gamelift/latest/apireference/API_UpdateGameSession.html\">UpdateGameSession</a>.</p> <ul> <li> <p> <b>NoProtection</b> - Game sessions can be terminated during active gameplay as a result of a scale-down event. </p> </li> <li> <p> <b>FullProtection</b> - Game sessions in <code>ACTIVE</code> status cannot be terminated during a scale-down event.</p> </li> </ul>"
        }
      ]
    },
    "RuntimeConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RuntimeConfiguration"
        },
        {
          "description": "<p>Instructions for how to launch and maintain server processes on instances in the fleet. The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently. </p> <note> <p>The <code>RuntimeConfiguration</code> parameter is required unless the fleet is being configured using the older parameters <code>ServerLaunchPath</code> and <code>ServerLaunchParameters</code>, which are still supported for backward compatibility.</p> </note>"
        }
      ]
    },
    "ResourceCreationLimitPolicy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceCreationLimitPolicy"
        },
        {
          "description": "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."
        }
      ]
    },
    "MetricGroups": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MetricGroupList"
        },
        {
          "description": "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. "
        }
      ]
    },
    "PeerVpcAwsAccountId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonZeroAndMaxString"
        },
        {
          "description": "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. "
        }
      ]
    },
    "PeerVpcId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonZeroAndMaxString"
        },
        {
          "description": "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 <a href=\"https://console.aws.amazon.com/vpc/\">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html\">VPC Peering with Amazon GameLift Fleets</a>."
        }
      ]
    },
    "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 <code>ON_DEMAND</code>. Learn more about when to use <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot\"> On-Demand versus Spot Instances</a>. This property cannot be changed after the fleet is created."
        }
      ]
    },
    "InstanceRoleArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "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 <a href=\"https://console.aws.amazon.com/iam/\">IAM dashboard</a> in the Amazon Web Services Management Console. Learn more about using on-box credentials for your game servers at <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html\"> Access external resources from a game server</a>. This property cannot be changed after the fleet is created."
        }
      ]
    },
    "CertificateConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CertificateConfiguration"
        },
        {
          "description": "<p>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 <code>CertificateConfiguration</code> is <code>DISABLED</code>. You can't change this property after you create the fleet. </p> <p>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.</p> <note> <p>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 <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html\">Supported Regions</a> in the <i>Certificate Manager User Guide</i>.</p> </note>"
        }
      ]
    },
    "Locations": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LocationConfigurationList"
        },
        {
          "description": "<p>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 <code>us-west-2</code>. To create a fleet with instances in the home Region only, don't use this parameter. </p> <p>To use this parameter, Amazon GameLift requires you to use your home location in the request.</p>"
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagList"
        },
        {
          "description": "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 <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>."
        }
      ]
    },
    "ComputeType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComputeType"
        },
        {
          "description": "The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift. By default, this property is set to <code>EC2</code>."
        }
      ]
    },
    "AnywhereConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AnywhereConfiguration"
        },
        {
          "description": "Amazon GameLift Anywhere configuration options."
        }
      ]
    }
  },
  "required": [
    "Name"
  ]
}