WorkspaceDirectory

{
  "type": "object",
  "properties": {
    "DirectoryId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DirectoryId"
        },
        {
          "description": "The directory identifier."
        }
      ]
    },
    "Alias": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Alias"
        },
        {
          "description": "The directory alias."
        }
      ]
    },
    "DirectoryName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DirectoryName"
        },
        {
          "description": "The name of the directory."
        }
      ]
    },
    "RegistrationCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RegistrationCode"
        },
        {
          "description": "The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory."
        }
      ]
    },
    "SubnetIds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SubnetIds"
        },
        {
          "description": "The identifiers of the subnets used with the directory."
        }
      ]
    },
    "DnsIpAddresses": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DnsIpAddresses"
        },
        {
          "description": "The IP addresses of the DNS servers for the directory."
        }
      ]
    },
    "CustomerUserName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserName"
        },
        {
          "description": "The user name for the service account."
        }
      ]
    },
    "IamRoleId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ARN"
        },
        {
          "description": "The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf."
        }
      ]
    },
    "DirectoryType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceDirectoryType"
        },
        {
          "description": "The directory type."
        }
      ]
    },
    "WorkspaceSecurityGroupId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SecurityGroupId"
        },
        {
          "description": "The identifier of the security group that is assigned to new WorkSpaces."
        }
      ]
    },
    "State": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceDirectoryState"
        },
        {
          "description": "The state of the directory's registration with Amazon WorkSpaces. After a directory is deregistered, the <code>DEREGISTERED</code> state is returned very briefly before the directory metadata is cleaned up, so this state is rarely returned. To confirm that a directory is deregistered, check for the directory ID by using <a href=\"https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceDirectories.html\"> DescribeWorkspaceDirectories</a>. If the directory ID isn't returned, then the directory has been successfully deregistered."
        }
      ]
    },
    "WorkspaceCreationProperties": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DefaultWorkspaceCreationProperties"
        },
        {
          "description": "The default creation properties for all WorkSpaces in the directory."
        }
      ]
    },
    "ipGroupIds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IpGroupIdList"
        },
        {
          "description": "The identifiers of the IP access control groups associated with the directory."
        }
      ]
    },
    "WorkspaceAccessProperties": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceAccessProperties"
        },
        {
          "description": "The devices and operating systems that users can use to access WorkSpaces."
        }
      ]
    },
    "Tenancy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Tenancy"
        },
        {
          "description": "Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to <code>DEDICATED</code>. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html\">Bring Your Own Windows Desktop Images</a>."
        }
      ]
    },
    "SelfservicePermissions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SelfservicePermissions"
        },
        {
          "description": "The default self-service permissions for WorkSpaces in the directory."
        }
      ]
    },
    "SamlProperties": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SamlProperties"
        },
        {
          "description": "Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider."
        }
      ]
    },
    "CertificateBasedAuthProperties": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CertificateBasedAuthProperties"
        },
        {
          "description": "The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login."
        }
      ]
    }
  },
  "description": "Describes a directory that is used with Amazon WorkSpaces.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "WorkspaceDirectory",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces/refs/heads/main/json-schema/workspaces-workspace-directory-schema.json"
}