Amazon GameLift · JSON Structure

Gamelift Alias Structure

Properties that describe an alias resource.

Related actions

All APIs by task

Type: object Properties: 7
Cloud ComputingGame ServersGamingMultiplayerMatchmakingFlexMatchFleetIQ

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

Properties

AliasId Name AliasArn Description RoutingStrategy CreationTime LastUpdatedTime

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-alias-structure.json",
  "name": "Alias",
  "description": "<p>Properties that describe an alias resource.</p> <p> <b>Related actions</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>",
  "type": "object",
  "properties": {
    "AliasId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AliasId"
        },
        {
          "description": "A unique identifier for the alias. Alias IDs are unique within a Region."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonBlankAndLengthConstraintString"
        },
        {
          "description": "A descriptive label that is associated with an alias. Alias names do not need to be unique."
        }
      ]
    },
    "AliasArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AliasArn"
        },
        {
          "description": "The Amazon Resource Name (<a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html\">ARN</a>) that is assigned to a Amazon GameLift alias resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:&lt;region&gt;::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>. In a GameLift alias ARN, the resource ID matches the alias ID value."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FreeText"
        },
        {
          "description": "A human-readable description of an alias."
        }
      ]
    },
    "RoutingStrategy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RoutingStrategy"
        },
        {
          "description": "The routing configuration, including routing type and fleet target, for the alias. "
        }
      ]
    },
    "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 <code>\"1469498468.057\"</code>)."
        }
      ]
    },
    "LastUpdatedTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The time that this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example <code>\"1469498468.057\"</code>)."
        }
      ]
    }
  }
}