Skip to content

AssociateFileSystemInput

Source code in docs_src/capo_storage_gateway/types/associate_file_system_input.py
class AssociateFileSystemInput(TypedDict, closed=True):
    user_name: "capo_storage_gateway.types.domain_user_name.DomainUserName"
    """<p>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.</p>"""
    password: "capo_storage_gateway.types.domain_user_password.DomainUserPassword"
    """<p>The password of the user credential.</p>"""
    client_token: "capo_storage_gateway.types.client_token.ClientToken"
    """<p>A unique string value that you supply that is used by the FSx File Gateway to ensure idempotent file system association creation.</p>"""
    gateway_arn: "capo_storage_gateway.types.gateway_arn.GatewayARN"
    location_arn: (
        "capo_storage_gateway.types.file_system_location_arn.FileSystemLocationARN"
    )
    """<p>The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.</p>"""
    tags: NotRequired["capo_storage_gateway.types.tags.Tags"]
    """<p>A list of up to 50 tags that can be assigned to the file system association. Each tag is a key-value pair.</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>"""
    cache_attributes: NotRequired[
        "capo_storage_gateway.types.cache_attributes.CacheAttributes"
    ]
    endpoint_network_configuration: NotRequired[
        "capo_storage_gateway.types.endpoint_network_configuration.EndpointNetworkConfiguration"
    ]
    """<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>"""

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]

client_token instance-attribute

client_token: ClientToken

A unique string value that you supply that is used by the FSx File Gateway to ensure idempotent file system association creation.

endpoint_network_configuration instance-attribute

endpoint_network_configuration: NotRequired[EndpointNetworkConfiguration]

Specifies the 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.

gateway_arn instance-attribute

gateway_arn: GatewayARN

location_arn instance-attribute

location_arn: FileSystemLocationARN

The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.

password instance-attribute

The password of the user credential.

tags instance-attribute

tags: NotRequired[Tags]

A list of up to 50 tags that can be assigned to the file system association. Each tag is a key-value pair.

user_name instance-attribute

user_name: DomainUserName

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.