Amazon WorkSpaces Web · JSON Structure

Workspaces Web Create Ip Access Settings Request Structure

CreateIpAccessSettingsRequest schema from Amazon WorkSpaces Web API

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

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

Properties

additionalEncryptionContext clientToken customerManagedKey description displayName ipRules tags

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

JSON Structure

Raw ↑
{
  "type": "object",
  "required": [
    "ipRules"
  ],
  "name": "CreateIpAccessSettingsRequest",
  "properties": {
    "additionalEncryptionContext": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EncryptionContextMap"
        },
        {
          "description": "Additional encryption context of the IP access settings."
        }
      ]
    },
    "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>"
        }
      ]
    },
    "customerManagedKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/keyArn"
        },
        {
          "description": "The custom managed key of the IP access settings."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Description"
        },
        {
          "description": "The description of the IP access settings."
        }
      ]
    },
    "displayName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DisplayName"
        },
        {
          "description": "The display name of the IP access settings."
        }
      ]
    },
    "ipRules": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IpRuleList"
        },
        {
          "description": "The IP rules of the IP access settings."
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagList"
        },
        {
          "description": "The tags to add to the browser settings resource. A tag is a key-value pair."
        }
      ]
    }
  },
  "$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-ip-access-settings-request-structure.json",
  "description": "CreateIpAccessSettingsRequest schema from Amazon WorkSpaces Web API"
}