Amazon WorkSpaces Web · JSON Structure

Workspaces Web Network Settings Structure

A network settings resource that can be associated with a web portal. Once associated with a web portal, network settings define how streaming instances will connect with your specified VPC.

Type: object Properties: 5 Required: 1
End User ComputingSecure BrowserVirtual DesktopZero Trust

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

Properties

associatedPortalArns networkSettingsArn securityGroupIds subnetIds vpcId

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "required": [
    "networkSettingsArn"
  ],
  "properties": {
    "associatedPortalArns": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ArnList"
        },
        {
          "description": "A list of web portal ARNs that this network settings is associated with."
        }
      ]
    },
    "networkSettingsArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ARN"
        },
        {
          "description": "The ARN of the network settings."
        }
      ]
    },
    "securityGroupIds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SecurityGroupIdList"
        },
        {
          "description": "One or more security groups used to control access from streaming instances to your VPC. "
        }
      ]
    },
    "subnetIds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SubnetIdList"
        },
        {
          "description": "The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones."
        }
      ]
    },
    "vpcId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VpcId"
        },
        {
          "description": "The VPC that streaming instances will connect to."
        }
      ]
    }
  },
  "description": "A network settings resource that can be associated with a web portal. Once associated with a web portal, network settings define how streaming instances will connect with your specified VPC. ",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "name": "NetworkSettings",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces-web/refs/heads/main/json-structure/workspaces-web-network-settings-structure.json"
}