UpdateChapCredentialsInput

A JSON object containing one or more of the following fields:

BackupFile StorageGatewayHybrid CloudStorage

Properties

Name Type Description
TargetARN object
SecretToAuthenticateInitiator object
InitiatorName object
SecretToAuthenticateTarget object
View JSON Schema on GitHub

JSON Schema

amazon-storage-gateway-update-chap-credentials-input-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-storage-gateway/refs/heads/main/json-schema/amazon-storage-gateway-update-chap-credentials-input-schema.json",
  "title": "UpdateChapCredentialsInput",
  "description": "<p>A JSON object containing one or more of the following fields:</p> <ul> <li> <p> <a>UpdateChapCredentialsInput$InitiatorName</a> </p> </li> <li> <p> <a>UpdateChapCredentialsInput$SecretToAuthenticateInitiator</a> </p> </li> <li> <p> <a>UpdateChapCredentialsInput$SecretToAuthenticateTarget</a> </p> </li> <li> <p> <a>UpdateChapCredentialsInput$TargetARN</a> </p> </li> </ul>",
  "type": "object",
  "properties": {
    "TargetARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TargetARN"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return the TargetARN for specified VolumeARN."
        }
      ]
    },
    "SecretToAuthenticateInitiator": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChapSecret"
        },
        {
          "description": "<p>The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.</p> <note> <p>The secret key must be between 12 and 16 bytes when encoded in UTF-8.</p> </note>"
        }
      ]
    },
    "InitiatorName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IqnName"
        },
        {
          "description": "The iSCSI initiator that connects to the target."
        }
      ]
    },
    "SecretToAuthenticateTarget": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChapSecret"
        },
        {
          "description": "<p>The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).</p> <p>Byte constraints: Minimum bytes of 12. Maximum bytes of 16.</p> <note> <p>The secret key must be between 12 and 16 bytes when encoded in UTF-8.</p> </note>"
        }
      ]
    }
  },
  "required": [
    "TargetARN",
    "SecretToAuthenticateInitiator",
    "InitiatorName"
  ]
}