AssociateFileSystemInput

AssociateFileSystemInput schema from Amazon Storage Gateway API

BackupFile StorageGatewayHybrid CloudStorage

Properties

Name Type Description
UserName object
Password object
ClientToken object
GatewayARN object
LocationARN object
Tags object
AuditDestinationARN object
CacheAttributes object
EndpointNetworkConfiguration object
View JSON Schema on GitHub

JSON Schema

amazon-storage-gateway-associate-file-system-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-associate-file-system-input-schema.json",
  "title": "AssociateFileSystemInput",
  "description": "AssociateFileSystemInput schema from Amazon Storage Gateway API",
  "type": "object",
  "properties": {
    "UserName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DomainUserName"
        },
        {
          "description": "The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group."
        }
      ]
    },
    "Password": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DomainUserPassword"
        },
        {
          "description": "The password of the user credential."
        }
      ]
    },
    "ClientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientToken"
        },
        {
          "description": "A unique string value that you supply that is used by the FSx File Gateway to ensure idempotent file system association creation."
        }
      ]
    },
    "GatewayARN": {
      "$ref": "#/components/schemas/GatewayARN"
    },
    "LocationARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FileSystemLocationARN"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway."
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Tags"
        },
        {
          "description": "A list of up to 50 tags that can be assigned to the file system association. Each tag is a key-value pair."
        }
      ]
    },
    "AuditDestinationARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AuditDestinationARN"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the storage used for the audit logs."
        }
      ]
    },
    "CacheAttributes": {
      "$ref": "#/components/schemas/CacheAttributes"
    },
    "EndpointNetworkConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EndpointNetworkConfiguration"
        },
        {
          "description": "<p>Specifies the network configuration information for the gateway associated with the Amazon FSx file system.</p> <note> <p>If multiple file systems are associated with this gateway, this parameter's <code>IpAddresses</code> field is required.</p> </note>"
        }
      ]
    }
  },
  "required": [
    "UserName",
    "Password",
    "ClientToken",
    "GatewayARN",
    "LocationARN"
  ]
}