Skip to content

FileSystemAssociationInfo

Source code in docs_src/capo_storage_gateway/types/file_system_association_info.py
class FileSystemAssociationInfo(TypedDict, closed=True):
    file_system_association_arn: NotRequired[
        "capo_storage_gateway.types.file_system_association_arn.FileSystemAssociationARN"
    ]
    """<p>The Amazon Resource Name (ARN) of the file system association.</p>"""
    location_arn: NotRequired[
        "capo_storage_gateway.types.file_system_location_arn.FileSystemLocationARN"
    ]
    """<p>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>.</p>"""
    file_system_association_status: NotRequired[
        "capo_storage_gateway.types.file_system_association_status.FileSystemAssociationStatus"
    ]
    """<p>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> </p>"""
    audit_destination_arn: NotRequired[
        "capo_storage_gateway.types.audit_destination_arn.AuditDestinationARN"
    ]
    """<p>The Amazon Resource Name (ARN) of the storage used for the audit logs.</p>"""
    gateway_arn: NotRequired["capo_storage_gateway.types.gateway_arn.GatewayARN"]
    tags: NotRequired["capo_storage_gateway.types.tags.Tags"]
    """<p>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.</p>"""
    cache_attributes: NotRequired[
        "capo_storage_gateway.types.cache_attributes.CacheAttributes"
    ]
    endpoint_network_configuration: NotRequired[
        "capo_storage_gateway.types.endpoint_network_configuration.EndpointNetworkConfiguration"
    ]
    """<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>"""
    file_system_association_status_details: NotRequired[
        "capo_storage_gateway.types.file_system_association_status_details.FileSystemAssociationStatusDetails"
    ]
    """<p>An array containing the FileSystemAssociationStatusDetail data type, which provides detailed information on file system association status.</p>"""

audit_destination_arn instance-attribute

audit_destination_arn: NotRequired[AuditDestinationARN]

The Amazon Resource Name (ARN) of the storage used for the audit logs.

cache_attributes instance-attribute

cache_attributes: NotRequired[CacheAttributes]

endpoint_network_configuration instance-attribute

endpoint_network_configuration: NotRequired[EndpointNetworkConfiguration]

Specifies network configuration information for the gateway associated with the Amazon FSx file system.

If multiple file systems are associated with this gateway, this parameter's IpAddresses field is required.

file_system_association_arn instance-attribute

file_system_association_arn: NotRequired[FileSystemAssociationARN]

The Amazon Resource Name (ARN) of the file system association.

file_system_association_status instance-attribute

file_system_association_status: NotRequired[FileSystemAssociationStatus]

The status of the file system association. Valid Values: AVAILABLE | CREATING | DELETING | FORCE_DELETING | UPDATING | ERROR

file_system_association_status_details instance-attribute

file_system_association_status_details: NotRequired[FileSystemAssociationStatusDetails]

An array containing the FileSystemAssociationStatusDetail data type, which provides detailed information on file system association status.

gateway_arn instance-attribute

gateway_arn: NotRequired[GatewayARN]

location_arn instance-attribute

location_arn: NotRequired[FileSystemLocationARN]

The ARN of the backend Amazon FSx file system used for storing file data. For information, see FileSystem in the Amazon FSx API Reference.

tags instance-attribute

tags: NotRequired[Tags]

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.