NetworkSettings

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.

End User ComputingSecure BrowserVirtual DesktopZero Trust

Properties

Name Type Description
associatedPortalArns object
networkSettingsArn object
securityGroupIds object
subnetIds object
vpcId object
View JSON Schema on GitHub

JSON Schema

workspaces-web-network-settings-schema.json 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-schema.org/draft/2020-12/schema",
  "title": "NetworkSettings",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces-web/refs/heads/main/json-schema/workspaces-web-network-settings-schema.json"
}