Amazon WorkSpaces · JSON Structure

Workspaces Connection Alias Structure

Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Type: object Properties: 5
DesktopEnd User ComputingVirtual DesktopDesktop as a Service

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

Properties

ConnectionString AliasId State OwnerAccountId Associations

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

JSON Structure

Raw ↑
{
  "type": "object",
  "properties": {
    "ConnectionString": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ConnectionString"
        },
        {
          "description": "The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as <code>www.example.com</code>."
        }
      ]
    },
    "AliasId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ConnectionAliasId"
        },
        {
          "description": "The identifier of the connection alias."
        }
      ]
    },
    "State": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ConnectionAliasState"
        },
        {
          "description": "The current state of the connection alias."
        }
      ]
    },
    "OwnerAccountId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AwsAccount"
        },
        {
          "description": "The identifier of the Amazon Web Services account that owns the connection alias."
        }
      ]
    },
    "Associations": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ConnectionAliasAssociationList"
        },
        {
          "description": "The association status of the connection alias."
        }
      ]
    }
  },
  "description": "Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html\"> Cross-Region Redirection for Amazon WorkSpaces</a>.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "name": "ConnectionAlias",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces/refs/heads/main/json-structure/workspaces-connection-alias-structure.json"
}