Amazon Storage Gateway · Schema
FileSystemAssociationInfo
Describes the object returned by DescribeFileSystemAssociations that describes a created file system association.
BackupFile StorageGatewayHybrid CloudStorage
Properties
| Name | Type | Description |
|---|---|---|
| FileSystemAssociationARN | object | |
| LocationARN | object | |
| FileSystemAssociationStatus | object | |
| AuditDestinationARN | object | |
| GatewayARN | object | |
| Tags | object | |
| CacheAttributes | object | |
| EndpointNetworkConfiguration | object | |
| FileSystemAssociationStatusDetails | object |
JSON Schema
{
"$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-file-system-association-info-schema.json",
"title": "FileSystemAssociationInfo",
"description": "Describes the object returned by <code>DescribeFileSystemAssociations</code> that describes a created file system association.",
"type": "object",
"properties": {
"FileSystemAssociationARN": {
"allOf": [
{
"$ref": "#/components/schemas/FileSystemAssociationARN"
},
{
"description": "The Amazon Resource Name (ARN) of the file system association."
}
]
},
"LocationARN": {
"allOf": [
{
"$ref": "#/components/schemas/FileSystemLocationARN"
},
{
"description": "The ARN of the backend Amazon FSx file system used for storing file data. For information, see <a href=\"https://docs.aws.amazon.com/fsx/latest/APIReference/API_FileSystem.html\">FileSystem</a> in the <i>Amazon FSx API Reference</i>."
}
]
},
"FileSystemAssociationStatus": {
"allOf": [
{
"$ref": "#/components/schemas/FileSystemAssociationStatus"
},
{
"description": "The status of the file system association. Valid Values: <code>AVAILABLE</code> | <code>CREATING</code> | <code>DELETING</code> | <code>FORCE_DELETING</code> | <code>UPDATING</code> | <code>ERROR</code> "
}
]
},
"AuditDestinationARN": {
"allOf": [
{
"$ref": "#/components/schemas/AuditDestinationARN"
},
{
"description": "The Amazon Resource Name (ARN) of the storage used for the audit logs."
}
]
},
"GatewayARN": {
"$ref": "#/components/schemas/GatewayARN"
},
"Tags": {
"allOf": [
{
"$ref": "#/components/schemas/Tags"
},
{
"description": "A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair."
}
]
},
"CacheAttributes": {
"$ref": "#/components/schemas/CacheAttributes"
},
"EndpointNetworkConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/EndpointNetworkConfiguration"
},
{
"description": "<p>Specifies 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>"
}
]
},
"FileSystemAssociationStatusDetails": {
"allOf": [
{
"$ref": "#/components/schemas/FileSystemAssociationStatusDetails"
},
{
"description": "An array containing the FileSystemAssociationStatusDetail data type, which provides detailed information on file system association status."
}
]
}
}
}