You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::FSx::Types::WindowsFileSystemConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

The configuration for this Microsoft Windows file system.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#active_directory_idString

The ID for an existing Microsoft Active Directory instance that the file system should join when it\'s created.

Returns:

  • (String)

    The ID for an existing Microsoft Active Directory instance that the file system should join when it\'s created.

#automatic_backup_retention_daysInteger

The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 35 days.

Returns:

  • (Integer)

    The number of days to retain automatic backups.

#copy_tags_to_backupsBoolean

A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it\'s set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn\'t specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups.

Returns:

  • (Boolean)

    A boolean flag indicating whether tags on the file system should be copied to backups.

#daily_automatic_backup_start_timeString

The preferred time to take daily automatic backups, in the UTC time zone.

Returns:

  • (String)

    The preferred time to take daily automatic backups, in the UTC time zone.

#deployment_typeString

Specifies the file system deployment type, valid values are the following:

  • MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.

  • SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy.

    Possible values:

    • MULTI_AZ_1
    • SINGLE_AZ_1

Returns:

  • (String)

    Specifies the file system deployment type, valid values are the following:.

#maintenance_operations_in_progressArray<String>

The list of maintenance operations in progress for this file system.

Returns:

  • (Array<String>)

    The list of maintenance operations in progress for this file system.

#preferred_file_server_ipString

For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for both SINGLE_AZ_1 and MULTI_AZ_1 deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system\'s DNSName instead. For more information and instruction on mapping and mounting file shares, see https://docs.aws.amazon.com/fsx/latest/WindowsGuide/accessing-file-shares.html.

Returns:

  • (String)

    For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

#preferred_subnet_idString

For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.

For SINGLE_AZ_1 deployment types, this value is the same as that for SubnetIDs.

Returns:

  • (String)

    For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located.

#remote_administration_endpointString

For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.

For SINGLE_AZ_1 deployment types, this is the DNS name of the file system.

This endpoint is temporarily unavailable when the file system is undergoing maintenance.

Returns:

  • (String)

    For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.

#self_managed_active_directory_configurationTypes::SelfManagedActiveDirectoryAttributes

The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server instance is joined.

Returns:

#throughput_capacityInteger

The throughput of an Amazon FSx file system, measured in megabytes per second.

Returns:

  • (Integer)

    The throughput of an Amazon FSx file system, measured in megabytes per second.

#weekly_maintenance_start_timeString

The preferred time to perform weekly maintenance, in the UTC time zone.

Returns:

  • (String)

    The preferred time to perform weekly maintenance, in the UTC time zone.