Amazon WorkSpaces Web · JSON Structure

Workspaces Web Create Network Settings Request Structure

CreateNetworkSettingsRequest schema from Amazon WorkSpaces Web API

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

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

Properties

clientToken securityGroupIds subnetIds tags vpcId

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

JSON Structure

Raw ↑
{
  "type": "object",
  "required": [
    "securityGroupIds",
    "subnetIds",
    "vpcId"
  ],
  "name": "CreateNetworkSettingsRequest",
  "properties": {
    "clientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientToken"
        },
        {
          "description": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. </p> <p>If you do not specify a client token, one is automatically generated by the AWS SDK.</p>"
        }
      ]
    },
    "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."
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagList"
        },
        {
          "description": "The tags to add to the network settings resource. A tag is a key-value pair."
        }
      ]
    },
    "vpcId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VpcId"
        },
        {
          "description": "The VPC that streaming instances will connect to."
        }
      ]
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces-web/refs/heads/main/json-structure/workspaces-web-create-network-settings-request-structure.json",
  "description": "CreateNetworkSettingsRequest schema from Amazon WorkSpaces Web API"
}