id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
WindowsGuide-060 | WindowsGuide.pdf | 60 | a user session, which closes all files opened by that user. You can use the Windows-native Shared Folders GUI tool and the Amazon FSx CLI for remote management on PowerShell to manage user sessions and open files on your FSx for Windows File Server file system. Using the GUI to manage users and sessions The following procedures detail how you can manage user sessions and open files on your Amazon FSx file system using the Microsoft Windows shared folders tool. To launch the shared folders tool 1. Launch your Amazon EC2 instance and connect it to the Microsoft Active Directory that your Amazon FSx file system is joined to. To do this, choose one of the following procedures from the AWS Directory Service Administration Guide: • Seamlessly join a Windows EC2 instance • Manually join a Windows instance 2. Connect to your instance as a user that is a member of the file system administrators group. In AWS Managed Microsoft Active Directory, this group is called AWS Delegated FSx Administrators. In your self-managed Microsoft Active Directory, this group is called Domain Admins or the custom name for the administrators group that you provided during creation. For more information, see Connecting to Your Windows Instance in the Amazon EC2 User Guide. 3. Open the Start menu and run fsmgmt.msc using Run As Administrator. Doing this opens 4. 5. the Shared Folders GUI tool. For Action, choose Connect to another computer. For Another computer, enter the DNS name of your Amazon FSx file system, for example fs-012345678901234567.ad-domain.com. 6. Choose OK. An entry for your Amazon FSx file system then appears in the list for the Shared Folders tool. Using the GUI to manage users and sessions 144 Amazon FSx for Windows File Server To manage user sessions (GUI) Windows User Guide In the Shared Folders tool, choose Sessions to view all the user sessions that are connected to your FSx for Windows File Server file system. If a user or application is accessing a file share on your Amazon FSx file system, this snap-in shows you their session. You can disconnect sessions by opening the context (right-click) menu for a session and choosing Close Session. To disconnect all open sessions, open the context (right-click) menu for Sessions, choose Disconnect All Sessions, and confirm your action. Using the GUI to manage users and sessions 145 Amazon FSx for Windows File Server To manage open files (GUI) Windows User Guide In the Shared Folders tool, choose Open Files to view all the files on the system that are currently open. The view also shows which users have the files or folders open. This information can be helpful in tracking down why other users cannot open certain files. You can close any file that any user has open simply by opening the context (right-click) menu for the file's entry in the list and choosing Close Open File. To disconnect all open files on the file system, the context (right-click) menu for Open Files and choose Disconnect All Open Files, and confirm your action. Using the GUI to manage users and sessions 146 Amazon FSx for Windows File Server Windows User Guide Using PowerShell to manage user sessions and open files You can manage active user sessions and open files on your file system using the Amazon FSx CLI for remote management on PowerShell. To learn how to use this CLI, see Using the Amazon FSx CLI for PowerShell. Following are commands that you can use for user session and open file management. Command Description Get-FSxSmbSession Retrieves information about the Server Message Block (SMB) sessions that are currently established between the file system and the associated clients. Close-FSxSmbSession Ends an SMB session. Get-FSxSmbOpenFile Retrieves information about files that are open for the clients connected to the file system. Close-FSxSmbOpenFile Closes a file that is open for one of the clients of the SMB server. The online help for each command provides a reference of all command options. To access this help, run the command with a -?, for example Get-FSxSmbSession -?. Managing storage on FSx for Windows File Server Your file system's storage configuration includes the amount of provisioned storage capacity, the storage type, and if the storage type is solid state drive (SSD), the amount of SSD IOPS. You can configure these resources, along with the file system's throughput capacity, when creating a file system and after it's created, to achieve the desired performance for your workload. Learn how to manage your file system's storage and storage-related performance using the AWS Management Console, AWS CLI, and the Amazon FSx CLI for remote management on PowerShell by exploring the following topics. Topics • Optimizing storage costs Using PowerShell to manage user sessions and open files 147 Windows User Guide Amazon FSx for Windows File Server • |
WindowsGuide-061 | WindowsGuide.pdf | 61 | the storage type is solid state drive (SSD), the amount of SSD IOPS. You can configure these resources, along with the file system's throughput capacity, when creating a file system and after it's created, to achieve the desired performance for your workload. Learn how to manage your file system's storage and storage-related performance using the AWS Management Console, AWS CLI, and the Amazon FSx CLI for remote management on PowerShell by exploring the following topics. Topics • Optimizing storage costs Using PowerShell to manage user sessions and open files 147 Windows User Guide Amazon FSx for Windows File Server • Managing storage capacity • Managing your file system's storage type • Managing SSD IOPS • Reducing storage costs with Data Deduplication • Managing storage quotas • Increasing file system storage capacity • Monitoring storage capacity increases • Increasing the storage capacity of an FSx for Windows File Server file system dynamically • Updating the storage type of a FSx for Windows file system • Monitoring storage type updates • Updating a file system's SSD IOPS • Monitoring provisioned SSD IOPS updates • Managing data deduplication • Troubleshooting data deduplication Optimizing storage costs You can optimize your storage costs using the storage configuration options available in FSx for Windows. Storage type options—FSx for Windows File Server provides two storage types, hard disk drives (HDD) and solid state drives (SSD)—to enable you to optimize cost/performance to meet your workload needs. HDD storage is designed for a broad spectrum of workloads, including home directories, user and departmental shares, and content management systems. SSD storage is designed for the highest-performance and most latency-sensitive workloads, including databases, media processing workloads, and data analytics applications. For more information about storage types and file system performance, see FSx for Windows File Server performance. Data deduplication—Large datasets often have redundant data, which increases data storage costs. For example, user file shares can have multiple copies of the same file, stored by multiple users. Software development shares can contain many binaries that remain unchanged from build to build. You can reduce your data storage costs by turning on data deduplication for your file system. When it's turned on, data deduplication automatically reduces or eliminates redundant Optimizing storage costs 148 Amazon FSx for Windows File Server Windows User Guide data by storing duplicated portions of the dataset only once. For more information about data deduplication, and how to easily turn it on for your Amazon FSx file system, see Reducing storage costs with Data Deduplication. Managing storage capacity You can increase your FSx for Windows file system's storage capacity as your storage requirements change. You can do so using the Amazon FSx console, the Amazon FSx API, or the AWS Command Line Interface (AWS CLI). Factors to consider when planning a storage capacity increase include knowing when you need to increase storage capacity, understanding how Amazon FSx processes storage capacity increases, and tracking the progress of a storage increase request. You can only increase a file system's storage capacity; you cannot decrease storage capacity. Note You can't increase storage capacity for file systems created before June 23, 2019 or file systems restored from a backup belonging to a file system that was created before June 23, 2019. When you increase the storage capacity of your Amazon FSx file system, Amazon FSx adds a new, larger set of disks to your file system behind the scenes. Amazon FSx then runs a storage optimization process in the background to transparently migrate data from the old disks to the new disks. Storage optimization can take between a few hours and several days, depending on the storage type and other factors, with minimal noticeable impact on the workload performance. During this optimization, backup usage is temporarily higher, because both the old and new storage volumes are included in the file system-level backups. Both sets of storage volumes are included to ensure that Amazon FSx can successfully take and restore from backups even during storage scaling activity. The backup usage reverts to its previous baseline level after the old storage volumes are no longer included in the backup history. When the new storage capacity becomes available, you are billed only for the new storage capacity. The following illustration shows the four main steps of the process that Amazon FSx uses when increasing a file system's storage capacity. Managing storage capacity 149 Amazon FSx for Windows File Server Windows User Guide You can track the progress of storage optimization, SSD storage capacity increases, or SSD IOPS updates at any time using the Amazon FSx console, CLI, or API. For more information, see Monitoring storage capacity increases. What to know about increasing a file system's storage capacity Here are a few important items to consider when increasing storage capacity: Managing storage capacity 150 Amazon FSx for Windows |
WindowsGuide-062 | WindowsGuide.pdf | 62 | The following illustration shows the four main steps of the process that Amazon FSx uses when increasing a file system's storage capacity. Managing storage capacity 149 Amazon FSx for Windows File Server Windows User Guide You can track the progress of storage optimization, SSD storage capacity increases, or SSD IOPS updates at any time using the Amazon FSx console, CLI, or API. For more information, see Monitoring storage capacity increases. What to know about increasing a file system's storage capacity Here are a few important items to consider when increasing storage capacity: Managing storage capacity 150 Amazon FSx for Windows File Server Windows User Guide • Increase only – You can only increase the amount of storage capacity for a file system; you can't decrease storage capacity. • Minimum increase – Each storage capacity increase must be a minimum of 10 percent of the file system's current storage capacity, up to the maximum allowed value of 65,536 GiB. • Minimum throughput capacity – To increase storage capacity, a file system must have a minimum throughput capacity of 16 MBps. This is because the storage optimization step is a throughput-intensive process. • Time between increases – You can't make further storage capacity increases on a file system until 6 hours after the last increase was requested, or until the storage optimization process has completed, whichever time is longer. Storage optimization can take from a few hours up to a few days to complete. To minimize the time it takes for storage optimization to complete, we recommend increasing your file system's throughput capacity before increasing storage capacity (the throughput capacity can be scaled back down after storage scaling completes), and increasing storage capacity when there is minimal traffic on the file system. Note Certain file system events can consume disk I/O performance resources For example: The optimization phase of storage capacity scaling can generate increased disk throughput, and potentially cause performance warnings. For more information, see Performance warnings and recommendations. Knowing when to increase storage capacity Increase your file system's storage capacity when it's running low on free storage capacity. Use the FreeStorageCapacity CloudWatch metric to monitor the amount of free storage available on the file system. You can create an Amazon CloudWatch alarm on this metric and get notified when it drops below a specific threshold. For more information, see Monitoring with Amazon CloudWatch. We recommend maintaining at least 20% of free storage capacity at all times on your file system. Using all of your storage capacity can negatively impact your performance and might introduce data inconsistencies. You can automatically increase your file system's storage capacity when the amount of free storage capacity falls below a defined threshold that you specify. Use the AWS‐developed custom AWS Managing storage capacity 151 Amazon FSx for Windows File Server Windows User Guide CloudFormation template to deploy all of the components required to implement the automated solution. For more information, see Increasing storage capacity dynamically. Storage capacity increases and file system performance Most workloads experience minimal performance impact while Amazon FSx runs the storage optimization process in the background after the new storage capacity is available. However, file systems with HDD storage type and workloads involving large numbers of end users, high levels of I/O, or datasets that have large numbers of small files could temporarily experience reduction in the performance. For these cases, we recommend that you first increase your file system's throughput capacity before increasing storage capacity. For these types of workloads, we also recommend changing throughput capacity during idle periods when there is minimal load on your file system. This enables you to continue providing the same level of throughput to meet your application’s performance needs. For more information, see Managing throughput capacity. Managing your file system's storage type You can change your file system storage type from HDD to SSD using the AWS Management Console and AWS CLI. When you change the storage type to SSD, keep in mind that you can't update your file system configuration again until 6 hours after the last update was requested, or until the storage optimization process is complete—whichever time is longer. Storage optimization can take between a few hours and a few days to complete. To minimize this time, we recommend updating your storage type when there is minimal traffic on your file system. For more information, see Updating the storage type of a FSx for Windows file system. You can't change your file system storage type from SSD to HDD. If you want to change a file system's storage type from SSD to HDD, you will need to restore a backup of the file system to a new file system that you configure to use HDD storage. For more information, see Restoring backups to new file system. About storage types You can configure |
WindowsGuide-063 | WindowsGuide.pdf | 63 | complete. To minimize this time, we recommend updating your storage type when there is minimal traffic on your file system. For more information, see Updating the storage type of a FSx for Windows file system. You can't change your file system storage type from SSD to HDD. If you want to change a file system's storage type from SSD to HDD, you will need to restore a backup of the file system to a new file system that you configure to use HDD storage. For more information, see Restoring backups to new file system. About storage types You can configure your FSx for Windows File Server file system to use either the solid state drive (SSD) or the magnetic hard disk drive (HDD) storage type. SSD storage is appropriate for most production workloads that have high performance requirements and latency-sensitivity. Examples of these workloads include databases, data analytics, media processing, and business applications. We also recommend SSD for use cases involving large numbers of end users, high levels of I/O, or datasets that have large numbers of Managing storage types 152 Amazon FSx for Windows File Server Windows User Guide small files. Lastly, we recommend using SSD storage if you plan to enable shadow copies. You can configure and scale SSD IOPS for file systems with SSD storage, but not HDD storage. HDD storage is designed for a broad range of workloads—including home directories, user and departmental file shares, and content management systems. HDD storage comes at a lower cost relative to SSD storage, but with higher latencies and lower levels of disk throughput and disk IOPS per unit of storage. It might be suitable for general-purpose user shares and home directories with low I/O requirements, large content management systems (CMS) where data is retrieved infrequently, or datasets with small numbers of large files. For more information, see Storage configuration & performance. Managing SSD IOPS For file systems configured with SSD storage, the amount of SSD IOPS determines the amount of disk I/O available when your file system has to read data from and write data to disk, as opposed to data that is in cache. You can select and scale the amount of SSD IOPS independently of storage capacity. The maximum SSD IOPS that you can provision is dependent on the amount of storage capacity and throughput capacity you select for your file system. If you attempt to increase your SSD IOPS above the limit that's supported by your throughput capacity, you might need to increase your throughput capacity to get that level of SSD IOPS. For more information, see FSx for Windows File Server performance and Managing throughput capacity. Here are a few important items to know about updating a file system's provisioned SSD IOPS: • Choosing an IOPS mode – there are two IOPS modes to choose from: • Automatic – choose this mode and Amazon FSx will automatically scale your SSD IOPS to maintain 3 SSD IOPS per GiB of storage capacity, up to 400,000 SSD IOPS per file system. • User-provisioned – choose this mode so that you can specify the number of SSD IOPS within the range of 96–400,000. Specify a number between 3–50 IOPS per GiB of storage capacity for all AWS Regions where Amazon FSx is available, or between 3–500 IOPS per GiB of storage capacity in US East (N. Virginia), US West (Oregon), US East (Ohio), Europe (Ireland), Asia Pacific (Tokyo), and Asia Pacific (Singapore). When you choose the user-provisiohed mode, and the amount of SSD IOPS you specify is not at least 3 IOPS per GiB, the request fails. For higher levels of provisioned SSD IOPS, you pay for the average IOPS above 3 IOPS per GiB per file system. • Storage capacity updates – If you increase your file system's storage capacity, and the amount requires by default an amount of SSD IOPS that is greater than your current user-provisioned Managing SSD IOPS 153 Amazon FSx for Windows File Server Windows User Guide SSD IOPS level, Amazon FSx automatically switches your file system to Automatic mode and your file system will have a minimum of 3 SSD IOPS per GiB of storage capacity. • Throughput capacity updates – If you increase your throughput capacity, and the maximum SSD IOPS supported by your new throughput capacity is higher than your user-provisioned SSD IOPS level, Amazon FSx automatically switches your file system to Automatic mode. • Frequency of SSD IOPS increases – You can't make further SSD IOPS increases, throughput capacity increases, or storage type updates on a file system until 6 hours after the last increase was requested, or until the storage optimization process has completed—whichever time is longer. Storage optimization can take from a few hours up to a few days to complete. To minimize the time it takes |
WindowsGuide-064 | WindowsGuide.pdf | 64 | you increase your throughput capacity, and the maximum SSD IOPS supported by your new throughput capacity is higher than your user-provisioned SSD IOPS level, Amazon FSx automatically switches your file system to Automatic mode. • Frequency of SSD IOPS increases – You can't make further SSD IOPS increases, throughput capacity increases, or storage type updates on a file system until 6 hours after the last increase was requested, or until the storage optimization process has completed—whichever time is longer. Storage optimization can take from a few hours up to a few days to complete. To minimize the time it takes for storage optimization to complete, we recommend scaling SSD IOPS when there is minimal traffic on the file system. Note Note that throughput capacity levels of 4,608 MBps and higher are supported only in the following AWS Regions: US East (N. Virginia), US West (Oregon), US East (Ohio), Europe (Ireland), Asia Pacific (Tokyo), and Asia Pacific (Singapore). For more information about how update the amount of provisioned SSD IOPS for your FSx for Windows File Server file system, see Updating a file system's SSD IOPS. Reducing storage costs with Data Deduplication Data Deduplication, often referred to as Dedup for short, helps storage administrators reduce costs that are associated with duplicated data. With FSx for Windows File Server, you can use Microsoft Data Deduplication to identify and eliminate redundant data. Large datasets often have redundant data, which increases the data storage costs. For example: • User file shares may have many copies of the same or similar files. • Software development shares can have many binaries that remain unchanged from build to build. You can reduce your data storage costs by enabling data deduplication for your file system. Data deduplication reduces or eliminates redundant data by storing duplicated portions of the dataset only once. When you enable Data Deduplication, Data compression is enabled by default, Data deduplication 154 Amazon FSx for Windows File Server Windows User Guide compressing the data after deduplication for additional savings. Data Deduplication optimizes redundancies without compromising data fidelity or integrity. Data deduplication runs as a background process that continually and automatically scans and optimizes your file system, and it is transparent to your users and connected clients. The storage savings that you can achieve with data deduplication depends on the nature of your dataset, including how much duplication exists across files. Typical savings average 50–60 percent for general-purpose file shares. Within shares, savings range from 30–50 percent for user documents to 70–80 percent for software development datasets. You can measure potential deduplication savings using the Measure-FSxDedupFileMetadata remote PowerShell command described below. You can also customize data deduplication to meet your specific storage needs. For example, you can configure deduplication to run only on certain file types, or you can create a custom job schedule. Because deduplication jobs can consume file server resources, we recommend monitoring the status of your deduplication jobs using the Get-FSxDedupStatus. For information about configuring data deduplication on your file system, see Managing data deduplication. For information on resolving issues related to data deduplication, see Use the following information to help troubleshoot some common issues when configuring and using data deduplication. Topics • Data deduplication is not working • Deduplication values are unexpectedly set to 0 • Space is not freed up on file system after deleting files Data deduplication is not working To see the current status of data deduplication, run the Get-FSxDedupStatus PowerShell command to view the completion status for the most recent deduplication jobs. If one or more jobs is failing, you may not see an increase in free storage capacity on your file system. The most common reason for deduplication jobs failing is insufficient memory. Data deduplication 155 Amazon FSx for Windows File Server Windows User Guide • Microsoft recommends optimally having 1 GB of memory per 1 TB of logical data (or at a minimum 350 MB per 1 TB of logical data). Use the Amazon FSx performance table to determine the memory associated with your file system's throughput capacity and ensure the memory resources are sufficient for the size of your data. If it is not, you need to increase the file system's throughput capacity to the level that meets the memory requirements of 1 GB per 1 TB of logical data. • Deduplication jobs are configured with the Windows recommended default of 25% memory allocation, which means that for a file system with 32 GB of memory, 8 GB will be available for deduplication. The memory allocation is configurable (using the Set-FSxDedupSchedule command with parameter –Memory). Be aware that using a higher memory allocation for dedup may impact file system performance. • You can modify the configuration of deduplication jobs to reduce the amount of memory required. For example, you can constrain the optimization to run |
WindowsGuide-065 | WindowsGuide.pdf | 65 | level that meets the memory requirements of 1 GB per 1 TB of logical data. • Deduplication jobs are configured with the Windows recommended default of 25% memory allocation, which means that for a file system with 32 GB of memory, 8 GB will be available for deduplication. The memory allocation is configurable (using the Set-FSxDedupSchedule command with parameter –Memory). Be aware that using a higher memory allocation for dedup may impact file system performance. • You can modify the configuration of deduplication jobs to reduce the amount of memory required. For example, you can constrain the optimization to run on specific file types or folders, or set a minimum file size and age for optimization. We also recommend configuring deduplication jobs to run during idle periods when there is minimal load on your file system. You may also see errors if deduplication jobs have insufficient time to complete. You may need to change the maximum duration of jobs, as described in Modifying a data deduplication schedule. If deduplication jobs have been failing for a long period of time, and there have been changes to the data on the file system during this period, subsequent deduplication jobs may require more resources to complete successfully for the first time. Deduplication values are unexpectedly set to 0 The values for SavedSpace and OptimizedFilesSavingsRate are unexpectedly 0 for a file system on which you have configured data deduplication. This can occur during the storage optimization process when you increase the file system's storage capacity. When you increase a file system's storage capacity, Amazon FSx cancels existing data deduplication jobs during the storage optimization process, which migrates data from the old disks to the new, larger disks. Amazon FSx resumes data deduplication on the file system once the storage optimization job completes. For more information about increasing storage capacity and storage optimization, see Managing storage capacity. Data deduplication 156 Amazon FSx for Windows File Server Windows User Guide Space is not freed up on file system after deleting files The expected behavior of data deduplication is that if the data that was deleted was something that dedup had saved space on, then the space is not actually freed up on your file system until the garbage collection job runs. A practice you may find helpful is to set the schedule to run the garbage collection job right after you delete a large number of files. After the garbage collection job finishes, you can set the garbage collection schedule back to its original settings. This ensures you can quickly see the space from your deletions immediately. Use the following procedure to set the garbage collection job to run in 5 minutes. 1. To verify that data deduplication is enabled, use the Get-FSxDedupStatus command. For more information on the command and its expected output, see Viewing the amount of saved space. 2. Use the following to set the schedule to run the garbage collection job 5 minutes from now. $FiveMinutesFromNowUTC = ((get-date).AddMinutes(5)).ToUniversalTime() $DayOfWeek = $FiveMinutesFromNowUTC.DayOfWeek $Time = $FiveMinutesFromNowUTC.ToString("HH:mm") Invoke-Command -ComputerName ${RPS_ENDPOINT} -ConfigurationName FSxRemoteAdmin - ScriptBlock { Set-FSxDedupSchedule -Name "WeeklyGarbageCollection" -Days $Using:DayOfWeek - Start $Using:Time -DurationHours 9 } 3. After the garbage collection job has run and the space has been freed up, set the schedule back to its original settings. . For more information about data deduplication, see the Microsoft Understanding Data Deduplication documentation. Data deduplication 157 Amazon FSx for Windows File Server Windows User Guide Warning It is not recommended to run certain Robocopy commands with data deduplication because these commands can impact the data integrity of the Chunk Store. For more information, see the Microsoft Data Deduplication interoperability documentation. Best practices when using data deduplication Here are some best practices for using Data Deduplication: • Schedule Data Deduplication jobs to run when your file system is idle: The default schedule includes a weekly GarbageCollection job at 2:45 UTC on Saturdays. It can take multiple hours to complete if you have a large amount of data churn on your file system. If this time isn't ideal for your workload, schedule this job to run at a time when you expect low traffic on your file system. • Configure sufficient throughput capacity for Data Deduplication to complete: Higher throughput capacities provide higher levels of memory. Microsoft recommends having 1 GB of memory per 1 TB of logical data to run Data Deduplication. Use the Amazon FSx performance table to determine the memory that's associated with your file system's throughput capacity and ensure that the memory resources are sufficient for the size of your data. • Customize Data Deduplication settings to meet your specific storage needs and reduce performance requirements: You can constrain the optimization to run on specific file types or folders, or set a minimum file size and age for optimization. To learn more, see |
WindowsGuide-066 | WindowsGuide.pdf | 66 | complete: Higher throughput capacities provide higher levels of memory. Microsoft recommends having 1 GB of memory per 1 TB of logical data to run Data Deduplication. Use the Amazon FSx performance table to determine the memory that's associated with your file system's throughput capacity and ensure that the memory resources are sufficient for the size of your data. • Customize Data Deduplication settings to meet your specific storage needs and reduce performance requirements: You can constrain the optimization to run on specific file types or folders, or set a minimum file size and age for optimization. To learn more, see Reducing storage costs with Data Deduplication. Managing storage quotas You can configure user storage quotas on your file systems to limit how much data storage that users can consume. After you set quotas, you can track quota status to monitor usage and see when users surpass their quotas. You can also enforce quotas by stopping users who reach their quotas from writing to the storage space. When you enforce quotas, a user that exceeds their quota receives an "insufficient disk space" error message. You can set these thresholds for quota settings: Managing storage quotas 158 Amazon FSx for Windows File Server Windows User Guide • Warning – used to track whether a user or group is approaching their quota limit, relevant for tracking only. • Limit – the storage quota limit for a user or group. You can configure default quotas that are applied to new users who access a file system and quotas that apply to specific users or groups. You can also view a report of how much storage each user or group is consuming and whether they're surpassing their quotas. Storage consumption at a user level is tracked based on file ownership. Storage consumption is calculated using logical file size, not the actual physical storage space that files occupy. User storage quotas are tracked at the time when data is written to a file. Updating quotas for multiple users requires either running the update command once for each user, or organizing the users into a group and updating the quota for that group. You can manage user storage quotas on your file system using the Amazon FSx CLI for remote management on PowerShell. To learn how to use this CLI, see Using the Amazon FSx CLI for PowerShell. Following are commands that you can use to manage user storage quotas. User storage quotas command Description Enable-FSxUserQuotas Starts tracking or enforcing user storage quotas, or both. Disable-FSxUserQuotas Stops tracking and enforcement for user storage quotas. Get-FSxUserQuotaSettings Retrieves the current user-storage quota settings for the file system. Get-FSxUserQuotaEntries Retrieves the current user-storage quota entries for individual users and groups on the file system. Set-FSxUserQuotas Set the user storage quota for an individual user or group. Quota values are specified in bytes. The online help for each command provides a reference of all command options. To access this help, run the command with -?, for example Enable-FSxUserQuotas -?. Managing storage quotas 159 Amazon FSx for Windows File Server Windows User Guide Increasing file system storage capacity You can increase your FSx for Windows File Server file system's storage capacity as your storage requirements change. Use the Amazon FSx console, the AWS CLI, or the Amazon FSx API to increase a file system's storage capacity as described in the following procedures. For more information, see Managing storage capacity. To increase storage capacity for a file system (console) 1. Open the Amazon FSx console at https://console.aws.amazon.com/fsx/. 2. Navigate to File systems and choose the Windows file system that you want to increase storage capacity for. 3. For Actions, choose Update storage. Or, in the Summary panel, choose Update next to the file system's Storage capacity. The Update storage capacity window appears. 4. For Input type, choose Percentage to enter the new storage capacity as a percentage change from the current value, or choose Absolute to enter the new value in GiB. 5. Enter the Desired storage capacity. Note The desired capacity value must be at least 10 percent larger than the current value, up to the maximum value of 65,536 GiB. 6. Choose Update to initiate the storage capacity update. 7. You can monitor the update progress on the File systems detail page, in the Updates tab. To increase storage capacity for a file system (CLI) To increase the storage capacity for an FSx for Windows File Server file system, use the AWS CLI command update-file-system. Set the following parameters: • --file-system-id to the ID of the file system you are updating. • --storage-capacity to a value that is at least 10 percent greater than the current value. Increasing storage capacity 160 Amazon FSx for Windows File Server Windows User Guide You can monitor the progress of the update by using the |
WindowsGuide-067 | WindowsGuide.pdf | 67 | can monitor the update progress on the File systems detail page, in the Updates tab. To increase storage capacity for a file system (CLI) To increase the storage capacity for an FSx for Windows File Server file system, use the AWS CLI command update-file-system. Set the following parameters: • --file-system-id to the ID of the file system you are updating. • --storage-capacity to a value that is at least 10 percent greater than the current value. Increasing storage capacity 160 Amazon FSx for Windows File Server Windows User Guide You can monitor the progress of the update by using the AWS CLI command describe-file-systems. Look for the administrative-actions in the output. For more information, see AdministrativeAction. Monitoring storage capacity increases After increasing your file system's storage capacity, you can monitor the progress of the storage capacity increase using the Amazon FSx console, the API, or the AWS CLI as described in the following procedures. Monitoring increases in the console In the Updates tab in the File system details window, you can view the 10 most recent updates for each update type. For storage capacity updates, you can view the following information. Update type Possible values are Storage capacity. Target value The desired value to update the file system's storage capacity to. Status The current status of the update. For storage capacity updates, the possible values are as follows: • Pending – Amazon FSx has received the update request, but has not started processing it. • In progress – Amazon FSx is processing the update request. • Updated optimizing – Amazon FSx has increased the file system's storage capacity. The storage optimization process is now moving the file system data to the new larger disks. • Completed – The storage capacity increase completed successfully. • Failed – The storage capacity increase failed. Choose the question mark (?) to see details on why the storage update failed. Progress % Displays the progress of the storage optimization process as percent complete. Monitoring storage increases 161 Amazon FSx for Windows File Server Request time Windows User Guide The time that Amazon FSx received the update action request. Monitoring increases with the AWS CLI and API You can view and monitor file system storage capacity increase requests using the describe-file-systems AWS CLI command and the DescribeFileSystems API action. The AdministrativeActions array lists the 10 most recent update actions for each administrative action type. When you increase a file system's storage capacity, two AdministrativeActions are generated: a FILE_SYSTEM_UPDATE and a STORAGE_OPTIMIZATION action. The following example shows an excerpt of the response of a describe-file-systems CLI command. The file system has a storage capacity of 300 GB, and there is a pending administrative action to increase the storage capacity to 1000 GB. { "FileSystems": [ { "OwnerId": "111122223333", . . . "StorageCapacity": 300, "AdministrativeActions": [ { "AdministrativeActionType": "FILE_SYSTEM_UPDATE", "RequestTime": 1581694764.757, "Status": "PENDING", "TargetFileSystemValues": { "StorageCapacity": 1000 } }, { "AdministrativeActionType": "STORAGE_OPTIMIZATION", "RequestTime": 1581694764.757, "Status": "PENDING", } ] Monitoring storage increases 162 Amazon FSx for Windows File Server Windows User Guide Amazon FSx processes the FILE_SYSTEM_UPDATE action first, adding the new larger storage disks to the file system. When the new storage is available to the file system, the FILE_SYSTEM_UPDATE status changes to UPDATED_OPTIMIZING. The storage capacity shows the new larger value, and Amazon FSx begins processing the STORAGE_OPTIMIZATION administrative action. This is shown in the following excerpt of the response of a describe-file-systems CLI command. The ProgressPercent property displays the progress of the storage optimization process. After the storage optimization process completes successfully, the status of the FILE_SYSTEM_UPDATE action changes to COMPLETED, and the STORAGE_OPTIMIZATION action no longer appears. { "FileSystems": [ { "OwnerId": "111122223333", . . . "StorageCapacity": 1000, "AdministrativeActions": [ { "AdministrativeActionType": "FILE_SYSTEM_UPDATE", "RequestTime": 1581694764.757, "Status": "UPDATED_OPTIMIZING", "TargetFileSystemValues": { "StorageCapacity": 1000 } }, { "AdministrativeActionType": "STORAGE_OPTIMIZATION", "RequestTime": 1581694764.757, "Status": "IN_PROGRESS", "ProgressPercent": 50, } ] If the storage capacity increase fails, the status of the FILE_SYSTEM_UPDATE action changes to FAILED. The FailureDetails property provides information about the failure, shown in the following example. { Monitoring storage increases 163 Amazon FSx for Windows File Server "FileSystems": [ { "OwnerId": "111122223333", . . . "StorageCapacity": 300, "AdministrativeActions": [ { Windows User Guide "AdministrativeActionType": "FILE_SYSTEM_UPDATE", "FailureDetails": { "Message": "string" }, "RequestTime": 1581694764.757, "Status": "FAILED", "TargetFileSystemValues": "StorageCapacity": 1000 } ] For information about troubleshooting failed actions, see Storage or throughput capacity updates fail. Increasing the storage capacity of an FSx for Windows File Server file system dynamically As an alternative to manually increasing your FSx for Windows File Server file system's storage capacity as the amount of data stored increases, you can use a AWS CloudFormation template to increase storage automatically. The solution presented in the this section dynamically increases a file system's storage capacity when the amount of free storage capacity falls below a defined threshold that you specify. |
WindowsGuide-068 | WindowsGuide.pdf | 68 | }, "RequestTime": 1581694764.757, "Status": "FAILED", "TargetFileSystemValues": "StorageCapacity": 1000 } ] For information about troubleshooting failed actions, see Storage or throughput capacity updates fail. Increasing the storage capacity of an FSx for Windows File Server file system dynamically As an alternative to manually increasing your FSx for Windows File Server file system's storage capacity as the amount of data stored increases, you can use a AWS CloudFormation template to increase storage automatically. The solution presented in the this section dynamically increases a file system's storage capacity when the amount of free storage capacity falls below a defined threshold that you specify. This AWS CloudFormation template automatically deploys all of the components that are required to define the free storage capacity threshold, the Amazon CloudWatch alarm based on this threshold, and the AWS Lambda function that increases the file system’s storage capacity. The solution takes in the following parameters: • The file system ID • The free storage capacity threshold (numerical value) • Unit of measurement (percentage [default] or GiB) Increasing storage capacity dynamically 164 Amazon FSx for Windows File Server Windows User Guide • The percentage by which to increase the storage capacity (%) • The email address for the SNS subscription • Adjust alarm threshold (Yes/No) Topics • Architecture overview • AWS CloudFormation template • Automated deployment with AWS CloudFormation Architecture overview Deploying this solution builds the following resources in the AWS Cloud. The diagram illustrates the following steps: 1. The AWS CloudFormation template deploys a CloudWatch alarm, an AWS Lambda function, an Amazon Simple Notification Service (Amazon SNS) queue, and all required AWS Identity and Increasing storage capacity dynamically 165 Amazon FSx for Windows File Server Windows User Guide Access Management (IAM) roles. The IAM role gives the Lambda function permission to invoke the Amazon FSx API operations. 2. CloudWatch triggers an alarm when the file system’s free storage capacity goes below the specified threshold, and sends a message to the Amazon SNS queue. 3. The solution then triggers the Lambda function that is subscribed to this Amazon SNS topic. 4. The Lambda function calculates the new file system storage capacity based on the specified percent increase value and sets the new file system storage capacity. 5. The Lambda function can optionally adjust the free storage capacity threshold so that it is equal to a specified percentage of the file system’s new storage capacity. 6. The original CloudWatch alarm state and results of the Lambda function operations are sent to the Amazon SNS queue. To receive notifications about the actions that are performed as a response to the CloudWatch alarm, you must confirm the Amazon SNS topic subscription by following the link provided in the Subscription Confirmation email. AWS CloudFormation template This solution uses AWS CloudFormation to automate deploying the components that are used to automatically increase the storage capacity of an FSx for Windows File Server file system. To use this solution, download the IncreaseFSxSize AWS CloudFormation template. The template uses the Parameters described as follows. Review the template parameters and their default values, and modify them for the needs of your file system. FileSystemId No default value. The ID of the file system for which you want to automatically increase the storage capacity. LowFreeDataStorageCapacityThreshold No default value. Specifies the initial free storage capacity threshold at which to trigger an alarm and automatically increase the file system's storage capacity, specified in GiB or as a percentage (%) of the file system's current storage capacity. When expressed as a percentage, the CloudFormation template re-calculates to GiB to match the CloudWatch alarm settings. Increasing storage capacity dynamically 166 Amazon FSx for Windows File Server Windows User Guide LowFreeDataStorageCapacityThresholdUnit Default is %. Specifies the units for the LowFreeDataStorageCapacityThreshold, either in GiB or as a percentage of the current storage capacity. AlarmModificationNotification Default is Yes. If set to Yes, the initial LowFreeDataStorageCapacityThreshold, is increased proportionally to the value of PercentIncrease for subsequent alarm thresholds. For example, when PercentIncrease is set to 20, and AlarmModificationNotification is set to Yes, the available free space threshold (LowFreeDataStorageCapacityThreshold) specified in GiB is increased by 20% for subsequent storage capacity increase events. EmailAddress No default value. Specifies the email address to use for the SNS subscription and receives storage capacity threshold alerts. PercentIncrease No default value. Specifies the amount by which to increase the storage capacity, expressed as a percentage of the current storage capacity. Automated deployment with AWS CloudFormation The following procedure configures and deploys an AWS CloudFormation stack to automatically increase the storage capacity of an FSx for Windows File Server file system. It takes about 5 minutes to deploy. Note Implementing this solution incurs billing for the associated AWS services. For more information, see the pricing details pages for those services. Before you start, you must have the ID of the Amazon FSx file |
WindowsGuide-069 | WindowsGuide.pdf | 69 | receives storage capacity threshold alerts. PercentIncrease No default value. Specifies the amount by which to increase the storage capacity, expressed as a percentage of the current storage capacity. Automated deployment with AWS CloudFormation The following procedure configures and deploys an AWS CloudFormation stack to automatically increase the storage capacity of an FSx for Windows File Server file system. It takes about 5 minutes to deploy. Note Implementing this solution incurs billing for the associated AWS services. For more information, see the pricing details pages for those services. Before you start, you must have the ID of the Amazon FSx file system running in an Amazon Virtual Private Cloud (Amazon VPC) in your AWS account. For more information about creating Amazon FSx resources, see Getting started with Amazon FSx for Windows File Server. Increasing storage capacity dynamically 167 Amazon FSx for Windows File Server Windows User Guide To launch the automatic storage capacity increase solution stack 1. Download the IncreaseFSxSize AWS CloudFormation template. For more information about creating a CloudFormation stack, see Creating a stack on the AWS CloudFormation console in the AWS CloudFormation User Guide. Note Amazon FSx is currently only available in specific AWS Regions. You must launch this solution in an AWS Region where Amazon FSx is available. For more information, see Amazon FSx endpoints and quotas in the AWS General Reference. 2. In Specify stack details, enter the values for your automatic storage capacity increase solution. Increasing storage capacity dynamically 168 Amazon FSx for Windows File Server Windows User Guide 3. 4. 5. 6. Enter a Stack name. For Parameters, review the parameters for the template and modify them for the needs of your file system. Then choose Next. Enter any Options settings that you want for your custom solution, and then choose Next. For Review, review and confirm the solution settings. You must select the check box acknowledging that the template creates IAM resources. 7. Choose Create to deploy the stack. Increasing storage capacity dynamically 169 Amazon FSx for Windows File Server Windows User Guide You can view the status of the stack in the AWS CloudFormation console in the Status column. You should see a status of CREATE_COMPLETE in about 5 minutes. Updating the stack After the stack is created, you can update it by using the same template and providing new values for the parameters. For more information, see Updating stacks directly in the AWS CloudFormation User Guide. Updating the storage type of a FSx for Windows file system You can change the storage type of a file system that uses HDD storage to use SSD storage. You can use the the Amazon FSx console, the AWS CLI, or the Amazon FSx API to change a file system's storage type, as shown in the following procedures. For more information, see Managing your file system's storage type. To update a file system's storage type (console) 1. Open the Amazon FSx console at https://console.aws.amazon.com/fsx/. 2. Navigate to File systems and choose the Windows file system that you want to update the storage type for. 3. Under Actions, choose Update storage type. Or, in the Summary panel, select the Update button next to HDD. The Update storage type window appears. 4. For Desired storage type, choose SSD. Choose Update to initiate the storage type update. You can monitor the progress of the storage type update using the console and the CLI. To update a file system's storage type (CLI) To update storage type for an FSx for Windows File Server file system, use the AWS CLI command update-file-system. Set the following parameters: • --file-system-id to the ID of the file system that you want to update. • --storage-type to SSD. You can't switch from SSD storage type to HDD storage type. You can monitor the progress of the update by using the AWS CLI command describe-file-systems. Look for the administrative-actions in the output. Updating storage type 170 Amazon FSx for Windows File Server Windows User Guide For more information, see AdministrativeAction. Monitoring storage type updates After you update your file system's storage type from HDD to SSD storage, you can monitor the progress of the storage type update using the Amazon FSx console, the AWS CLI, or the API, as described in the following procedures. Monitoring file system updates in the console On the Updates tab in the File system details window, you can view the 10 most recent updates for each update type. For storage type updates, you can view the following information. Update type Possible value is Storage type. Target value SSD Status The current status of the update. For storage type updates, the possible values are as follows: • Pending – Amazon FSx received the update request, but has not started processing it. • In progress – Amazon FSx is processing the update request. |
WindowsGuide-070 | WindowsGuide.pdf | 70 | the API, as described in the following procedures. Monitoring file system updates in the console On the Updates tab in the File system details window, you can view the 10 most recent updates for each update type. For storage type updates, you can view the following information. Update type Possible value is Storage type. Target value SSD Status The current status of the update. For storage type updates, the possible values are as follows: • Pending – Amazon FSx received the update request, but has not started processing it. • In progress – Amazon FSx is processing the update request. • Updated optimizing – The SSD storage performance is available for write operations. The update enters an Updated optimizing state, which typically lasts a few hours, during which read operations will have performance levels between HDD and SSD. Once your update action is complete, your new SSD performance is available for both reads and writes. • Completed – The storage type update completed successfully. • Failed – The storage type update failed. Choose the question mark (?) to see details. Progress % Displays the progress of the storage optimization process by the percentage that's complete. Request time The time that Amazon FSx received the update action request. Monitoring storage type updates 171 Amazon FSx for Windows File Server Windows User Guide Monitoring updates with the AWS CLI and API You can view and monitor file system storage type update requests using the describe-file-systems AWS CLI command and the DescribeFileSystems API action. The AdministrativeActions array lists the 10 most recent update actions for each administrative action type. When you increase a file system's SSD IOPS, two AdministrativeActions are generated: a FILE_SYSTEM_UPDATE and a STORAGE_TYPE_OPTIMIZATION action. Updating a file system's SSD IOPS For file systems configured with SSD storage, the level of provisioned SSD IOPS determines the amount of disk I/O available when your file system has to read data from and write data to disk, as opposed to reading or writing data that is in cache. You can update SSD IOPS for a file system using the Amazon FSx console, the AWS CLI, or the Amazon FSx API, as described in the following procedures. For more information about managing SSD IOPS, see Managing SSD IOPS. To update SSD IOPS for a file system (console) 1. Open the Amazon FSx console at https://console.aws.amazon.com/fsx/. 2. Navigate to File systems and choose the Windows file system that you want to update SSD IOPS for. 3. Under Actions, choose Update SSD IOPS. Or, in the Summary panel, select the Update button next to Provisioned SSD IOPS. The Update IOPS provisioning window opens. 4. For Mode, choose Automatic or User-provisioned. If you choose Automatic, Amazon FSx automatically provisions 3 SSD IOPS per GiB of storage capacity for your file system. If you choose User-provisioned, enter any whole number in the range of 96–400,000. 5. Choose Update to initiate the provisioned SSD IOPS update. 6. You can monitor the update progress on the File systems detail page, on the Updates tab. To update SSD IOPS for a file system (CLI) To update SSD IOPS for an FSx for Windows File Server file system, use the --windows- configuration DiskIopsConfiguration property. This property has two parameters, Iops and Mode: • If you want to specify the number of SSD IOPS, use Iops=number_of_IOPS, up to a maximum of 400,000 in supported AWS Regions and Mode=USER_PROVISIONED. Updating the SSD IOPS 172 Amazon FSx for Windows File Server Windows User Guide • If you want Amazon FSx to increase your SSD IOPS automatically, use Mode=AUTOMATIC and don't use the Iops parameter. Amazon FSx automatically maintains 3 SSD IOPS per GiB of storage capacity on your file system, up to a maximum of 400,000 in supported AWS Regions. You can monitor the progress of the update by using the AWS CLI command describe-file-systems. Look for the administrative-actions in the output. For more information, see AdministrativeAction. Monitoring provisioned SSD IOPS updates After you update the amount of provisioned SSD IOPS for your file system, you can monitor the progress of the SSD IOPS update using the Amazon FSx console, the AWS CLI, and the API, as described in the following procedures. Monitoring updates in the console In the Updates tab in the File system details window, you can view the 10 most recent updates for each update type. For provisioned SSD IOPS updates, you can view the following information. Update type Possible values are IOPS Mode and SSD IOPS. Target value The desired value to update the file system's IOPS mode and SSD IOPS to. Status The current status of the update. For SSD IOPS updates, the possible values are as follows: • Pending – Amazon FSx has received the update request, but has not started processing it. • In progress – Amazon FSx |
WindowsGuide-071 | WindowsGuide.pdf | 71 | the console In the Updates tab in the File system details window, you can view the 10 most recent updates for each update type. For provisioned SSD IOPS updates, you can view the following information. Update type Possible values are IOPS Mode and SSD IOPS. Target value The desired value to update the file system's IOPS mode and SSD IOPS to. Status The current status of the update. For SSD IOPS updates, the possible values are as follows: • Pending – Amazon FSx has received the update request, but has not started processing it. • In progress – Amazon FSx is processing the update request. • Updated optimizing – The new IOPS level is available for your workload's write operations. Your update enters an Updated optimizing state, which typically lasts a few hours, during which your workload's read operations have IOPS performance between the previous level and the new level. After your update action is complete, your new IOPS level is available for both reads and writes. Monitoring provisioned SSD IOPS updates 173 Amazon FSx for Windows File Server Windows User Guide • Completed – The SSD IOPS update completed successfully. • Failed – The SSD IOPS update failed. Choose the question mark (?) to see details on why the storage update failed. Progress % Displays the progress of the storage optimization process as percent complete. Request time The time that Amazon FSx received the update action request. Monitoring updates with the AWS CLI and API You can view and monitor file system SSD IOPS update requests using the describe-file-systems AWS CLI command and the DescribeFileSystems API action. The AdministrativeActions array lists the 10 most recent update actions for each administrative action type. When you increase a file system's SSD IOPS, two AdministrativeActions are generated: a FILE_SYSTEM_UPDATE and an IOPS_OPTIMIZATION action. Managing data deduplication You can manage your file system's data deduplication settings using the Amazon FSx CLI for remote management on PowerShell. For more information about using the Amazon FSx CLI remote management on PowerShell, see Using the Amazon FSx CLI for PowerShell. Following are commands that you can use for data deduplication. Data deduplication command Enable-FSxDedup Description Enables data deduplication on the file share. Data compression after deduplication is enabled by default when you enable data deduplication. Disable-FSxDedup Disables data deduplication on the file share. Get-FSxDedupConfiguration Retrieves deduplication configuration information, including Minimum file size and age for optimization, compression settings, and Excluded file types and folders. Managing data deduplication 174 Amazon FSx for Windows File Server Windows User Guide Data deduplication command Description Set-FSxDedupConfiguration Changes the deduplication configuration settings, including minimum file size and age for optimization, compression settings, and excluded file types and folders. Get-FSxDedupStatus Retrieve the deduplication status, and include read-only properties that describe optimization savings and status on the file system, times, and completion status for the last dedup jobs on the file system. Get-FSxDedupMetadata Retrieves deduplication optimization metadata. Update-FSxDedupStatus Computes and retrieves updated data deduplication savings information. Measure-FSxDedupFi leMetadata Measures and retrieves the potential storage space that you can reclaim on your file system if you delete a group of folders. Files often have chunks that are shared across other folders, and the deduplication engine calculates which chunks are unique and would be deleted. Get-FSxDedupSchedule Retrieves deduplication schedules that are currently defined. New-FSxDedupSchedule Create and customize a data deduplication schedule. Set-FSxDedupSchedule Change configuration settings for existing data deduplication schedules. Remove-FSxDedupSchedule Delete a deduplication schedule. Get-FSxDedupJob Get status and information for all currently running or queued deduplication jobs. Stop-FSxDedupJob Cancel one or more specified data deduplication jobs. The online help for each command provides a reference of all command options. To access this help, run the command with -?, for example Enable-FSxDedup -?. Managing data deduplication 175 Amazon FSx for Windows File Server Windows User Guide Enabling data deduplication You enable data deduplication on an Amazon FSx for Windows File Server file share using the Enable-FSxDedup command, as follows. PS C:\Users\Admin> Invoke-Command -ComputerName amznfsxzzzzzzzz.corp.example.com - ConfigurationName FSxRemoteAdmin -ScriptBlock {Enable-FsxDedup } When you enable data deduplication, a default schedule and configuration are created. You can create, modify, and remove schedules and configurations using the commands below. You can use the Disable-FSxDedup command to disable data deduplication entirely on your file system. Creating a data deduplication schedule Although the default schedule works well in most cases, you can create a new deduplication schedule by using the New-FsxDedupSchedule command, shown as follows. Data deduplication schedules use UTC time. PS C:\Users\Admin> Invoke-Command -ComputerName amznfsxzzzzzzzz.corp.example.com - ConfigurationName FSxRemoteAdmin -ScriptBlock { New-FSxDedupSchedule -Name "CustomOptimization" -Type Optimization -Days Mon,Wed,Sat - Start 08:00 -DurationHours 7 } This command creates a schedule named CustomOptimization that runs on days Monday, Wednesday, and Saturday, starting the job at 8:00 am (UTC) each day, with a maximum duration of 7 hours, after which the job stops if |
WindowsGuide-072 | WindowsGuide.pdf | 72 | entirely on your file system. Creating a data deduplication schedule Although the default schedule works well in most cases, you can create a new deduplication schedule by using the New-FsxDedupSchedule command, shown as follows. Data deduplication schedules use UTC time. PS C:\Users\Admin> Invoke-Command -ComputerName amznfsxzzzzzzzz.corp.example.com - ConfigurationName FSxRemoteAdmin -ScriptBlock { New-FSxDedupSchedule -Name "CustomOptimization" -Type Optimization -Days Mon,Wed,Sat - Start 08:00 -DurationHours 7 } This command creates a schedule named CustomOptimization that runs on days Monday, Wednesday, and Saturday, starting the job at 8:00 am (UTC) each day, with a maximum duration of 7 hours, after which the job stops if it is still running. Note that creating new, custom deduplication job schedules does not override or remove the existing default schedule. Before creating a custom deduplication job, you may want to disable the default job if you don’t need it. You can disable the default deduplication schedule by using the Set-FsxDedupSchedule command, shown as follows. PS C:\Users\Admin> Invoke-Command -ComputerName amznfsxzzzzzzzz.corp.example.com -ConfigurationName FSxRemoteAdmin -ScriptBlock {Set-FSxDedupSchedule -Name “BackgroundOptimization” -Enabled $false} Managing data deduplication 176 Amazon FSx for Windows File Server Windows User Guide You can remove a deduplication schedule by using the Remove-FSxDedupSchedule -Name "ScheduleName" command. Note that the default BackgroundOptimization deduplication schedule cannot be modified or removed and will need to be disabled instead. Modifying a data deduplication schedule You can modify an existing deduplication schedule by using the Set-FsxDedupSchedule command, shown as follows. PS C:\Users\Admin> Invoke-Command -ComputerName amznfsxzzzzzzzz.corp.example.com - ConfigurationName FSxRemoteAdmin -ScriptBlock { Set-FSxDedupSchedule -Name "CustomOptimization" -Type Optimization -Days Mon,Tues,Wed,Sat -Start 09:00 -DurationHours 9 } This command modifies the existing CustomOptimization schedule to run on days Monday to Wednesday and Saturday, starting the job at 9:00 am (UTC) each day, with a maximum duration of 9 hours, after which the job stops if it is still running. To modify the minimum file age before optimizing setting, use the Set- FSxDedupConfiguration command. Viewing the amount of saved space To view the amount of disk space you are saving from running data deduplication, use the Get- FSxDedupStatus command, as follows. PS C:\Users\Admin> Invoke-Command -ComputerName amznfsxzzzzzzzz.corp.example.com - ConfigurationName FsxRemoteAdmin -ScriptBlock { Get-FSxDedupStatus } | select OptimizedFilesCount,OptimizedFilesSize,SavedSpace,OptimizedFilesSavingsRate OptimizedFilesCount OptimizedFilesSize SavedSpace OptimizedFilesSavingsRate ------------------- ------------------ ---------- ------------------------- 12587 31163594 25944826 83 Managing data deduplication 177 Amazon FSx for Windows File Server Windows User Guide Note The values shown in the command response for following parameters are not reliable, and you should not use these values: Capacity, FreeSpace, UsedSpace, UnoptimizedSize, and SavingsRate. Troubleshooting data deduplication Use the following information to help troubleshoot some common issues when configuring and using data deduplication. Topics • Data deduplication is not working • Deduplication values are unexpectedly set to 0 • Space is not freed up on file system after deleting files Data deduplication is not working To see the current status of data deduplication, run the Get-FSxDedupStatus PowerShell command to view the completion status for the most recent deduplication jobs. If one or more jobs is failing, you may not see an increase in free storage capacity on your file system. The most common reason for deduplication jobs failing is insufficient memory. • Microsoft recommends optimally having 1 GB of memory per 1 TB of logical data (or at a minimum 350 MB per 1 TB of logical data). Use the Amazon FSx performance table to determine the memory associated with your file system's throughput capacity and ensure the memory resources are sufficient for the size of your data. If it is not, you need to increase the file system's throughput capacity to the level that meets the memory requirements of 1 GB per 1 TB of logical data. • Deduplication jobs are configured with the Windows recommended default of 25% memory allocation, which means that for a file system with 32 GB of memory, 8 GB will be available for deduplication. The memory allocation is configurable (using the Set-FSxDedupSchedule command with parameter –Memory). Be aware that using a higher memory allocation for dedup may impact file system performance. Troubleshooting data deduplication 178 Amazon FSx for Windows File Server Windows User Guide • You can modify the configuration of deduplication jobs to reduce the amount of memory required. For example, you can constrain the optimization to run on specific file types or folders, or set a minimum file size and age for optimization. We also recommend configuring deduplication jobs to run during idle periods when there is minimal load on your file system. You may also see errors if deduplication jobs have insufficient time to complete. You may need to change the maximum duration of jobs, as described in Modifying a data deduplication schedule. If deduplication jobs have been failing for a long period of time, and there have been changes to the data on the file system during this period, subsequent deduplication jobs may require more resources to complete |
WindowsGuide-073 | WindowsGuide.pdf | 73 | types or folders, or set a minimum file size and age for optimization. We also recommend configuring deduplication jobs to run during idle periods when there is minimal load on your file system. You may also see errors if deduplication jobs have insufficient time to complete. You may need to change the maximum duration of jobs, as described in Modifying a data deduplication schedule. If deduplication jobs have been failing for a long period of time, and there have been changes to the data on the file system during this period, subsequent deduplication jobs may require more resources to complete successfully for the first time. Deduplication values are unexpectedly set to 0 The values for SavedSpace and OptimizedFilesSavingsRate are unexpectedly 0 for a file system on which you have configured data deduplication. This can occur during the storage optimization process when you increase the file system's storage capacity. When you increase a file system's storage capacity, Amazon FSx cancels existing data deduplication jobs during the storage optimization process, which migrates data from the old disks to the new, larger disks. Amazon FSx resumes data deduplication on the file system once the storage optimization job completes. For more information about increasing storage capacity and storage optimization, see Managing storage capacity. Space is not freed up on file system after deleting files The expected behavior of data deduplication is that if the data that was deleted was something that dedup had saved space on, then the space is not actually freed up on your file system until the garbage collection job runs. A practice you may find helpful is to set the schedule to run the garbage collection job right after you delete a large number of files. After the garbage collection job finishes, you can set the garbage collection schedule back to its original settings. This ensures you can quickly see the space from your deletions immediately. Use the following procedure to set the garbage collection job to run in 5 minutes. 1. To verify that data deduplication is enabled, use the Get-FSxDedupStatus command. For more information on the command and its expected output, see Viewing the amount of saved space. Troubleshooting data deduplication 179 Amazon FSx for Windows File Server Windows User Guide 2. Use the following to set the schedule to run the garbage collection job 5 minutes from now. $FiveMinutesFromNowUTC = ((get-date).AddMinutes(5)).ToUniversalTime() $DayOfWeek = $FiveMinutesFromNowUTC.DayOfWeek $Time = $FiveMinutesFromNowUTC.ToString("HH:mm") Invoke-Command -ComputerName ${RPS_ENDPOINT} -ConfigurationName FSxRemoteAdmin - ScriptBlock { Set-FSxDedupSchedule -Name "WeeklyGarbageCollection" -Days $Using:DayOfWeek - Start $Using:Time -DurationHours 9 } 3. After the garbage collection job has run and the space has been freed up, set the schedule back to its original settings. Using DFS Namespaces DFS Namespaces is a Windows Server role service that you use to group shared folders located on different servers into one or more logically structured namespaces. This makes it possible to give users a virtual view of shared folders, where a single path leads to files located on multiple file systems, as shown in the following diagram. In addition to organizing and unifying access to your file shares across multiple file systems, Group multiple FSx for Windows File Server file systems with DFS Namespaces You can use Microsoft's Distributed File System (DFS) Namespaces to group file shares on multiple FSx for Windows File Server file systems into one common folder structure, or namespace. Using DFS Namespaces, you can scale file storage beyond the maximum storage capacity of single file system (64 TiB) for large file datasets—up to hundreds of petabytes. This section shows you how to set up DFS namespaces on multiple FSx for Windows File Server file systems. DFS Namespaces is a Windows Server role service that you use to group shared folders located on different servers into one or more logically structured namespaces. This makes it possible to give users a virtual view of shared folders, where a single path leads to files located on multiple file systems, as shown in the following diagram. In addition to organizing and unifying access to your file shares across multiple file systems, Using DFS Namespaces 180 Amazon FSx for Windows File Server Windows User Guide For a step-by-step procedure for grouping FSx for Windows file systems using DFS Namespaces, see Group multiple file systems under a single namespace. Improving performance with shards Amazon FSx for Windows File Server supports the use of the Microsoft Distributed File System (DFS). By using DFS Namespaces, you can scale out performance (both read and write) to serve I/ O-intensive workloads by spreading your file data across multiple Amazon FSx file systems. At the same time, you can still present a unified view under a common namespace to your applications. This solution involves dividing your file data into smaller datasets or shards and storing them across different file systems. Applications accessing |
WindowsGuide-074 | WindowsGuide.pdf | 74 | using DFS Namespaces, see Group multiple file systems under a single namespace. Improving performance with shards Amazon FSx for Windows File Server supports the use of the Microsoft Distributed File System (DFS). By using DFS Namespaces, you can scale out performance (both read and write) to serve I/ O-intensive workloads by spreading your file data across multiple Amazon FSx file systems. At the same time, you can still present a unified view under a common namespace to your applications. This solution involves dividing your file data into smaller datasets or shards and storing them across different file systems. Applications accessing your data from multiple instances can achieve high levels of performance by reading and writing to these shards in parallel. You can use the solution provided in Sharding data using DFS Namespaces for scale-out performance to distribute read/write access to your data uniformly across your data multiple FSx for Windows File Server file systems. Group multiple file systems under a single namespace In this procedure, you will create a single domain-based namespace (example.com\corp) on two namespace servers, in order to consolidate file shares stored on multiple FSx for Windows file systems (finance, marketing, sales, home_directories). You will also set up four file shares under the namespace, each transparently redirecting users to shares hosted on separate FSx for Windows file systems. This enables your users to access file shares using a common namespace instead of having to specify the DNS names for each of the file systems hosting the file shares. Improving performance with shards 181 Amazon FSx for Windows File Server Windows User Guide Note Amazon FSx cannot be added to the root of the DFS share path. To group multiple file systems into a common DFS namespace 1. If you don't already have DFS Namespace servers running, you can launch a pair of highly available DFS Namespace servers using the setup-DFSN-servers.template AWS CloudFormation template. For more information on creating an AWS CloudFormation stack, see Creating a Stack on the AWS CloudFormation Console in the AWS CloudFormation User Guide. 2. Connect to one of the DFS Namespace servers launched in the previous step as a user in the AWS Delegated Administrators group. For more information, see Connecting to Your Windows Instance in the Amazon EC2 User Guide. 3. Access the DFS Management Console by opening. Open the Start menu and run dfsmgmt.msc. This opens the DFS Management GUI tool. 4. Choose Action then New Namespace, type in the computer name of the first DFS Namespace server you launched for Server and choose Next. 5. For Name, type in the namespace you're creating (for example, corp). 6. Choose Edit Settings and set the appropriate permissions based on your requirements. Choose Next. 7. Leave the default Domain-based namespace option selected, leave the Enable Windows Server 2008 mode option selected, and choose Next. Note Windows Server 2008 mode is the latest available option for Namespaces. 8. Review the namespace settings and choose Create. 9. With the newly created namespace selected under Namespaces in the navigation bar, choose Action then Add Namespace Server. 10. Type in the computer name of the second DFS Namespace server you launched for Namespace server. 11. Choose Edit Settings, set the appropriate permissions based on your requirements, and choose OK. Group file systems into one namespace 182 Amazon FSx for Windows File Server Windows User Guide 12. Open the context (right-click) menu for the namespace you just created, choose New Folder, type in the name of the folder (for example, finance for Name, and choose OK. 13. Type in the DNS name of the file share that you want the DFS Namespace folder to point to in UNC format (for example, \\fs-0123456789abcdef0.example.com\finance) for Path to folder target and choose OK. 14. If the share doesn't exist: a. b. c. d. Choose Yes to create it. From the Create Share dialog, choose Browse. Choose an existing folder, or create a new folder under D$, and choose OK. Set the appropriate share permissions, and choose OK. 15. From the New Folder dialog, choose OK. The new folder will be created under the namespace. 16. Repeat the last four steps for other folders you want to share under the same namespace. Sharding data using DFS Namespaces for scale-out performance The following procedure guides you through creating a DFS solution on Amazon FSx for scale-out performance. In this example, the data stored in the corp namespace is sharded alphabetically. Data files ‘A-F’, ‘G-M’ and ‘N-Z’ are all stored on different file shares. Based on the type of data, I/ O size, and I/O access pattern, you should decide how to best shard your data across multiple file shares. Choose a sharding convention that distributes I/O evenly across all the file shares you plan on using. Keep in mind that each namespace supports up |
WindowsGuide-075 | WindowsGuide.pdf | 75 | data using DFS Namespaces for scale-out performance The following procedure guides you through creating a DFS solution on Amazon FSx for scale-out performance. In this example, the data stored in the corp namespace is sharded alphabetically. Data files ‘A-F’, ‘G-M’ and ‘N-Z’ are all stored on different file shares. Based on the type of data, I/ O size, and I/O access pattern, you should decide how to best shard your data across multiple file shares. Choose a sharding convention that distributes I/O evenly across all the file shares you plan on using. Keep in mind that each namespace supports up to 50,000 file shares and hundreds of petabytes of storage capacity in aggregate. Sharding data using DFS Namespaces for scale-out performance 183 Amazon FSx for Windows File Server Windows User Guide To set up DFS Namespaces for scale-out performance 1. If you don't already have DFS Namespace servers running, you can launch a pair of highly available DFS Namespace servers using the setup-DFSN-servers.template AWS CloudFormation template. For more information on creating an AWS CloudFormation stack, see Creating a Stack on the AWS CloudFormation Console in the AWS CloudFormation User Guide. 2. Connect to one of the DFS Namespace servers launched in the previous step as a user in the AWS Delegated Administrators group. For more information, see Connecting to Your Windows Instance in the Amazon EC2 User Guide. 3. Access the DFS Management Console. Open the Start menu and run dfsmgmt.msc. This opens the DFS Management GUI tool. 4. Choose Action then New Namespace, type in the computer name of the first DFS Namespace server you launched for Server and choose Next. 5. For Name, type in the namespace you're creating (for example, corp). 6. Choose Edit Settings and set the appropriate permissions based on your requirements. Choose Next. 7. Leave the default Domain-based namespace option selected, leave the Enable Windows Server 2008 mode option selected, and choose Next. Note Windows Server 2008 mode is the latest available option for Namespaces. 8. Review the namespace settings and choose Create. 9. With the newly created namespace selected under Namespaces in the navigation bar, choose Action then Add Namespace Server. 10. Type in the computer name of the second DFS Namespace server you launched for Namespace server. 11. Choose Edit Settings, set the appropriate permissions based on your requirements, and choose OK. 12. Open the context (right-click) menu for the namespace you just created, choose New Folder, enter the name of the folder for the first shard (for example, A-F for Name), and choose Add. 13. Type in the DNS name of the file share hosting this shard in UNC format (for example, \ \fs-0123456789abcdef0.example.com\A-F) for Path to folder target and choose OK. 14. If the share doesn't exist: Sharding data using DFS Namespaces for scale-out performance 184 Amazon FSx for Windows File Server Windows User Guide a. b. c. d. Choose Yes to create it. From the Create Share dialog, choose Browse. Choose an existing folder, or create a new folder under D$, and choose OK. Set the appropriate share permissions, and choose OK. 15. With the folder target now added for the shard, choose OK. 16. Repeat the last four steps for other shards you want to add to the same namespace. Managing throughput capacity You can increase and decrease your file system's throughput capacity to help manage its performance at any time. Throughput capacity is one of the dimensions that determines the speed at which the file server hosting your FSx for Windows File Server file system can serve data. Higher levels of throughput capacity also come with higher levels of I/O operations per second (IOPS) and a larger amount of cache memory on the file server. For more information, see FSx for Windows File Server performance. Topics • How throughput scaling works • Knowing when to modify throughput capacity • Modifying throughput capacity • Monitoring throughput capacity updates How throughput scaling works When you modify your file system's throughput capacity, Amazon FSx switches out the file system's file server to one with more or less throughput behind the scenes. For Multi-AZ file systems, switching to a new file server triggers an automatic failover and failback while Amazon FSx switches out the preferred and secondary file servers. Single-AZ file systems will be unavailable for a few minutes while the file server is switched during throughput capacity scaling. You are billed for the new amount of throughput capacity once it becomes available to your file system. Managing throughput capacity 185 Amazon FSx for Windows File Server Windows User Guide Note During a maintenance operation on the back end, system modifications (including throughput capacity modifications) may be delayed. Maintenance operations can cause system modifications to queue up to be processed. For Multi-AZ file systems, throughput capacity scaling results in an automatic |
WindowsGuide-076 | WindowsGuide.pdf | 76 | switches out the preferred and secondary file servers. Single-AZ file systems will be unavailable for a few minutes while the file server is switched during throughput capacity scaling. You are billed for the new amount of throughput capacity once it becomes available to your file system. Managing throughput capacity 185 Amazon FSx for Windows File Server Windows User Guide Note During a maintenance operation on the back end, system modifications (including throughput capacity modifications) may be delayed. Maintenance operations can cause system modifications to queue up to be processed. For Multi-AZ file systems, throughput capacity scaling results in an automatic failover and failback while Amazon FSx switches out the preferred and secondary file servers. During file server replacements, which happen during throughput capacity scaling as well as file system maintenance and an unplanned service disruption, any ongoing traffic to the file system will be served by the remaining file server. When the replaced file server is back online, FSx for Windows will run a resynchronization job to ensure that data is synced back to the newly replaced file server. FSx for Windows is designed to minimize the impact of this resynchronization activity on application and users. However, the resynchronization process involves synchronizing data in large blocks. This means that a large block of data can require synchronization even if only a small portion is updated. Consequently, the amount of resynchronization depends not only on the amount of data churn, but also the nature of the data churn on the file system. If your workload is write-heavy and IOPS-heavy, the data synchronization process may take longer and require additional performance resources. Your file system will continue to be available during this time, but in order to reduce the duration of data synchronization, we recommend modifying throughput capacity during idle periods when there is minimal load on your file system. We also recommend ensuring that your file system has sufficient throughput capacity to run the synchronization job in addition to your workload, in order to reduce the duration of data synchronization. Lastly, we recommend testing the impact of failovers while your file system has a lighter load. Knowing when to modify throughput capacity Amazon FSx integrates with Amazon CloudWatch, enabling you to monitor your file system's ongoing throughput usage levels. The performance (throughput and IOPS) that you can drive through your file system depends on your specific workload’s characteristics, along with your file system’s throughput capacity, storage capacity, and storage type. You can use CloudWatch metrics to determine which of these dimensions to change to improve performance. For more information, see Monitoring with Amazon CloudWatch. Knowing when to modify throughput capacity 186 Amazon FSx for Windows File Server Windows User Guide FSx for Windows File Server provides performance alerts based on values of CloudWatch metrics for your file system in the Monitoring & performance dashboard in the File system details page on the Amazon FSx console. This includes throughput capacity, and other file system metrics that can benefit from throughput capacity increases. For more information, see Performance warnings and recommendations. Configure your file system with sufficient throughput capacity to meet not only the expected traffic of your workload, but also additional performance resources that are needed to support the features you enable on your file system. For example, if you’re running data deduplication, the throughput capacity that you select must provide enough memory to run deduplication based on the storage that you have. If you’re using shadow copies, increase throughput capacity to a value that's at least three times the value that's expected to be driven by your workload to avoid Windows Server deleting your shadow copies. For more information, see Impact of throughput capacity on performance. Modifying throughput capacity You can increase or decrease your file system's throughput capacity using the Amazon FSx console, the AWS Command Line Interface (AWS CLI), or the Amazon FSx API, as described in the following procedures. To modify a file system's throughput capacity (console) 1. Open the Amazon FSx console at https://console.aws.amazon.com/fsx/. 2. Navigate to File systems, and choose the Windows file system that you want to increase the throughput capacity for. 3. For Actions, choose Update throughput. Or, in the Summary panel, choose Update next to the file system's Throughput capacity. The Update throughput capacity window appears. 4. Choose the new value for Throughput capacity from the list. 5. Choose Update to initiate the throughput capacity update. Modifying throughput capacity 187 Amazon FSx for Windows File Server Windows User Guide Note Multi-AZ file systems fail over and fail back when updating throughput scaling, and are fully available. Single-AZ file systems experience a very brief period of unavailability during the update. 6. You can monitor the update progress on the File systems detail page, in the Updates tab. You can monitor the progress of the |
WindowsGuide-077 | WindowsGuide.pdf | 77 | next to the file system's Throughput capacity. The Update throughput capacity window appears. 4. Choose the new value for Throughput capacity from the list. 5. Choose Update to initiate the throughput capacity update. Modifying throughput capacity 187 Amazon FSx for Windows File Server Windows User Guide Note Multi-AZ file systems fail over and fail back when updating throughput scaling, and are fully available. Single-AZ file systems experience a very brief period of unavailability during the update. 6. You can monitor the update progress on the File systems detail page, in the Updates tab. You can monitor the progress of the update by using the Amazon FSx console, the AWS CLI, and the API. For more information, see Monitoring throughput capacity updates. To modify a file system's throughput capacity (CLI) To increase or decrease a file system's throughput capacity, use the AWS CLI command update-file- system. Set the following parameters: • --file-system-id to the ID of the file system that you are updating. • ThroughputCapacity to the desired value; valid values are 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4608, 6144, 9216, 12288 MBps. You can monitor the progress of the update by using the Amazon FSx console, the AWS CLI, and the API. For more information, see Monitoring throughput capacity updates. Monitoring throughput capacity updates You can monitor the progress of a throughput capacity modification using the Amazon FSx console, the API, and the AWS CLI. Monitoring throughput capacity changes in the console In the Updates tab in the File system details window, you can view the 10 most recent update actions for each update action type. Monitoring throughput capacity updates 188 Amazon FSx for Windows File Server Windows User Guide For throughput capacity update actions, you can view the following information. Update type Possible value is Throughput capacity. Target value The desired value to change the file system's throughput capacity to. Status The current status of the update. For throughput capacity updates, the possible values are as follows: • Pending – Amazon FSx has received the update request, but has not started processing it. • In progress – Amazon FSx is processing the update request. • Updated optimizing – Amazon FSx has updated the file system's network I/O, CPU, and memory resources. The new disk I/O performance level is available for write operations. Your read operations will see disk I/O performance between the previous level and the new level until your file system is no longer in the this state. • Completed – The throughput capacity update completed successfully. • Failed – The throughput capacity update failed. Choose the question mark (?) to see details on why the throughput update failed. Request time The time that Amazon FSx received the update request. Monitoring throughput capacity updates 189 Amazon FSx for Windows File Server Windows User Guide Monitoring changes with the AWS CLI and API You can view and monitor file system throughput capacity modification requests using the describe-file-systems CLI command and the DescribeFileSystems API action. The AdministrativeActions array lists the 10 most recent update actions for each administrative action type. When you modify a file system's throughput capacity, a FILE_SYSTEM_UPDATE administrative action is generated. The following example shows the response excerpt of a describe-file-systems CLI command. The file system has a throughput capacity of 8 MBps, and the target throughput capacity of 256 MBps. . . . "ThroughputCapacity": 8, "AdministrativeActions": [ { "AdministrativeActionType": "FILE_SYSTEM_UPDATE", "RequestTime": 1581694764.757, "Status": "PENDING", "TargetFileSystemValues": { "WindowsConfiguration": { "ThroughputCapacity": 256 } } } ] When Amazon FSx completes processing the action successfully, the status changes to COMPLETED. The new throughput capacity is then available to the file system, and shows in the ThroughputCapacity property. This is shown in the following response excerpt of a describe- file-systems CLI command. . . . "ThroughputCapacity": 256, "AdministrativeActions": [ { "AdministrativeActionType": "FILE_SYSTEM_UPDATE", Monitoring throughput capacity updates 190 Amazon FSx for Windows File Server Windows User Guide "RequestTime": 1581694764.757, "Status": "COMPLETED", "TargetFileSystemValues": { "WindowsConfiguration": { "ThroughputCapacity": 256 } } } ] If the throughput capacity modification fails, the status changes to FAILED, and the FailureDetails property provides information about the failure. For information about troubleshooting failed actions, see Storage or throughput capacity updates fail. Tagging your Amazon FSx resources To help you manage your file systems and other FSx for Windows File Server resources, you can assign your own metadata to each resource in the form of tags. Tags enable you to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. This is useful when you have many resources of the same type—you can quickly identify a specific resource based on the tags that you've assigned to it. This topic describes tags and shows you how to create them. Topics • Tag basics • Tagging your resources • Tag restrictions • Permissions required |
WindowsGuide-078 | WindowsGuide.pdf | 78 | resources To help you manage your file systems and other FSx for Windows File Server resources, you can assign your own metadata to each resource in the form of tags. Tags enable you to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. This is useful when you have many resources of the same type—you can quickly identify a specific resource based on the tags that you've assigned to it. This topic describes tags and shows you how to create them. Topics • Tag basics • Tagging your resources • Tag restrictions • Permissions required to tag resources Tag basics A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For example, you could define a set of tags for your account's FSx for Windows File Server file systems that helps you track each instance's owner and stack level. Tagging resources 191 Amazon FSx for Windows File Server Windows User Guide We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. For more information about how to implement an effective resource tagging strategy, see the AWS whitepaper Tagging Best Practices. Tags don't have any semantic meaning to Amazon FSx and are interpreted strictly as a string of characters. Also, tags are not automatically assigned to your resources. You can edit tag keys and values, and you can remove tags from a resource at any time. You can set the value of a tag to an empty string, but you can't set the value of a tag to null. If you add a tag that has the same key as an existing tag on that resource, the new value overwrites the old value. If you delete a resource, any tags for the resource are also deleted. If you're using the FSx for Windows File Server API, the AWS CLI, or an AWS SDK, you can use the TagResource API action to apply tags to existing resources. Additionally, some resource-creating actions enable you to specify tags for a resource when the resource is created. If tags cannot be applied during resource creation, we roll back the resource creation process. This ensures that resources are either created with tags or not created at all, and that no resources are left untagged at any time. By tagging resources at the time of creation, you can eliminate the need to run custom tagging scripts after resource creation. For more information about enabling users to tag resources on creation, see Grant permission to tag resources during creation. Tagging your resources You can tag FSx for Windows File Server resources that exist in your account. If you're using the Amazon FSx console, you can apply tags to resources by using the Tags tab on the relevant resource screen. When you create resources, you can apply the Name key with a value, and you can apply tags of your choice when creating a new file system. The console may organize resources according to the Name tag, but this tag doesn't have any semantic meaning to the FSx for Windows File Server service. You can apply tag-based resource-level permissions in your IAM policies to the FSx for Windows File Server API actions that support tagging on creation to implement granular control over the users and groups that can tag resources on creation. Your resources are properly secured from creation—tags are applied immediately to your resources, therefore any tag-based resource-level permissions controlling the use of resources are immediately effective. Your resources can be tracked and reported on more accurately. You can enforce the use of tagging on new resources, and control which tag keys and values are set on your resources. Tagging your resources 192 Amazon FSx for Windows File Server Windows User Guide You can also apply resource-level permissions to the TagResource and UntagResource FSx for Windows File Server API actions in your IAM policies to control which tag keys and values are set on your existing resources. For more information about tagging your resources for billing, see Using cost allocation tags in the AWS Billing User Guide. Tag restrictions The following basic restrictions apply to tags: • Maximum number of tags per resource – 50 • For each resource, each tag key must be unique, and each tag key can have only one value. • Maximum key length – 128 Unicode characters in UTF-8 • Maximum value length – 256 Unicode |
WindowsGuide-079 | WindowsGuide.pdf | 79 | and UntagResource FSx for Windows File Server API actions in your IAM policies to control which tag keys and values are set on your existing resources. For more information about tagging your resources for billing, see Using cost allocation tags in the AWS Billing User Guide. Tag restrictions The following basic restrictions apply to tags: • Maximum number of tags per resource – 50 • For each resource, each tag key must be unique, and each tag key can have only one value. • Maximum key length – 128 Unicode characters in UTF-8 • Maximum value length – 256 Unicode characters in UTF-8 • The allowed characters for FSx for Windows File Server tags are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. • Tag keys and values are case-sensitive. • The aws: prefix is reserved for AWS use. If a tag has a tag key with this prefix, then you can't edit or delete the tag's key or value. Tags with the aws: prefix do not count against your tags per resource limit. You can't delete a resource based solely on its tags; you must specify the resource identifier. For example, to delete a file system that you tagged with a tag key called DeleteMe, you must use the DeleteFileSystem action with the file system resource identifier, such as fs-1234567890abcdef0. When you tag public or shared resources, the tags you assign are available only to your AWS account; no other AWS account will have access to those tags. For tag-based access control to shared resources, each AWS account must assign its own set of tags to control access to the resource. Permissions required to tag resources For more information about the permissions required to tag Amazon FSx resources at creation, see Grant permission to tag resources during creation. For more information about using tags to Tag restrictions 193 Amazon FSx for Windows File Server Windows User Guide restrict access to Amazon FSx resources in IAM policies, see Using tags to control access to your Amazon FSx resources. Update a file system using the AWS CLI There are three elements that you can update using the procedures in this walkthrough. All other elements of your file system that you can update, you can do so from the console. These procedures assume you have the AWS CLI installed and configured on your local computer. For more information, see Install and Configure in the AWS Command Line Interface User Guide. • AutomaticBackupRetentionDays – the number of days that you want to retain automatic backups for your file system. • DailyAutomaticBackupStartTime – the time of the day in Coordinated Universal Time (UTC) that you want the daily automatic backup window to start. The window is 30 minutes starting from this specified time. This window can't overlap with the weekly maintenance backup window. • WeeklyMaintenanceStartTime – the time of the week that you want the maintenance window to start. Day 1 is Monday, 2 is Tuesday, and so on. The window is 30 minutes starting from this specified time. This window can't overlap with the daily automatic backup window. The following procedures outlines how to update your file system with the AWS CLI. To update how long automatic backups are retained for your file system 1. Open a command prompt or terminal on your computer. 2. Run the following command, replacing the file system ID with the ID for your file system, and the number of days that you want to retain your automatic backups for. aws fsx update-file-system --file-system-id fs-0123456789abcdef0 --windows- configuration AutomaticBackupRetentionDays=30 To update the daily backup window of your file system 1. Open a command prompt or terminal on your computer. 2. Run the following command, replacing the file system ID with the ID for your file system, and the time with when you want to begin the window. Update a file system using the AWS CLI 194 Amazon FSx for Windows File Server Windows User Guide aws fsx update-file-system --file-system-id fs-0123456789abcdef0 --windows- configuration DailyAutomaticBackupStartTime=01:00 To update the weekly maintenance window of your file system 1. Open a command prompt or terminal on your computer. 2. Run the following command, replacing the file system ID with the ID for your file system, and the date and time with when you want to begin the window. aws fsx update-file-system --file-system-id fs-0123456789abcdef0 --windows- configuration WeeklyMaintenanceStartTime=1:01:30 Update a file system using the AWS CLI 195 Amazon FSx for Windows File Server Windows User Guide Protecting your data with backups, shadow copies, and scheduled replication Beyond automatically replicating your file system's data to ensure high durability, Amazon FSx provides you with the following options to further protect the data stored on your file systems: • Native Amazon FSx backups support your backup retention and |
WindowsGuide-080 | WindowsGuide.pdf | 80 | replacing the file system ID with the ID for your file system, and the date and time with when you want to begin the window. aws fsx update-file-system --file-system-id fs-0123456789abcdef0 --windows- configuration WeeklyMaintenanceStartTime=1:01:30 Update a file system using the AWS CLI 195 Amazon FSx for Windows File Server Windows User Guide Protecting your data with backups, shadow copies, and scheduled replication Beyond automatically replicating your file system's data to ensure high durability, Amazon FSx provides you with the following options to further protect the data stored on your file systems: • Native Amazon FSx backups support your backup retention and compliance needs within Amazon FSx. • AWS Backup backups of your Amazon FSx file systems are part of a centralized and automated backup solution across AWS services in the cloud and on premises. • Windows shadow copies enable your users to easily undo file changes and compare file versions by restoring files to previous versions. • AWS DataSync scheduled replication of your Amazon FSx file system to a second file system provides data protection and recovery. Topics • Protecting your data with backups • Protecting your data with shadow copies • Scheduled replication using AWS DataSync Protecting your data with backups You can protect the data on your FSx for Windows File Server file system by taking regular file system backups. Amazon FSx provides you with multiple options for backing up your file systems. You can use automatic daily backups to take a backup everyday. You can take a user-initiated backup of your file system at any time. You can also use AWS Backup as part of a centralized backup solution for your AWS resources. These backup solutions can help you to meet your data retention, business, and compliance needs. We recommend using the automatic daily backups that are enabled by default for your file system, and using AWS Backup for a centralized backup solution across AWS services. AWS Backup enables you to configure additional backup plans with different frequencies (for example, multiple times a day, daily, or weekly) and retention periods. Protecting your data with backups 196 Amazon FSx for Windows File Server Windows User Guide With Amazon FSx, backups are file-system-consistent, highly durable, and incremental. Each backup contains all of the information that is necessary to create a new file system, effectively restoring a point-in-time snapshot of the file system. To ensure file system consistency, Amazon FSx uses the Volume Shadow Copy Service (VSS) in Microsoft Windows. To ensure high durability, Amazon FSx stores backups in Amazon Simple Storage Service (Amazon S3). Amazon FSx backups are incremental, whether they are generated using the automatic daily backup or the user-initiated backup feature. This means that only the data on the file system that has changed after your most recent backup is saved. This minimizes the time required to create the backup and saves on storage costs by not duplicating data. At some point during the backup process, storage I/O may be suspended briefly, typically for a few seconds. Because the VSS service needs to flush any cached writes to disk before resuming I/O, the duration of the pause may be longer if your workload has a large amount of write operations per second (DataWriteOperations). Most end users and applications will experience this I/O suspension as a brief I/O pause. Your applications may have different sensitivity to timeout settings depending on how they are configured. Creating regular backups for your file system is a best practice that complements the replication that Amazon FSx for Windows File Server performs for your file system. Amazon FSx backups help support your backup retention and compliance needs. Working with Amazon FSx backups is easy, whether it's creating backups, copying a backup, restoring a file system from a backup, or deleting a backup. Note that in order to view usage for a single file system backup, you will need to enable tags for that specific backup and enable tag-based billing reporting. Topics • Working with automatic daily backups • Working with user-initiated backups • Using AWS Backup with Amazon FSx • Copying backups • Restoring backups to new file system • Creating user-initiated backups • Deleting backups • Size of backups • Copying backups within the same account • Restoring a backup to a new file system Protecting your data with backups 197 Amazon FSx for Windows File Server Windows User Guide Working with automatic daily backups By default, Amazon FSx takes an automatic daily backup of your file system. These automatic daily backups occur during the daily backup window that was established when you created the file system. When you choose your daily backup window, we recommend that you choose a convenient time of the day that is outside of the normal operating hours for the applications that use the file system. We also |
WindowsGuide-081 | WindowsGuide.pdf | 81 | the same account • Restoring a backup to a new file system Protecting your data with backups 197 Amazon FSx for Windows File Server Windows User Guide Working with automatic daily backups By default, Amazon FSx takes an automatic daily backup of your file system. These automatic daily backups occur during the daily backup window that was established when you created the file system. When you choose your daily backup window, we recommend that you choose a convenient time of the day that is outside of the normal operating hours for the applications that use the file system. We also recommend choosing a backup window outside of the maintenance window because automated backups may not occur if there is ongoing file system maintenance. Automatic daily backups are kept for a certain period of time, known as a retention period. When you create a file system in the Amazon FSx console, the default automatic daily backup retention period is 30 days. The default retention period is different in the Amazon FSx API and CLI. You can set the retention period to be between 0–90 days. Setting the retention period to 0 (zero) days turns off automatic daily backups. Automatic daily backups are deleted when the file system is deleted. Note Setting the retention period to 0 days means that your file system is never automatically backed up. We highly recommend that you use automatic daily backups for file systems that have any level of critical functionality associated with them. You can use the AWS CLI or one of the AWS SDKs to change the backup window and backup retention period for your file systems. Use the UpdateFileSystem API operation or the update- file-system CLI command. For more information, see Update a file system using the AWS CLI. Important Lowering the retention period for automatic daily backups will result in the permanent deletion of backups outside of the new retention window. Ensure that you no longer need these older backups before proceeding. Working with user-initiated backups With Amazon FSx, you can manually take backups of your file systems at any time. You can do so using the Amazon FSx console, API, or the AWS Command Line Interface (AWS CLI). Your user- Working with automatic daily backups 198 Amazon FSx for Windows File Server Windows User Guide initiated backups of Amazon FSx file systems never expire, and they are available for as long as you want to keep them. User-initiated backups are retained even after you delete the file system that was backed up. You can delete user-initiated backups only by using the Amazon FSx console, API, or CLI. They are never automatically deleted by Amazon FSx. For more information, see Deleting backups. If a backup is initiated while the file system is being modified (such as during an update to throughput capacity, or during file system maintenance), the backup request is queued and will resume when the activity is complete. To learn how to take user-initiated backups of your file systems, see Creating user-initiated backups. Using AWS Backup with Amazon FSx AWS Backup is a simple and cost-effective way to protect your data by backing up your Amazon FSx file systems. AWS Backup is a unified backup service designed to simplify the creation, copying, restoration, and deletion of backups, while providing improved reporting and auditing. AWS Backup makes it easier to develop a centralized backup strategy for legal, regulatory, and professional compliance. AWS Backup also makes protecting your AWS storage volumes, databases, and file systems simpler by providing a central place where you can do the following: • Configure and audit the AWS resources that you want to back up. • Automate backup scheduling. • Set retention policies. • Copy backups across AWS Regions and across AWS accounts. • Monitor all recent backup, copy, and restore activity. AWS Backup uses the built-in backup functionality of Amazon FSx. Backups taken from the AWS Backup console have the same level of file system consistency and performance, and the same restore options as backups taken through the Amazon FSx console. Backups taken from AWS Backup are incremental relative to any other Amazon FSx backups you take, either user-initiated or automatic. If you use AWS Backup to manage these backups, you gain additional functionality, such as unlimited retention options and the ability to create scheduled backups as frequently as every hour. In addition, AWS Backup retains your immutable backups even after the source file system is deleted. This protects against accidental or malicious deletion. Using AWS Backup with Amazon FSx 199 Amazon FSx for Windows File Server Windows User Guide Backups taken by AWS Backup are considered user-initiated backups, and they count toward the user-initiated backup quota for Amazon FSx. You can see and restore backups taken by AWS Backup in the Amazon FSx console, CLI, |
WindowsGuide-082 | WindowsGuide.pdf | 82 | to manage these backups, you gain additional functionality, such as unlimited retention options and the ability to create scheduled backups as frequently as every hour. In addition, AWS Backup retains your immutable backups even after the source file system is deleted. This protects against accidental or malicious deletion. Using AWS Backup with Amazon FSx 199 Amazon FSx for Windows File Server Windows User Guide Backups taken by AWS Backup are considered user-initiated backups, and they count toward the user-initiated backup quota for Amazon FSx. You can see and restore backups taken by AWS Backup in the Amazon FSx console, CLI, and API. However, you can't delete backups taken by AWS Backup in the Amazon FSx console, CLI, or API. For more information about how to use AWS Backup to back up your Amazon FSx file systems, see Working with Amazon FSx File Systems in the AWS Backup Developer Guide. Copying backups You can use Amazon FSx to manually copy backups within the same AWS account to another AWS Region (cross-Region copies) or within the same AWS Region (in-Region copies). You can make cross-Region copies only within the same AWS partition. You can create user-initiated backup copies using the Amazon FSx console, AWS CLI, or API. When you create a user-initiated backup copy, it has the type USER_INITIATED. You can also use AWS Backup to copy backups across AWS Regions and across AWS accounts. AWS Backup is a fully managed backup management service that provides a central interface for policy-based backup plans. With its cross-account management, you can automatically use backup policies to apply backup plans across the accounts within your organization. Cross-Region backup copies are particularly valuable for cross-Region disaster recovery. You take backups and copy them to another AWS Region so that in the event of a disaster in the primary AWS Region, you can restore from backup and recover availability quickly in the other AWS Region. You can also use backup copies to clone your file dataset to another AWS Region or within the same AWS Region. You make backup copies within the same AWS account (cross-Region or in- Region) by using the Amazon FSx console, AWS CLI, or Amazon FSx API. You can also use AWS Backup to perform backup copies, either on-demand or policy-based. Cross-account backup copies are valuable for meeting regulatory compliance requirements to copy backups to an isolated account. They also provide an additional layer of data protection to help prevent accidental or malicious deletion of backups, loss of credentials, or compromise of AWS KMS keys. Cross-account backups support fan-in (copy backups from multiple primary accounts to one isolated backup copy account) and fan-out (copy backups from one primary account to multiple isolated backup copy accounts). You can make cross-account backup copies by using AWS Backup with AWS Organizations support. Account boundaries for cross-account copies are defined by AWS Organizations policies. For more information about using AWS Backup to make cross-account backup copies, see Creating backup copies across AWS accounts in the AWS Backup Developer Guide. Copying backups 200 Amazon FSx for Windows File Server Backup copy limitations The following are some limitations when you copy backups: Windows User Guide • Cross-Region backup copies are supported only between any two commercial AWS Regions, between the China (Beijing) and China (Ningxia) Regions, and between the AWS GovCloud (US- East) and AWS GovCloud (US-West) Regions, but not across those sets of Regions. • Cross-Region backup copies are not supported in opt-in Regions. • You can make in-Region backup copies within any AWS Region. • The source backup must have a status of AVAILABLE before you can copy it. • You cannot delete a source backup if it is being copied. There might be a short delay between when the destination backup becomes available and when you are allowed to delete the source backup. You should keep this delay in mind if you retry deleting a source backup. • You can have up to five backup copy requests in progress to a single destination AWS Region per account. Permissions for cross-Region backup copies You use an IAM policy statement to grant permissions to perform a backup copy operation. To communicate with the source AWS Region to request a cross-Region backup copy, the requester (IAM role or IAM user) must have access to the source backup and the source AWS Region. You use the policy to grant permissions to the CopyBackup action for the backup copy operation. You specify the action in the policy's Action field, and you specify the resource value in the policy's Resource field, as in the following example. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "fsx:CopyBackup", "Resource": "arn:aws:fsx:*:111111111111:backup/*" } ] } For more information on IAM policies, see Policies and permissions in IAM in the IAM User Guide. Copying backups 201 Amazon |
WindowsGuide-083 | WindowsGuide.pdf | 83 | a cross-Region backup copy, the requester (IAM role or IAM user) must have access to the source backup and the source AWS Region. You use the policy to grant permissions to the CopyBackup action for the backup copy operation. You specify the action in the policy's Action field, and you specify the resource value in the policy's Resource field, as in the following example. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "fsx:CopyBackup", "Resource": "arn:aws:fsx:*:111111111111:backup/*" } ] } For more information on IAM policies, see Policies and permissions in IAM in the IAM User Guide. Copying backups 201 Amazon FSx for Windows File Server Windows User Guide Full and incremental copies When you copy a backup to a different destination AWS Region or destination AWS account from the source backup, the first copy is a full backup copy, even if you use the same KMS key to encrypt both source and destination copies of the backup. After the first backup copy, all subsequent backup copies to the same destination Region within the same AWS account are incremental, provided that you haven't deleted all previously-copied backups in that Region and have been using the same AWS KMS key. If either condition isn't met, the copy operation results in a full (not incremental) backup copy. To learn how to copy backups of your file systems, see Copying backups within the same account. Restoring backups to new file system You can use an available backup to create a new file system, effectively restoring a point-in-time snapshot of another file system. You can restore a backup using the console, AWS CLI, or one of the AWS SDKs. Restoring a backup to a new file system takes the same amount of time as creating a new file system. The data restored from the backup is lazy-loaded onto the file system, during which time you will experience slightly higher latency. To ensure that users can continue to access the restored file system, make sure that the Active Directory domain associated with the restored file system is the same as that of the original file system, or is trusted by the Active Directory domain of the original file system. For more information about Active Directory, see Working with Microsoft Active Directory. To learn how to restore a backup to a new FSx for Windows file system, see Restoring a backup to a new file system. Note You can only restore a file system backup to a new file system with the same deployment type and storage capacity as the original. You can increase the new file system's storage capacity after it becomes available. For more information, see Managing storage capacity. You can change any of the following file system settings when restoring a backup to a new file system: • Storage type Restoring backups to new file system 202 Windows User Guide Amazon FSx for Windows File Server • Throughput capacity • VPC • Availability Zone • Subnet • VPC security groups • Active Directory Configuration • AWS KMS encryption key • Daily automatic backup start time • Weekly maintenance window Creating user-initiated backups In addition to automatic daily file system backups, you can create a user-initiated file system backup at anytime, using the Amazon FSx console as described in the following procedure. To create a user-initiated file system backup 1. Open the Amazon FSx console at https://console.aws.amazon.com/fsx/. 2. 3. 4. From the console dashboard, choose the name of the file system that you want to back up. From Actions, choose Create backup. In the Create backup dialog box that opens, provide a name for your backup. Backup names can be a maximum of 256 Unicode characters, including letters, white space, numbers, and the special characters . + - = _ : / 5. Choose Create backup. You have now created your file system backup. You can find a table of all your backups in the Amazon FSx console by choosing Backups in the left side navigation. Your new user-initiated backup has the type USER_INITIATED, and its status is CREATING until it becomes AVAILABLE. For more information, see Working with user-initiated backups. Deleting backups You can delete any user-initiated and automatic daily backups of your file system using the Amazon FSx console, CLI, or API, described in the following procedures. For deleting backups taken by AWS Backup, which have type of AWS Backup, you must use the the AWS Backup console, CLI, Creating user-initiated backups 203 Amazon FSx for Windows File Server Windows User Guide or API. Deleting a backup is a permanent, unrecoverable action. Any data in a deleted backup is also deleted. Do not delete a backup unless you're sure you won't need that backup again in the future. To delete a backup (console) 1. Open the Amazon FSx console at https://console.aws.amazon.com/fsx/. 2. From |
WindowsGuide-084 | WindowsGuide.pdf | 84 | system using the Amazon FSx console, CLI, or API, described in the following procedures. For deleting backups taken by AWS Backup, which have type of AWS Backup, you must use the the AWS Backup console, CLI, Creating user-initiated backups 203 Amazon FSx for Windows File Server Windows User Guide or API. Deleting a backup is a permanent, unrecoverable action. Any data in a deleted backup is also deleted. Do not delete a backup unless you're sure you won't need that backup again in the future. To delete a backup (console) 1. Open the Amazon FSx console at https://console.aws.amazon.com/fsx/. 2. From the console dashboard, choose Backups from the left side navigation. 3. Choose the backup that you want to delete from the Backups table, and then choose Delete backup. 4. In the Delete backups dialog box that opens, confirm that the ID of the backup identifies the backup that you want to delete. 5. Confirm that the check box is checked for the backup that you want to delete. 6. Choose Delete backups. Your backup and all included data are now permanently and unrecoverably deleted. Size of backups Backups size is determined using the used storage in the file system, rather than the total provisioned storage capacity. The size of your backups will depend on the used storage capacity as well as the amount of data churn on your file system. Depending on how your data is distributed across the file system’s storage volumes and how often it changes, your total backup usage may be greater or less than your used storage capacity. When you delete a backup, only the data unique to that backup is removed. In order to provide backups that are file-system-consistent, durable, and incremental, Amazon FSx backs up data at the block level. The data on the file system's storage volumes may be stored across multiple blocks depending on the pattern that they were written or over-written in. As a result, the total size of backup usage may not match the exact size of the files and directories on the file system. Your overall backup usage and cost can be found in the AWS Billing Dashboard or AWS Cost Management Console. Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing Size of backups 204 Amazon FSx for Windows File Server Windows User Guide information to see the total cost of that application across several services. For more information, see Using Cost Allocation Tags in the AWS Billing User Guide. Note When you increase storage capacity, the process of migrating data from the old set of storage disks to the new, larger set of storage disks can result in a temporary increase in backup usage until backups associated with the old set of storage disks are deleted. If your file system’s storage was only partially used before you increase storage capacity, the size of data that needs to be migrated to the new disks may be larger than the size of data that exists on the original storage disks. This may cause an increase in backup usage up to the new storage capacity level. You should consider the impact of increasing storage capacity on your backup planning. Copying backups within the same account You can use the AWS Management Console and AWS CLI to manually copy backups within the same AWS account to another AWS Region (cross-Region copies) or within the same AWS Region (in-Region copies) using the following procedures. To copy a backup within the same account (cross-Region or in-Region) using the console 1. Open the Amazon FSx console at https://console.aws.amazon.com/fsx/. 2. 3. In the navigation pane, choose Backups. In the Backups table, choose the backup that you want to copy, and then choose Copy backup. 4. In the Settings section, do the following: • In the Destination Region list, choose a destination AWS Region to copy the backup to. The destination can be in another AWS Region (cross-Region copy) or within the same AWS Region (in-Region copy). • (Optional) Select Copy Tags to copy tags from the source backup to the destination backup. If you select Copy Tags and also add tags at step 6, all the tags are merged. 5. 6. For Encryption, choose the AWS KMS encryption key to encrypt the copied backup. For Tags - optional, enter a key and value to add tags for your copied backup. If you add tags here and also selected Copy Tags at step 4, all the tags are |
WindowsGuide-085 | WindowsGuide.pdf | 85 | to. The destination can be in another AWS Region (cross-Region copy) or within the same AWS Region (in-Region copy). • (Optional) Select Copy Tags to copy tags from the source backup to the destination backup. If you select Copy Tags and also add tags at step 6, all the tags are merged. 5. 6. For Encryption, choose the AWS KMS encryption key to encrypt the copied backup. For Tags - optional, enter a key and value to add tags for your copied backup. If you add tags here and also selected Copy Tags at step 4, all the tags are merged. Copying backups 205 Amazon FSx for Windows File Server 7. Choose Copy backup. Windows User Guide Your backup is copied within the same AWS account to the selected AWS Region. To copy a backup within the same account (cross-Region or in-Region) using the CLI • Use the copy-backup CLI command or the CopyBackup API operation to copy a backup within the same AWS account, either across an AWS Region or within an AWS Region. The following command copies a backup with an ID of backup-0abc123456789cba7 from the us-east-1 Region. aws fsx copy-backup \ --source-backup-id backup-0abc123456789cba7 \ --source-region us-east-1 The response shows the description of the copied backup. You can view your backups on the Amazon FSx console or programmatically using the describe-backups CLI command or the DescribeBackups API operation. Restoring a backup to a new file system You can restore a file system backup to create new file system using the AWS Management Console, CLI, and API, as described in the following procedure. To restore a file system from a backup 1. Open the Amazon FSx console at https://console.aws.amazon.com/fsx/. 2. From the console dashboard, choose Backups from the left side navigation. 3. Choose the backup that you want to restore from the Backups table, and then choose Restore backup. Doing so opens the file system creation wizard. This wizard is identical to the standard file system creation wizard, except the Deployment type and Storage capacity are already set and can't be changed. However, you can change the throughput capacity, associated VPC, and other settings, and storage type. The storage type is set to SSD by default, but you can change it to HDD under the following conditions: Restoring a backup 206 Amazon FSx for Windows File Server Windows User Guide • The file system deployment type is Multi-AZ or Single-AZ 2. • The storage capacity is at least 2,000 GiB. 4. Complete the wizard as you do when you create a new file system. 5. Choose Review and create. 6. Review the settings you chose for your Amazon FSx file system, and then choose Create file system. Amazon FSx is creating a new file system, and once its status changes to AVAILABLE, you can use the file system as normal. Protecting your data with shadow copies A Microsoft Windows shadow copy is a snapshot of a Windows file system at a point in time. With shadow copies enabled, users can quickly recover deleted or changed files that are stored on the network, and compare file versions. Storage administrators can easily schedule shadow copies to be taken periodically using Windows PowerShell commands. Shadow copies are stored alongside your file system's data, and consume file system storage capacity only for the changed portions of files. All shadow copies stored in your file system are included in file system backups. Note Shadow copies are not enabled on FSx for Windows File Server by default. To protect the data on your file system using shadow copies, you must enable shadow copies and set up a shadow copy schedule on your file system. For more information, see Configuring shadow copies to use the default storage and schedule. Warning Shadow copies are not a substitute for backups. If you enable shadow copies, make sure that you continue performing regular backups. Topics Protecting data with shadow copies 207 Amazon FSx for Windows File Server Windows User Guide • Best practices when using shadow copies • Setting up shadow copies • Configuring shadow copies to use the default storage and schedule • Setting the maximum amount of shadow copy storage • Viewing shadow copy storage • Creating a custom shadow copy schedule • Viewing the shadow copy schedule • Creating a shadow copy • Viewing existing shadow copies • Deleting shadow copies • Deleting a shadow copy schedule • Deleting shadow copy storage, schedule, and all shadow copies • Troubleshooting shadow copies Best practices when using shadow copies You can enable shadow copies for your file system to allow end-users to view and restore individual files or folders from an earlier snapshot in Windows File Explorer. Amazon FSx uses the shadow copies feature as provided by Microsoft Windows Server. Use these best practices for shadow copies: • |
WindowsGuide-086 | WindowsGuide.pdf | 86 | a custom shadow copy schedule • Viewing the shadow copy schedule • Creating a shadow copy • Viewing existing shadow copies • Deleting shadow copies • Deleting a shadow copy schedule • Deleting shadow copy storage, schedule, and all shadow copies • Troubleshooting shadow copies Best practices when using shadow copies You can enable shadow copies for your file system to allow end-users to view and restore individual files or folders from an earlier snapshot in Windows File Explorer. Amazon FSx uses the shadow copies feature as provided by Microsoft Windows Server. Use these best practices for shadow copies: • Ensure your file system has sufficient performance resources: Microsoft Windows uses a copy- on-write method to record changes since the most recent shadow copy point, and this copy-on- write activity can result in up to three I/O operations for every file write operation. • Use SSD storage and increase throughput capacity: Because Windows requires a high level of I/O performance to maintain shadow copies, we recommend using SSD storage and increasing throughput capacity up to a value as high as three times that of your expected workload. This helps to ensure that your file system has enough resources to avoid issues like the unwanted deletion of shadow copies. • Maintain only the number of shadow copies that you need: If you have a large number of shadow copies—for example, more than 64 of the most recent shadow copies—or shadow copies that occupy a large amount of storage (TB-scale) on a single file system, processes such as failover and failback might take some extra time. This is due to the need for FSx for Windows to run consistency checks on the shadow copy storage. You might also experience higher latency Best practices 208 Amazon FSx for Windows File Server Windows User Guide of I/O operations due to the need for FSx for Windows to perform copy-on-write activity while maintaining the shadow copies. To minimize availability and performance impact from shadow copies, delete unused shadow copies manually or configure scripts to delete old shadow copies on your file system automatically. Note During failover events for Multi-AZ file systems, FSx for Windows runs a consistency check that requires scanning the shadow copy storage on your file system before the new active file server comes online. The duration of the consistency check is related to the number of shadow copies on your file system as well as the storage consumed. To prevent delayed failover and failback events, we recommend maintaining fewer than 64 shadow copies on your file system and following the steps below to regularly monitor and delete your oldest shadow copies. Setting up shadow copies You enable and schedule periodic shadow copies on your file system using Windows PowerShell commands defined by Amazon FSx. The following are three main settings when configuring shadow copies on your FSx for Windows File Server file system: • Setting the maximum amount of storage that shadow copies can consume on your file system • (Optional) Setting the maximum number of shadow copies that can be stored on your file system. The default value is 20. • (Optional) Setting a schedule that defines the times and intervals at which to take shadow copies, such as daily, weekly, and monthly You can store a maximum of 500 shadow copies per file system at any point in time; however, we recommend maintaining fewer than 64 shadow copies at any time to ensure availability and performance. When you reach this limit, the next shadow copy that you take replaces the oldest shadow copy. Similarly, when the maximum shadow copy storage amount is reached, one or more of the oldest shadow copies are deleted to make sufficient storage space for the next shadow copy. For information about how to quickly enable and schedule periodic shadow copies by using default Amazon FSx settings, see Configuring shadow copies to use the default storage and schedule. Setting up shadow copies 209 Amazon FSx for Windows File Server Windows User Guide Considerations for allocating shadow copy storage A shadow copy is a block-level copy of file changes that were made since the last shadow copy. The entire file is not copied, only the changes. Therefore, previous versions of files typically don't take up as much storage space as the current file. The amount of volume space used for changes can vary according to your workload. When a file is modified, the storage space used by shadow copies depends on your workload. When you determine how much storage space to allocate for shadow copies, you should account for your workload's file system usage patterns. When you enable shadow copies, you can specify the maximum amount of storage that shadow copies can consume on the file system. The default limit is 10 percent of your file system. |
WindowsGuide-087 | WindowsGuide.pdf | 87 | previous versions of files typically don't take up as much storage space as the current file. The amount of volume space used for changes can vary according to your workload. When a file is modified, the storage space used by shadow copies depends on your workload. When you determine how much storage space to allocate for shadow copies, you should account for your workload's file system usage patterns. When you enable shadow copies, you can specify the maximum amount of storage that shadow copies can consume on the file system. The default limit is 10 percent of your file system. We recommend that you increase the limit if your users frequently add or modify files. Setting the limit too small can result in the oldest shadow copies being deleted more often than users might expect. You can set the shadow copy storage as unbounded (Set-FsxShadowStorage -Maxsize "UNBOUNDED"). However, an unbounded configuration can result in a large number of shadow copies consuming your file system storage. This could result in not having enough storage capacity for your workloads. If you set an unbounded storage, be sure to scale your storage capacity as the shadow copy limits are reached. For information about configuring your shadow copy storage to a specific size or as unbounded, see Setting the maximum amount of shadow copy storage. After you enable shadow copies, you can monitor the amount of storage space consumed by the shadow copies. For more information, see Viewing shadow copy storage. Considerations when setting the maximum number of shadow copies When you enable shadow copies, you can specify the maximum number of shadow copies stored on the file system. The default limit is 20, and to minimize availability and performance impact from shadow copies, Microsoft recommends configuring the maximum number of shadow copies to less than 64. Because Windows requires a high level of I/O performance to maintain shadow copies, we recommend using SSD storage and increasing throughput capacity up to a value as high as three times that of your expected workload. This helps to ensure that your file system has enough resources to avoid issues like the unwanted deletion of shadow copies. You can set the maximum number of shadow copies up to 500. However, if you have a large number of shadow copies or shadow copies that occupy a large amount of storage (TB-scale) on a single file system, processes such as failover and failback may take longer than expected. This is because Windows needs to run consistency checks on the shadow copy storage. You may also Setting up shadow copies 210 Amazon FSx for Windows File Server Windows User Guide experience higher latency of I/O operations due to the need for Windows to perform copy-on-write activity while maintaining the shadow copies. File system recommendations for shadow copies Following are file system recommendations for using shadow copies. • Make sure you provision sufficient performance capacity for your workload needs on your file system. Amazon FSx delivers the Shadow Copies feature as provided by Microsoft Windows Server. By design, Microsoft Windows uses a copy-on-write method for recording the changes since the most recent shadow copy point, and this copy-on-write activity can result in up to three I/O operations for every file write operation. If Windows is unable to keep up with the incoming rate of I/O operations per second, it can cause all shadow copies to be deleted because it can no longer maintain the shadow copies via copy-on-write. Therefore, it is important that you provision sufficient I/O performance capacity for your workload needs on your file system (both the throughput capacity dimension that determines the file server I/O performance, and the storage type and capacity that determine the storage I/O performance). • We generally recommend that you use file systems configured with SSD storage rather than HDD storage when you enable shadow copies, given that Windows consumes a higher I/O performance to maintain shadow copies, and given that HDD storage provides lower performance capacity for I/O operations. • Your file system should have at least 320 MB of free space, in addition to the maximum shadow copy storage amount configured (MaxSpace). For example, if you allocated 5 GB MaxSpace to shadow copies, your file system should always have at least 320 MB free space in addition to the 5 GB MaxSpace. Warning When configuring your shadow copy schedule, make sure that you don't schedule shadow copies when migrating data or when data deduplication jobs are scheduled to run. You should schedule shadow copies when you expect your file system to be idle. For information about configuring a custom shadow copy schedule, see Creating a custom shadow copy schedule. Setting up shadow copies 211 Amazon FSx for Windows File Server Windows User Guide Restoring individual files and folders After you configure shadow |
WindowsGuide-088 | WindowsGuide.pdf | 88 | copies, your file system should always have at least 320 MB free space in addition to the 5 GB MaxSpace. Warning When configuring your shadow copy schedule, make sure that you don't schedule shadow copies when migrating data or when data deduplication jobs are scheduled to run. You should schedule shadow copies when you expect your file system to be idle. For information about configuring a custom shadow copy schedule, see Creating a custom shadow copy schedule. Setting up shadow copies 211 Amazon FSx for Windows File Server Windows User Guide Restoring individual files and folders After you configure shadow copies on your Amazon FSx file system, your users can quickly restore previous versions of individual files or folders, and recover deleted files. Users restore files to previous versions using the familiar Windows File Explorer interface. To restore a file, you choose the file to restore, then choose Restore previous versions from the context (right-click) menu. Users can then view and restore a previous version from the Previous Versions list. Setting up shadow copies 212 Amazon FSx for Windows File Server Windows User Guide Configuring shadow copies to use the default storage and schedule You can quickly set up shadow copies on your file system by using the default shadow copy storage setting and schedule. The default shadow copy storage setting lets shadow copies consume a maximum of 10 percent of your file system storage capacity. If you increase your file system's storage capacity, the amount of the currently allocated shadow copy storage is not similarly increased. The default schedule automatically takes shadow copies every Monday, Tuesday, Wednesday, Thursday, and Friday, at 7:00 AM and 12:00 PM UTC. To set the default level of shadow copy storage 1. Connect to a Windows compute instance that has network connectivity with your file system. Configure shadow copies to use default settings 213 Amazon FSx for Windows File Server Windows User Guide 2. Log in to the Windows compute instance as a member of the file system administrators group. In AWS Managed Microsoft AD, that group is AWS Delegated FSx Administrators. In your self- managed Microsoft AD, that group is Domain Admins or the custom group that you specified for administration when you created your file system. For more information, see Connecting to Your Windows Instance in the Amazon EC2 User Guide. 3. Set the default amount of shadow storage using the following command. Replace FSxFileSystem-Remote-PowerShell-Endpoint with the Windows Remote PowerShell endpoint of file system that you want to administer. You can find the Windows Remote PowerShell endpoint in the Amazon FSx console, in the Network & Security section of the file system details screen, or in the response of the DescribeFileSystem API operation. PS C:\Users\delegateadmin> Invoke-Command -ComputerName FSxFileSystem-Remote- PowerShell-Endpoint -ConfigurationName FSxRemoteAdmin -scriptblock {Set- FsxShadowStorage -Default} The response looks like the following. FSx Shadow Storage Configuration AllocatedSpace UsedSpace MaxSpace MaxShadowCopyNumber -------------- --------- -------- ------------------- 0 0 10737418240 20 To set the default shadow copy schedule 1. Connect to a Windows compute instance that has network connectivity with your file system. 2. Log in to the Windows compute instance as a member of the file system administrators group. In AWS Managed Microsoft AD, that group is AWS Delegated FSx Administrators. In your self- managed Microsoft AD, that group is Domain Admins or the custom group that you specified for administration when you created your file system. For more information, see Connecting to Your Windows Instance in the Amazon EC2 User Guide. 3. Set the default shadow copy schedule by using the following command. PS C:\Users\delegateadmin> Invoke-Command -ComputerName FSxFileSystem-Remote- PowerShell-Endpoint -ConfigurationName FSxRemoteAdmin -scriptblock {Set- FsxShadowCopySchedule -Default} Configure shadow copies to use default settings 214 Amazon FSx for Windows File Server Windows User Guide The response displays the default schedule that is now set. FSx Shadow Copy Schedule Start Time Days of week WeeksInterval ---------- ------------ ------------- 2019-07-16T07:00:00+00:00 Monday,Tuesday,Wednesday,Thursday,Friday 1 2019-07-16T12:00:00+00:00 Monday,Tuesday,Wednesday,Thursday,Friday 1 To learn about additional options and creating a custom shadow copy schedule, see Creating a custom shadow copy schedule. Setting the maximum amount of shadow copy storage You define the maximum amount of storage that shadow copies can consume on a file system using the Set-FsxShadowStorage custom PowerShell command. You can specify the maximum size that shadow copies can grow to by using either the -Maxsize or the -Default parameters. Using Default sets the maximum to 10% of the file system's storage capacity. You cannot specify the -Maxsize and -Default parameters in the same command. Using -Maxsize, you can define shadow copy storage as follows: • In bytes: Set-FsxShadowStorage -Maxsize 2500000000 • In kilobytes, megabytes, gigabytes, or other units: Set-FsxShadowStorage -Maxsize (2500MB) or Set-FsxShadowStorage -Maxsize (2.5GB) • As a percentage of the overall storage: Set-FsxShadowStorage -Maxsize "20%" • As unbounded: Set-FsxShadowStorage -Maxsize "UNBOUNDED" Use -Default to set shadow storage to use up to |
WindowsGuide-089 | WindowsGuide.pdf | 89 | maximum size that shadow copies can grow to by using either the -Maxsize or the -Default parameters. Using Default sets the maximum to 10% of the file system's storage capacity. You cannot specify the -Maxsize and -Default parameters in the same command. Using -Maxsize, you can define shadow copy storage as follows: • In bytes: Set-FsxShadowStorage -Maxsize 2500000000 • In kilobytes, megabytes, gigabytes, or other units: Set-FsxShadowStorage -Maxsize (2500MB) or Set-FsxShadowStorage -Maxsize (2.5GB) • As a percentage of the overall storage: Set-FsxShadowStorage -Maxsize "20%" • As unbounded: Set-FsxShadowStorage -Maxsize "UNBOUNDED" Use -Default to set shadow storage to use up to 10 percent of the file system: Set- FsxShadowStorage -Default. To learn more about using the default option, see Configuring shadow copies to use the default storage and schedule. To set the amount of shadow copy storage on an FSx for Windows File Server file system 1. Connect to a compute instance that has network connectivity with your file system as a user that is a member of the file system administrators group. In AWS Managed Microsoft AD, that group is AWS Delegated FSx Administrators. In your self-managed Microsoft AD, that Setting the maximum amount of shadow copy storage 215 Amazon FSx for Windows File Server Windows User Guide group is Domain Admins or the custom group that you specified for administration when you created your file system. For more information, see Connecting to Your Windows Instance in the Amazon EC2 User Guide. 2. Open a Windows PowerShell window on the compute instance. 3. Use the following command to open a remote PowerShell session on your Amazon FSx file system. Replace FSxFileSystem-Remote-PowerShell-Endpoint with the Windows Remote PowerShell endpoint of file system that you want to administer. You can find the Windows Remote PowerShell endpoint in the Amazon FSx console, in the Network & Security section of the file system details screen, or in the response of the DescribeFileSystem API operation. PS C:\Users\delegateadmin> enter-pssession -computername FSxFileSystem-Remote- PowerShell-Endpoint -configurationname fsxremoteadmin 4. Verify that shadow copy storage is not already configured on the file system using the following command. [fs-1234567890abcef12]: PS>Get-FsxShadowStorage No Fsx Shadow Storage Configured 5. Set the amount of shadow storage to 10 percent of the volume and the maximum number of shadow copes to 20 using the -Default option. [fs-1234567890abcef12]: PS>Set-FsxShadowStorage -Default FSx Shadow Storage Configuration AllocatedSpace UsedSpace MaxSpace MaxShadowCopyNumber -------------- --------- -------- ------------------- 0 0 32530536858 20 You can limit the maximum number of shadow copies allowed on your file system by using the Set-FSxShadowStorage command with the -MaxShadowCopyNumber parameter and specifying a value from 1-500. By default, the maximum number of shadow copies is set to 20, as recommended for by Microsoft for active workloads. Setting the maximum amount of shadow copy storage 216 Amazon FSx for Windows File Server Windows User Guide Viewing shadow copy storage You can view the amount of storage currently consumed by shadow copies on your file system using the Get-FsxShadowStorage command in a remote PowerShell session on your file system. For instructions on launching a remote PowerShell session on your file system, see Using the Amazon FSx CLI for PowerShell. [fs-1234567890abcef12]: PS>PS>Get-fsxshadowstorage FSx Shadow Storage Configuration AllocatedSpace UsedSpace MaxSpace MaxShadowCopyNumber -------------- --------- -------- ------------------- 0 0 10737418240 20 The output shows the shadow storage configuration, as follows: • AllocatedSpace – The amount of storage on the file system in bytes currently allocated to shadow copies. Initially, this value is 0. • UsedSpace – The amount of storage, in bytes, currently used by shadow copies. Initially, this value is 0. • MaxSpace – The maximum amount of storage, in bytes, to which shadow storage can grow. This is the value that you set for shadow copy storage using the Set-FsxShadowStorage command. • MaxShadowCopyNumber – The maximum number of shadow copies that the file system can have, from 1-500. When the UsedSpace amount reaches the maximum shadow copy storage amount configured (MaxSpace) or the number of shadow copies reaches the maximum shadow copy number configured (MaxShadowCopyNumber), the next shadow copy that you take replaces the oldest shadow copy. If you don't want to lose your oldest shadow copies, monitor your shadow copy storage to make sure that you have sufficient storage space for new shadow copies. If you need more space, you can delete existing shadow copies or increase the maximum amount of shadow copy storage. Note When shadow copies are automatically or manually created, they use the amount of shadow copy storage that you configured as a storage limit. Shadow copies grow in size over time and utilize the available storage space shown by the CloudWatch Viewing shadow copy storage 217 Amazon FSx for Windows File Server Windows User Guide FreeStorageCapacity metric up to the maximum shadow copy storage amount configured (MaxSpace). Creating a custom shadow copy schedule Shadow copy schedules use scheduled task |
WindowsGuide-090 | WindowsGuide.pdf | 90 | copies. If you need more space, you can delete existing shadow copies or increase the maximum amount of shadow copy storage. Note When shadow copies are automatically or manually created, they use the amount of shadow copy storage that you configured as a storage limit. Shadow copies grow in size over time and utilize the available storage space shown by the CloudWatch Viewing shadow copy storage 217 Amazon FSx for Windows File Server Windows User Guide FreeStorageCapacity metric up to the maximum shadow copy storage amount configured (MaxSpace). Creating a custom shadow copy schedule Shadow copy schedules use scheduled task triggers in Microsoft Windows to specify when shadow copies are automatically taken. A shadow copy schedule can have multiple triggers, providing you with a lot of scheduling flexibility. Only one shadow copy schedule can exist at a time. Before you can create a shadow copy schedule, you must first set the amount of shadow copy storage. When you run the Set-FsxShadowCopySchedule command on a file system, you overwrite any existing shadow copy schedule. If your client computer is in the UTC time zone, you can also specify the time zone for a trigger using Windows time zones and the -TimezoneId option. For a list of Windows time zones, see Microsoft's Default Timezone documentation or run the following at a Windows command prompt: tzutil /l. To learn more about Windows task triggers, see Task Triggers in Microsoft Windows Developer Center documentation. You can also use the -Default option to quickly set up a default shadow copy schedule. To learn more, see Configuring shadow copies to use the default storage and schedule. To create a custom shadow copy schedule 1. Create a set of Windows scheduled task triggers to define when shadow copies are taken in the shadow copy schedule. Use the new-scheduledTaskTrigger command in a PowerShell on your local machine to set multiple triggers. This following example creates a custom shadow copy schedule that takes shadow copies every Monday–Friday, at 6:00 AM and at 6:00 PM UTC. By default, times are in UTC, unless you specify a time zone in the Windows scheduled task triggers you create. PS C:\Users\delegateadmin> $trigger1 = new-scheduledTaskTrigger -weekly -DaysOfWeek Monday,Tuesday,Wednesday,Thursday,Friday -at 06:00 PS C:\Users\delegateadmin> $trigger2 = new-scheduledTaskTrigger -weekly -DaysOfWeek Monday,Tuesday,Wednesday,Thursday,Friday -at 18:00 2. Use invoke-command to run the scriptblock command. Doing so writes a script that sets the shadow copy schedule with the new-scheduledTaskTrigger value that you just created. Replace FSxFileSystem-Remote-PowerShell-Endpoint with the Windows Creating a custom shadow copy schedule 218 Amazon FSx for Windows File Server Windows User Guide Remote PowerShell endpoint of file system that you want to administer. You can find the Windows Remote PowerShell endpoint in the Amazon FSx console, in the Network & Security section of the file system details screen, or in the response of the DescribeFileSystem API operation. PS C:\Users\delegateadmin> invoke-command -ComputerName FSxFileSystem-Remote- PowerShell-Endpoint -ConfigurationName FSxRemoteAdmin -scriptblock { 3. Enter the following line at the >> prompt to set your shadow copy schedule using the set- fsxshadowcopyschedule command. >> set-fsxshadowcopyschedule -scheduledtasktriggers $Using:trigger1,$Using:trigger2 -Confirm:$false } The response displays the shadow copy schedule that you configured on the file system. FSx Shadow Copy Schedule Start Time: : 2019-07-16T06:00:00+00:00 Days of Week : Monday,Tuesday,Wednesday,Thursday,Friday WeeksInterval : 1 PSComputerName : fs-0123456789abcdef1 RunspaceId : 12345678-90ab-cdef-1234-567890abcde1 Start Time: : 2019-07-16T18:00:00+00:00 Days of Week : Monday,Tuesday,Wednesday,Thursday,Friday WeeksInterval : 1 PSComputerName : fs-0123456789abcdef1 RunspaceId : 12345678-90ab-cdef-1234-567890abcdef Viewing the shadow copy schedule To view the existing shadow copy schedule on your file system, enter the following command in a remote PowerShell session on your file system. For instructions on launching a remote PowerShell session on your file system, see Using the Amazon FSx CLI for PowerShell. [fs-0123456789abcdef1]PS> Get-FsxShadowCopySchedule FSx Shadow Copy Schedule Viewing the shadow copy schedule 219 Amazon FSx for Windows File Server Windows User Guide Start Time Days of week WeeksInterval ---------- ------------ ------------- 2019-07-16T07:00:00+00:00 Monday,Tuesday,Wednesday,Thursday,Friday 1 2019-07-16T12:00:00+00:00 Monday,Tuesday,Wednesday,Thursday,Friday 1 Creating a shadow copy To manually create a shadow copy, enter the following command in a remote PowerShell session on your file system. For instructions on launching a remote PowerShell session on your file system, see Using the Amazon FSx CLI for PowerShell. [fs-0123456789abcdef1]PS>New-FsxShadowCopy Shadow Copy {ABCDEF12-3456-7890-ABCD-EF1234567890} taken successfully Viewing existing shadow copies To view the set of existing shadow copies on your file system, enter the following command in a remote PowerShell session on your file system. For instructions on launching a remote PowerShell session on your file system, see Using the Amazon FSx CLI for PowerShell. [fs-0123456789abcdef1]PS>Get-FsxShadowCopies FSx Shadow Copies: 2 total Shadow Copy ID Creation Time -------------- ----------------- {ABCDEF12-3456-7890-ABCD-EF1234567890} 6/17/2019 7:11:09 AM {FEDCBA21-6543-0987-0987-EF3214567892} 6/19/2019 11:24:19 AM Deleting shadow copies You can delete one or more existing shadow copies on your file system using the Remove- FsxShadowCopies command in a remote PowerShell session on your file system. For instructions on launching a remote PowerShell |
WindowsGuide-091 | WindowsGuide.pdf | 91 | set of existing shadow copies on your file system, enter the following command in a remote PowerShell session on your file system. For instructions on launching a remote PowerShell session on your file system, see Using the Amazon FSx CLI for PowerShell. [fs-0123456789abcdef1]PS>Get-FsxShadowCopies FSx Shadow Copies: 2 total Shadow Copy ID Creation Time -------------- ----------------- {ABCDEF12-3456-7890-ABCD-EF1234567890} 6/17/2019 7:11:09 AM {FEDCBA21-6543-0987-0987-EF3214567892} 6/19/2019 11:24:19 AM Deleting shadow copies You can delete one or more existing shadow copies on your file system using the Remove- FsxShadowCopies command in a remote PowerShell session on your file system. For instructions on launching a remote PowerShell session on your file system, see Using the Amazon FSx CLI for PowerShell. Specify which shadow copies to delete by using one of the following required options: • -Oldest deletes the oldest shadow copy Creating a shadow copy 220 Amazon FSx for Windows File Server Windows User Guide • -All deletes all existing shadow copies • -ShadowCopyId deletes a specific shadow copy by ID. You can use only one option with the command. An error occurs if you don't specify which shadow copy to delete, if you specify multiple shadow copy IDs, or if you specify an invalid shadow copy ID. To delete the oldest shadow copy on your file system, enter the following command in a remote PowerShell session on your file system. [fs-0123456789abcdef1]PS>Remove-FsxShadowCopies -Oldest Confirm Are you sure you want to perform this action? Performing the operation "Remove-FSxShadowCopies" on target "Removing oldest shadow copy". [Y] Yes [A] Yes to All [N] No [L] No to All [?] Help (Default is "Y": Y Shadow Copy {ABCDEF12-3456-7890-ABCD-EF1234567890} deleted To delete a specific shadow copy on your file system, enter the following command in a remote PowerShell session on your file system. [fs-0123456789abcdef1]PS>Remove-FsxShadowCopies -ShadowCopyId "{ABCDEF12-3456-7890- ABCD-EF1234567890}" Are you sure you want to perform this action? Performing the operation "Remove-FSxShadowCopies" on target "Removing shadow copy {ABCDEF12-3456-7890-ABCD-EF1234567890}". [Y] Yes [A] Yes to All [N] No [L] No to All [?] Help (Default is "Y":>Y Shadow Copy \\AMZNFSXABCDE123\root\cimv2:Wind32_ShadowCopy.ID{ABCDEF12-3456-7890-ABCD- EF1234567890}".ID deleted. To delete a certain number of the oldest shadow copies on your file system, update your - MaxShadowCopyNumber parameter to the desired number of shadow copies that you would like to have remaining. However, this change will only take effect after the next shadow copy snapshot is taken, when the system will automatically delete the excess shadow copies. Use the following command in a remote PowerShell session on your file system. [fs-1234567890abcef12]: PS>Get-fsxshadowstorage FSx Shadow Storage Configuration AllocatedSpace UsedSpace MaxSpace MaxShadowCopyNumber Deleting shadow copies 221 Amazon FSx for Windows File Server Windows User Guide -------------- --------- ----------- ------------------- 556679168 21659648 10737418240 50 [fs-1234567890abcef12]: PS>Set-FsxShadowStorage -MaxShadowCopyNumber 5 Validation You have 50 shadow copies. Older versions of shadow copies will be deleted, keeping 5 latest shadow copies on your file system. Do you want to continue? [Y] Yes [N] No [?] Help (default is "N"): y FSx Shadow Storage Configuration AllocatedSpace UsedSpace MaxSpace MaxShadowCopyNumber -------------- --------- -------- ------------------- 556679168 21659648 10737418240 5 Deleting a shadow copy schedule To delete the existing shadow copy schedule on your file system, enter the following command in a remote PowerShell session on your file system. For instructions on launching a remote PowerShell session on your file system, see Using the Amazon FSx CLI for PowerShell. [fs-0123456789abcdef1]PS>Remove-FsxShadowCopySchedule Confirm Are you sure you want to perform this action? Performing the operation "Remove-FsxShadowCopySchedule" on target "Removing FSx Shadow Copy Schedule". [Y] Yes [A] Yes to All [N] No [L] No to All [?] Help (Default is "Y"): Y [fs-0123456789abcdef1]PS> Deleting shadow copy storage, schedule, and all shadow copies You can delete your shadow copy configuration, including all existing shadow copies and the shadow copy schedule. At the same time, you can release the shadow copy storage on the file system. To do this, enter the Remove-FsxShadowStorage command in a remote PowerShell session on your file system. For instructions on launching a remote PowerShell session on your file system, see Using the Amazon FSx CLI for PowerShell. Deleting a shadow copy schedule 222 Amazon FSx for Windows File Server Windows User Guide [fs-0123456789abcdef1]PS>Remove-FsxShadowStorage Confirm Are you sure you want to perform this action? Performing the operation "Remove-FsxShadowStorage" on target "Removing all Shadow Copies, Shadow Copy Schedule, and Shadow Storage". [Y] Yes [A] Yes to All [N] No [L] No to All [?] Help (Default is "Y": Y FSx Shadow Storage Configuration Removing Shadow Copy Schedule Removing Shadow Copies All shadow copies removed. Removing Shadow Storage Shadow Storage removed successfully. Troubleshooting shadow copies There are a number of potential causes when shadow copies are missing or inaccessible, as described in the following section. Topics • Oldest shadow copies are missing • All of my shadow copies are missing • Cannot create Amazon FSx backups or access shadow copies on a recently restored or updated file |
WindowsGuide-092 | WindowsGuide.pdf | 92 | Copy Schedule, and Shadow Storage". [Y] Yes [A] Yes to All [N] No [L] No to All [?] Help (Default is "Y": Y FSx Shadow Storage Configuration Removing Shadow Copy Schedule Removing Shadow Copies All shadow copies removed. Removing Shadow Storage Shadow Storage removed successfully. Troubleshooting shadow copies There are a number of potential causes when shadow copies are missing or inaccessible, as described in the following section. Topics • Oldest shadow copies are missing • All of my shadow copies are missing • Cannot create Amazon FSx backups or access shadow copies on a recently restored or updated file system Oldest shadow copies are missing The oldest shadow copies are deleted in either of these situations: • If you have 500 shadow copies, the next shadow copy replaces the oldest shadow copy, regardless of the remaining allocated storage volume space for shadow copies. • If the maximum shadow copy storage amount configured is reached, the next shadow copy replaces one or more of the oldest shadow copies, even if you have fewer than 500 shadow copies. Both results are expected behavior. If you have insufficient storage allocated for shadow copies, consider increasing the storage you have allocated. Troubleshooting shadow copies 223 Amazon FSx for Windows File Server Windows User Guide All of my shadow copies are missing Having insufficient I/O performance capacity on your file system (for example, because you're using HDD storage, because the HDD storage has run out of burst capacity, or because the throughput capacity is insufficient) can cause all shadow copies to be deleted by Windows Server because it is unable to maintain the shadow copies with the available I/O performance capacity. Consider the following recommendations to help prevent this problem: • If you're using HDD storage, use the Amazon FSx console or Amazon FSx API to switch to using SSD storage. For more information, see Managing your file system's storage type. • Increase the file system's throughput capacity to a value three times your expected workload. • Make sure that your file system has at least 320 MB of free space, in addition to the maximum shadow copy storage amount configured. • Schedule shadow copies when you expect your file system to be idle. For more information, see File system recommendations for shadow copies. Cannot create Amazon FSx backups or access shadow copies on a recently restored or updated file system This is expected behavior. Amazon FSx rebuilds the shadow-copy state on a recently restored file system and does not allow access to shadow copies or backups while the rebuilding is still in progress. Scheduled replication using AWS DataSync You can use AWS DataSync to schedule periodic replication of your FSx for Windows File Server file system to a second file system. This capability is available for both in-Region and cross-Region deployments. To learn more, see Migrating existing files to FSx for Windows File Server using AWS DataSync in this guide and Data transfer between AWS storage services in the AWS DataSync User Guide. Scheduled replication 224 Amazon FSx for Windows File Server Windows User Guide Using FSx for Windows File Server with Microsoft SQL Server High availability (HA) Microsoft SQL Server is typically deployed across multiple database nodes in a Windows Server Failover Cluster (WSFC), with each node having access to shared file storage. You can use FSx for Windows File Server as shared storage for High Availability (HA) Microsoft SQL Server deployments in two ways: as storage for active data files and as an SMB file share witness. Note Currently, Amazon FSx doesn't support the Microsoft SQL Server IFI (Instant File Initialization) feature. SSD storage is recommended for SQL Server. SSD storage is designed for the highest-performance and most latency-sensitive workloads, including databases. For information about using Amazon FSx to reduce complexity and costs for your SQL Server high availability deployments, see the following posts on the AWS Storage Blog: • Simplify your Microsoft SQL Server high availability deployments using Amazon FSx for Windows File Server • Optimizing cost for your high availability SQL Server deployments on AWS • Simplify SQL Server Always On deployments with AWS Launch Wizard and Amazon FSx Using Amazon FSx for Active SQL Server Data Files Microsoft SQL Server can be deployed with an SMB file share as the storage option for active data files. Amazon FSx is optimized to provide shared storage for SQL Server databases by supporting continuously available (CA) file shares. These file shares are designed for applications like SQL Server that require uninterrupted access to shared file data. While you can create CA shares on Single-AZ 2 file systems, it is required that you use CA shares on Multi-AZ file systems for all SQL Server deployments, whether HA or not. Using Amazon FSx for Active SQL Server Data Files 225 Amazon FSx for |
WindowsGuide-093 | WindowsGuide.pdf | 93 | SQL Server can be deployed with an SMB file share as the storage option for active data files. Amazon FSx is optimized to provide shared storage for SQL Server databases by supporting continuously available (CA) file shares. These file shares are designed for applications like SQL Server that require uninterrupted access to shared file data. While you can create CA shares on Single-AZ 2 file systems, it is required that you use CA shares on Multi-AZ file systems for all SQL Server deployments, whether HA or not. Using Amazon FSx for Active SQL Server Data Files 225 Amazon FSx for Windows File Server Windows User Guide Create a Continuously Available Share You can create CA shares using the Amazon FSx CLI for Remote Management on PowerShell. To specify that the share is a continuously available share, use the New-FSxSmbShare with the -ContinuouslyAvailable option set to $True. For more information, see To create a continuously available (CA) share. Configure SMB timeout settings As described in Failing over process, failover and failback for Multi-AZ can result in I/O pauses that typically complete in less than 30 seconds. Your SQL Server application may have different sensitivity to timeout settings depending on how it is configured. You can tune the SMB client configuration session timeout to make sure your application is resilient to Multi-AZ file system failovers. You can test the behavior of your application during failovers by updating your file system’s throughput capacity, which initiates an automatic failover and failback. Using Amazon FSx as an SMB File Share Witness Windows Server Failover cluster deployments commonly deploy an SMB file share witness to maintain quorum of the cluster’s resources. Witness file shares require only a small amount of storage for quorum information. Amazon FSx file systems can be used as an SMB file share witness for Windows Server Failover Cluster deployments. Create a Continuously Available Share 226 Amazon FSx for Windows File Server Windows User Guide Migrating existing file storage to Amazon FSx Amazon FSx for Windows File Server has the features, performance, and compatibility to help you easily lift and shift enterprise applications to the Amazon Web Services Cloud. The process to migrate your on-premises Microsoft Windows File Server storage to FSx for Windows File Server has the following four major steps: 1. Migrate your files to FSx for Windows File Server. For more information, see Migrating existing file storage to FSx for Windows File Server. 2. Migrate your file share configuration to FSx for Windows File Server. For more information, see Migrating your on-premises file share configurations to Amazon FSx. 3. Associate your existing DNS name as a DNS alias for your Amazon FSx file system. For more information, see Associating a DNS alias with Amazon FSx. 4. Cut over to FSx for Windows File Server. For more information, see Cutting over operations to Amazon FSx for Windows File Server. You can find the details for each step in the process in the following sections. Topics • Migrating existing file storage to FSx for Windows File Server • Migrating your on-premises file share configurations to Amazon FSx • Migrating your on-premises DNS configuration to FSx for Windows File Server • Cutting over operations to Amazon FSx for Windows File Server Migrating existing file storage to FSx for Windows File Server To migrate your existing files to FSx for Windows File Server file systems, we recommend using AWS DataSync, an online data transfer service designed to simplify, automate, and accelerate copying large amounts of data to and from AWS storage services. DataSync copies data over the internet or AWS Direct Connect. As a fully managed service, DataSync removes much of the need to modify applications, develop scripts, or manage infrastructure. For more information, see Migrating existing files to FSx for Windows File Server using AWS DataSync. As an alternative solution, you can use Robust File Copy, or Robocopy, which is a command line directory and file replication command set for Microsoft Windows. For detailed procedures on how Migrating files to FSx for Windows File Server 227 Amazon FSx for Windows File Server Windows User Guide to use Robocopy to migrate file storage to FSx for Windows File Server, see Migrating existing files to FSx for Windows File Server using Robocopy. Best practices for migrating existing file storage to FSx for Windows File Server To migrate large amounts of data to FSx for Windows File Server as quickly as possible, use Amazon FSx file systems configured with solid state drive (SSD) storage. After the migration is complete, you can move the data to Amazon FSx file systems using hard disk drive (HDD) storage if that is the best solution for your application. To move data from an Amazon FSx file system using SSD storage to HDD storage, you can take the following steps. (Note |
WindowsGuide-094 | WindowsGuide.pdf | 94 | FSx for Windows File Server using Robocopy. Best practices for migrating existing file storage to FSx for Windows File Server To migrate large amounts of data to FSx for Windows File Server as quickly as possible, use Amazon FSx file systems configured with solid state drive (SSD) storage. After the migration is complete, you can move the data to Amazon FSx file systems using hard disk drive (HDD) storage if that is the best solution for your application. To move data from an Amazon FSx file system using SSD storage to HDD storage, you can take the following steps. (Note that HDD file systems have a minimum 2TB storage capacity, and you cannot change storage capacity when restoring from a backup.) 1. Take a backup of your SSD file system. For more information, see Creating user-initiated backups. 2. Restore the backup to a file system using HDD storage. For more information, see Restoring backups to new file system. Migrating existing files to FSx for Windows File Server using AWS DataSync We recommend using AWS DataSync to transfer data between FSx for Windows File Server file systems. DataSync is a data transfer service that simplifies, automates, and accelerates moving and replicating data between on-premises storage systems and other AWS storage services over the internet or AWS Direct Connect. DataSync can transfer your file system data and metadata, such as ownership, timestamps, and access permissions. DataSync supports copying NTFS access control lists (ACLs), and also supports copying file audit control information, also known as NTFS system access control lists (SACLs), which are used by administrators to control audit logging of user attempts to access files. You can use DataSync to transfer files between two FSx for Windows File Server file systems, and also move data to a file system in a different AWS Region or AWS account. You can use DataSync with FSx for Windows File Server file systems for other tasks. For example, you can perform one- time data migrations, periodically ingest data for distributed workloads, and schedule replication for data protection and recovery. Migrating best practices 228 Amazon FSx for Windows File Server Windows User Guide In AWS DataSync, a location for FSx for Windows File Server is an endpoint for an FSx for Windows File Server. You can transfer files between a location for FSx for Windows File Server and a location for other file systems. For information, see Working with Locations in the AWS DataSync User Guide. DataSync accesses your FSx for Windows File Server using the Server Message Block (SMB) protocol. It authenticates with the user name and password that you configure in the AWS DataSync console or AWS CLI. Prerequisites To migrate data into your Amazon FSx for Windows File Server setup, you need a server and network that meet the DataSync requirements. To learn more, see Requirements for DataSync in the AWS DataSync User Guide. If you are performing a large data migration, or a migration involving many small files, we recommend using an Amazon FSx File System with SSD storage type. This is because DataSync tasks involve scans of file metadata which can exhaust the disk IOPS limits of HDD file systems, leading to long-running migrations and file system performance impact. For more information, see: Best practices for migrating existing file storage to FSx for Windows File Server. If your dataset consists of mostly small files, with file counts in the millions, or if you have more available network bandwidth than a single DataSync task can consume, you can also accelerate your data transfers with scale out architecture. For more information, see: How to accelerate your data transfers with AWS DataSync scale out architectures. You can monitor the disk I/O utilization of your file system using FSx performance metrics. Basic steps for migrating files using DataSync To transfer files from a source location to a destination location using DataSync, take the following basic steps: • Download and deploy an agent in your environment and activate it. • Create and configure a source and destination location. • Create and configure a task. • Run the task to transfer files from the source to the destination. Migrating files using AWS DataSync 229 Amazon FSx for Windows File Server Windows User Guide To learn how to transfer files from an existing on-premises file system to your FSx for Windows File Server, see Data transfer between self-managed storage and AWS, Creating a location for SMB, and Creating a location for Amazon FSx for Windows File Server in the AWS DataSync User Guide. To learn how to transfer files from an existing in-cloud file system to your FSx for Windows File Server, see Deploy your agent as an Amazon EC2 instance in the AWS DataSync User Guide. Migrating between two Amazon FSx file systems You can use DataSync to |
WindowsGuide-095 | WindowsGuide.pdf | 95 | File Server Windows User Guide To learn how to transfer files from an existing on-premises file system to your FSx for Windows File Server, see Data transfer between self-managed storage and AWS, Creating a location for SMB, and Creating a location for Amazon FSx for Windows File Server in the AWS DataSync User Guide. To learn how to transfer files from an existing in-cloud file system to your FSx for Windows File Server, see Deploy your agent as an Amazon EC2 instance in the AWS DataSync User Guide. Migrating between two Amazon FSx file systems You can use DataSync to migrate data between two Amazon FSx file systems. This can be helpful if you need to move your workload from an existing file system to a new file system with a different configuration, such as from a Single-AZ to a Multi-AZ configuration. You can also use DataSync to split your workload between two file systems. Here is a sample overview of the migration process: 1. Create DataSync locations for the source and destination file systems. Note that the source and destination must belong to the same Active Directory (AD) domain, or have an AD trust relationship between their domains. 2. Create and configure a DataSync task to transfer data from the source to the destination. You can run the task as a one-time instance, or set the task to run automatically on a schedule that you configure. 3. After the task completes successfully, the data in your destination file system is an exact copy of your source. Note that you will need to temporarily pause any write activity or file updates on your source file system to complete the task. You can then cut over to your destination file system and delete the source file system. Before migrating from your production file system, you can test the migration process on a file system that's restored from a recent backup. This enables you to estimate how long the data transfer process takes, and to troubleshoot DataSync errors in advance. To minimize your cutover time, you can run DataSync tasks in advance, moving the majority of your data from your source file system to your destination file system. After stopping traffic to your source file system, you can run one final task transfer to sync any data that’s been newly updated since you stopped traffic, and then cut over to your destination file system. You can configure DataSync tasks to only run in certain directories, or to include or exclude certain paths. This can be useful if you’re running multiple tasks in parallel, or if you want to migrate a subset of your data. Migrating files using AWS DataSync 230 Amazon FSx for Windows File Server Windows User Guide You can create a DNS alias on your destination file system that's the same as the DNS name of your source file system. This enables your end-users and applications to continue accessing file data using the DNS name of your source file system. For more information about how to set up a DNS alias, see: Accessing data using DNS aliases. When performing this type of migration, we recommend the following: • Schedule your migration to avoid any file system backups, your weekly maintenance window, and Data Deduplication jobs. Specifically, we recommend disabling the Data Deduplication GarbageCollection job if it coincides with your planned migration. • Use an SSD storage type for both your source and destination file systems. You can switch between HDD and SSD storage types by restoring from backup. For more information see: Migrating existing file storage to FSx for Windows File Server. • Configure your source and destination file systems with sufficient throughput capacity for the amount of data that you need to transfer. During DataSync task processes, monitor the performance utilization of both the source and the destination file systems. For more information, see: Monitoring with Amazon CloudWatch. • Set up DataSync monitoring to help you understand the progress of ongoing tasks. You can also send DataSync logs to the Amazon CloudWatch Logs group to assist you with debugging your tasks if you encounter any errors. Migrating existing files to FSx for Windows File Server using Robocopy Built on Microsoft Windows Server, Amazon FSx for Windows File Server enables you to migrate your existing datasets fully into your Amazon FSx file systems. You can migrate the data for each file. You can also migrate all the relevant file metadata including attributes, timestamps, access control lists (ACLs), owner information, and auditing information. With this total migration support, Amazon FSx enables moving your Windows-based workloads and applications relying on these file datasets to the Amazon Web Services Cloud. Use the following topics as a guide through the process for copying existing file data. As you perform this copy, you preserve all |
WindowsGuide-096 | WindowsGuide.pdf | 96 | Microsoft Windows Server, Amazon FSx for Windows File Server enables you to migrate your existing datasets fully into your Amazon FSx file systems. You can migrate the data for each file. You can also migrate all the relevant file metadata including attributes, timestamps, access control lists (ACLs), owner information, and auditing information. With this total migration support, Amazon FSx enables moving your Windows-based workloads and applications relying on these file datasets to the Amazon Web Services Cloud. Use the following topics as a guide through the process for copying existing file data. As you perform this copy, you preserve all file metadata from your on-premises data centers or from your self-managed file servers on Amazon EC2. Prerequisites for file migration with Robocopy Before you begin, make sure that you do the following: Migrating files using Robocopy 231 Amazon FSx for Windows File Server Windows User Guide • Establish network connectivity (by using AWS Direct Connect or VPN) between your on-premises Active Directory and the VPC where you want to create the Amazon FSx file system. • Create a service account on your Active Directory with delegated permissions to join computers to the domain. For more information, see Delegate Privileges to Your Service Account in the AWS Directory Service Administration Guide. • Create an Amazon FSx file system, joined to your self-managed (on-premises) Microsoft AD directory. • Note the location (for example, \\Source\Share) of the file share (either on-premises or in AWS) that contains the existing files you want to transfer over to Amazon FSx. • Note the location (for example, \\Target\Share) of the file share on your Amazon FSx file system to which you want to transfer over your existing files. The following table summarizes the source and destination file system accessibility requirements for three migration user access models. Migration user access model Source file system accessibility requirements Destination FSx file server accessibility requirements Direct read/write permissions model The user needs to have at least read permissions The user needs to have at least write permissions (NTFS ACLs) on the files (NTFS ACLs) on the files and folders being migrated. and folders being migrated. Backup/restore privilege model to override The user needs to be a member of the on-premis The user needs to be a member of the Amazon access permissions es Active Directory's Backup Operators group, and use the /b flag with RoboCopy. FSx file system's administr ators group*, and use the / b flag with RoboCopy. Domain administrator (full) privilege model to override access permissions The user needs to be a member of the on- premises Active Directory 's Domain Admins group. The user needs to be a member of the Amazon FSx file system's administr ators group*, and use the / b flag with RoboCopy Migrating files using Robocopy 232 Amazon FSx for Windows File Server Windows User Guide Note * For file systems joined to an AWS Managed Microsoft AD, the Amazon FSx file system administrators group is AWS Delegated FSx Administrators. In your self-managed Microsoft AD, the Amazon FSx file system administrators group is Domain Admins or the custom group that you specified for administration when you created your file system. Migrating files using Robocopy You can migrate your existing files from your on-premises file systems to FSx for Windows File Server file systems by using the following procedure. To migrate existing files to Amazon FSx using Robocopy 1. Launch a Windows Server 2016 Amazon EC2 instance in the same Amazon VPC as that of your Amazon FSx file system. 2. Connect to your Amazon EC2 instance. For more information, see Connecting to Your Windows Instance in the Amazon EC2 User Guide for Windows Instances. 3. Open Command Prompt and map the source file share on your existing file server (on- premises or in AWS) to a drive letter (for example, Y:) as follows. As part of this, you provide credentials for a member of your on-premises Active Directory's Domain Administrators group. C:\>net use Y: \\fileserver1.mydata.com\localdata /user:mydata.com\Administrator Enter the password for ‘fileserver1.mydata.com’: _ Drive Y: is now connected to \\fileserver1.mydata.com\localdata. The command completed successfully. Migrating files using Robocopy 233 Amazon FSx for Windows File Server Windows User Guide 4. Map the target file share on your Amazon FSx file system to a different drive letter (for example, Z:) on your Amazon EC2 instance as follows. As part of this, you provide credentials for a user account that is a member of your on-premises Active Directory's domain administrators group and your Amazon FSx file system’s administrators group. For file systems joined to an AWS Managed Microsoft AD, that group is AWS Delegated FSx Administrators. In your self-managed Microsoft AD, that group is Domain Admins or the custom group that you specified for administration when you created your file system. For more information, see the table of |
WindowsGuide-097 | WindowsGuide.pdf | 97 | your Amazon FSx file system to a different drive letter (for example, Z:) on your Amazon EC2 instance as follows. As part of this, you provide credentials for a user account that is a member of your on-premises Active Directory's domain administrators group and your Amazon FSx file system’s administrators group. For file systems joined to an AWS Managed Microsoft AD, that group is AWS Delegated FSx Administrators. In your self-managed Microsoft AD, that group is Domain Admins or the custom group that you specified for administration when you created your file system. For more information, see the table of source and destination file system accessibility requirements in the Prerequisites for file migration with Robocopy. C:\>net use Z: \\amznfsxabcdef1.mydata.com\share /user:mydata.com\Administrator Enter the password for 'amznfsxabcdef1.mydata.com': _ Drive Z: is now connected to \\amznfsxabcdef1.mydata.com\share. The command completed successfully. 5. Choose Run as Administrator from the context menu. Open Command Prompt or Windows PowerShell as an administrator, and run the following Robocopy command to copy the files from the source share to the target share. The ROBOCOPY command is a flexible file-transfer utility with multiple options to control the data transfer process. Because of this ROBOCOPY command process, all the files and directories from the source share are copied to the Amazon FSx target share. The copy preserves file and folder NTFS ACLs, attributes, timestamps, owner information, and auditing information. robocopy Y:\ Z:\ /copy:DATSOU /secfix /e /b /MT:8 The example command preceding uses the following elements and options: • Y – Refers to the source share located in the on-premises Active Directory forest mydata.com. • Z – Refers to the target share \\amznfsxabcdef1.mydata.com\share on Amazon FSx. • /copy – Specifies the following file properties to be copied: • D – data • A – attributes Migrating files using Robocopy 234 Amazon FSx for Windows File Server Windows User Guide • T – timestamps • S – NTFS ACLs • O – owner information • U – auditing information. • /secfix – Fixes file security on all files, even skipped ones. • /e – Copies subdirectories, including empty ones. • /b – Uses the backup and restore privilege in Windows to copy files even if their NTFS ACLs deny permissions to the current user. • /MT:8 – Specifies how many threads to use for performing multithreaded copies. Note If you are copying large files over a slow or unreliable connection, you can enable restartable mode by using the /zb option with the robocopy in place of the /b option. With restartable mode, if the transfer of a large file is interrupted, a subsequent Robocopy operation can pick up in the middle of the transfer instead of having to re-copy the entire file from the beginning. Enabling restartable mode can reduce the data transfer speed. Migrating your on-premises file share configurations to Amazon FSx You can migrate an existing file share configuration to Amazon FSx by using the following procedure. In this procedure, the source file server is the file server whose file share configuration you want to migrate to Amazon FSx. Note First migrate your files to Amazon FSx before migrating your file share configuration. For more information, see Migrating existing file storage to FSx for Windows File Server. Migrating file share configurations 235 Amazon FSx for Windows File Server Windows User Guide To migrate existing file shares to FSx for Windows File Server 1. On the source file server, choose Run as Administrator from the context menu. Open Windows PowerShell as an administrator. 2. Export the source file server's file shares to a file named SmbShares.xml by running the following commands in the PowerShell. Replace F: in this example with the drive letter on your file server from which you are exporting file shares. $shareFolder = Get-SmbShare -Special $false | ? { $_.Path -like “F:\*” } $shareFolder | Export-Clixml -Path F:\SmbShares.xml 3. 4. Edit the SmbShares.xml file, replacing all references to F: (your drive letter) to D:\share as Amazon FSx file systems reside on D:\share. Import the existing file share configuration to FSx for Windows File Server. On a client that has access to your destination Amazon FSx file system and the source file server, copy the saved file share configuration. Then import it into a variable by using the following command. $shares = Import-Clixml -Path F:\SmbShares.xml 5. Prepare the credential object required to create the file shares on your FSx for Windows File Server file server using one of the following options. To generate the credential object interactively, use the following command. $credential = Get-Credential To generate the credential object using an AWS Secrets Manager resource, use the following command. $credential = ConvertFrom-Json -InputObject (Get-SECSecretValue -SecretId $AdminSecret).SecretString $FSxAdminUserCredential = (New-Object PSCredential($credential.UserName,(ConvertTo- SecureString $credential.Password -AsPlainText -Force))) 6. Migrate the file share configuration to your Amazon FSx file server using the following script. |
WindowsGuide-098 | WindowsGuide.pdf | 98 | import it into a variable by using the following command. $shares = Import-Clixml -Path F:\SmbShares.xml 5. Prepare the credential object required to create the file shares on your FSx for Windows File Server file server using one of the following options. To generate the credential object interactively, use the following command. $credential = Get-Credential To generate the credential object using an AWS Secrets Manager resource, use the following command. $credential = ConvertFrom-Json -InputObject (Get-SECSecretValue -SecretId $AdminSecret).SecretString $FSxAdminUserCredential = (New-Object PSCredential($credential.UserName,(ConvertTo- SecureString $credential.Password -AsPlainText -Force))) 6. Migrate the file share configuration to your Amazon FSx file server using the following script. $FSxAcceptedParameters = ("ContinuouslyAvailable", "Description", "ConcurrentUserLimit", "CATimeout", "FolderEnumerationMode", "CachingMode", "FullAccess", "ChangeAccess", "ReadAccess", "NoAccess", "SecurityDescriptor", "Path", "Name", "EncryptData") Migrating file share configurations 236 Amazon FSx for Windows File Server Windows User Guide ForEach ($item in $shares) { $param = @{}; Foreach ($property in $item.psObject.properties) { if ($property.Name -In $FSxAcceptedParameters) { $param[$property.Name] = $property.Value } } Invoke-Command -ConfigurationName FSxRemoteAdmin -ComputerName amznfsxxxxxxxxx.corp.com -ErrorVariable errmsg -ScriptBlock { New-FSxSmbShare - Credential $Using:credential @Using:param } } Migrating your on-premises DNS configuration to FSx for Windows File Server FSx for Windows File Server provides a default Domain Name System (DNS) name for every file system that you can use to access the data on your file system. You can also access your file systems using any DNS name of your choosing by configuring the alternate DNS name as a DNS alias for your Amazon FSx file system. With DNS aliases, you can continue to use your existing DNS names to access data stored on Amazon FSx when migrating file system storage from on-premises to Amazon FSx. This helps eliminate the need to update any tools or applications that use your DNS names when migrating to Amazon FSx. You can associate DNS aliases with existing FSx for Windows File Server file systems, when you create new file systems, and when you create a new file system from a backup. You can associate up to 50 DNS aliases with a file system at any one time. For more information, see Managing DNS aliases. A DNS alias name has to meet the following requirements: • Must be formatted as a fully qualified domain name (FQDN), for example, accounting.example.com. • Can contain alphanumeric characters and the hyphen (‐). • Cannot start or end with a hyphen. • Can start with a numeric. Migrating your on-premises DNS configuration to FSx for Windows File Server 237 Amazon FSx for Windows File Server Windows User Guide For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes. The following procedures describe how to associate DNS aliases with your existing FSx for Windows File Server file systems using the Amazon FSx console, CLI, and API. For more information about associating DNS aliases when creating new file systems, including new file systems from a backup, see Associating DNS aliases with file systems. To associate DNS aliases with an existing file system (console) 1. Open the Amazon FSx console at https://console.aws.amazon.com/fsx/. 2. Navigate to File systems, and choose the Windows file system that you want to associate your DNS aliases with. 3. On the Network & security tab, choose Manage for DNS aliases to open the Manage DNS aliases dialog box. Migrating your on-premises DNS configuration to FSx for Windows File Server 238 Amazon FSx for Windows File Server Windows User Guide 4. In the Associate new aliases box, enter the DNS aliases that you want to associate. 5. Choose Associate to add the aliases to the file system. You can monitor the status of the aliases that you just associated in the Current aliases list. When the status reads Available, the alias is associated with the file system (a process that can take up to 2.5 minutes). To associate DNS aliases with an existing file system (CLI) • Use the associate-file-system-aliases CLI command or the AssociateFileSystemAliases API operation to associate DNS aliases with an existing file system. Migrating your on-premises DNS configuration to FSx for Windows File Server 239 Amazon FSx for Windows File Server Windows User Guide The following CLI request associates two aliases with the specified file system. aws fsx associate-file-system-aliases \ --file-system-id fs-0123456789abcdef0 \ --aliases financials.corp.example.com transfers.corp.example.com The response shows the status of the aliases that Amazon FSx is associating with the file system. { "Aliases": [ { "Name": "financials.corp.example.com", "Lifecycle": CREATING }, { "Name": "transfers.corp.example.com", "Lifecycle": CREATING } ] } To monitor the status of the aliases that you are associating, use the describe-file- system-aliases CLI command (DescribeFileSystemAliases is the equivalent API operation). When Lifecycle for an alias has a value of AVAILABLE, you can use it to access the file system (a process that can take up to 2.5 minutes). Cutting over |
WindowsGuide-099 | WindowsGuide.pdf | 99 | specified file system. aws fsx associate-file-system-aliases \ --file-system-id fs-0123456789abcdef0 \ --aliases financials.corp.example.com transfers.corp.example.com The response shows the status of the aliases that Amazon FSx is associating with the file system. { "Aliases": [ { "Name": "financials.corp.example.com", "Lifecycle": CREATING }, { "Name": "transfers.corp.example.com", "Lifecycle": CREATING } ] } To monitor the status of the aliases that you are associating, use the describe-file- system-aliases CLI command (DescribeFileSystemAliases is the equivalent API operation). When Lifecycle for an alias has a value of AVAILABLE, you can use it to access the file system (a process that can take up to 2.5 minutes). Cutting over operations to Amazon FSx for Windows File Server After you have migrated your on-premises file storage, file share configuration, and DNS configuration, the next step is cutting over your operations to the FSx for Windows File Server file systems. To cut over to your FSx for Windows File Server file system, you perform the following steps: • Prepare for the cut over. • Temporarily disconnect SMB clients from the original file system. • Perform a final file and file share configuration sync. Cutting over to FSx for Windows File Server 240 Amazon FSx for Windows File Server Windows User Guide • Configure service principal names (SPNs) for your Amazon FSx file system. • Update DNS CNAME records to point to your Amazon FSx file system. The procedures to perform each of these steps are provided in the following sections. Topics • Preparing for the cutover to Amazon FSx • Configure SPNs for Kerberos authentication • Update the DNS CNAME records for the Amazon FSx file system Preparing for the cutover to Amazon FSx To prepare for the cutover to your Amazon FSx file system, you must do the following: • Disconnect all clients that write to the original file system. • Perform a final file sync using AWS DataSync or Robocopy. For more information, see Migrating existing file storage to FSx for Windows File Server. • Perform a final file share configuration sync. For more information, see Migrating your on- premises file share configurations to Amazon FSx. Configure SPNs for Kerberos authentication We recommend that you use Kerberos-based authentication and encryption in transit with Amazon FSx. Kerberos provides the most secure authentication for clients that access your file system. To enable Kerberos authentication for clients accessing Amazon FSx using a DNS alias, you must add service principal names (SPNs) that correspond to the DNS alias on your Amazon FSx file system’s Active Directory computer object. There are two required SPNs for Kerberos authentication. HOST/alias HOST/alias.domain As an example, if the alias is finance.domain.com, the two required SPNs are as follows. HOST/finance Preparing for the cutover to Amazon FSx 241 Amazon FSx for Windows File Server HOST/finance.domain.com Windows User Guide An SPN can only be associated with a single Active Directory computer object at a time. If there are existing SPNs for the DNS name configured for your original file system's Active Directory computer object, you must delete them before creating SPNs for your Amazon FSx file system. The following procedures describe how to find any existing SPNs, delete them, and create new SPNs for your Amazon FSx file system's Active Directory computer object. To install the required PowerShell Active Directory module 1. Log on to a Windows instance joined to the Active Directory that your Amazon FSx file system is joined to. 2. Open PowerShell as administrator. 3. Install the PowerShell Active Directory module using the following command. Install-WindowsFeature RSAT-AD-PowerShell To find and delete existing DNS alias SPNs on the original file system's Active Directory computer object 1. Find any existing SPNs by using the following commands. Replace alias_fqdn with the DNS alias that you associated with the file system in Migrating your on-premises DNS configuration to FSx for Windows File Server. ## Find SPNs for original file system's AD computer object $ALIAS = "alias_fqdn" SetSPN /Q ("HOST/" + $ALIAS) SetSPN /Q ("HOST/" + $ALIAS.Split(".")[0]) 2. Delete the existing HOST SPNs returned in the previous step by using the following example script. • Replace alias_fqdn with the full DNS alias that you associated with the file system in Migrating your on-premises DNS configuration to FSx for Windows File Server. • Replace file_system_DNS_name with the original file system's DNS name . ## Delete SPNs for original file system's AD computer object Configure SPNs for Kerberos authentication 242 Amazon FSx for Windows File Server $Alias = "alias_fqdn" Windows User Guide $FileSystemDnsName = "file_system_dns_name" $FileSystemHost = (Resolve-DnsName ${FileSystemDnsName} | Where Type -eq 'A') [0].Name.Split(".")[0] $FSxAdComputer = (Get-AdComputer -Identity ${FileSystemHost}) SetSPN /D ("HOST/" + ${Alias}) ${FSxAdComputer}.Name SetSPN /D ("HOST/" + ${Alias}.Split(".")[0]) ${FSxAdComputer}.Name 3. Repeat these steps for each DNS alias that you associated with the file system in Migrating your on-premises DNS configuration to FSx for Windows File Server. To set SPNs on your |
WindowsGuide-100 | WindowsGuide.pdf | 100 | Replace file_system_DNS_name with the original file system's DNS name . ## Delete SPNs for original file system's AD computer object Configure SPNs for Kerberos authentication 242 Amazon FSx for Windows File Server $Alias = "alias_fqdn" Windows User Guide $FileSystemDnsName = "file_system_dns_name" $FileSystemHost = (Resolve-DnsName ${FileSystemDnsName} | Where Type -eq 'A') [0].Name.Split(".")[0] $FSxAdComputer = (Get-AdComputer -Identity ${FileSystemHost}) SetSPN /D ("HOST/" + ${Alias}) ${FSxAdComputer}.Name SetSPN /D ("HOST/" + ${Alias}.Split(".")[0]) ${FSxAdComputer}.Name 3. Repeat these steps for each DNS alias that you associated with the file system in Migrating your on-premises DNS configuration to FSx for Windows File Server. To set SPNs on your Amazon FSx file system’s Active Directory computer object 1. Set new SPNs for your Amazon FSx file system by running the following commands. • Replace file_system_DNS_name with the DNS name that Amazon FSx assigned to the file system. To find your file system's DNS name on the Amazon FSx console, choose File systems, and choose your file system. Choose the Network & security pane of the file system details page. You can also get the DNS name in the response of the DescribeFileSystems API operation. • Replace alias_fqdn with the full DNS alias that you associated with the file system in Migrating your on-premises DNS configuration to FSx for Windows File Server. ## Set SPNs for FSx file system AD computer object $FSxDnsName = "file_system_DNS_name" $Alias = "alias_fqdn" $FileSystemHost = (Resolve-DnsName $FSxDnsName | Where Type -eq 'A') [0].Name.Split(".")[0] $FSxAdComputer = (Get-AdComputer -Identity $FileSystemHost) Set-AdComputer -Identity $FSxAdComputer -Add @{"msDS- AdditionalDnsHostname"="$Alias"} SetSpn /S ("HOST/" + $Alias.Split('.')[0]) $FSxAdComputer.Name SetSpn /S ("HOST/" + $Alias) $FSxAdComputer.Name Configure SPNs for Kerberos authentication 243 Amazon FSx for Windows File Server Windows User Guide Note Setting an SPN for your Amazon FSx file system will fail if an SPN for the DNS alias exists in the AD for the original file system's computer object. For information about finding and deleting existing SPNs, see To find and delete existing DNS alias SPNs on the original file system's Active Directory computer object. 2. Verify that the new SPNs are configured for the DNS alias using the following example script. Ensure that the response includes two HOST SPNs, HOST/alias and HOST/alias_fqdn. Replace file_system_DNS_name with the DNS name that Amazon FSx assigned to your file system. To find your file system's DNS name on the Amazon FSx console, choose File systems, choose your file system, and then choose the Network & security pane on the file system details page. You can also get the DNS name in the response of the DescribeFileSystems API operation. ## Verify SPNs on FSx file system AD computer object $FileSystemDnsName = "file_system_dns_name" $FileSystemHost = (Resolve-DnsName ${FileSystemDnsName} | Where Type -eq 'A') [0].Name.Split(".")[0] $FSxAdComputer = (Get-AdComputer -Identity ${FileSystemHost}) SetSpn /L ${FSxAdComputer}.Name 3. Repeat the previous steps for each DNS alias that you've associated with the file system in Migrating your on-premises DNS configuration to FSx for Windows File Server. Note You can enforce Kerberos authentication and encryption in transit with clients connecting to your file system using DNS aliases by setting the following Group Policy Objects (GPOs) in your Active Directory: • Restrict NTLM: Outgoing NTLM traffic to remote servers • Restrict NTLM: Add remote server exceptions for NTLM authentication Configure SPNs for Kerberos authentication 244 Amazon FSx for Windows File Server Windows User Guide For more information, see Enforcing Kerberos authentication using Group Policy Objects (GPOs) in Walkthrough 5: Using DNS aliases to access your file system. Update the DNS CNAME records for the Amazon FSx file system After you properly configure SPNs for your file system, you can cut over to Amazon FSx by replacing each DNS record that resolved to the original file system with a DNS record that resolves to the default DNS name of the Amazon FSx file system. To install the required PowerShell cmdlets 1. Log on to a Windows instance joined to the Active Directory that your Amazon FSx file system is joined to as a user that is a member of a group that has DNS administration permissions (AWS Delegated Domain Name System Administrators in AWS Managed Microsoft Active Directory, and Domain Admins or another group to which you've delegated DNS administration permissions in your self-managed Active Directory) For more information, see Connecting to your Windows instance in the Amazon EC2 User Guide. 2. Open PowerShell as administrator. 3. The PowerShell DNS server module is required to perform the instructions in this procedure. Install it using the following command. Install-WindowsFeature RSAT-DNS-Server To update an existing a DNS CNAME record 1. The following script updates any existing DNS CNAME records for the alias_fqdn to your Amazon FSx file system's computer object. If none is found, it creates a new DNS CNAME record for the DNS alias alias_fqdn that resolves to the default DNS name for your Amazon FSx file system. To |
WindowsGuide-101 | WindowsGuide.pdf | 101 | information, see Connecting to your Windows instance in the Amazon EC2 User Guide. 2. Open PowerShell as administrator. 3. The PowerShell DNS server module is required to perform the instructions in this procedure. Install it using the following command. Install-WindowsFeature RSAT-DNS-Server To update an existing a DNS CNAME record 1. The following script updates any existing DNS CNAME records for the alias_fqdn to your Amazon FSx file system's computer object. If none is found, it creates a new DNS CNAME record for the DNS alias alias_fqdn that resolves to the default DNS name for your Amazon FSx file system. To run the script: • Replace alias_fqdn with the DNS alias that you associated with the file system. Update the DNS CNAME records for the Amazon FSx file system 245 Amazon FSx for Windows File Server Windows User Guide • Replace file_system_DNS_name with the default DNS name Amazon FSx has assigned to the file system. $Alias="alias_fqdn" $FSxDnsName="file_system_dns_name" $AliasHost=$Alias.Split('.')[0] $ZoneName=((Get-WmiObject Win32_ComputerSystem).Domain) $DnsServerComputerName = (Resolve-DnsName $ZoneName -Type NS | Where Type -eq 'A' | Select -ExpandProperty Name)[0] Add-DnsServerResourceRecordCName -Name $AliasHost -ComputerName $DnsServerComputerName -HostNameAlias $FSxDnsName -ZoneName $ZoneName 2. Repeat the previous step for each DNS alias that you associated with the file system in Migrating your on-premises DNS configuration to FSx for Windows File Server. Update the DNS CNAME records for the Amazon FSx file system 246 Amazon FSx for Windows File Server Windows User Guide Monitoring FSx for Windows File Server file systems Monitoring is an important part of maintaining the reliability, availability, and performance of FSx for Windows File Server and your AWS solutions. You should collect monitoring data from all parts of your AWS solution so that you can more easily debug a failure if one occurs. However, before you start monitoring FSx for Windows File Server, you should create a monitoring plan that includes answers to the following questions: • What are your monitoring goals? • What resources will you monitor? • How often will you monitor these resources? • What monitoring tools will you use? • Who will perform the monitoring tasks? • Who should be notified when something goes wrong? For more information about logging and monitoring in FSx for Windows File Server, see the following topics. Topics • Automated and manual monitoring • Monitoring with Amazon CloudWatch • Logging Amazon FSx for Windows File Server API calls using AWS CloudTrail Automated and manual monitoring AWS provides various tools that you can use to monitor FSx for Windows File Server. You can configure some of these tools to do the monitoring for you, whereas some of the tools require manual intervention. We recommend that you automate monitoring tasks as much as possible. Automated monitoring tools You can use the following automated monitoring tools to watch FSx for Windows File Server and report when something is wrong: Automated and manual monitoring 247 Amazon FSx for Windows File Server Windows User Guide • Amazon CloudWatch Alarms – Watch a single metric over a time period that you specify, and perform one or more actions based on the value of the metric relative to a given threshold over a number of time periods. The action is a notification sent to an Amazon Simple Notification Service (Amazon SNS) topic or Amazon EC2 Auto Scaling policy. CloudWatch alarms do not invoke actions simply because they are in a particular state; the state must have changed and been maintained for a specified number of periods. For more information, see Monitoring with Amazon CloudWatch. • Amazon CloudWatch Logs – Monitor, store, and access your log files from AWS CloudTrail or other sources. For more information, see What Is Amazon CloudWatch Logs? in the Amazon CloudWatch Logs User Guide. • AWS CloudTrail Log Monitoring – Share log files between accounts, monitor CloudTrail log files in real time by sending them to CloudWatch Logs, write log processing applications in Java, and validate that your log files have not changed after delivery by CloudTrail. For more information, see Working with CloudTrail Log Files in the AWS CloudTrail User Guide. Manual monitoring tools Another important part of monitoring FSx for Windows File Server involves manually monitoring those items that the Amazon CloudWatch alarms don't cover. The FSx for Windows File Server, CloudWatch, and other AWS console dashboards provide an at-a-glance view of the state of your AWS environment. Amazon FSx Monitoring & performance dashboard shows: • Current warnings and CloudWatch alarms • A summary of file system activity • File system storage capacity and utilization • File server and storage volume performance • CloudWatch alarms Amazon CloudWatch Dashboard shows: • Current alarms and status • Graphs of alarms and resources • Service health status Manual monitoring tools 248 Amazon FSx for Windows File Server Windows User Guide In addition, you can use CloudWatch to do the following: • Create |
WindowsGuide-102 | WindowsGuide.pdf | 102 | File Server, CloudWatch, and other AWS console dashboards provide an at-a-glance view of the state of your AWS environment. Amazon FSx Monitoring & performance dashboard shows: • Current warnings and CloudWatch alarms • A summary of file system activity • File system storage capacity and utilization • File server and storage volume performance • CloudWatch alarms Amazon CloudWatch Dashboard shows: • Current alarms and status • Graphs of alarms and resources • Service health status Manual monitoring tools 248 Amazon FSx for Windows File Server Windows User Guide In addition, you can use CloudWatch to do the following: • Create customized dashboards to monitor the services you use. • Graph metric data to troubleshoot issues and discover trends. • Search and browse all your AWS resource metrics. • Create and edit alarms to be notified of problems. For more information about the Amazon FSx Monitoring & performance dashboard, see Using file system metrics. Monitoring with Amazon CloudWatch Amazon CloudWatch collects and processes raw data from your FSx for Windows File Server file system into readable, near real-time metrics. These statistics are retained for a period of 15 months, giving you to access historical information to help gain perspectives on how your workflow or file system is performing. FSx for Windows File Server publishes CloudWatch metrics in the following domains: • Network I/O metrics measure activity between clients accessing the file system and the file server. • File server metrics measure network throughput utilization, file server CPU and memory, and file server disk throughput and IOPS utilization. • Disk I/O metrics measure activity between the file server and the storage volumes. • Storage volume metrics measure disk throughput utilization for HDD storage volumes, and IOPS utilization for SSD storage volumes. • Storage capacity metrics measure storage usage, including storage savings due to Data Deduplication. The following diagram illustrates an FSx for Windows File Server file system, its components, and the metric domains. Monitoring with Amazon CloudWatch 249 Amazon FSx for Windows File Server Windows User Guide By default, Amazon FSx for Windows File Server sends metric data to CloudWatch at 1-minute periods, with the following exceptions that are emitted in 5-minute intervals: • FileServerDiskThroughputBalance • FileServerDiskIopsBalance For more information about CloudWatch, see What is Amazon CloudWatch? in the Amazon CloudWatch User Guide. Metrics might not be published for Single-AZ file systems during file system maintenance or infrastructure component replacement, and for Multi-AZ file systems during failover and failback between the primary and secondary file servers. Some Amazon FSx CloudWatch metrics are reported as raw Bytes. Bytes are not rounded to either a decimal or binary multiple of the unit. Topics • CloudWatch metrics and dimensions • Using file system metrics • Performance warnings and recommendations • Accessing file system metrics • Creating CloudWatch alarms CloudWatch metrics and dimensions FSx for Windows File Server publishes the following metrics into the AWS/FSx namespace in Amazon CloudWatch for all file systems: Metrics and dimensions 250 Amazon FSx for Windows File Server • DataReadBytes • DataWriteBytes • DataReadOperations • DataWriteOperations • MetadataOperations • FreeStorageCapacity Windows User Guide FSx for Windows File Server publishes the metrics described in the following sections into the AWS/ FSx namespace in Amazon CloudWatch for file systems configured with a throughput capacity of at least 32 MBps. Network I/O metrics The AWS/FSx namespace includes the following network I/O metrics. Metric Description DataReadBytes The number of bytes for read operations for clients accessing the file system. Units: Bytes Valid statistics: Sum DataWriteBytes The number of bytes for write operations for clients accessing the file system. Units: Bytes Valid statistics: Sum The number of read operations for clients accessing the file system. Units: Count Valid statistics: Sum The number of write operations for clients accessing the file system. 251 DataReadO perations DataWrite Operations Metrics and dimensions Amazon FSx for Windows File Server Windows User Guide Metric Description Units: Count Valid statistics: Sum MetadataO perations The number of metadata operations for clients accessing the file system. Units: Count Valid statistics: Sum The number of active connections between clients and the file server. Units: Count ClientCon nections File server metrics The AWS/FSx namespace includes the following file server metrics. Metric Description NetworkThroughputU tilization The network throughput for clients accessing the file system, as a percentage of the provisioned limit. Units: Percent CPUUtilization The percentage utilization of your file server’s CPU resources. Units: Percent MemoryUtilization The percentage utilization of your file server’s memory resources. Units: Percent Metrics and dimensions 252 Amazon FSx for Windows File Server Windows User Guide Metric Description FileServerDiskThro ughputUtilization The disk throughput between your file server and its storage volumes, as a percentage of the provisioned limit determined by throughput capacity. FileServerDiskThro ughputBalance Units: Percent The percentage of available burst credits for disk throughput between your file server and its storage volumes. |
WindowsGuide-103 | WindowsGuide.pdf | 103 | throughput for clients accessing the file system, as a percentage of the provisioned limit. Units: Percent CPUUtilization The percentage utilization of your file server’s CPU resources. Units: Percent MemoryUtilization The percentage utilization of your file server’s memory resources. Units: Percent Metrics and dimensions 252 Amazon FSx for Windows File Server Windows User Guide Metric Description FileServerDiskThro ughputUtilization The disk throughput between your file server and its storage volumes, as a percentage of the provisioned limit determined by throughput capacity. FileServerDiskThro ughputBalance Units: Percent The percentage of available burst credits for disk throughput between your file server and its storage volumes. Valid for file systems provisioned with throughput capacity of 256 MBps or less. Units: Percent FileServerDiskIops Utilization The disk IOPS between your file server and storage volumes, as a percentage of the provisioned limit determined by throughput capacity. Units: Percent FileServerDiskIopsBalance The percentage of available burst credits for disk IOPS between your file server and its storage volumes. Valid for file systems provisioned with throughput capacity of 256 MBps or less. Units: Percent Disk I/O metrics The AWS/FSx namespace includes the following disk I/O metrics. Metric Description DiskReadBytes The number of bytes for read operations that access storage volumes. Units: Bytes Valid statistics: Sum Metrics and dimensions 253 Amazon FSx for Windows File Server Windows User Guide Metric Description DiskWriteBytes The number of bytes for write operations that access storage volumes. Units: Bytes Valid statistics: Sum DiskReadO perations The number of read operations for the file server accessing storage volumes. Units: Count Valid statistics: Sum DiskWrite Operations The number of write operations for the file server accessing storage volumes. Units: Count Valid statistics: Sum FSx for Windows storage volume metrics The AWS/FSx namespace includes the following storage volume metrics. Metric Description DiskThroughputUtilization (HDD only) The disk throughput between your file server and its storage volumes, as a percentage of the provisioned limit determined by the storage volumes. Units: Percent DiskThroughputBalance (HDD only) The percentage of available burst credits for disk throughput and disk IOPS for the storage volumes. Units: Percent Metrics and dimensions 254 Amazon FSx for Windows File Server Windows User Guide Metric Description DiskIopsUtilization (SSD only) The disk IOPS between your file server and storage volumes, as a percentage of the provisioned IOPS limit determined by the storage volumes. Units: Percent Storage capacity metrics The AWS/FSx namespace includes the following storage capacity metrics. Metric Description FreeStorageCapacity The amount of available storage capacity. Units: Bytes Valid statistics: Average, Minimum StorageCapacityUtilization Used physical storage capacity as a percentage of total storage capacity. Units: Percent DeduplicationSavedStorage The amount of storage space saved by data deduplica tion, if it is enabled. Units: Bytes Namespace and dimensions for FSx for Windows File Server metrics FSx for Windows File Server metrics use the FSx namespace and provide metrics for a single dimension, FileSystemId. You can find a file system's ID using the describe-file-systems AWS CLI command or the DescribeFileSystems API command. A file system ID takes the form of fs-0123456789abcdef0. Metrics and dimensions 255 Amazon FSx for Windows File Server Windows User Guide Using file system metrics There are two primary architectural components of each Amazon FSx file system: • The file server that serves data to clients accessing the file system. • The storage volumes that host the data in your file system. FSx for Windows File Server reports metrics in CloudWatch that track the performance and resource utilization for your file system's file server and storage volumes. The following diagram illustrates an Amazon FSx file system with its architectural components, and the performance and resource CloudWatch metrics available for monitoring. The key property shown for a set of metrics is the file system property that determines the capacity for those metrics. Adjusting that property modifies the file system's performance for that set of metrics. Use the Monitoring & performance panel in the Amazon FSx console to view the FSx for Windows File Server CloudWatch metrics described in the following table. How do I... Monitorin g & performan ce panel Chart Relevant metrics ...determine my file system's total IOPS? Summary Total IOPS SUM(DataReadO perations + DataWriteOperations Using CloudWatch metrics 256 Amazon FSx for Windows File Server Windows User Guide How do I... Monitorin g & performan ce panel ...determine my file system's total throughput? ...determine the amount of available storage capacity on my file system? ...determine the number of connections established between clients and the file server? ...determine the amount of used physical disk space as a percentage of the file system's total storage capacity? Storage ...determine the amount of physical disk space saved by data deduplication? Chart Relevant metrics + MetadataOperations )/Period (in seconds) Total throughpu t SUM(DataReadBytes + DataWriteBytes )/ Period (in seconds) FreeStorageCapacity ClientConnections StorageCapacityUti lization DeduplicationSaved Storage Available storage capacity Client connectio ns Storage capacity utilizati on Storage saved |
WindowsGuide-104 | WindowsGuide.pdf | 104 | g & performan ce panel ...determine my file system's total throughput? ...determine the amount of available storage capacity on my file system? ...determine the number of connections established between clients and the file server? ...determine the amount of used physical disk space as a percentage of the file system's total storage capacity? Storage ...determine the amount of physical disk space saved by data deduplication? Chart Relevant metrics + MetadataOperations )/Period (in seconds) Total throughpu t SUM(DataReadBytes + DataWriteBytes )/ Period (in seconds) FreeStorageCapacity ClientConnections StorageCapacityUti lization DeduplicationSaved Storage Available storage capacity Client connectio ns Storage capacity utilizati on Storage saved from Data Deduplica tion Performan ce - File server ...determine the network throughput for clients accessing the file system, as a percentage of the file system's provisioned throughput? Network throughpu t utilizati on NetworkThroughputU tilization 1 Using CloudWatch metrics 257 Amazon FSx for Windows File Server Windows User Guide How do I... Monitorin g & performan ce panel Chart Relevant metrics ...determine the disk throughput between file server and its storage volumes, as a percentage of the provisioned limit Disk throughpu t utilizati determined by Throughput Capacity? on FileServerDiskThro ughputUtilization 1 ...determine the percentage of available burst credits for disk throughput between Disk throughpu FileServerDiskThro ughputBalance the file server and its storage volumes? t burst balance ...determine the amount of disk IOPS between the file server and storage Disk IOPS utilizati FileServerDiskIops Utilization volumes, as a percentage of the provision on ed limit determined by Throughput Capacity? ...determine the percentage of available burst credits for disk IOPS between the file Disk IOPS burst FileServerDiskIops Balance server and storage volumes? ...determine the file server's CPU utilization percentage? ...determine the file server's memory utilization percentage? balance CPU utilizati on Memory utilizati on CPUUtilization MemoryUtilization Performan ce – Storage ...determine the throughput for operation s that access storage volumes, as a percentage of the provisioned limit volumes determined by HDD Storage Capacity? Disk throughpu t utilizati on (HDD) DiskThroughputUtil ization Using CloudWatch metrics 258 Amazon FSx for Windows File Server Windows User Guide How do I... Monitorin g & performan ce panel Chart Relevant metrics ...determine the percentage of available throughput and IOPS burst credits for Disk throughpu DiskThroughputBala nce 2 operations that access HDD storage volumes? t burst balance (HDD) ...determine the IOPS for operations that access storage volumes, as a percentage of the provisioned limit determined by HDD Disk IOPS utilizati on (HDD) Storage Capacity? ...determine the IOPS for operations that access storage volumes, as a percentage of Disk IOPS utilizati the provisioned limit determined by SSD on (SSD) Storage Capacity? SUM(DiskReadO perations + DiskWriteOperation s ) / Period (in seconds) / (12 * provisioned HDD storage capacity in TiB) DiskIopsUtilization Note 1We recommend that you maintain an average throughput capacity utilization under 50% to ensure that you have enough spare throughput capacity for unexpected spikes in your workload, as well as for any background Windows storage operations (such as storage synchronization, deduplication, or shadow copies). 2HDD storage volumes can experience significant performance variations depending on the workload. Sudden spikes in IOPS or throughput can lead to disk performance degradation. For more information, see HDD burst performance. Using CloudWatch metrics 259 Amazon FSx for Windows File Server Windows User Guide Performance warnings and recommendations FSx for Windows provides you with performance warnings for file systems configured with a throughput capacity of at least 32 MBps. Amazon FSx displays a warning for a set of the CloudWatch metrics whenever one of these metrics has approached or crossed a predetermined threshold for multiple consecutive data points. These warnings provide you with actionable recommendations that you can use to optimize your file system's performance. Warnings are accessible in several areas of the Monitoring & performance dashboard. All active or recent Amazon FSx performance warnings and any CloudWatch alarms configured for the file system that are in an ALARM state appear in the Monitoring & performance panel in the Summary section. The warning also appears in the section of the dashboard that the metric graph is displayed. You can create CloudWatch alarms for any of the Amazon FSx metrics. For more information, see Creating CloudWatch alarms. Use performance warnings to improve file system performance Amazon FSx provides actionable recommendations that you can use to optimize your file system's performance. These recommendations describe how you can address a potential performance bottle neck. You can take the recommended action if you expect the activity to continue, or if it's causing an impact to your file system's performance. Depending on which metric has triggered a warning, you can resolve it by increasing either the file system's throughput capacity or storage capacity, as described in the following table. If there's a warning for this metric Do this Network throughput – utilization File server > Disk IOPS – utilization File |
WindowsGuide-105 | WindowsGuide.pdf | 105 | FSx provides actionable recommendations that you can use to optimize your file system's performance. These recommendations describe how you can address a potential performance bottle neck. You can take the recommended action if you expect the activity to continue, or if it's causing an impact to your file system's performance. Depending on which metric has triggered a warning, you can resolve it by increasing either the file system's throughput capacity or storage capacity, as described in the following table. If there's a warning for this metric Do this Network throughput – utilization File server > Disk IOPS – utilization File server > Disk throughput – utilization Increase throughput capacity File server > Disk IOPS - burst balance File server > Disk throughput – burst balance Storage capacity utilization Increase storage capacity Performance warnings and recommendations 260 Amazon FSx for Windows File Server Windows User Guide If there's a warning for this metric Do this Storage volume > Disk throughput – utilization (HDD) Storage volume > Disk throughput – burst balance (HDD) Increase storage capacity or switch to SDD storage type Storage volume > Disk IOPS – utilization (SSD) Increase SSD IOPS Note Certain file system events can consume disk I/O performance resources and potentially trigger performance warnings. For example: • The optimization phase of storage capacity scaling can generate increased disk throughput, as described in Storage capacity increases and file system performance • For Multi-AZ file systems, events such as throughput capacity scaling, hardware replacement, or Availability Zone disruption result in automatic failover and failback events. Any data changes that occur during this time need to be synchronized between the primary and secondary file servers, and Windows Server runs a data synchronization job that can consume disk I/O resources. For more information, see Managing throughput capacity. For more information file system performance, see FSx for Windows File Server performance. Accessing file system metrics You can see Amazon FSx metrics for CloudWatch in the following ways. • The Amazon FSx console • The CloudWatch console • The CloudWatch CLI • The CloudWatch API The following procedures describe how to access your file system's metrics using these various tools. Accessing file system metrics 261 Amazon FSx for Windows File Server Windows User Guide To view file system metrics using the Amazon FSx console 1. Open the Amazon FSx console at https://console.aws.amazon.com/fsx/. 2. To display the File system details page, choose File systems in the navigation pane. 3. Choose the file system whose metrics you want to view. 4. To view graphs of the file system's metrics, choose Monitoring & performance on the second panel. • The Summary metrics are displayed by default, showing any active warnings and CloudWatch alarms along with File system activity metrics. • Choose Storage to view storage capacity and utilization metrics. • Choose Performance to view file server and storage performance metrics Accessing file system metrics 262 Amazon FSx for Windows File Server Windows User Guide • Choose CloudWatch alarms to view graphs of any alarms configured for the file system. For more information, see Using file system metrics To view metrics in the CloudWatch console 1. To view a file system metric in the Metrics page of the Amazon CloudWatch console, navigate to the metric in the Monitoring & performance panel of the Amazon FSx console. 2. Choose View in metrics from the actions menu in the upper right of the metric graph, as shown in the following image. This opens the Metrics page in the CloudWatch console, showing the metric graph, as shown in the following image. Accessing file system metrics 263 Amazon FSx for Windows File Server Windows User Guide To add metrics to a CloudWatch dashboard 1. To add a set of FSx for Windows file system metrics to a dashboard in the CloudWatch console, choose the set of metrics (Summary, Storage, or Performance) in the Monitoring & performance panel of the Amazon FSx console. 2. Choose Add to dashboard in the upper right of the panel, this opens the CloudWatch console. 3. Select an existing CloudWatch dashboard from the list, or create a new dashboard. For more information, see Using Amazon CloudWatch dashboards in the Amazon CloudWatch User Guide. To access metrics from the AWS CLI • Use the list-metrics command with the --namespace "AWS/FSx" namespace. For more information, see the AWS CLI Command Reference. $ aws cloudwatch list-metrics --namespace "AWS/FSx" aws cloudwatch list-metrics --namespace "AWS/FSx" { "Metrics": [ { "Namespace": "AWS/FSx", "MetricName": "DataWriteOperationTime", "Dimensions": [ { Accessing file system metrics 264 Amazon FSx for Windows File Server Windows User Guide "Name": "FileSystemId", "Value": "fs-09a106ebc3a0bb087" } ] }, { "Namespace": "AWS/FSx", "MetricName": "CapacityPoolWriteBytes", "Dimensions": [ { "Name": "VolumeId", "Value": "fsvol-0cb2281509f5db3c2" }, { "Name": "FileSystemId", "Value": "fs-09a106ebc3a0bb087" } ] }, { "Namespace": "AWS/FSx", "MetricName": "DiskReadBytes", "Dimensions": [ { "Name": "FileSystemId", "Value": "fs-09a106ebc3a0bb087" } ] |
WindowsGuide-106 | WindowsGuide.pdf | 106 | the AWS CLI • Use the list-metrics command with the --namespace "AWS/FSx" namespace. For more information, see the AWS CLI Command Reference. $ aws cloudwatch list-metrics --namespace "AWS/FSx" aws cloudwatch list-metrics --namespace "AWS/FSx" { "Metrics": [ { "Namespace": "AWS/FSx", "MetricName": "DataWriteOperationTime", "Dimensions": [ { Accessing file system metrics 264 Amazon FSx for Windows File Server Windows User Guide "Name": "FileSystemId", "Value": "fs-09a106ebc3a0bb087" } ] }, { "Namespace": "AWS/FSx", "MetricName": "CapacityPoolWriteBytes", "Dimensions": [ { "Name": "VolumeId", "Value": "fsvol-0cb2281509f5db3c2" }, { "Name": "FileSystemId", "Value": "fs-09a106ebc3a0bb087" } ] }, { "Namespace": "AWS/FSx", "MetricName": "DiskReadBytes", "Dimensions": [ { "Name": "FileSystemId", "Value": "fs-09a106ebc3a0bb087" } ] }, { "Namespace": "AWS/FSx", "MetricName": "CompressionRatio", "Dimensions": [ { "Name": "FileSystemId", "Value": "fs-0f84c9a176a4d7c92" } ] }, . . . } Accessing file system metrics 265 Amazon FSx for Windows File Server Using the CloudWatch API To access metrics from the CloudWatch API Windows User Guide • Call GetMetricStatistics. For more information, see Amazon CloudWatch API Reference. Creating CloudWatch alarms You can create a CloudWatch alarm that sends an Amazon SNS message when the alarm changes state. An alarm watches a single metric over a time period you specify, and performs one or more actions based on the value of the metric relative to a given threshold over a number of time periods. The action is a notification sent to an Amazon SNS topic or Auto Scaling policy. Alarms invoke actions for sustained state changes only. CloudWatch alarms don't invoke actions simply because they are in a particular state; the state must have changed and been maintained for a specified number of periods. You can create an alarm from the Amazon FSx console or the CloudWatch console. The following procedures describe how to create alarms for Amazon FSx using the console, AWS CLI, and API. To set a CloudWatch alarm (console) 1. Open the Amazon FSx console at https://console.aws.amazon.com/fsx/. 2. From the navigation pane, choose File systems, and then choose the file system you want to create the alarm for. 3. Choose the Actions menu, and choose View details. 4. On the Summary page, choose Monitoring and performance. 5. Choose CloudWatch alarms. 6. Choose Create CloudWatch alarm. You are redirected to the CloudWatch console. 7. Choose Select metrics, and choose Next. 8. In the Metrics section, choose FSX. 9. Choose File System Metrics, choose the metric you want to set the alarm for, and then choose Select metric. 10. In the Conditions section, choose the conditions you want for the alarm, and choose Next. Creating CloudWatch alarms 266 Amazon FSx for Windows File Server Windows User Guide Note Metrics may not be published during file system maintenance for Single-AZ file systems, or during failover and failback to or from the primary or secondary servers for Multi-AZ file systems. To prevent unnecessary and misleading alarm condition changes and to configure your alarms so that they are resilient to missing data points, see Configuring how CloudWatch alarms treat missing data in the Amazon CloudWatch User Guide. 11. If you want CloudWatch to send you an email or SNS notification when the alarm state triggers the action, choose an alarm state for Whenever this alarm state is. For select an SNS topic, choose an existing SNS topic. If you select Create topic, you can set the name and email addresses for a new email subscription list. This list is saved and appears in the field for future alarms. Choose Next. Note If you use Create topic to create a new Amazon SNS topic, the email addresses must be verified before they receive notifications. Emails are only sent when the alarm enters an alarm state. If this alarm state change happens before the email addresses are verified, they do not receive a notification. 12. Fill in the Name, Description, and Whenever values for the metric, and choose Next. 13. On the Preview and create page, review the alarm you're about to create, and then choose Create Alarm. To set alarms using the CloudWatch console 1. Sign in to the AWS Management Console and open the CloudWatch console at https:// console.aws.amazon.com/cloudwatch/. 2. Choose Create Alarm to start the Create Alarm Wizard. 3. Choose FSx Metrics, and scroll through the Amazon FSx metrics to locate the metric you want to place an alarm on. To display just the Amazon FSx metrics in this dialog box, search on the file system ID of your file system. Select the metric to create an alarm on, and choose Next. 4. Fill in the Name, Description, and Whenever values for the metric. Creating CloudWatch alarms 267 Amazon FSx for Windows File Server Windows User Guide 5. If you want CloudWatch to send you an email when the alarm state is reached, for Whenever this alarm, choose State is ALARM. For Send notification to, choose an existing SNS topic. If you select |
WindowsGuide-107 | WindowsGuide.pdf | 107 | you want to place an alarm on. To display just the Amazon FSx metrics in this dialog box, search on the file system ID of your file system. Select the metric to create an alarm on, and choose Next. 4. Fill in the Name, Description, and Whenever values for the metric. Creating CloudWatch alarms 267 Amazon FSx for Windows File Server Windows User Guide 5. If you want CloudWatch to send you an email when the alarm state is reached, for Whenever this alarm, choose State is ALARM. For Send notification to, choose an existing SNS topic. If you select Create topic, you can set the name and email addresses for a new email subscription list. This list is saved and appears in the field for future alarms. Note If you use Create topic to create a new Amazon SNS topic, the email addresses must be verified before they receive notifications. Emails are only sent when the alarm enters an alarm state. If this alarm state change happens before the email addresses are verified, they do not receive a notification. 6. At this point, the Alarm Preview area gives you a chance to preview the alarm you're about to create. Choose Create Alarm. To set a CloudWatch alarm (CLI) • Call put-metric-alarm. For more information, see AWS CLI Command Reference. To set an alarm (API) • Call PutMetricAlarm. For more information, see Amazon CloudWatch API Reference. Logging Amazon FSx for Windows File Server API calls using AWS CloudTrail Amazon FSx for Windows File Server is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in Amazon FSx. CloudTrail captures all API calls for Amazon FSx as events. The calls captured include calls from the Amazon FSx console and code calls to the Amazon FSx API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Amazon FSx. If you don't configure a trail, you can still view the most recent events in the CloudTrail console in Event history. Using the information collected by CloudTrail, you can determine the request that was made to Amazon FSx, the IP address from which the request was made, who made the request, when it was made, and additional details. To learn more about CloudTrail, see the AWS CloudTrail User Guide. CloudTrail logs 268 Amazon FSx for Windows File Server Windows User Guide Amazon FSx information in CloudTrail CloudTrail is enabled on your AWS account when you create the account. When activity occurs in Amazon FSx, that activity is recorded in a CloudTrail event along with other AWS service events in Event history. You can view, search, and download recent events in your AWS account. For more information, see Viewing events with CloudTrail Event history. For an ongoing record of events in your AWS account, including events for Amazon FSx, create a trail. A trail enables CloudTrail to deliver log files to an Amazon S3 bucket. By default, when you create a trail in the console, the trail applies to all AWS Regions. The trail logs events from all Regions in the AWS partition and delivers the log files to the Amazon S3 bucket that you specify. Additionally, you can configure other AWS services to further analyze and act upon the event data collected in CloudTrail logs. For more information, see the following: • Overview for creating a trail • CloudTrail supported services and integrations • Configuring Amazon SNS notifications for CloudTrail • Receiving CloudTrail log files from multiple regions and Receiving CloudTrail log files from multiple accounts All Amazon FSx actions are logged by CloudTrail and are documented in the Amazon FSx API Reference. For example, calls to the CreateFileSystem, CreateBackup and TagResource actions generate entries in the CloudTrail log files. Every event or log entry contains information about who generated the request. The identity information helps you determine the following: • Whether the request was made with root or AWS Identity and Access Management (IAM) user credentials. • Whether the request was made with temporary security credentials for a role or federated user. • Whether the request was made by another AWS service. For more information, see the CloudTrail userIdentity element. Amazon FSx information in CloudTrail 269 Amazon FSx for Windows File Server Windows User Guide Understanding Amazon FSx log file entries A trail is a configuration that enables delivery of events as log files to an Amazon S3 bucket that you specify. CloudTrail log files contain one or more log entries. An event represents a single request from any source and includes information about the requested action, the date and time of the action, request parameters, and so on. CloudTrail log files aren't an ordered stack trace of |
WindowsGuide-108 | WindowsGuide.pdf | 108 | by another AWS service. For more information, see the CloudTrail userIdentity element. Amazon FSx information in CloudTrail 269 Amazon FSx for Windows File Server Windows User Guide Understanding Amazon FSx log file entries A trail is a configuration that enables delivery of events as log files to an Amazon S3 bucket that you specify. CloudTrail log files contain one or more log entries. An event represents a single request from any source and includes information about the requested action, the date and time of the action, request parameters, and so on. CloudTrail log files aren't an ordered stack trace of the public API calls, so they don't appear in any specific order. The following example shows a CloudTrail log entry that demonstrates the TagResource operation when a tag for a file system is created from the console. { "eventVersion": "1.05", "userIdentity": { "type": “Root”, "principalId": “111122223333”, "arn": "arn:aws:sts::111122223333:root”, "accountId": “111122223333”, "accessKeyId": "AKIAIOSFODNN7EXAMPLE”, "sessionContext": { "attributes": { "mfaAuthenticated": "false", "creationDate": "2018-11-14T22:36:07Z" } } }, "eventTime": "2018-11-14T22:36:07Z", "eventSource": "fsx.amazonaws.com", "eventName": "TagResource", "awsRegion": "us-east-1", "sourceIPAddress": “192.0.2.0”, "userAgent": “console.amazonaws.com”, "requestParameters": { "resourceARN": "arn:aws:fsx:us-east-1:111122223333:file-system/fs- ab12cd34ef56gh789” }, "responseElements": null, "requestID": “aEXAMPLE-abcd-1234-56ef-b4cEXAMPLE51”, "eventID": “bEXAMPLE-gl12-3f5h-3sh4-ab6EXAMPLE9p”, "eventType": "AwsApiCall", "apiVersion": "2018-03-01", "recipientAccountId": “111122223333” Understanding Amazon FSx log file entries 270 Amazon FSx for Windows File Server Windows User Guide } The following example shows a CloudTrail log entry that demonstrates the UntagResource action when a tag for a file system is deleted from the console. { "eventVersion": "1.05", "userIdentity": { "type": “Root”, "principalId": "111122223333", "arn": "arn:aws:sts::111122223333:root", "accountId": "111122223333", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "attributes": { "mfaAuthenticated": "false", "creationDate": "2018-11-14T23:40:54Z" } } }, "eventTime": "2018-11-14T23:40:54Z", "eventSource": "fsx.amazonaws.com", "eventName": "UntagResource", "awsRegion": "us-east-1", "sourceIPAddress": "192.0.2.0", "userAgent": "console.amazonaws.com", "requestParameters": { "resourceARN": "arn:aws:fsx:us-east-1:111122223333:file-system/fs- ab12cd34ef56gh789" }, "responseElements": null, "requestID": "aEXAMPLE-abcd-1234-56ef-b4cEXAMPLE51", "eventID": "bEXAMPLE-gl12-3f5h-3sh4-ab6EXAMPLE9p", "eventType": "AwsApiCall", "apiVersion": "2018-03-01", "recipientAccountId": "111122223333" } Understanding Amazon FSx log file entries 271 Amazon FSx for Windows File Server Windows User Guide Security in Amazon FSx Cloud security at AWS is the highest priority. As an AWS customer, you benefit from a data center and network architecture that is built to meet the requirements of the most security-sensitive organizations. Security is a shared responsibility between AWS and you. The shared responsibility model describes this as security of the cloud and security in the cloud: • Security of the cloud – AWS is responsible for protecting the infrastructure that runs AWS services in the Amazon Web Services Cloud. AWS also provides you with services that you can use securely. Third-party auditors regularly test and verify the effectiveness of our security as part of the AWS compliance programs. To learn about the compliance programs that apply to Amazon FSx for Windows File Server, see AWS Services in Scope by Compliance Program. • Security in the cloud – Your responsibility is determined by the AWS service that you use. You are also responsible for other factors including the sensitivity of your data, your company’s requirements, and applicable laws and regulations. This documentation helps you understand how to apply the shared responsibility model when using Amazon FSx for Windows File Server. The following topics show you how to configure Amazon FSx for Windows File Server to meet your security and compliance objectives. You also learn how to use other AWS services that help you to monitor and secure your Amazon FSx for Windows File Server resources. Topics • Data protection in Amazon FSx for Windows File Server • File- and folder-level access control using Windows ACLs • File system access control with Amazon VPC • Logging end user access with file access auditing • Identity and access management for Amazon FSx for Windows File Server • Compliance Validation for Amazon FSx for Windows File Server • Amazon FSx for Windows File Server and interface VPC endpoints 272 Amazon FSx for Windows File Server Windows User Guide Data protection in Amazon FSx for Windows File Server The AWS shared responsibility model applies to data protection in Amazon FSx for Windows File Server. As described in this model, AWS is responsible for protecting the global infrastructure that runs all of the AWS Cloud. You are responsible for maintaining control over your content that is hosted on this infrastructure. You are also responsible for the security configuration and management tasks for the AWS services that you use. For more information about data privacy, see the Data Privacy FAQ. For information about data protection in Europe, see the AWS Shared Responsibility Model and GDPR blog post on the AWS Security Blog. For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS IAM Identity Center or AWS Identity and Access Management (IAM). That way, each user is given only the permissions necessary to fulfill their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) |
WindowsGuide-109 | WindowsGuide.pdf | 109 | the AWS services that you use. For more information about data privacy, see the Data Privacy FAQ. For information about data protection in Europe, see the AWS Shared Responsibility Model and GDPR blog post on the AWS Security Blog. For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS IAM Identity Center or AWS Identity and Access Management (IAM). That way, each user is given only the permissions necessary to fulfill their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) with each account. • Use SSL/TLS to communicate with AWS resources. We require TLS 1.2 and recommend TLS 1.3. • Set up API and user activity logging with AWS CloudTrail. For information about using CloudTrail trails to capture AWS activities, see Working with CloudTrail trails in the AWS CloudTrail User Guide. • Use AWS encryption solutions, along with all default security controls within AWS services. • Use advanced managed security services such as Amazon Macie, which assists in discovering and securing sensitive data that is stored in Amazon S3. • If you require FIPS 140-3 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS endpoint. For more information about the available FIPS endpoints, see Federal Information Processing Standard (FIPS) 140-3. We strongly recommend that you never put confidential or sensitive information, such as your customers' email addresses, into tags or free-form text fields such as a Name field. This includes when you work with FSx for Windows File Server or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into tags or free-form text fields used for names may be used for billing or diagnostic logs. If you provide a URL to an external server, we strongly recommend that you do not include credentials information in the URL to validate your request to that server. Data protection 273 Amazon FSx for Windows File Server Windows User Guide Data encryption in FSx for Windows File Server Amazon FSx for Windows File Server supports encryption of data at rest and encryption of data in transit. Encryption of data at rest is automatically enabled when creating an Amazon FSx file system. Encryption of data in transit is supported on file shares that are mapped on a compute instance that supports SMB protocol 3.0 or newer. Amazon FSx automatically encrypts data in transit using SMB encryption as you access your file system without the need for you to modify your applications. When to use encryption If your organization is subject to corporate or regulatory policies that require encryption of data and metadata at rest, we recommend creating an encrypted file system mounting your file system using encryption of data in transit. If your organization is subject to corporate or regulatory policies that require encryption of data and metadata at rest, your data is automatically encrypted at rest. We also recommend that you enable encryption of data in transit by mounting your file system using encryption of data in transit. Encryption of data at rest All Amazon FSx file systems are encrypted at rest with keys managed using AWS Key Management Service (AWS KMS). Data is automatically encrypted before being written to the file system, and automatically decrypted as it is read. These processes are handled transparently by Amazon FSx, so you don't have to modify your applications. Amazon FSx uses an industry-standard AES-256 encryption algorithm to encrypt Amazon FSx data and metadata at rest. For more information, see Cryptography Basics in the AWS Key Management Service Developer Guide. Note The AWS key management infrastructure uses Federal Information Processing Standards (FIPS) 140-2 approved cryptographic algorithms. The infrastructure is consistent with National Institute of Standards and Technology (NIST) 800-57 recommendations. Data encryption 274 Amazon FSx for Windows File Server Windows User Guide How Amazon FSx uses AWS KMS Amazon FSx integrates with AWS KMS for key management. Amazon FSx uses an AWS KMS key to encrypt your file system. You choose the KMS key used to encrypt and decrypt file systems (both data and metadata). You can enable, disable, or revoke grants on this KMS key. This KMS key can be one of the two following types: • AWS managed key – This is the default KMS key, and it's free to use. • Customer managed key – This is the most flexible KMS key to use, because you can configure its key policies and grants for multiple users or services. For more information on creating customer managed keys, see Creating keys in the AWS Key Management Service Developer Guide. If you use a customer managed key as your KMS key for file data encryption and decryption, you can enable |
WindowsGuide-110 | WindowsGuide.pdf | 110 | revoke grants on this KMS key. This KMS key can be one of the two following types: • AWS managed key – This is the default KMS key, and it's free to use. • Customer managed key – This is the most flexible KMS key to use, because you can configure its key policies and grants for multiple users or services. For more information on creating customer managed keys, see Creating keys in the AWS Key Management Service Developer Guide. If you use a customer managed key as your KMS key for file data encryption and decryption, you can enable key rotation. When you enable key rotation, AWS KMS automatically rotates your key once per year. Additionally, with a customer managed key, you can choose when to disable, re- enable, delete, or revoke access to your KMS key at any time. For more information, see Rotating AWS KMS keys in the AWS Key Management Service Developer Guide. Amazon FSx Key policies for AWS KMS Key policies are the primary way to control access to KMS keys. For more information on key policies, see Using key policies in AWS KMS in the AWS Key Management Service Developer Guide. The following list describes all the AWS KMS-related permissions supported by Amazon FSx for encrypted at rest file systems: • kms:Encrypt – (Optional) Encrypts plaintext into ciphertext. This permission is included in the default key policy. • kms:Decrypt – (Required) Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted. This permission is included in the default key policy. • kms:ReEncrypt – (Optional) Encrypts data on the server side with a new KMS key, without exposing the plaintext of the data on the client side. The data is first decrypted and then re- encrypted. This permission is included in the default key policy. • kms:GenerateDataKeyWithoutPlaintext – (Required) Returns a data encryption key encrypted under a KMS key. This permission is included in the default key policy under kms:GenerateDataKey*. • kms:CreateGrant – (Required) Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies. For more Encryption at rest 275 Amazon FSx for Windows File Server Windows User Guide information on grants, see Using grants in the AWS Key Management Service Developer Guide. This permission is included in the default key policy. • kms:DescribeKey – (Required) Provides detailed information about the specified KMS key. This permission is included in the default key policy. • kms:ListAliases – (Optional) Lists all of the key aliases in the account. When you use the console to create an encrypted file system, this permission populates the list of KMS keys. We recommend using this permission to provide the best user experience. This permission is included in the default key policy. Encryption of data in transit Encryption of data in transit is supported on file shares that are mapped on a compute instance that supports SMB protocol 3.0 or newer. This includes all Windows versions starting from Windows Server 2012 and Windows 8, and all Linux clients with Samba client version 4.2 or newer. Amazon FSx for Windows File Server automatically encrypts data in transit using SMB encryption as you access your file system without the need for you to modify your applications. SMB encryption uses AES-128-GCM or AES-128-CCM (with the GCM variant being chosen if the client supports SMB 3.1.1) as its encryption algorithm, and also provides data integrity with signing using SMB Kerberos session keys. The use of AES-128-GCM leads to better performance, for example, up to a 2x performance improvement when copying large files over encrypted SMB connections. To meet compliance requirements for always encrypting data-in-transit, you can limit file system access to only allow access to clients that support SMB encryption. You can also enable or disable in-transit encryption per file share or to the entire file system. This allows you to have a mix of encrypted and unencrypted file shares on the same file system. Managing encryption in transit You can use a set of custom PowerShell commands to control the encryption of your data in transit between your FSx for Windows File Server file system and clients. You can limit file system access to only clients supporting SMB encryption so that data-in-transit is always encrypted. When enforcement is turned on for encryption of data-in-transit, users accessing the file system from clients that do not support SMB 3.0 encryption will not be able to access file shares for which encryption is turned on. Encryption in transit 276 Amazon FSx for Windows File Server Windows User Guide You can also control encryption of data-in-transit on a file share-level instead of file server-level. You can use file share-level encryption controls to have a mix of encrypted and unencrypted file shares on the same |
WindowsGuide-111 | WindowsGuide.pdf | 111 | file system access to only clients supporting SMB encryption so that data-in-transit is always encrypted. When enforcement is turned on for encryption of data-in-transit, users accessing the file system from clients that do not support SMB 3.0 encryption will not be able to access file shares for which encryption is turned on. Encryption in transit 276 Amazon FSx for Windows File Server Windows User Guide You can also control encryption of data-in-transit on a file share-level instead of file server-level. You can use file share-level encryption controls to have a mix of encrypted and unencrypted file shares on the same file system if you want to enforce encryption in-transit for some file shares that have sensitive data, and allow all users to access some other file shares. Server-wide encryption has precedence over share level encryption. If global encryption is enabled, you cannot selectively disable encryption for certain shares. You can manage in-transit encryption on your file system using the Amazon FSx CLI for remote management on PowerShell. To learn how to use this CLI, see Using the Amazon FSx CLI for PowerShell. Following are commands that you can use to manage user in-transit encryption on your file system. Encryption in Transit Command Description Get-FSxSmbServerCo nfiguration Retrieves the Server Message Block (SMB) server configura tion. In the system response you can determine the encryptio n in transit settings for your filesystem based on the values for the EncryptData and RejectUnencryptedAccess properties. Set-FSxSmbServerCo nfiguration This command has two options for configuring in-transit encryption globally on the file system: • -EncryptData $True|$False – Set this parameter to True to turn on in-transit data encryption. Set this parameter to False to turn off in-transit data encryption. • -RejectUnencryptedAccess $True|$False – Set this parameter to True to disallow clients that do not support encryption to access the file system. Set this parameter to False to allow clients that do not support encryption to access the file system. Set-FSxSmbShare -name name -EncryptData $True Set this parameter to True to turn on in-transit data encryptio n for the share. Set this parameter to False to turn off in- transit data encryption for the share. Encryption in transit 277 Amazon FSx for Windows File Server Windows User Guide The online help for each command provides a reference of all command options. To access this help, run the command with -?, for example Get-FSxSmbServerConfiguration -?. File- and folder-level access control using Windows ACLs Amazon FSx for Windows File Server supports identity-based authentication over the Server Message Block (SMB) protocol through Microsoft Active Directory. Active Directory is the Microsoft directory service to store information about objects on the network and make this information easy for administrators and users to find and use. These objects typically include shared resources such as file servers, and the network user and computer accounts. To learn more about Active Directory support in Amazon FSx, see Working with Microsoft Active Directory. Your domain-joined compute instances can access Amazon FSx file shares using Active Directory credentials. You use standard Windows access control lists (ACLs) for fine-grained file- and folder- level access control. Amazon FSx file systems automatically verify the credentials of users accessing file system data to enforce these Windows ACLs. Every Amazon FSx file system comes with a default Windows file share called share. The Windows ACLs for this shared folder are configured to allow read/write access to domain users. They also allow full control to the delegated administrators group in your Active Directory that is delegated to perform administrative actions on your file systems. If you're integrating your file system with AWS Managed Microsoft AD, this group is AWS Delegated FSx Administrators. If you're integrating your file system with your self-managed Microsoft AD setup, this group can be Domain Admins. Or it can be a custom delegated administrators group that you specified when creating the file system. To change the ACLs, you can map the share as a user that is a member of the delegated administrators group. Warning Amazon FSx requires that the SYSTEM user have Full control NTFS ACL permissions on all folders within your file system. Do not change the NTFS ACL permissions for this user on your folders. Doing so can make your file share inaccessible and prevent file system backups from being usable. Windows ACLs 278 Amazon FSx for Windows File Server Related Links Windows User Guide • What Is AWS Directory Service? in the AWS Directory Service Administration Guide. • Create Your AWS Managed Microsoft AD directory in the AWS Directory Service Administration Guide. • When to Create a Trust Relationship in the AWS Directory Service Administration Guide. • Step 1. Setting up an Active Directory. File system access control with Amazon VPC You access your Amazon FSx file system through an elastic network interface. This network interface resides |
WindowsGuide-112 | WindowsGuide.pdf | 112 | make your file share inaccessible and prevent file system backups from being usable. Windows ACLs 278 Amazon FSx for Windows File Server Related Links Windows User Guide • What Is AWS Directory Service? in the AWS Directory Service Administration Guide. • Create Your AWS Managed Microsoft AD directory in the AWS Directory Service Administration Guide. • When to Create a Trust Relationship in the AWS Directory Service Administration Guide. • Step 1. Setting up an Active Directory. File system access control with Amazon VPC You access your Amazon FSx file system through an elastic network interface. This network interface resides in the virtual private cloud (VPC) based on the Amazon Virtual Private Cloud (Amazon VPC) service that you associate with your file system. You connect to your Amazon FSx file system through its Domain Name Service (DNS) name. The DNS name maps to the private IP address of the file system's elastic network interface in your VPC. Only resources within the associated VPC, resources connected with the associated VPC by AWS Direct Connect or VPN, or resources within peered VPCs can access your file system's network interface. For more information, see What is Amazon VPC? in the Amazon VPC User Guide. Warning You must not modify or delete the elastic network interface(s) associated with your file system. Modifying or deleting the network interface can cause a permanent loss of connection between your VPC and your file system. FSx for Windows File Server supports VPC sharing, which enables you to view, create, modify, and delete resources in a shared subnet in a VPC owned by another AWS account. For more information, see Working with Shared VPCs in the Amazon VPC User Guide. Amazon VPC Security Groups To further control network traffic going through your file system's elastic network interface(s) within your VPC, use security groups to limit access to your file systems. A security group is a stateful firewall that controls the traffic to and from its associated network interfaces. In this case, the associated resource is your file system's network interface(s). Related Links 279 Amazon FSx for Windows File Server Windows User Guide To use a security group to control access to your Amazon FSx file system, add inbound and outbound rules. Inbound rules control incoming traffic, and outbound rules control outgoing traffic from your file system. Make sure that you have the right network traffic rules in your security group to map your Amazon FSx file system's file share to a folder on your supported compute instance. For more information on security group rules, see Security Group Rules in the Amazon EC2 User Guide. To create a security group for Amazon FSx 1. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2. 2. In the navigation pane, choose Security Groups. 3. Choose Create Security Group. Specify a name and description for the security group. For VPC, choose the Amazon VPC associated with your file system to create the security group within that VPC. 4. 5. 6. Add the following rules to allow outbound network traffic on the following ports: a. For VPC security groups, the default security group for your default Amazon VPC is already added to your file system in the console. Please ensure that the security group and the VPC Network ACLs for the subnet(s) where you're creating your FSx file system allow traffic on the ports and in the directions shown in the following diagram. Amazon VPC Security Groups 280 Amazon FSx for Windows File Server Windows User Guide The following table identifies the role of each port. Protocol Ports Role TCP/UDP TCP/UDP TCP/UDP TCP/UDP UDP TCP TCP TCP 53 88 464 389 123 135 445 636 Domain Name System (DNS) Kerberos authentication Change/Set password Lightweight Directory Access Protocol (LDAP) Network Time Protocol (NTP) Distributed Computing Environment / End Point Mapper (DCE / EPMAP) Directory Services SMB file sharing Lightweight Directory Access Protocol over TLS/ SSL (LDAPS) Amazon VPC Security Groups 281 Amazon FSx for Windows File Server Windows User Guide Protocol Ports Role TCP TCP TCP TCP TCP 3268 3269 5985 Microsoft Global Catalog Microsoft Global Catalog over SSL WinRM 2.0 (Microsoft Windows Remote Management) 9389 Microsoft AD DS Web Services, PowerShell 49152 - 65535 Ephemeral ports for RPC Important Allowing outbound traffic on TCP port 9389 is required for Single-AZ 2 and all Multi-AZ file system deployments. b. Ensure that these traffic rules are also mirrored on the firewalls that apply to each of the AD domain controllers, DNS servers, FSx clients and FSx administrators. Important While Amazon VPC security groups require ports to be opened only in the direction that network traffic is initiated, most Windows firewalls and VPC network ACLs require ports to be open in both directions. Note If you have Active Directory sites defined, you must be sure that the subnet(s) in |
WindowsGuide-113 | WindowsGuide.pdf | 113 | for RPC Important Allowing outbound traffic on TCP port 9389 is required for Single-AZ 2 and all Multi-AZ file system deployments. b. Ensure that these traffic rules are also mirrored on the firewalls that apply to each of the AD domain controllers, DNS servers, FSx clients and FSx administrators. Important While Amazon VPC security groups require ports to be opened only in the direction that network traffic is initiated, most Windows firewalls and VPC network ACLs require ports to be open in both directions. Note If you have Active Directory sites defined, you must be sure that the subnet(s) in the VPC associated with your Amazon FSx file system are defined in an Active Directory site, and that no conflicts exist between the subnet(s) in your VPC and the subnets in your other sites. You can view and change these settings using the Active Directory Sites and Services MMC snap-in. Amazon VPC Security Groups 282 Amazon FSx for Windows File Server Windows User Guide Note In some cases, you might have modified the rules of your AWS Managed Microsoft AD security group from the default settings. If so, make sure that this security group has the required inbound rules to allow traffic from your Amazon FSx file system. For more information about the required inbound rules, see AWS Managed Microsoft AD Prerequisites in the AWS Directory Service Administration Guide. Now that you've created your security group, you can associate it with your Amazon FSx file system's elastic network interface(s). To associate a security group with your Amazon FSx file system 1. Open the Amazon FSx console at https://console.aws.amazon.com/fsx/. 2. On the dashboard, choose your file system to view its details. 3. Choose the Network & Security tab, and choose your file system's network interface(s); for example, ENI-01234567890123456. For Single-AZ file systems, you’ll see a single network interface. For Multi-AZ file systems, you’ll see one network interface in the Preferred subnet and one in the Standby subnet. 4. 5. For each network interface, choose the network interface and in Actions, choose Change Security Groups. In the Change Security Groups dialog box, choose the security groups to use, and choose Save. Disallow Access to a File System To temporarily disallow network access to your file system from all clients, you can remove all the security groups associated with your file system's elastic network interface(s) and replace them with a group that has no inbound/outbound rules. Amazon VPC Network ACLs Another option for securing access to the file system within your VPC is to establish network access control lists (network ACLs). Network ACLs are separate from security groups, but have Amazon VPC Network ACLs 283 Amazon FSx for Windows File Server Windows User Guide similar functionality to add an additional layer of security to the resources in your VPC. For more information on network ACLs, see Network ACLs in the Amazon VPC User Guide. Logging end user access with file access auditing Amazon FSx for Windows File Server supports auditing end-user access to files, folders, and file shares. You can choose to send a file system's audit event logs to other AWS services that offer a rich set of features. These include the enabling querying, processing, storing and archiving logs, issuing notifications, and triggering actions to further advance your security and compliance goals. For more information about using file access auditing to get insights into access patterns and implement security notifications for end user activity, see File storage access patterns insights and Implementing security notifications for end user activity. Note File access auditing is supported only on FSx for Windows file systems with a throughput capacity of 32 MBps or greater. You can modify the throughput capacity on existing file systems. For more information, see Managing throughput capacity. File access auditing enables you to record end-user accesses of individual files, folders, and file shares based on your defined audit controls. Audit controls are also known as NTFS system access control lists (SACLs). If you already have audit controls set up on your existing file data, you can take advantage of file access auditing by creating a new Amazon FSx for Windows File Server file system and migrating your data. Amazon FSx supports the following Windows audit events for file, folder, and file share accesses: • For file accesses, it supports: All, Traverse folder / Execute file, List folder / Read data, Read attributes, Create files / Write data, Create folders / Append data, Write attributes, Delete subfolders and files, Delete, Read permissions, Change permissions, and Take ownership. • For file share accesses, it supports: Connect to a file share. Across file, folder, and file share accesses, Amazon FSx supports logging of successful attempts (such as a user with sufficient permissions successfully accessing a file or file share), failed attempts, or both. Logging end |
WindowsGuide-114 | WindowsGuide.pdf | 114 | following Windows audit events for file, folder, and file share accesses: • For file accesses, it supports: All, Traverse folder / Execute file, List folder / Read data, Read attributes, Create files / Write data, Create folders / Append data, Write attributes, Delete subfolders and files, Delete, Read permissions, Change permissions, and Take ownership. • For file share accesses, it supports: Connect to a file share. Across file, folder, and file share accesses, Amazon FSx supports logging of successful attempts (such as a user with sufficient permissions successfully accessing a file or file share), failed attempts, or both. Logging end user access 284 Amazon FSx for Windows File Server Windows User Guide You can configure whether you want access auditing only on files and folders, only on file shares, or both. You can also configure which types of accesses should be logged (successful attempts only, failed attempts only, or both). You can also turn off file access auditing at any time. Note File access auditing records end-user access data only from the time it is enabled. That is, file access auditing doesn't generate audit event logs of end-user file, folder, and file share access activity that occurred before file access auditing was enabled. The maximum rate of access audit events supported is 5,000 events per second. Access audit events are not generated for each file read and write operation, but generated once per file metadata operation, such as when a user creates, opens, or deletes a file. Topics • Audit event log destinations • Migrating your audit controls • Viewing event logs • Setting file and folder auditing controls • Managing file access auditing Audit event log destinations When you enable file access auditing, you must configure an AWS service to which Amazon FSx sends the audit event logs. You can send audit event logs to either an Amazon CloudWatch Logs log stream in a CloudWatch Logs log group or an Amazon Data Firehose delivery stream. You choose the audit event logs destination either when you create your Amazon FSx for Windows File Server file system, or anytime after by updating an existing file system. For more information, see Managing file access auditing. Following are some recommendations that may help you decide which audit event logs destination to choose: • Choose CloudWatch Logs if you want to store, view, and search audit event logs in the Amazon CloudWatch console, run queries on the logs using CloudWatch Logs Insights, and trigger CloudWatch alarms or Lambda functions. Audit event log destinations 285 Amazon FSx for Windows File Server Windows User Guide • Choose Amazon Data Firehose if you want to continuously stream events to storage in Amazon S3, to a database in Amazon Redshift, to Amazon OpenSearch Service, or to AWS Partner solutions such as Splunk or Datadog for further analysis. By default, Amazon FSx will create and use a default CloudWatch Logs log group in your account as the audit event log destination. If you want to use a custom CloudWatch Logs log group or use Firehose as the audit event log destination, here are the requirements for the names and locations of the audit event log destination: • The name of the CloudWatch Logs log group must begin with the /aws/fsx/ prefix. If you don't have an existing CloudWatch Logs log group when you create or update a file system on the console, Amazon FSx can create and use a default log stream in the CloudWatch Logs /aws/ fsx/windows log group. If you don't want to use the default log group, the configuration UI lets you create a CloudWatch Logs log group when you create or update your file system on the console. • The name of the Firehose delivery stream must begin with the aws-fsx- prefix. If you don't have an existing Firehose delivery stream, you can create one when you create or update your file system at the console. • The Firehose delivery stream must be configured to use Direct PUT as its source. You cannot use an existing Kinesis data stream as a data source for your delivery stream. • The destination (either CloudWatch Logs log group or Firehose delivery stream) must be in the same AWS partition, AWS Region, and AWS account as your Amazon FSx file system. You can change the audit event log destination at any time (for example, from CloudWatch Logs to Firehose). When you do so, new audit event logs are sent only to the new destination. Best effort audit event log delivery Typically, audit event log records are delivered to the destination in minutes, but can sometimes take longer. On very rare occasions, audit event log records might be missed. If your use case requires particular semantics (for example, ensuring that no audit events are missed), we recommend that you account |
WindowsGuide-115 | WindowsGuide.pdf | 115 | partition, AWS Region, and AWS account as your Amazon FSx file system. You can change the audit event log destination at any time (for example, from CloudWatch Logs to Firehose). When you do so, new audit event logs are sent only to the new destination. Best effort audit event log delivery Typically, audit event log records are delivered to the destination in minutes, but can sometimes take longer. On very rare occasions, audit event log records might be missed. If your use case requires particular semantics (for example, ensuring that no audit events are missed), we recommend that you account for missed events when designing your workflows. You can audit for missed events by scanning the file and folder structure on your file system. Audit event log destinations 286 Amazon FSx for Windows File Server Windows User Guide Migrating your audit controls If you have audit controls (SACLs) already set up on your existing file data, you can create an Amazon FSx file system and migrate your data to your new file system. We recommend using AWS DataSync to transfer data and the associated SACLs to your Amazon FSx file system. As an alternative solution, you can use Robocopy (Robust File Copy). For more information, see Migrating existing file storage to Amazon FSx. Viewing event logs You can view the audit event logs after Amazon FSx has started emitting them. Where and how you view the logs depends on the audit event log destination: • You can view CloudWatch Logs logs by going to the CloudWatch console and choosing the log group and log stream to which your audit event logs are sent. For more information, see View log data sent to CloudWatch Logs in the Amazon CloudWatch Logs User Guide. You can use CloudWatch Logs Insights to interactively search and analyze your log data. For more information, see Analyzing Log Data with CloudWatch Logs Insights, in the Amazon CloudWatch Logs User Guide. You can also export the audit event logs to Amazon S3. For more information, see Exporting Log Data to Amazon S3, also in the Amazon CloudWatch Logs User Guide. • You can't view the audit event logs on Firehose. However, you can configure Firehose to forward the logs to a destination that you can read from. The destinations include Amazon S3, Amazon Redshift, Amazon OpenSearch Service, and partner solutions such as Splunk and Datadog, For more information, see Choose destination in the Amazon Data Firehose Developer Guide. Audit event fields This section provides descriptions of the information in audit event logs and examples of audit events. Following are descriptions of the salient fields in a Windows audit event. • EventID refers to the Microsoft-defined Windows event log event ID. See Microsoft documentation for information on file system events and file share events. • SubjectUserName refers to the user performing the access. Migrating your audit controls 287 Amazon FSx for Windows File Server Windows User Guide • ObjectName refers to the target file, folder, or file share that was accessed. • ShareName is available for events that are generated for file share access. For example, EventID 5140 is generated when a network share object was accessed. • IpAddress refers to the client that initiated the event for file share events. • Keywords, when available, refer to whether the file access was successful or a failure. For successful accesses, the value is 0x8020000000000000. For failed accesses, the value is 0x8010000000000000. • TimeCreated SystemTime refers to the time the event was generated in the system and shown in <YYYY-MM-DDThh:mm:ss.s>Z format. • Computer refers to the DNS name of the file system Windows Remote PowerShell Endpoint and can be used to identify the file system. • AccessMask, when available, refers to the type of file access performed (for example, ReadData, WriteData). • AccessList refers to requested or granted access to an Object. For details, see the table below and Microsoft documentation (such as in Event 4556). Access Type Access Mask Read Data or List Directory Write Data or Add File Append Data or Add Subdirectory Read Extended Attributes Write Extended Attributes Execute/Traverse Delete Child Read Attributes Write Attributes 0x1 0x2 0x4 0x8 0x10 0x20 0x40 0x80 0x100 Value %%4416 %%4417 %%4418 %%4419 %%4420 %%4421 %%4422 %%4423 %%4424 Viewing event logs 288 Amazon FSx for Windows File Server Windows User Guide Access Type Access Mask Delete Read ACL Write ACL Write Owner Synchronize Access Security ACL 0x10000 0x20000 0x40000 0x80000 0x100000 0x1000000 Value %%1537 %%1538 %%1539 %%1540 %%1541 %%1542 Following are some key events with examples. Note that the XML is formatted for readability. Event ID 4660 is logged when an object is deleted. <Event xmlns='http://schemas.microsoft.com/win/2004/08/events/event'><System> <Provider Name='Microsoft-Windows-Security-Auditing' Guid='{54849625-5478-4994- A5BA-3E3B0328C30D}'/> <EventID>4660</EventID><Version>0</Version><Level>0</Level> <Task>12800</Task><Opcode>0</Opcode> <Keywords>0x8020000000000000</Keywords><TimeCreated SystemTime='2021-05-18T04:51:56.916563800Z'/> <EventRecordID>315452</EventRecordID><Correlation/> <Execution ProcessID='4' ThreadID='5636'/><Channel>Security</Channel> <Computer>amznfsxgyzohmw8.example.com</Computer><Security/></System><EventData> <Data Name='SubjectUserSid'>S-1-5-21-658495921-4185342820-3824891517-1113</Data> <Data Name='SubjectUserName'>Admin</Data><Data Name='SubjectDomainName'>example</Data> <Data Name='SubjectLogonId'>0x50932f71</Data><Data Name='ObjectServer'>Security</Data> <Data Name='HandleId'>0x12e0</Data><Data Name='ProcessId'>0x4</Data><Data Name='ProcessName'></Data> <Data |
WindowsGuide-116 | WindowsGuide.pdf | 116 | %%4419 %%4420 %%4421 %%4422 %%4423 %%4424 Viewing event logs 288 Amazon FSx for Windows File Server Windows User Guide Access Type Access Mask Delete Read ACL Write ACL Write Owner Synchronize Access Security ACL 0x10000 0x20000 0x40000 0x80000 0x100000 0x1000000 Value %%1537 %%1538 %%1539 %%1540 %%1541 %%1542 Following are some key events with examples. Note that the XML is formatted for readability. Event ID 4660 is logged when an object is deleted. <Event xmlns='http://schemas.microsoft.com/win/2004/08/events/event'><System> <Provider Name='Microsoft-Windows-Security-Auditing' Guid='{54849625-5478-4994- A5BA-3E3B0328C30D}'/> <EventID>4660</EventID><Version>0</Version><Level>0</Level> <Task>12800</Task><Opcode>0</Opcode> <Keywords>0x8020000000000000</Keywords><TimeCreated SystemTime='2021-05-18T04:51:56.916563800Z'/> <EventRecordID>315452</EventRecordID><Correlation/> <Execution ProcessID='4' ThreadID='5636'/><Channel>Security</Channel> <Computer>amznfsxgyzohmw8.example.com</Computer><Security/></System><EventData> <Data Name='SubjectUserSid'>S-1-5-21-658495921-4185342820-3824891517-1113</Data> <Data Name='SubjectUserName'>Admin</Data><Data Name='SubjectDomainName'>example</Data> <Data Name='SubjectLogonId'>0x50932f71</Data><Data Name='ObjectServer'>Security</Data> <Data Name='HandleId'>0x12e0</Data><Data Name='ProcessId'>0x4</Data><Data Name='ProcessName'></Data> <Data Name='TransactionId'>{00000000-0000-0000-0000-000000000000}</Data></EventData></ Event> Event ID 4659 is logged on a request to delete a file. <Event xmlns='http://schemas.microsoft.com/win/2004/08/events/event'><System> <Provider Name='Microsoft-Windows-Security-Auditing' Guid='{54849625-5478-4994- A5BA-3E3B0328C30D}'/> Viewing event logs 289 Amazon FSx for Windows File Server Windows User Guide <EventID>4659</EventID><Version>0</Version><Level>0</Level><Task>12800</ Task><Opcode>0</Opcode> <Keywords>0x8020000000000000</Keywords><TimeCreated SystemTime='2021-0603T19:18:09.951551200Z'/> <EventRecordID>308888</EventRecordID><Correlation/><Execution ProcessID='4' ThreadID='5540'/> <Channel>Security</Channel><Computer>amznfsxgyzohmw8.example.com</Computer><Security/ ></System> <EventData><Data Name='SubjectUserSid'>S-1-5-21-658495921-4185342820-3824891517-1113</ Data> <Data Name='SubjectUserName'>Admin</Data><Data Name='SubjectDomainName'>example</Data> <Data Name='SubjectLogonId'>0x2a9a603f</Data><Data Name='ObjectServer'>Security</Data> <Data Name='ObjectType'>File</Data><Data Name='ObjectName'>\Device\HarddiskVolume8\shar \event.txt</Data> <Data Name='HandleId'>0x0</Data><Data Name='TransactionId'>{00000000-0000-0000-0000-000000000000}</Data> <Data Name='AccessList'>%%1537 %%4423 </Data><Data Name='AccessMask'>0x10080</Data><Data Name='PrivilegeList'>-</Data> <Data Name='ProcessId'>0x4</Data></EventData></Event> Event ID 4663 is logged when a specific operation was performed on the object. The following example shows reading data from a file, which can be interpreted from AccessList %%4416. <Event xmlns='http://schemas.microsoft.com/win/2004/08/events/event'><System> <Provider Name='Microsoft-Windows-Security-Auditing' Guid='{54849625-5478-4994- A5BA-3E3B0328C30D}'/> <EventID>4663< /EventID><Version>1</Version><Level>0</Level><Task>12800</ Task><Opcode>0</Opcode> <Keywords>0x8020000000000000</Keywords><TimeCreated SystemTime='2021-06-03T19:10:13.887145400Z'/> <EventRecordID>308831</EventRecordID><Correlation/><Execution ProcessID='4' ThreadID='6916'/> <Channel>Security</Channel><Computer>amznfsxgyzohmw8.example.com</Computer><Security/ ></System> <EventData>< Data Name='SubjectUserSid'>S-1-5-21-658495921-4185342820-3824891517-1113< /Data> <Data Name='SubjectUserName'>Admin</Data><Data Name='SubjectDomainName'>example</Data> <Data Name='SubjectLogonId'>0x2a9a603f</Data><Data Name='ObjectServer'>Security</Data> <Data Name='ObjectType'>File</Data><Data Name='ObjectName'>\Device \HarddiskVolume8\share\event.txt</Data> <Data Name='HandleId'>0x101c</Data><Data Name='AccessList'>%%4416 </Data> Viewing event logs 290 Amazon FSx for Windows File Server Windows User Guide <Data Name='AccessMask'>0x1</Data><Data Name='ProcessId'>0x4</Data> <Data Name='ProcessName'></Data><Data Name='ResourceAttributes'>S:AI</Data> </EventData></Event> The following example shows write/append data from a file, which can be interpreted from AccessList %%4417. <Event xmlns='http://schemas.microsoft.com/win/2004/08/events/event'><System> <Provider Name='Microsoft-Windows-Security-Auditing' Guid='{54849625-5478-4994- A5BA-3E3B0328C30D}'/> <EventID>4663</EventID><Version>1</Version><Level>0</Level><Task>12800</ Task><Opcode>0</Opcode> <Keywords>0x8020000000000000</Keywords><TimeCreated SystemTime='2021-06-03T19:12:16.813827100Z'/> <EventRecordID>308838</EventRecordID><Correlation/><Execution ProcessID='4' ThreadID='5828'/> <Channel>Security</Channel><Computer>amznfsxgyzohmw8.example.com</Computer><Security/ ></System> <EventData><Data Name='SubjectUserSid'>S-1-5-21-658495921-4185342820-3824891517-1113</ Data> <Data Name='SubjectUserName'>Admin</Data><Data Name='SubjectDomainName'>example</Data> <Data Name='SubjectLogonId'>0x2a9a603f</Data><Data Name='ObjectServer'>Security</Data> <Data Name='ObjectType'>File</Data><Data Name='ObjectName'>\Device \HarddiskVolume8\share\event.txt</Data> <Data Name='HandleId'>0xa38</Data><Data Name='AccessList'>%%4417 </Data><Data Name='AccessMask'>0x2</Data><Data Name='ProcessId'>0x4</Data> <Data Name='ProcessName'></Data><Data Name='ResourceAttributes'>S:AI</Data></ EventData></Event> Event ID 4656 indicates that a specific access was requested for an object. In the following example, the Read request was initiated to ObjectName "permtest" and was a failed attempt, as seen in the Keywords value of 0x8010000000000000. <Event xmlns='http://schemas.microsoft.com/win/2004/08/events/event'><System> <Provider Name='Microsoft-Windows-Security-Auditing' Guid='{54849625-5478-4994- A5BA-3E3B0328C30D}'/> <EventID>4656</EventID><Version>1</Version><Level>0</Level><Task>12800</ Task><Opcode>0</Opcode> <Keywords>0x8010000000000000</Keywords><TimeCreated SystemTime='2021-06-03T19:22:55.113783500Z'/> <EventRecordID>308919</EventRecordID><Correlation/><Execution ProcessID='4' ThreadID='4924'/> Viewing event logs 291 Amazon FSx for Windows File Server Windows User Guide <Channel>Security</Channel><Computer>amznfsxgyzohmw8.example.com</Computer><Security/ ></System> <EventData><Data Name='SubjectUserSid'>S-1-5-21-658495921-4185342820-3824891517-1113</ Data> <Data Name='SubjectUserName'>Admin</Data><Data Name='SubjectDomainName'>example</Data> <Data Name='SubjectLogonId'>0x2a9a603f</Data><Data Name='ObjectServer'>Security</Data> <Data Name='ObjectType'>File</Data><Data Name='ObjectName'>\Device \HarddiskVolume8\share\permtest</Data> <Data Name='HandleId'>0x0</Data><Data Name='TransactionId'>{00000000-0000-0000-0000-000000000000}</Data> <Data Name='AccessList'>%%1541 %%4416 %%4423 </Data><Data Name='AccessReason'>%%1541: %%1805 %%4416: %%1805 %%4423: %%1811 D:(A;OICI;0x1301bf;;;AU) </Data><Data Name='AccessMask'>0x100081</Data><Data Name='PrivilegeList'>-</Data> <Data Name='RestrictedSidCount'>0</Data><Data Name='ProcessId'>0x4</Data><Data Name='ProcessName'></Data> <Data Name='ResourceAttributes'>-</Data></EventData></Event> Event ID 4670 is logged when permissions for an object are changed. The following example shows that user "admin" modified the permission on ObjectName "permtest" to add permissions to SID "S-1-5-21-658495921-4185342820-3824891517-1113". Refer to Microsoft documentation for more information on how to interpret the permissions. <Event xmlns='http://schemas.microsoft.com/win/2004/08/events/event'><System> <Provider Name='Microsoft-Windows-Security-Auditing' Guid='{54849625-5478-4994- A5BA-3E3B0328C30D}'/> <EventID>4670</EventID><Version>0</Version><Level>0</Level> <Task>13570</Task><Opcode>0</Opcode><Keywords>0x8020000000000000</Keywords> <TimeCreated SystemTime='2021-06-03T19:39:47.537129500Z'/><EventRecordID>308992</ EventRecordID> <Correlation/><Execution ProcessID='4' ThreadID='2776'/><Channel>Security</Channel> <Computer>amznfsxgyzohmw8.example.com</Computer><Security/></System><EventData> <Data Name='SubjectUserSid'>S-1-5-21-658495921-4185342820-3824891517-1113</Data> <Data Name='SubjectUserName'>Admin</Data><Data Name='SubjectDomainName'>example</Data> <Data Name='SubjectLogonId'>0x2a9a603f</Data><Data Name='ObjectServer'>Security</Data> <Data Name='ObjectType'>File</Data><Data Name='ObjectName'>\Device \HarddiskVolume8\share\permtest</Data> <Data Name='HandleId'>0xcc8</Data> <Data Name='OldSd'>D:PAI(A;OICI;FA;;;SY) (A;OICI;FA;;;S-1-5-21-658495921-4185342820-3824891517-2622)</Data> Viewing event logs 292 Amazon FSx for Windows File Server Windows User Guide <Data Name='NewSd'>D:PARAI(A;OICI;FA;;;S-1-5-21-658495921-4185342820-3824891517-1113) (A;OICI;FA;;;SY)(A;OICI;FA;;; S-1-5-21-658495921-4185342820-3824891517-2622)</Data><Data Name='ProcessId'>0x4</Data> <Data Name='ProcessName'></Data></EventData></Event> Event ID 5140 is logged every time a file share is accessed. <Event xmlns='http://schemas.microsoft.com/win/2004/08/events/event'><System> <Provider Name='Microsoft-Windows-Security-Auditing' Guid='{54849625-5478-4994- A5BA-3E3B0328C30D}'/> <EventID>5140</EventID><Version>1</Version><Level>0</Level><Task>12808</ Task><Opcode>0</Opcode> <Keywords>0x8020000000000000</Keywords><TimeCreated SystemTime='2021-06-03T19:32:07.535208200Z'/> <EventRecordID>308947</EventRecordID><Correlation/><Execution ProcessID='4' ThreadID='3120'/> <Channel>Security</Channel><Computer>amznfsxgyzohmw8.example.com</Computer><Security/ ></System> <EventData><Data Name='SubjectUserSid'>S-1-5-21-658495921-4185342820-3824891517-2620</ Data> <Data Name='SubjectUserName'>EC2AMAZ-1GP4HMN$</Data><Data Name='SubjectDomainName'>example</Data> <Data Name='SubjectLogonId'>0x2d4ca529</Data><Data Name='ObjectType'>File</Data><Data Name='IpAddress'>172.45.6.789</Data> <Data Name='IpPort'>49730</Data><Data Name='ShareName'>\\AMZNFSXCYDKLDZZ\share</Data> <Data Name='ShareLocalPath'>\??\D:\share</Data><Data Name='AccessMask'>0x1</Data><Data Name='AccessList'>%%4416 </Data></EventData></Event> Event ID 5145 is logged when access is denied at the file share level. The following example shows access to ShareName "demoshare01" was denied. <Event xmlns='http://schemas.microsoft.com/win/2004/08/events/event'><System> <Provider Name='Microsoft-Windows-Security-Auditing' Guid='{54849625-5478-4994- A5BA-3E3B0328C30D}'/> <EventID>5145</EventID><Version>0</Version><Level>0</Level> <Task>12811</Task><Opcode>0</Opcode><Keywords>0x8010000000000000</Keywords> <TimeCreated SystemTime='2021-05-19T22:30:40.485188700Z'/><EventRecordID>282939</ EventRecordID> <Correlation/><Execution ProcessID='4' ThreadID='344'/><Channel>Security</Channel> <Computer>amznfsxtmn9autz.example.com</Computer><Security/></System><EventData> <Data Name='SubjectUserSid'>S-1-5-21-658495921-4185342820-3824891517- Viewing event logs 293 Amazon FSx for Windows File Server Windows User Guide 1113</Data><Data Name='SubjectUserName'>Admin</Data><Data Name='SubjectDomainName'>example</Data> <Data Name='SubjectLogonId'>0x95b3fb7</Data><Data Name='ObjectType'>File</Data> <Data Name='IpAddress'>172.31.7.112</Data><Data Name='IpPort'>59979</Data> <Data Name='ShareName'>\\AMZNFSXDPNTE0DC\demoshare01</Data><Data Name='ShareLocalPath'> \??\D:\demoshare01</Data> <Data Name='RelativeTargetName'>Desktop.ini</Data><Data Name='AccessMask'>0x120089</ Data> <Data Name='AccessList'>%%1538 %%1541 %%4416 %%4419 %%4423 </Data><Data Name='AccessReason'>%%1538: %%1804 %%1541: %%1805 %%4416: %%1805 %%4419: %%1805 %%4423: %%1805 </Data></ EventData></Event> If you use CloudWatch Logs Insights to search your log data, you can run queries on the event fields, as shown by the following examples: • To query for a specific event ID: fields @message | filter @message like /4660/ • To query all events matching a particular file name: fields @message | filter @message like /event.txt/ For more information on the CloudWatch Logs Insights query language, see Analyzing Log Data with CloudWatch Logs Insights, in the Amazon CloudWatch Logs User Guide. Setting file and folder auditing controls You need to set audit controls on the files and folders that you want audited for user access attempts. Audit controls are also known as NTFS system access control lists (SACLs). You configure audit controls using the Windows-native GUI interface or programmatically using Windows PowerShell commands. If inheritance is enabled, you typically need to set audit controls only on the top-level folders you want to log accesses for. Setting file and folder auditing controls |
WindowsGuide-117 | WindowsGuide.pdf | 117 | CloudWatch Logs Insights query language, see Analyzing Log Data with CloudWatch Logs Insights, in the Amazon CloudWatch Logs User Guide. Setting file and folder auditing controls You need to set audit controls on the files and folders that you want audited for user access attempts. Audit controls are also known as NTFS system access control lists (SACLs). You configure audit controls using the Windows-native GUI interface or programmatically using Windows PowerShell commands. If inheritance is enabled, you typically need to set audit controls only on the top-level folders you want to log accesses for. Setting file and folder auditing controls 294 Amazon FSx for Windows File Server Windows User Guide Using the Windows GUI to set auditing access To use a GUI for setting audit controls on your files and folders, use Windows File Explorer. On a given file or folder, open Windows File Explorer and select the Properties > Security > Advanced > Auditing tab. The following audit control example audits successful events for a folder. A Windows event log entry will be emitted whenever that handle is opened for read successfully by the Admin user. The Type field indicates what actions you want to audit. Set this field to Success to audit successful attempts, Fail to audit failed attempts, or All to audit both successful and failed attempts. For more information on the auditing entry fields, see Apply a basic audit policy on a file or folder in the Microsoft documentation. Using PowerShell commands to set auditing access You can use the Microsoft Windows Set-Acl command to set the auditing SACL on any file or folder. For information about this command, see the Microsoft Set-Acl documentation. Following is an example of using a series of PowerShell commands and variables to set auditing access for successful attempts. You can adapt these example commands to fit the needs on your file system. $path = "C:\Users\TestUser\Desktop\DemoTest\" Setting file and folder auditing controls 295 Amazon FSx for Windows File Server Windows User Guide $ACL = Get-Acl $path $ACL | Format-List $AuditUser = "TESTDOMAIN\TestUser" $AuditRules = "FullControl" $InheritType = "ContainerInherit,ObjectInherit" $AuditType = "Success" $AccessRule = New-Object System.Security.AccessControl.FileSystemAuditRule($AuditUser, $AuditRules,$InheritType,"None",$AuditType) $ACL.SetAuditRule($AccessRule) $ACL | Set-Acl $path Get-Acl $path -Audit | Format-List Managing file access auditing You can enable file access auditing when creating a new Amazon FSx for Windows File Server file system. File access auditing is turned off by default when you create a file system from the Amazon FSx console. On existing file systems that have file access auditing enabled, you can change the file access auditing settings, including changing the access attempt types for file and file share accesses, and the audit event log destination. You can perform these tasks using the Amazon FSx console, AWS CLI, or API. Note File access auditing is supported only on Amazon FSx for Windows File Server file systems with a throughput capacity of 32 MBps or greater. You cannot create or update a file system with a throughput capacity of less than 32 MBps if file access auditing is enabled. You can modify the throughput capacity at any time after you create the file system. For more information, see Managing throughput capacity. Managing file access auditing 296 Amazon FSx for Windows File Server Windows User Guide To enable file access auditing when creating a file system (console) 1. Open the Amazon FSx console at https://console.aws.amazon.com/fsx/. 2. Follow the procedure for creating a new file system described in Step 5. Create your file system in the Getting Started section. 3. Open the Auditing - optional section. File access auditing is disabled by default. 4. To enable and configure file access auditing, do the following. • For Log access to files and folders, select the logging of successful and/or failed attempts. Logging is disabled for files and folders if you don't make a selection. • For Log access to file shares, select the logging of successful and/or failed attempts. Logging is disabled for file shares if you don't make a selection. • For Choose an audit event log destination, choose CloudWatch Logs or Firehose. Then choose an existing log or delivery stream or create a new one. For CloudWatch Logs, Amazon FSx can create and use a default log stream in the CloudWatch Logs /aws/fsx/windows log group. Following is an example of a file access auditing configuration that will audit successful and failed access attempts of end users for files, folders, and file shares. The audit event logs will be sent to the default CloudWatch Logs /aws/fsx/windows log group destination. Managing file access auditing 297 Amazon FSx for Windows File Server Windows User Guide 5. Continue with the next section of the file system creation wizard. When the file system is Available, the file access auditing feature is enabled. To enable file access auditing when creating a file |
WindowsGuide-118 | WindowsGuide.pdf | 118 | log stream in the CloudWatch Logs /aws/fsx/windows log group. Following is an example of a file access auditing configuration that will audit successful and failed access attempts of end users for files, folders, and file shares. The audit event logs will be sent to the default CloudWatch Logs /aws/fsx/windows log group destination. Managing file access auditing 297 Amazon FSx for Windows File Server Windows User Guide 5. Continue with the next section of the file system creation wizard. When the file system is Available, the file access auditing feature is enabled. To enable file access auditing when creating a file system (CLI) 1. When creating a new file system, use the AuditLogConfiguration property with the CreateFileSystem API operation to enable file access auditing for the new file system. aws fsx create-file-system \ --file-system-type WINDOWS \ --storage-capacity 300 \ --subnet-ids subnet-123456 \ --windows-configuration AuditLogConfiguration='{FileAccessAuditLogLevel="SUCCESS_AND_FAILURE", \ FileShareAccessAuditLogLevel="SUCCESS_AND_FAILURE", \ AuditLogDestination="arn:aws:logs:us-east-1:123456789012:log-group:/aws/fsx/my- customer-log-group"}' Managing file access auditing 298 Amazon FSx for Windows File Server Windows User Guide 2. When the file system is Available, the file access auditing feature is enabled. To change the file access auditing configuration (console) 1. Open the Amazon FSx console at https://console.aws.amazon.com/fsx/. 2. Navigate to File systems, and choose the Windows file system that you want to manage file access auditing for. 3. Choose the Administration tab. 4. On the File Access Auditing panel, choose Manage. 5. On the Manage file access auditing settings dialog, change the desired settings. Managing file access auditing 299 Amazon FSx for Windows File Server Windows User Guide • For Log access to files and folders, select the logging of successful and/or failed attempts. Logging is disabled for files and folders if you don't make a selection. • For Log access to file shares, select the logging of successful and/or failed attempts. Logging is disabled for file shares if you don't make a selection. • For Choose an audit event log destination, choose CloudWatch Logs or Firehose. Then choose an existing log or delivery stream or create a new one. 6. Choose Save. To change the file access auditing configuration (CLI) • Use the update-file-system CLI command or the equivalent UpdateFileSystem API operation. aws fsx update-file-system \ --file-system-id fs-0123456789abcdef0 \ Managing file access auditing 300 Amazon FSx for Windows File Server Windows User Guide --windows-configuration AuditLogConfiguration='{FileAccessAuditLogLevel="SUCCESS_ONLY", \ FileShareAccessAuditLogLevel="FAILURE_ONLY", \ AuditLogDestination="arn:aws:logs:us-east-1:123456789012:log-group:/aws/fsx/my- customer-log-group"}' Identity and access management for Amazon FSx for Windows File Server AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use FSx for Windows File Server resources. IAM is an AWS service that you can use with no additional charge. Topics • Audience • Authenticating with identities • Managing access using policies • How Amazon FSx for Windows File Server works with IAM • Identity-based policy examples for Amazon FSx for Windows File Server • AWS managed policies for Amazon FSx • Troubleshooting Amazon FSx for Windows File Server identity and access • Using tags with Amazon FSx • Using service-linked roles for FSx for Windows File Server Audience How you use AWS Identity and Access Management (IAM) differs, depending on the work that you do in FSx for Windows File Server. Service user – If you use the FSx for Windows File Server service to do your job, then your administrator provides you with the credentials and permissions that you need. As you use more Identity and access management 301 Amazon FSx for Windows File Server Windows User Guide FSx for Windows File Server features to do your work, you might need additional permissions. Understanding how access is managed can help you request the right permissions from your administrator. If you cannot access a feature in FSx for Windows File Server, see Troubleshooting Amazon FSx for Windows File Server identity and access. Service administrator – If you're in charge of FSx for Windows File Server resources at your company, you probably have full access to FSx for Windows File Server. It's your job to determine which FSx for Windows File Server features and resources your service users should access. You must then submit requests to your IAM administrator to change the permissions of your service users. Review the information on this page to understand the basic concepts of IAM. To learn more about how your company can use IAM with FSx for Windows File Server, see How Amazon FSx for Windows File Server works with IAM. IAM administrator – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to FSx for Windows File Server. To view example FSx for Windows File Server identity-based policies that you can use in IAM, see Identity-based policy examples for Amazon FSx |
WindowsGuide-119 | WindowsGuide.pdf | 119 | to change the permissions of your service users. Review the information on this page to understand the basic concepts of IAM. To learn more about how your company can use IAM with FSx for Windows File Server, see How Amazon FSx for Windows File Server works with IAM. IAM administrator – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to FSx for Windows File Server. To view example FSx for Windows File Server identity-based policies that you can use in IAM, see Identity-based policy examples for Amazon FSx for Windows File Server. Authenticating with identities Authentication is how you sign in to AWS using your identity credentials. You must be authenticated (signed in to AWS) as the AWS account root user, as an IAM user, or by assuming an IAM role. You can sign in to AWS as a federated identity by using credentials provided through an identity source. AWS IAM Identity Center (IAM Identity Center) users, your company's single sign-on authentication, and your Google or Facebook credentials are examples of federated identities. When you sign in as a federated identity, your administrator previously set up identity federation using IAM roles. When you access AWS by using federation, you are indirectly assuming a role. Depending on the type of user you are, you can sign in to the AWS Management Console or the AWS access portal. For more information about signing in to AWS, see How to sign in to your AWS account in the AWS Sign-In User Guide. If you access AWS programmatically, AWS provides a software development kit (SDK) and a command line interface (CLI) to cryptographically sign your requests by using your credentials. If you don't use AWS tools, you must sign requests yourself. For more information about using the recommended method to sign requests yourself, see AWS Signature Version 4 for API requests in the IAM User Guide. Authenticating with identities 302 Amazon FSx for Windows File Server Windows User Guide Regardless of the authentication method that you use, you might be required to provide additional security information. For example, AWS recommends that you use multi-factor authentication (MFA) to increase the security of your account. To learn more, see Multi-factor authentication in the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. AWS account root user When you create an AWS account, you begin with one sign-in identity that has complete access to all AWS services and resources in the account. This identity is called the AWS account root user and is accessed by signing in with the email address and password that you used to create the account. We strongly recommend that you don't use the root user for your everyday tasks. Safeguard your root user credentials and use them to perform the tasks that only the root user can perform. For the complete list of tasks that require you to sign in as the root user, see Tasks that require root user credentials in the IAM User Guide. Federated identity As a best practice, require human users, including users that require administrator access, to use federation with an identity provider to access AWS services by using temporary credentials. A federated identity is a user from your enterprise user directory, a web identity provider, the AWS Directory Service, the Identity Center directory, or any user that accesses AWS services by using credentials provided through an identity source. When federated identities access AWS accounts, they assume roles, and the roles provide temporary credentials. For centralized access management, we recommend that you use AWS IAM Identity Center. You can create users and groups in IAM Identity Center, or you can connect and synchronize to a set of users and groups in your own identity source for use across all your AWS accounts and applications. For information about IAM Identity Center, see What is IAM Identity Center? in the AWS IAM Identity Center User Guide. IAM users and groups An IAM user is an identity within your AWS account that has specific permissions for a single person or application. Where possible, we recommend relying on temporary credentials instead of creating IAM users who have long-term credentials such as passwords and access keys. However, if you have specific use cases that require long-term credentials with IAM users, we recommend that you rotate access keys. For more information, see Rotate access keys regularly for use cases that require long- term credentials in the IAM User Guide. Authenticating with identities 303 Amazon FSx for Windows File Server Windows User Guide An IAM group is an identity that specifies a collection of IAM users. You can't sign in as a group. You can use groups to specify permissions for multiple users at |
WindowsGuide-120 | WindowsGuide.pdf | 120 | of creating IAM users who have long-term credentials such as passwords and access keys. However, if you have specific use cases that require long-term credentials with IAM users, we recommend that you rotate access keys. For more information, see Rotate access keys regularly for use cases that require long- term credentials in the IAM User Guide. Authenticating with identities 303 Amazon FSx for Windows File Server Windows User Guide An IAM group is an identity that specifies a collection of IAM users. You can't sign in as a group. You can use groups to specify permissions for multiple users at a time. Groups make permissions easier to manage for large sets of users. For example, you could have a group named IAMAdmins and give that group permissions to administer IAM resources. Users are different from roles. A user is uniquely associated with one person or application, but a role is intended to be assumable by anyone who needs it. Users have permanent long-term credentials, but roles provide temporary credentials. To learn more, see Use cases for IAM users in the IAM User Guide. IAM roles An IAM role is an identity within your AWS account that has specific permissions. It is similar to an IAM user, but is not associated with a specific person. To temporarily assume an IAM role in the AWS Management Console, you can switch from a user to an IAM role (console). You can assume a role by calling an AWS CLI or AWS API operation or by using a custom URL. For more information about methods for using roles, see Methods to assume a role in the IAM User Guide. IAM roles with temporary credentials are useful in the following situations: • Federated user access – To assign permissions to a federated identity, you create a role and define permissions for the role. When a federated identity authenticates, the identity is associated with the role and is granted the permissions that are defined by the role. For information about roles for federation, see Create a role for a third-party identity provider (federation) in the IAM User Guide. If you use IAM Identity Center, you configure a permission set. To control what your identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM. For information about permissions sets, see Permission sets in the AWS IAM Identity Center User Guide. • Temporary IAM user permissions – An IAM user or role can assume an IAM role to temporarily take on different permissions for a specific task. • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a different account to access resources in your account. Roles are the primary way to grant cross- account access. However, with some AWS services, you can attach a policy directly to a resource (instead of using a role as a proxy). To learn the difference between roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. • Cross-service access – Some AWS services use features in other AWS services. For example, when you make a call in a service, it's common for that service to run applications in Amazon EC2 or Authenticating with identities 304 Amazon FSx for Windows File Server Windows User Guide store objects in Amazon S3. A service might do this using the calling principal's permissions, using a service role, or using a service-linked role. • Forward access sessions (FAS) – When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. • Service role – A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. • Service-linked role – A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the |
WindowsGuide-121 | WindowsGuide.pdf | 121 | IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. • Service-linked role – A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. • Applications running on Amazon EC2 – You can use an IAM role to manage temporary credentials for applications that are running on an EC2 instance and making AWS CLI or AWS API requests. This is preferable to storing access keys within the EC2 instance. To assign an AWS role to an EC2 instance and make it available to all of its applications, you create an instance profile that is attached to the instance. An instance profile contains the role and enables programs that are running on the EC2 instance to get temporary credentials. For more information, see Use an IAM role to grant permissions to applications running on Amazon EC2 instances in the IAM User Guide. Managing access using policies You control access in AWS by creating policies and attaching them to AWS identities or resources. A policy is an object in AWS that, when associated with an identity or resource, defines their permissions. AWS evaluates these policies when a principal (user, root user, or role session) makes a request. Permissions in the policies determine whether the request is allowed or denied. Most policies are stored in AWS as JSON documents. For more information about the structure and contents of JSON policy documents, see Overview of JSON policies in the IAM User Guide. Managing access using policies 305 Amazon FSx for Windows File Server Windows User Guide Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. By default, users and roles have no permissions. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. IAM policies define permissions for an action regardless of the method that you use to perform the operation. For example, suppose that you have a policy that allows the iam:GetRole action. A user with that policy can get role information from the AWS Management Console, the AWS CLI, or the AWS API. Identity-based policies Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. Identity-based policies can be further categorized as inline policies or managed policies. Inline policies are embedded directly into a single user, group, or role. Managed policies are standalone policies that you can attach to multiple users, groups, and roles in your AWS account. Managed policies include AWS managed policies and customer managed policies. To learn how to choose between a managed policy or an inline policy, see Choose between managed policies and inline policies in the IAM User Guide. Resource-based policies Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a specific resource. For the resource where the policy is attached, the policy defines what actions a specified principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. Resource-based policies are inline policies that are located in that service. You can't use AWS managed policies from IAM in a resource-based policy. Managing access using policies 306 Amazon FSx for Windows File Server Access control lists (ACLs) Windows User Guide Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs. To learn more about ACLs, see Access control list (ACL) overview in the Amazon Simple Storage Service Developer Guide. Other policy |
WindowsGuide-122 | WindowsGuide.pdf | 122 | service. You can't use AWS managed policies from IAM in a resource-based policy. Managing access using policies 306 Amazon FSx for Windows File Server Access control lists (ACLs) Windows User Guide Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs. To learn more about ACLs, see Access control list (ACL) overview in the Amazon Simple Storage Service Developer Guide. Other policy types AWS supports additional, less-common policy types. These policy types can set the maximum permissions granted to you by the more common policy types. • Permissions boundaries – A permissions boundary is an advanced feature in which you set the maximum permissions that an identity-based policy can grant to an IAM entity (IAM user or role). You can set a permissions boundary for an entity. The resulting permissions are the intersection of an entity's identity-based policies and its permissions boundaries. Resource-based policies that specify the user or role in the Principal field are not limited by the permissions boundary. An explicit deny in any of these policies overrides the allow. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. • Service control policies (SCPs) – SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU) in AWS Organizations. AWS Organizations is a service for grouping and centrally managing multiple AWS accounts that your business owns. If you enable all features in an organization, then you can apply service control policies (SCPs) to any or all of your accounts. The SCP limits permissions for entities in member accounts, including each AWS account root user. For more information about Organizations and SCPs, see Service control policies in the AWS Organizations User Guide. • Resource control policies (RCPs) – RCPs are JSON policies that you can use to set the maximum available permissions for resources in your accounts without updating the IAM policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the effective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Organizations and RCPs, including a list of AWS services that support RCPs, see Resource control policies (RCPs) in the AWS Organizations User Guide. • Session policies – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary session for a role or federated user. The resulting session's Managing access using policies 307 Amazon FSx for Windows File Server Windows User Guide permissions are the intersection of the user or role's identity-based policies and the session policies. Permissions can also come from a resource-based policy. An explicit deny in any of these policies overrides the allow. For more information, see Session policies in the IAM User Guide. Multiple policy types When multiple types of policies apply to a request, the resulting permissions are more complicated to understand. To learn how AWS determines whether to allow a request when multiple policy types are involved, see Policy evaluation logic in the IAM User Guide. How Amazon FSx for Windows File Server works with IAM Before you use IAM to manage access to FSx for Windows File Server, learn what IAM features are available to use with FSx for Windows File Server. IAM features you can use with Amazon FSx for Windows File Server IAM feature FSx support Identity-based policies Resource-based policies Policy actions Policy resources Policy condition keys (service-specific) ACLs ABAC (tags in policies) Temporary credentials Forward access sessions Service roles Service-linked roles Yes No Yes Yes Yes No Yes Yes Yes No Yes How Amazon FSx for Windows File Server works with IAM 308 Amazon FSx for Windows File Server Windows User Guide To get a high-level view of how FSx and other AWS services work with most IAM features, see AWS services that work with IAM in the IAM User Guide. Identity-based policies for FSx Supports identity-based policies: Yes Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. With IAM identity-based policies, you can specify allowed or denied actions and resources as well as the conditions under which actions are allowed or denied. You can't specify the principal in an identity-based policy because it |
WindowsGuide-123 | WindowsGuide.pdf | 123 | Yes Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. With IAM identity-based policies, you can specify allowed or denied actions and resources as well as the conditions under which actions are allowed or denied. You can't specify the principal in an identity-based policy because it applies to the user or role to which it is attached. To learn about all of the elements that you can use in a JSON policy, see IAM JSON policy elements reference in the IAM User Guide. Identity-based policy examples for FSx To view examples of FSx for Windows File Server identity-based policies, see Identity-based policy examples for Amazon FSx for Windows File Server. Resource-based policies within FSx Supports resource-based policies: No Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a specific resource. For the resource where the policy is attached, the policy defines what actions a specified principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. To enable cross-account access, you can specify an entire account or IAM entities in another account as the principal in a resource-based policy. Adding a cross-account principal to a resource- based policy is only half of establishing the trust relationship. When the principal and the resource How Amazon FSx for Windows File Server works with IAM 309 Amazon FSx for Windows File Server Windows User Guide are in different AWS accounts, an IAM administrator in the trusted account must also grant the principal entity (user or role) permission to access the resource. They grant permission by attaching an identity-based policy to the entity. However, if a resource-based policy grants access to a principal in the same account, no additional identity-based policy is required. For more information, see Cross account resource access in IAM in the IAM User Guide. Policy actions for FSx Supports policy actions: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Policy actions usually have the same name as the associated AWS API operation. There are some exceptions, such as permission-only actions that don't have a matching API operation. There are also some operations that require multiple actions in a policy. These additional actions are called dependent actions. Include actions in a policy to grant permissions to perform the associated operation. To see a list of FSx actions, see Actions defined by Amazon FSx for Windows File Server in the Service Authorization Reference. Policy actions in FSx use the following prefix before the action: fsx To specify multiple actions in a single statement, separate them with commas. "Action": [ "fsx:action1", "fsx:action2" ] To view examples of FSx for Windows File Server identity-based policies, see Identity-based policy examples for Amazon FSx for Windows File Server. How Amazon FSx for Windows File Server works with IAM 310 Amazon FSx for Windows File Server Policy resources for FSx Supports policy resources: Yes Windows User Guide Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Resource JSON policy element specifies the object or objects to which the action applies. Statements must include either a Resource or a NotResource element. As a best practice, specify a resource using its Amazon Resource Name (ARN). You can do this for actions that support a specific resource type, known as resource-level permissions. For actions that don't support resource-level permissions, such as listing operations, use a wildcard (*) to indicate that the statement applies to all resources. "Resource": "*" To see a list of FSx resource types and their ARNs, see Resources defined by Amazon FSx for Windows File Server in the Service Authorization Reference. To learn with which actions you can specify the ARN of each resource, see Actions defined by Amazon FSx for Windows File Server. To view examples of FSx for Windows File Server identity-based policies, see Identity-based policy examples for Amazon FSx for Windows File Server. Policy condition keys for FSx |
WindowsGuide-124 | WindowsGuide.pdf | 124 | that don't support resource-level permissions, such as listing operations, use a wildcard (*) to indicate that the statement applies to all resources. "Resource": "*" To see a list of FSx resource types and their ARNs, see Resources defined by Amazon FSx for Windows File Server in the Service Authorization Reference. To learn with which actions you can specify the ARN of each resource, see Actions defined by Amazon FSx for Windows File Server. To view examples of FSx for Windows File Server identity-based policies, see Identity-based policy examples for Amazon FSx for Windows File Server. Policy condition keys for FSx Supports service-specific policy condition keys: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Condition element (or Condition block) lets you specify conditions in which a statement is in effect. The Condition element is optional. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values in the request. If you specify multiple Condition elements in a statement, or multiple keys in a single Condition element, AWS evaluates them using a logical AND operation. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical OR operation. All of the conditions must be met before the statement's permissions are granted. How Amazon FSx for Windows File Server works with IAM 311 Amazon FSx for Windows File Server Windows User Guide You can also use placeholder variables when you specify conditions. For example, you can grant an IAM user permission to access a resource only if it is tagged with their IAM user name. For more information, see IAM policy elements: variables and tags in the IAM User Guide. AWS supports global condition keys and service-specific condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide. To see a list of FSx condition keys, see Condition keys for Amazon FSx for Windows File Server in the Service Authorization Reference. To learn with which actions and resources you can use a condition key, see Actions defined by Amazon FSx for Windows File Server. To view examples of FSx for Windows File Server identity-based policies, see Identity-based policy examples for Amazon FSx for Windows File Server. ACLs in FSx Supports ACLs: No Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. ABAC with FSx Supports ABAC (tags in policies): Yes Attribute-based access control (ABAC) is an authorization strategy that defines permissions based on attributes. In AWS, these attributes are called tags. You can attach tags to IAM entities (users or roles) and to many AWS resources. Tagging entities and resources is the first step of ABAC. Then you design ABAC policies to allow operations when the principal's tag matches the tag on the resource that they are trying to access. ABAC is helpful in environments that are growing rapidly and helps with situations where policy management becomes cumbersome. To control access based on tags, you provide tag information in the condition element of a policy using the aws:ResourceTag/key-name, aws:RequestTag/key-name, or aws:TagKeys condition keys. If a service supports all three condition keys for every resource type, then the value is Yes for the service. If a service supports all three condition keys for only some resource types, then the value is Partial. How Amazon FSx for Windows File Server works with IAM 312 Amazon FSx for Windows File Server Windows User Guide For more information about ABAC, see Define permissions with ABAC authorization in the IAM User Guide. To view a tutorial with steps for setting up ABAC, see Use attribute-based access control (ABAC) in the IAM User Guide. Using temporary credentials with FSx Supports temporary credentials: Yes Some AWS services don't work when you sign in using temporary credentials. For additional information, including which AWS services work with temporary credentials, see AWS services that work with IAM in the IAM User Guide. You are using temporary credentials if you sign in to the AWS Management Console using any method except a user name and password. For example, when you access AWS using your company's single sign-on (SSO) link, that process automatically creates temporary credentials. You also automatically create temporary credentials when you sign in to the console as a user and then switch roles. For more information about switching roles, see Switch from a user to an IAM role (console) in the IAM User Guide. You can manually create temporary credentials using the AWS CLI or AWS API. You |
WindowsGuide-125 | WindowsGuide.pdf | 125 | IAM User Guide. You are using temporary credentials if you sign in to the AWS Management Console using any method except a user name and password. For example, when you access AWS using your company's single sign-on (SSO) link, that process automatically creates temporary credentials. You also automatically create temporary credentials when you sign in to the console as a user and then switch roles. For more information about switching roles, see Switch from a user to an IAM role (console) in the IAM User Guide. You can manually create temporary credentials using the AWS CLI or AWS API. You can then use those temporary credentials to access AWS. AWS recommends that you dynamically generate temporary credentials instead of using long-term access keys. For more information, see Temporary security credentials in IAM. Forward access sessions for FSx Supports forward access sessions (FAS): Yes When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. Service roles for FSx Supports service roles: No How Amazon FSx for Windows File Server works with IAM 313 Amazon FSx for Windows File Server Windows User Guide A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. Warning Changing the permissions for a service role might break FSx functionality. Edit service roles only when FSx provides guidance to do so. Service-linked roles for FSx Supports service-linked roles: Yes A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. For details about creating or managing FSx for Windows File Server service-linked roles, see Using service-linked roles for FSx for Windows File Server. Identity-based policy examples for Amazon FSx for Windows File Server By default, users and roles don't have permission to create or modify FSx for Windows File Server resources. They also can't perform tasks by using the AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS API. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. To learn how to create an IAM identity-based policy by using these example JSON policy documents, see Create IAM policies (console) in the IAM User Guide. For details about actions and resource types defined by FSx, including the format of the ARNs for each of the resource types, see Actions, resources, and condition keys for Amazon FSx for Windows File Server in the Service Authorization Reference. Topics Identity-based policy examples 314 Amazon FSx for Windows File Server • Policy best practices • Using the FSx console • Allow users to view their own permissions Policy best practices Windows User Guide Identity-based policies determine whether someone can create, access, or delete FSx for Windows File Server resources in your account. These actions can incur costs for your AWS account. When you create or edit identity-based policies, follow these guidelines and recommendations: • Get started with AWS managed policies and move toward least-privilege permissions – To get started granting permissions to your users and workloads, use the AWS managed policies that grant permissions for many common use cases. They are available in your AWS account. We recommend that you reduce permissions further by defining AWS customer managed policies that are specific to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. • Apply least-privilege permissions – When you set permissions with IAM policies, grant only the permissions required to perform a task. You do this by defining the actions that can be taken on specific resources under specific conditions, also known as least-privilege permissions. For more information about using IAM to apply permissions, see Policies and permissions in IAM in the |
WindowsGuide-126 | WindowsGuide.pdf | 126 | account. We recommend that you reduce permissions further by defining AWS customer managed policies that are specific to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. • Apply least-privilege permissions – When you set permissions with IAM policies, grant only the permissions required to perform a task. You do this by defining the actions that can be taken on specific resources under specific conditions, also known as least-privilege permissions. For more information about using IAM to apply permissions, see Policies and permissions in IAM in the IAM User Guide. • Use conditions in IAM policies to further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access to service actions if they are used through a specific AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. • Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language (JSON) and IAM best practices. IAM Access Analyzer provides more than 100 policy checks and actionable recommendations to help you author secure and functional policies. For more information, see Validate policies with IAM Access Analyzer in the IAM User Guide. • Require multi-factor authentication (MFA) – If you have a scenario that requires IAM users or a root user in your AWS account, turn on MFA for additional security. To require MFA when API operations are called, add MFA conditions to your policies. For more information, see Secure API access with MFA in the IAM User Guide. Identity-based policy examples 315 Amazon FSx for Windows File Server Windows User Guide For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide. Using the FSx console To access the Amazon FSx for Windows File Server console, you must have a minimum set of permissions. These permissions must allow you to list and view details about the FSx for Windows File Server resources in your AWS account. If you create an identity-based policy that is more restrictive than the minimum required permissions, the console won't function as intended for entities (users or roles) with that policy. You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API. Instead, allow access to only the actions that match the API operation that they're trying to perform. To ensure that users and roles can still use the FSx console, also attach the FSx AmazonFSxConsoleReadOnlyAccess AWS managed policy to the entities. For more information, see Adding permissions to a user in the IAM User Guide. Allow users to view their own permissions This example shows how you might create a policy that allows IAM users to view the inline and managed policies that are attached to their user identity. This policy includes permissions to complete this action on the console or programmatically using the AWS CLI or AWS API. { "Version": "2012-10-17", "Statement": [ { "Sid": "ViewOwnUserInfo", "Effect": "Allow", "Action": [ "iam:GetUserPolicy", "iam:ListGroupsForUser", "iam:ListAttachedUserPolicies", "iam:ListUserPolicies", "iam:GetUser" ], "Resource": ["arn:aws:iam::*:user/${aws:username}"] }, { "Sid": "NavigateInConsole", Identity-based policy examples 316 Amazon FSx for Windows File Server Windows User Guide "Effect": "Allow", "Action": [ "iam:GetGroupPolicy", "iam:GetPolicyVersion", "iam:GetPolicy", "iam:ListAttachedGroupPolicies", "iam:ListGroupPolicies", "iam:ListPolicyVersions", "iam:ListPolicies", "iam:ListUsers" ], "Resource": "*" } ] } AWS managed policies for Amazon FSx An AWS managed policy is a standalone policy that is created and administered by AWS. AWS managed policies are designed to provide permissions for many common use cases so that you can start assigning permissions to users, groups, and roles. Keep in mind that AWS managed policies might not grant least-privilege permissions for your specific use cases because they're available for all AWS customers to use. We recommend that you reduce permissions further by defining customer managed policies that are specific to your use cases. You cannot change the permissions defined in AWS managed policies. If AWS updates the permissions defined in an AWS managed policy, the update affects all principal identities (users, groups, and roles) that the policy is attached to. AWS is most likely to update an AWS managed policy when a new AWS service is launched or new API operations become available for existing services. For more information, see AWS managed policies in the IAM User Guide. AmazonFSxServiceRolePolicy Allows Amazon FSx to manage AWS resources on your behalf. See Using service-linked roles for FSx for Windows File Server to learn more. AWS managed |
WindowsGuide-127 | WindowsGuide.pdf | 127 | cannot change the permissions defined in AWS managed policies. If AWS updates the permissions defined in an AWS managed policy, the update affects all principal identities (users, groups, and roles) that the policy is attached to. AWS is most likely to update an AWS managed policy when a new AWS service is launched or new API operations become available for existing services. For more information, see AWS managed policies in the IAM User Guide. AmazonFSxServiceRolePolicy Allows Amazon FSx to manage AWS resources on your behalf. See Using service-linked roles for FSx for Windows File Server to learn more. AWS managed policies 317 Amazon FSx for Windows File Server Windows User Guide AWS managed policy: AmazonFSxDeleteServiceLinkedRoleAccess You can't attach AmazonFSxDeleteServiceLinkedRoleAccess to your IAM entities. This policy is linked to a service and used only with the service-linked role for that service. You cannot attach, detach, modify, or delete this policy. For more information, see Using service-linked roles for FSx for Windows File Server. This policy grants administrative permissions that allow Amazon FSx to delete its Service Linked Role for Amazon S3 access, used only by Amazon FSx for Lustre. Permissions details This policy includes permissions in iam to allow Amazon FSx to view, delete, and view the deletion status for the FSx Service Linked Roles for Amazon S3 access. To view the permissions for this policy, see AmazonFSxDeleteServiceLinkedRoleAccess in the AWS Managed Policy Reference Guide. AWS managed policy: AmazonFSxFullAccess You can attach AmazonFSxFullAccess to your IAM entities. Amazon FSx also attaches this policy to a service role that allows Amazon FSx to perform actions on your behalf. Provides full access to Amazon FSx and access to related AWS services. Permissions details This policy includes the following permissions. • fsx – Allows principals full access to perform all Amazon FSx actions, except for BypassSnaplockEnterpriseRetention. • ds – Allows principals to view information about the AWS Directory Service directories. • ec2 • Allows principals to create tags under the specified conditions. • To provide enhanced security group validation of all security groups that can be used with a VPC. • iam – Allows principles to create an Amazon FSx service linked role on the user's behalf. This is required so that Amazon FSx can manage AWS resources on the user's behalf. AWS managed policies 318 Amazon FSx for Windows File Server Windows User Guide • logs – Allows principals to create log groups, log streams, and write events to log streams. This is required so that users can monitor FSx for Windows File Server file system access by sending audit access logs to CloudWatch Logs. • firehose – Allows principals to write records to a Amazon Data Firehose. This is required so that users can monitor FSx for Windows File Server file system access by sending audit access logs to Firehose. To view the permissions for this policy, see AmazonFSxFullAccess in the AWS Managed Policy Reference Guide. AWS managed policy: AmazonFSxConsoleFullAccess You can attach the AmazonFSxConsoleFullAccess policy to your IAM identities. This policy grants administrative permissions that allow full access to Amazon FSx and access to related AWS services via the AWS Management Console. Permissions details This policy includes the following permissions. • fsx – Allows principals to perform all actions in the Amazon FSx management console, except for BypassSnaplockEnterpriseRetention. • cloudwatch – Allows principals to view CloudWatch Alarms and Metrics in the Amazon FSx management console. • ds – Allows principals to list information about an AWS Directory Service directory. • ec2 • Allows principals to create tags on route tables, list network interfaces, route tables, security groups, subnets and the VPC associated with an Amazon FSx file system. • Allows principals to provide enhanced security group validation of all security groups that can be used with a VPC. • Allows principals to view the elastic network interfaces associated with an Amazon FSx file system. • kms – Allows principals to list aliases for AWS Key Management Service keys. • s3 – Allows principals to list some or all of the objects in an Amazon S3 bucket (up to 1000). AWS managed policies 319 Amazon FSx for Windows File Server Windows User Guide • iam – Grants permission to create a service linked role that allows Amazon FSx to perform actions on the user's behalf. To view the permissions for this policy, see AmazonFSxConsoleFullAccess in the AWS Managed Policy Reference Guide. AWS managed policy: AmazonFSxConsoleReadOnlyAccess You can attach the AmazonFSxConsoleReadOnlyAccess policy to your IAM identities. This policy grants read-only permissions to Amazon FSx and related AWS services so that users can view information about these services in the AWS Management Console. Permissions details This policy includes the following permissions. • fsx – Allows principals to view information about Amazon FSx file systems, including all tags, in the Amazon FSx Management Console. • |
WindowsGuide-128 | WindowsGuide.pdf | 128 | linked role that allows Amazon FSx to perform actions on the user's behalf. To view the permissions for this policy, see AmazonFSxConsoleFullAccess in the AWS Managed Policy Reference Guide. AWS managed policy: AmazonFSxConsoleReadOnlyAccess You can attach the AmazonFSxConsoleReadOnlyAccess policy to your IAM identities. This policy grants read-only permissions to Amazon FSx and related AWS services so that users can view information about these services in the AWS Management Console. Permissions details This policy includes the following permissions. • fsx – Allows principals to view information about Amazon FSx file systems, including all tags, in the Amazon FSx Management Console. • cloudwatch – Allows principals to view CloudWatch Alarms and Metrics in the Amazon FSx Management Console. • ds – Allows principals to view information about an AWS Directory Service directory in the Amazon FSx Management Console. • ec2 • Allows principals to view network interfaces, security groups, subnets and the VPC associated with an Amazon FSx file system in the Amazon FSx Management Console. • Allows principals to provide enhanced security group validation of all security groups that can be used with a VPC. • Allows principals to view the elastic network interfaces associated with an Amazon FSx file system. • kms – Allows principals to view aliases for AWS Key Management Service keys in the Amazon FSx Management Console. • log – Allows principals to describe the Amazon CloudWatch Logs log groups associated with the account making the request. This is required so that principals can view the existing file access auditing configuration for an FSx for Windows File Server file system. AWS managed policies 320 Amazon FSx for Windows File Server Windows User Guide • firehose – Allows principals to describe the Amazon Data Firehose delivery streams associated with the account making the request. This is required so that principals can view the existing file access auditing configuration for an FSx for Windows File Server file system. To view the permissions for this policy, see AmazonFSxConsoleReadOnlyAccess in the AWS Managed Policy Reference Guide. AWS managed policy: AmazonFSxReadOnlyAccess You can attach the AmazonFSxReadOnlyAccess policy to your IAM identities. This policy grants administrative permissions that allow read-only access to Amazon FSx. • fsx – Allows principals to view information about Amazon FSx file systems, including all tags, in the Amazon FSx Management Console. • ec2 – To provide enhanced security group validation of all security groups that can be used with a VPC. To view the permissions for this policy, see AmazonFSxReadOnlyAccess in the AWS Managed Policy Reference Guide. Amazon FSx updates to AWS managed policies View details about updates to AWS managed policies for Amazon FSx since this service began tracking these changes. For automatic alerts about changes to this page, subscribe to the RSS feed on the Amazon FSx Document history page. Change Description Date AmazonFSxConsoleRe adOnlyAccess – Update to an existing policy Amazon FSx added new February 25, 2025 permission, ec2:Descr ibeNetworkInterfac es that allows principals to view the elastic network interfaces associated with their file system. AWS managed policies 321 Amazon FSx for Windows File Server Windows User Guide Change Description Date AmazonFSxConsoleFullAccess – Update to an existing policy AmazonFSxServiceRolePolicy – Update to an existing policy AmazonFSxReadOnlyAccess – Update to an existing policy AmazonFSxConsoleRe adOnlyAccess – Update to an existing policy Amazon FSx added new February 07, 2025 permission, ec2:Descr ibeNetworkInterfac es that allows principals to view the elastic network interfaces associated with their file system. Amazon FSx added new January 9, 2024 permission, ec2:GetSe curityGroupsForVpc that allows principals to provide enhanced security group validation of all security groups that can be used with a VPC. Amazon FSx added new January 9, 2024 permission, ec2:GetSe curityGroupsForVpc that allows principals to provide enhanced security group validation of all security groups that can be used with a VPC. Amazon FSx added new January 9, 2024 permission, ec2:GetSe curityGroupsForVpc that allows principals to provide enhanced security group validation of all security groups that can be used with a VPC. AWS managed policies 322 Amazon FSx for Windows File Server Windows User Guide Change Description Date AmazonFSxFullAccess – Update to an existing policy AmazonFSxConsoleFullAccess – Update to an existing policy Amazon FSx added new January 9, 2024 permission, ec2:GetSe curityGroupsForVpc that allows principals to provide enhanced security group validation of all security groups that can be used with a VPC. Amazon FSx added new January 9, 2024 permission, ec2:GetSe curityGroupsForVpc that allows principals to provide enhanced security group validation of all security groups that can be used with a VPC. AmazonFSxFullAccess – Update to an existing policy Amazon FSx added new permission to enable users December 20, 2023 AmazonFSxConsoleFullAccess – Update to an existing policy to perform cross-region and cross-account data replicati on for FSx for OpenZFS file systems. Amazon FSx added new permission to enable users to perform cross-region |
WindowsGuide-129 | WindowsGuide.pdf | 129 | that allows principals to provide enhanced security group validation of all security groups that can be used with a VPC. Amazon FSx added new January 9, 2024 permission, ec2:GetSe curityGroupsForVpc that allows principals to provide enhanced security group validation of all security groups that can be used with a VPC. AmazonFSxFullAccess – Update to an existing policy Amazon FSx added new permission to enable users December 20, 2023 AmazonFSxConsoleFullAccess – Update to an existing policy to perform cross-region and cross-account data replicati on for FSx for OpenZFS file systems. Amazon FSx added new permission to enable users to perform cross-region and cross-account data replicati on for FSx for OpenZFS file systems. December 20, 2023 AWS managed policies 323 Amazon FSx for Windows File Server Windows User Guide Change Description Date AmazonFSxFullAccess – Update to an existing policy Amazon FSx added new permission to enable users to November 26, 2023 perform on-demand replicati on of volumes for FSx for OpenZFS file systems. AmazonFSxConsoleFullAccess – Update to an existing policy Amazon FSx added new permission to enable users to November 26, 2023 perform on-demand replicati on of volumes for FSx for OpenZFS file systems. AmazonFSxFullAccess – Update to an existing policy Amazon FSx added new permissions to enable users November 14, 2023 to view, enable, and disable shared VPC support for FSx for ONTAP Multi-AZ file systems. AmazonFSxConsoleFullAccess – Update to an existing policy Amazon FSx added new permissions to enable users November 14, 2023 AmazonFSxFullAccess – Update to an existing policy to view, enable, and disable shared VPC support for FSx for ONTAP Multi-AZ file systems. Amazon FSx added new permissions to allow Amazon FSx to manage network configurations for FSx for OpenZFS Multi-AZ file systems. August 9, 2023 AWS managed policies 324 Amazon FSx for Windows File Server Windows User Guide Change Description Date AWS managed policy: AmazonFSxServiceRolePolicy – Update to an existing policy Amazon FSx modified July 24, 2023 the existing cloudwatc h:PutMetricData permission so that Amazon FSx publishes CloudWatc h metrics to the AWS/FSx namespace. AmazonFSxFullAccess – Update to an existing policy AmazonFSxConsoleFullAccess – Update to an existing policy Amazon FSx updated the July 13, 2023 policy to remove the fsx:* permission and add specific fsx actions. Amazon FSx updated the July 13, 2023 policy to remove the fsx:* permission and add specific fsx actions. AmazonFSxFullAccess – Update to an existing policy Amazon FSx added new permissions to allow Amazon May 31, 2023 AmazonFSxConsoleRe adOnlyAccess – Update to an existing policy FSx to manage network configurations for FSx for OpenZFS Multi-AZ file systems. Amazon FSx added new permissions to enable users to view enhanced performan ce metrics and recommended actions for FSx for Windows File Server file systems in the Amazon FSx console. September 21, 2022 AWS managed policies 325 Amazon FSx for Windows File Server Windows User Guide Change Description Date AmazonFSxConsoleFullAccess – Update to an existing policy Amazon FSx added new permissions to enable users September 21, 2022 to view enhanced performan ce metrics and recommended actions for FSx for Windows File Server file systems in the Amazon FSx console. AmazonFSxReadOnlyAccess – Started tracking policy This policy grants read- only access to all Amazon February 4, 2022 FSx resources and any tags associated with them. AmazonFSxDeleteSer viceLinkedRoleAccess – This policy grants administr ative permissions that allow Started tracking policy Amazon FSx to delete its January 7, 2022 Service Linked Role for Amazon S3 access. AmazonFSxServiceRolePolicy – Update to an existing policy Amazon FSx added new permissions to allow Amazon September 2, 2021 AmazonFSxFullAccess – Update to an existing policy FSx to manage network configurations for Amazon FSx for NetApp ONTAP file systems. Amazon FSx added new permissions to allow Amazon FSx to create tags on EC2 route tables for scoped down calls. September 2, 2021 AWS managed policies 326 Amazon FSx for Windows File Server Windows User Guide Change Description Date AmazonFSxConsoleFullAccess – Update to an existing policy Amazon FSx added new permissions to allow Amazon September 2, 2021 FSx to create Amazon FSx for NetApp ONTAP Multi-AZ file systems. AmazonFSxConsoleFullAccess – Update to an existing policy Amazon FSx added new permissions to allow Amazon September 2, 2021 FSx to create tags on EC2 route tables for scoped down calls. AmazonFSxServiceRolePolicy – Update to an existing policy Amazon FSx added new permissions to allow Amazon June 8, 2021 FSx to describe and write to CloudWatch Logs log streams. This is required so that users can view file access audit logs for FSx for Windows File Server file systems using CloudWatch Logs. AmazonFSxServiceRolePolicy – Update to an existing policy Amazon FSx added new permissions to allow Amazon June 8, 2021 FSx to describe and write to Amazon Data Firehose delivery streams. This is required so that users can view file access audit logs for an FSx for |
WindowsGuide-130 | WindowsGuide.pdf | 130 | for scoped down calls. AmazonFSxServiceRolePolicy – Update to an existing policy Amazon FSx added new permissions to allow Amazon June 8, 2021 FSx to describe and write to CloudWatch Logs log streams. This is required so that users can view file access audit logs for FSx for Windows File Server file systems using CloudWatch Logs. AmazonFSxServiceRolePolicy – Update to an existing policy Amazon FSx added new permissions to allow Amazon June 8, 2021 FSx to describe and write to Amazon Data Firehose delivery streams. This is required so that users can view file access audit logs for an FSx for Windows File Server file system using Amazon Data Firehose. AWS managed policies 327 Amazon FSx for Windows File Server Windows User Guide Change Description Date AmazonFSxFullAccess – Update to an existing policy Amazon FSx added new permissions to allow principal June 8, 2021 s to describe and create CloudWatch Logs log groups, log streams, and write events to log streams. This is required so that principals can view file access audit logs for FSx for Windows File Server file systems using CloudWatch Logs. AmazonFSxFullAccess – Update to an existing policy Amazon FSx added new permissions to allow principal June 8, 2021 s to describe and write records to a Amazon Data Firehose. This is required so that users can view file access audit logs for an FSx for Windows File Server file system using Amazon Data Firehose. AWS managed policies 328 Amazon FSx for Windows File Server Windows User Guide Change Description Date AmazonFSxConsoleFullAccess – Update to an existing policy Amazon FSx added new permissions to allow principal June 8, 2021 s to describe the Amazon CloudWatch Logs log groups associated with the account making the request. This is required so that principals can choose an existing CloudWatch Logs log group when configuring file access auditing for an FSx for Windows File Server file system. AmazonFSxConsoleFullAccess – Update to an existing policy Amazon FSx added new permissions to allow principal June 8, 2021 s to describe the Amazon Data Firehose delivery streams associated with the account making the request. This is required so that principals can choose an existing Firehose delivery stream when configuring file access auditing for an FSx for Windows File Server file system. AWS managed policies 329 Amazon FSx for Windows File Server Windows User Guide Change Description Date AmazonFSxConsoleRe adOnlyAccess – Update to an Amazon FSx added new permissions to allow principal June 8, 2021 existing policy s to describe the Amazon CloudWatch Logs log groups associated with the account making the request. This is required so that principals can view the existing file access auditing configuration for an FSx for Windows File Server file system. AmazonFSxConsoleRe adOnlyAccess – Update to an Amazon FSx added new permissions to allow principal June 8, 2021 existing policy s to describe the Amazon Data Firehose delivery streams associated with the account making the request. This is required so that principals can view the existing file access auditing configuration for an FSx for Windows File Server file system. Amazon FSx started tracking changes Amazon FSx started tracking changes for its AWS managed policies. June 8, 2021 AWS managed policies 330 Amazon FSx for Windows File Server Windows User Guide Troubleshooting Amazon FSx for Windows File Server identity and access Use the following information to help you diagnose and fix common issues that you might encounter when working with FSx for Windows File Server and IAM. Topics • I am not authorized to perform an action in FSx • I am not authorized to perform iam:PassRole • I want to allow people outside of my AWS account to access my FSx resources I am not authorized to perform an action in FSx If you receive an error that you're not authorized to perform an action, your policies must be updated to allow you to perform the action. The following example error occurs when the mateojackson IAM user tries to use the console to view details about a fictional my-example-widget resource but doesn't have the fictional fsx:GetWidget permissions. User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: fsx:GetWidget on resource: my-example-widget In this case, the policy for the mateojackson user must be updated to allow access to the my- example-widget resource by using the fsx:GetWidget action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. I am not authorized to perform iam:PassRole If you receive an error that you're not authorized to perform the iam:PassRole action, your policies must be updated to allow you to pass a role to FSx for Windows File Server. Some AWS services allow you to pass an existing role to that service instead of creating a new service role or service-linked role. To do this, you must have |
WindowsGuide-131 | WindowsGuide.pdf | 131 | allow access to the my- example-widget resource by using the fsx:GetWidget action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. I am not authorized to perform iam:PassRole If you receive an error that you're not authorized to perform the iam:PassRole action, your policies must be updated to allow you to pass a role to FSx for Windows File Server. Some AWS services allow you to pass an existing role to that service instead of creating a new service role or service-linked role. To do this, you must have permissions to pass the role to the service. Troubleshooting 331 Amazon FSx for Windows File Server Windows User Guide The following example error occurs when an IAM user named marymajor tries to use the console to perform an action in FSx for Windows File Server. However, the action requires the service to have permissions that are granted by a service role. Mary does not have permissions to pass the role to the service. User: arn:aws:iam::123456789012:user/marymajor is not authorized to perform: iam:PassRole In this case, Mary's policies must be updated to allow her to perform the iam:PassRole action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. I want to allow people outside of my AWS account to access my FSx resources You can create a role that users in other accounts or people outside of your organization can use to access your resources. You can specify who is trusted to assume the role. For services that support resource-based policies or access control lists (ACLs), you can use those policies to grant people access to your resources. To learn more, consult the following: • To learn whether FSx for Windows File Server supports these features, see How Amazon FSx for Windows File Server works with IAM. • To learn how to provide access to your resources across AWS accounts that you own, see Providing access to an IAM user in another AWS account that you own in the IAM User Guide. • To learn how to provide access to your resources to third-party AWS accounts, see Providing access to AWS accounts owned by third parties in the IAM User Guide. • To learn how to provide access through identity federation, see Providing access to externally authenticated users (identity federation) in the IAM User Guide. • To learn the difference between using roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. Using tags with Amazon FSx You can use tags to control access to Amazon FSx resources and to implement attribute-based access control (ABAC). Users need to have permission to apply tags to Amazon FSx resources during creation. Using tags with Amazon FSx 332 Amazon FSx for Windows File Server Windows User Guide Grant permission to tag resources during creation Some resource-creating FSx for Windows File Server API actions enable you to specify tags when you create the resource. You can use resource tags to implement attribute-based access control (ABAC). For more information, see What is ABAC for AWS in the IAM User Guide. To enable users to tag resources on creation, they must have permissions to use the action that creates the resource, such as fsx:CreateFileSystem or fsx:CreateBackup. If tags are specified in the resource-creating action, Amazon performs additional authorization on the fsx:TagResource action to verify if users have permissions to create tags. Therefore, users must also have explicit permissions to use the fsx:TagResource action. The following example demonstrates a policy that allows users to create file systems and apply tags to file systems during creation in a specific AWS account. { "Statement": [ { "Effect": "Allow", "Action": [ "fsx:CreateFileSystem", "fsx:TagResource" ], "Resource": "arn:aws:fsx:region:account-id:file-system/*" } ] } Similarly, the following policy allows users to create backups on a specific file system and apply any tags to the backup during backup creation. { "Statement": [ { "Effect": "Allow", "Action": [ "fsx:CreateBackup" ], "Resource": "arn:aws:fsx:region:account-id:file-system/file-system-id*" }, { Using tags with Amazon FSx 333 Amazon FSx for Windows File Server Windows User Guide "Effect": "Allow", "Action": [ "fsx:TagResource" ], "Resource": "arn:aws:fsx:region:account-id:backup/*" } ] } The fsx:TagResource action is only evaluated if tags are applied during the resource-creating action. Therefore, a user that has permissions to create a resource (assuming there are no tagging conditions) does not require permissions to use the fsx:TagResource action if no tags are specified in the request. However, if the user attempts to create a resource with tags, the request fails if the user does not have permissions to use the fsx:TagResource action. For more information about tagging Amazon FSx resources, see Tagging your Amazon FSx resources. For more information about using tags to control access to FSx resources, |
WindowsGuide-132 | WindowsGuide.pdf | 132 | } The fsx:TagResource action is only evaluated if tags are applied during the resource-creating action. Therefore, a user that has permissions to create a resource (assuming there are no tagging conditions) does not require permissions to use the fsx:TagResource action if no tags are specified in the request. However, if the user attempts to create a resource with tags, the request fails if the user does not have permissions to use the fsx:TagResource action. For more information about tagging Amazon FSx resources, see Tagging your Amazon FSx resources. For more information about using tags to control access to FSx resources, see Using tags to control access to your Amazon FSx resources. Using tags to control access to your Amazon FSx resources To control access to Amazon FSx resources and actions, you can use AWS Identity and Access Management (IAM) policies based on tags. You can provide the control in two ways: 1. Control access to Amazon FSx resources based on the tags on those resources. 2. Control what tags can be passed in an IAM request condition. For information about how to use tags to control access to AWS resources, see Controlling access using tags in the IAM User Guide. For more information about tagging Amazon FSx resources at creation, see Grant permission to tag resources during creation. For more information about tagging resources, see Tagging your Amazon FSx resources. Controlling access based on tags on a resource To control what actions a user or role can perform on an Amazon FSx resource, you can use tags on the resource. For example, you might want to allow or deny specific API operations on a file system resource based on the key-value pair of the tag on the resource. Using tags with Amazon FSx 334 Amazon FSx for Windows File Server Windows User Guide Example policy – Create a file system on when providing a specific tag This policy allows the user to create a file system only when they tag it with a specific tag key value pair, in this example, key=Department, value=Finance. { "Effect": "Allow", "Action": [ "fsx:CreateFileSystem", "fsx:TagResource" ], "Resource": "arn:aws:fsx:region:account-id:file-system/*", "Condition": { "StringEquals": { "aws:RequestTag/Department": "Finance" } } } Example policy – Create backups only of Amazon FSx file systems with a specific tag This policy allows users to create backups only of file systems that are tagged with the key value pair key=Department, value=Finance, and the backup will be created with the tag Deparment=Finance. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "fsx:CreateBackup" ], "Resource": "arn:aws:fsx:region:account-id:file-system/*", "Condition": { "StringEquals": { "aws:ResourceTag/Department": "Finance" } } }, { "Effect": "Allow", Using tags with Amazon FSx 335 Amazon FSx for Windows File Server Windows User Guide "Action": [ "fsx:TagResource", "fsx:CreateBackup" ], "Resource": "arn:aws:fsx:region:account-id:backup/*", "Condition": { "StringEquals": { "aws:RequestTag/Department": "Finance" } } } ] } Example policy – Create a file system with a specific tag from backups with a specific tag This policy allows users to create file systems that are tagged with Department=Finance only from backups that are tagged with Department=Finance. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "fsx:CreateFileSystemFromBackup", "fsx:TagResource" ], "Resource": "arn:aws:fsx:region:account-id:backup/*", "Condition": { "StringEquals": { "aws:ResourceTag/Department": "Finance" } } } ] } Example policy – Delete file systems with specific tags This policy allows a user to delete only file systems that are tagged with Department=Finance. If they create a final backup, then it must be tagged with Department=Finance. Using tags with Amazon FSx 336 Amazon FSx for Windows File Server Windows User Guide { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "fsx:DeleteFileSystem" ], "Resource": "arn:aws:fsx:region:account-id:file-system/*", "Condition": { "StringEquals": { "aws:ResourceTag/Department": "Finance" } } }, { "Effect": "Allow", "Action": [ "fsx:TagResource" ], "Resource": "arn:aws:fsx:region:account-id:backup/*", "Condition": { "StringEquals": { "aws:RequestTag/Department": "Finance" } } } ] } Using service-linked roles for FSx for Windows File Server Amazon FSx for Windows File Server uses AWS Identity and Access Management (IAM) service- linked roles. A service-linked role is a unique type of IAM role that is linked directly to FSx for Windows File Server. Service-linked roles are predefined by FSx for Windows File Server and include all the permissions that the service requires to call other AWS services on your behalf. A service-linked role makes setting up FSx for Windows File Server easier because you don’t have to manually add the necessary permissions. FSx for Windows File Server defines the permissions of its service-linked roles, and unless defined otherwise, only FSx for Windows File Server can assume Using service-linked roles 337 Amazon FSx for Windows File Server Windows User Guide its roles. The defined permissions include the trust policy and the permissions policy, and that permissions policy cannot be attached to any other IAM entity. You can delete a service-linked role only after first deleting their related resources. This protects your FSx for |
WindowsGuide-133 | WindowsGuide.pdf | 133 | role makes setting up FSx for Windows File Server easier because you don’t have to manually add the necessary permissions. FSx for Windows File Server defines the permissions of its service-linked roles, and unless defined otherwise, only FSx for Windows File Server can assume Using service-linked roles 337 Amazon FSx for Windows File Server Windows User Guide its roles. The defined permissions include the trust policy and the permissions policy, and that permissions policy cannot be attached to any other IAM entity. You can delete a service-linked role only after first deleting their related resources. This protects your FSx for Windows File Server resources because you can't inadvertently remove permission to access the resources. For information about other services that support service-linked roles, see AWS Services That Work with IAM and look for the services that have Yes in the Service-Linked Role column. Choose a Yes with a link to view the service-linked role documentation for that service. Service-linked role permissions for FSx for Windows File Server FSx for Windows File Server uses the service-linked role named AWSServiceRoleForAmazonFSx – Which performs certain actions in your account, like creating Elastic Network Interfaces for your file systems in your VPC. The role permissions policy allows FSx for Windows File Server to complete the following actions on the all applicable AWS resources: You can't attach AmazonFSxServiceRolePolicy to your IAM entities. This policy is attached to a service-linked role that allows FSx to manage AWS resources on your behalf. For more information, see Using service-linked roles for FSx for Windows File Server. For updates to this policy, see AmazonFSxServiceRolePolicy This policy grants administrative permissions that allows FSx to manage AWS resources on the user's behalf. Permissions details The AmazonFSxServiceRolePolicy role permissions are defined by the AmazonFSxServiceRolePolicy AWS managed policy. AmazonFSxServiceRolePolicy has the following permissions: Note AmazonFSxServiceRolePolicy is used by all Amazon FSx file system types; some of the listed permissions may not applicable to FSx for Windows. • ds – Allows FSx to view, authorize, and unauthorize applications in your AWS Directory Service directory. Using service-linked roles 338 Amazon FSx for Windows File Server Windows User Guide • ec2 – Allows FSx to do the following: • View, create, and disassociate network interfaces associated with an Amazon FSx file system. • View one or more Elastic IP addresses associated with an Amazon FSx file system. • View Amazon VPCs, security groups, and subnets associated with an Amazon FSx file system. • To provide enhanced security group validation of all security groups that can be used with a VPC. • Create a permission for an AWS-authorized user to perform certain operations on a network interface. • cloudwatch – Allows FSx to publish metric data points to CloudWatch under the AWS/FSx namespace. • route53 – Allows FSx to associate an Amazon VPC with a private hosted zone. • logs – Allows FSx to describe and write to CloudWatch Logs log streams. This is so that users can send file access audit logs for an FSx for Windows File Server file system to a CloudWatch Logs stream. • firehose – Allows FSx to describe and write to Amazon Data Firehose delivery streams. This is so that users can publish the file access audit logs for an FSx for Windows File Server file system to an Amazon Data Firehose delivery stream. { "Version": "2012-10-17", "Statement": [ { "Sid": "CreateFileSystem", "Effect": "Allow", "Action": [ "ds:AuthorizeApplication", "ds:GetAuthorizedApplicationDetails", "ds:UnauthorizeApplication", "ec2:CreateNetworkInterface", "ec2:CreateNetworkInterfacePermission", "ec2:DeleteNetworkInterface", "ec2:DescribeAddresses", "ec2:DescribeDhcpOptions", "ec2:DescribeNetworkInterfaces", "ec2:DescribeRouteTables", "ec2:DescribeSecurityGroups", "ec2:DescribeSubnets", Using service-linked roles 339 Amazon FSx for Windows File Server Windows User Guide "ec2:DescribeVPCs", "ec2:DisassociateAddress", "ec2:GetSecurityGroupsForVpc", "route53:AssociateVPCWithHostedZone" ], "Resource": "*" }, { "Sid": "PutMetrics", "Effect": "Allow", "Action": [ "cloudwatch:PutMetricData" ], "Resource": [ "*" ], "Condition": { "StringEquals": { "cloudwatch:namespace": "AWS/FSx" } } }, { "Sid": "TagResourceNetworkInterface", "Effect": "Allow", "Action": [ "ec2:CreateTags" ], "Resource": [ "arn:aws:ec2:*:*:network-interface/*" ], "Condition": { "StringEquals": { "ec2:CreateAction": "CreateNetworkInterface" }, "ForAllValues:StringEquals": { "aws:TagKeys": "AmazonFSx.FileSystemId" } } }, { "Sid": "ManageNetworkInterface", "Effect": "Allow", Using service-linked roles 340 Windows User Guide Amazon FSx for Windows File Server "Action": [ "ec2:AssignPrivateIpAddresses", "ec2:ModifyNetworkInterfaceAttribute", "ec2:UnassignPrivateIpAddresses" ], "Resource": [ "arn:aws:ec2:*:*:network-interface/*" ], "Condition": { "Null": { "aws:ResourceTag/AmazonFSx.FileSystemId": "false" } } }, { "Sid": "ManageRouteTable", "Effect": "Allow", "Action": [ "ec2:CreateRoute", "ec2:ReplaceRoute", "ec2:DeleteRoute" ], "Resource": [ "arn:aws:ec2:*:*:route-table/*" ], "Condition": { "StringEquals": { "aws:ResourceTag/AmazonFSx": "ManagedByAmazonFSx" } } }, { "Sid": "PutCloudWatchLogs", "Effect": "Allow", "Action": [ "logs:DescribeLogGroups", "logs:DescribeLogStreams", "logs:PutLogEvents" ], "Resource": "arn:aws:logs:*:*:log-group:/aws/fsx/*" }, { "Sid": "ManageAuditLogs", "Effect": "Allow", Using service-linked roles 341 Amazon FSx for Windows File Server Windows User Guide "Action": [ "firehose:DescribeDeliveryStream", "firehose:PutRecord", "firehose:PutRecordBatch" ], "Resource": "arn:aws:firehose:*:*:deliverystream/aws-fsx-*" } ] } Any updates to this policy are described in Amazon FSx updates to AWS managed policies. You must configure permissions to allow an IAM entity (such as a user, group, or role) to create, edit, or delete a service-linked role. For more information, see Service-Linked Role Permissions in the IAM |
WindowsGuide-134 | WindowsGuide.pdf | 134 | { "StringEquals": { "aws:ResourceTag/AmazonFSx": "ManagedByAmazonFSx" } } }, { "Sid": "PutCloudWatchLogs", "Effect": "Allow", "Action": [ "logs:DescribeLogGroups", "logs:DescribeLogStreams", "logs:PutLogEvents" ], "Resource": "arn:aws:logs:*:*:log-group:/aws/fsx/*" }, { "Sid": "ManageAuditLogs", "Effect": "Allow", Using service-linked roles 341 Amazon FSx for Windows File Server Windows User Guide "Action": [ "firehose:DescribeDeliveryStream", "firehose:PutRecord", "firehose:PutRecordBatch" ], "Resource": "arn:aws:firehose:*:*:deliverystream/aws-fsx-*" } ] } Any updates to this policy are described in Amazon FSx updates to AWS managed policies. You must configure permissions to allow an IAM entity (such as a user, group, or role) to create, edit, or delete a service-linked role. For more information, see Service-Linked Role Permissions in the IAM User Guide. Creating a service-linked role for FSx for Windows File Server You don't need to manually create a service-linked role. When you create a file system in the AWS Management Console, the IAM CLI, or the IAM API, FSx for Windows File Server creates the service- linked role for you. Important This service-linked role can appear in your account if you completed an action in another service that uses the features supported by this role. To learn more, see A New Role Appeared in My IAM Account. If you delete this service-linked role, and then need to create it again, you can use the same process to recreate the role in your account. When you create a file system, FSx for Windows File Server creates the service-linked role for you again. Editing a service-linked role for FSx for Windows File Server FSx for Windows File Server does not allow you to edit the service-linked role. After you create a service-linked role, you cannot change the name of the role because various entities might reference the role. However, you can edit the description of the role using IAM. For more information, see Editing a Service-Linked Role in the IAM User Guide. Using service-linked roles 342 Amazon FSx for Windows File Server Windows User Guide Deleting a service-linked role for FSx for Windows File Server If you no longer need to use a feature or service that requires a service-linked role, we recommend that you delete that role. That way you don’t have an unused entity that is not actively monitored or maintained. However, you must delete all of your file systems and backups before you can manually delete the service-linked role. Note If the FSx for Windows File Server service is using the role when you try to delete the resources, then the deletion might fail. If that happens, wait for a few minutes and try the operation again. To manually delete the service-linked role using IAM Use the IAM console, the IAM CLI, or the IAM API to delete the service-linked role. For more information, see Deleting a Service-Linked Role in the IAM User Guide. Supported regions for FSx for Windows File Server service-linked roles FSx for Windows File Server supports using service-linked roles in all of the regions where the service is available. For more information, see AWS Regions and Endpoints. Compliance Validation for Amazon FSx for Windows File Server To learn whether an AWS service is within the scope of specific compliance programs, see AWS services in Scope by Compliance Program and choose the compliance program that you are interested in. For general information, see AWS Compliance Programs. You can download third-party audit reports using AWS Artifact. For more information, see Downloading Reports in AWS Artifact. Your compliance responsibility when using AWS services is determined by the sensitivity of your data, your company's compliance objectives, and applicable laws and regulations. AWS provides the following resources to help with compliance: • Security Compliance & Governance – These solution implementation guides discuss architectural considerations and provide steps for deploying security and compliance features. Compliance Validation 343 Amazon FSx for Windows File Server Windows User Guide • HIPAA Eligible Services Reference – Lists HIPAA eligible services. Not all AWS services are HIPAA eligible. • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. • AWS Customer Compliance Guides – Understand the shared responsibility model through the lens of compliance. The guides summarize the best practices for securing AWS services and map the guidance to security controls across multiple frameworks (including National Institute of Standards and Technology (NIST), Payment Card Industry Security Standards Council (PCI), and International Organization for Standardization (ISO)). • Evaluating Resources with Rules in the AWS Config Developer Guide – The AWS Config service assesses how well your resource configurations comply with internal practices, industry guidelines, and regulations. • AWS Security Hub – This AWS service provides a comprehensive view of your security state within AWS. Security Hub uses security controls to evaluate your AWS resources and to check your compliance against security industry standards and best practices. For a list of supported services and controls, see Security Hub controls |
WindowsGuide-135 | WindowsGuide.pdf | 135 | of Standards and Technology (NIST), Payment Card Industry Security Standards Council (PCI), and International Organization for Standardization (ISO)). • Evaluating Resources with Rules in the AWS Config Developer Guide – The AWS Config service assesses how well your resource configurations comply with internal practices, industry guidelines, and regulations. • AWS Security Hub – This AWS service provides a comprehensive view of your security state within AWS. Security Hub uses security controls to evaluate your AWS resources and to check your compliance against security industry standards and best practices. For a list of supported services and controls, see Security Hub controls reference. • Amazon GuardDuty – This AWS service detects potential threats to your AWS accounts, workloads, containers, and data by monitoring your environment for suspicious and malicious activities. GuardDuty can help you address various compliance requirements, like PCI DSS, by meeting intrusion detection requirements mandated by certain compliance frameworks. • AWS Audit Manager – This AWS service helps you continuously audit your AWS usage to simplify how you manage risk and compliance with regulations and industry standards. Amazon FSx for Windows File Server and interface VPC endpoints You can improve the security posture of your VPC by configuring Amazon FSx to use an interface VPC endpoint. Interface VPC endpoints are powered by AWS PrivateLink, a technology that enables you to privately access Amazon FSx APIs without an internet gateway, NAT device, VPN connection, or AWS Direct Connect connection. Instances in your VPC don't need public IP addresses to communicate with Amazon FSx APIs. Traffic between your VPC and Amazon FSx does not leave the AWS network. Each interface VPC endpoint is represented by one or more elastic network interfaces in your subnets. A network interface provides a private IP address that serves as an entry point for traffic Interface VPC endpoints 344 Amazon FSx for Windows File Server Windows User Guide to the Amazon FSx API. Amazon FSx supports VPC endpoints configured with IPv4 and Dualstack (IPv4 and IPv6) IP address types. For more information, see Creating an interface VPC endpoint in the Amazon VPC User Guide. Considerations for Amazon FSx interface VPC endpoints Before you set up an interface VPC endpoint for Amazon FSx, be sure to review Interface VPC endpoint properties and limitations in the Amazon VPC User Guide. You can call any of the Amazon FSx API operations from your VPC. For example, you can create an FSx for Windows File Server file system by calling the CreateFileSystem API from within your VPC. For the full list of Amazon FSx APIs, see Actions in the Amazon FSx API Reference. VPC peering considerations You can connect other VPCs to the VPC with interface VPC endpoints using VPC peering. VPC peering is a networking connection between two VPCs. You can establish a VPC peering connection between your own two VPCs, or with a VPC in another AWS account. The VPCs can also be in two different AWS Regions. Traffic between peered VPCs stays on the AWS network and does not traverse the public internet. Once VPCs are peered, resources like Amazon Elastic Compute Cloud (Amazon EC2) instances in both VPCs can access the Amazon FSx API through interface VPC endpoints created in the one of the VPCs. Creating an interface VPC endpoint for Amazon FSx API You can create a VPC endpoint for the Amazon FSx API using either the Amazon VPC console or the AWS Command Line Interface (AWS CLI). For more information, see Creating an interface VPC endpoint in the Amazon VPC User Guide. To create an interface VPC endpoint for Amazon FSx, use one of the following: • com.amazonaws.region.fsx – Creates an endpoint for Amazon FSx API operations. • com.amazonaws.region.fsx-fips – Creates an endpoint for the Amazon FSx API that complies with Federal Information Processing Standard (FIPS) 140-2. Considerations for Amazon FSx interface VPC endpoints 345 Amazon FSx for Windows File Server Windows User Guide To use the private DNS option, you must set the enableDnsHostnames and enableDnsSupport attributes of your VPC. For more information, see Viewing and updating DNS support for your VPC in the Amazon VPC User Guide. Excluding AWS Regions in China, if you enable private DNS for the endpoint, you can make API requests to Amazon FSx with the VPC endpoint using its default DNS name for the AWS Region, for example fsx.us-east-1.amazonaws.com. For the China (Beijing) and China (Ningxia) AWS Regions, you can make API requests with the VPC endpoint using fsx-api.cn- north-1.amazonaws.com.cn and fsx-api.cn-northwest-1.amazonaws.com.cn, respectively. For more information, see Accessing a service through an interface VPC endpoint in the Amazon VPC User Guide. Creating a VPC endpoint policy for Amazon FSx To further control access to the Amazon FSx API, you can optionally attach an AWS Identity and Access Management (IAM) policy to your VPC endpoint. The policy specifies the |
WindowsGuide-136 | WindowsGuide.pdf | 136 | API requests to Amazon FSx with the VPC endpoint using its default DNS name for the AWS Region, for example fsx.us-east-1.amazonaws.com. For the China (Beijing) and China (Ningxia) AWS Regions, you can make API requests with the VPC endpoint using fsx-api.cn- north-1.amazonaws.com.cn and fsx-api.cn-northwest-1.amazonaws.com.cn, respectively. For more information, see Accessing a service through an interface VPC endpoint in the Amazon VPC User Guide. Creating a VPC endpoint policy for Amazon FSx To further control access to the Amazon FSx API, you can optionally attach an AWS Identity and Access Management (IAM) policy to your VPC endpoint. The policy specifies the following: • The principal that can perform actions. • The actions that can be performed. • The resources upon which actions can be performed. For more information, see Controlling access to services with VPC endpoints in the Amazon VPC User Guide. Creating a VPC endpoint policy for Amazon FSx 346 Amazon FSx for Windows File Server Windows User Guide Working with other services In addition to Amazon CloudWatch, AWS Identity and Access Management, AWS CloudTrail, and AWS DataSync, FSx for Windows File Server also integrates with the following AWS services: • Amazon AppStream 2.0 – AppStream 2.0is a fully managed application streaming service that provides users with instant access to their desktop applications from anywhere. AppStream 2.0 manages the AWS resources required to host and run your applications, scales automatically, and provides access to your users on demand. Learn how to create persistent storage for individual users, and share storage across many users on your FSx for Windows File Server file systems using AppStream 2.0. For more information, see Using Amazon FSx with Amazon AppStream 2.0. • Amazon Kendra – Amazon Kendra is an intelligent search service that uses natural language processing and advanced machine learning algorithms to return specific answers to search questions from your data. With Amazon Kendra, you can create a unified search experience by connecting multiple data repositories to an index and ingesting and crawling documents. For more information on using Amazon Kendra with FSx for Windows File Server, see Using FSx for Windows File Server with Amazon Kendra. Topics • Using Amazon FSx with Amazon AppStream 2.0 • Using FSx for Windows File Server with Amazon Kendra Using Amazon FSx with Amazon AppStream 2.0 By supporting the Server Message Block (SMB) protocol, Amazon FSx for Windows File Server supports accessing your file system from Amazon EC2, VMware Cloud on AWS, Amazon WorkSpaces, and Amazon AppStream 2.0 instances. AppStream 2.0 is a fully managed application streaming service. You centrally manage your desktop applications on AppStream 2.0 and securely deliver them to a browser on any computer. For more information on AppStream 2.0, see the Amazon AppStream 2.0 Administration Guide. For instructions on how you can streamline the management of your Amazon AppStream 2.0 images and fleets, see the AWS blog post Automatically create customized AppStream 2.0 Windows images. Using Amazon FSx with Amazon AppStream 2.0 347 Amazon FSx for Windows File Server Windows User Guide The following procedures show you how to use Amazon FSx with AppStream 2.0 to provide personal persistent storage to each user, and to provide a shared folder so that multiple users can access common files. Providing personal persistent storage to each user You can use Amazon FSx to provide every user in your organization a unique storage drive within AppStream 2.0 streaming sessions. A user will have permissions to access only their folder. The drive is automatically mounted at the start of a streaming session and files added or updated to the drive are automatically persisted between streaming sessions. There are three procedures you'll need to perform to complete this task. To create home folders for domain users using Amazon FSx 1. Create an Amazon FSx file system. For more information, see Getting started with Amazon FSx for Windows File Server. 2. After the file system is available, create a folder for every domain AppStream 2.0 user within your Amazon FSx file system. The example following uses the domain user name of the user as the name of the corresponding folder. Doing this means that you can build the UNC name of the file share to map easily using the Windows environment variable %username%. 3. Share each of these folders out as a shared folder. For more information, see Creating, updating, removing file shares. To launch a domain-joined AppStream 2.0 image builder 1. Sign into the AppStream 2.0 console: https://console.aws.amazon.com/appstream2 2. Choose Directory Configs from the navigation menu, and create a Directory Config object. For more information, see Using Active Directory with AppStream 2.0 in the Amazon AppStream 2.0 Administration Guide. 3. Choose Images, Image Builder, and launch a new image builder. 4. Choose the directory config object created earlier in the image builder launch wizard to join the image builder |
WindowsGuide-137 | WindowsGuide.pdf | 137 | environment variable %username%. 3. Share each of these folders out as a shared folder. For more information, see Creating, updating, removing file shares. To launch a domain-joined AppStream 2.0 image builder 1. Sign into the AppStream 2.0 console: https://console.aws.amazon.com/appstream2 2. Choose Directory Configs from the navigation menu, and create a Directory Config object. For more information, see Using Active Directory with AppStream 2.0 in the Amazon AppStream 2.0 Administration Guide. 3. Choose Images, Image Builder, and launch a new image builder. 4. Choose the directory config object created earlier in the image builder launch wizard to join the image builder to your Active Directory domain. 5. Launch the image builder in the same VPC as that of your Amazon FSx file system. Make sure to associate the image builder with the same AWS Managed Microsoft AD directory to which your Amazon FSx file system is joined. The VPC security groups that you associate with the image builder must allow access to your Amazon FSx file system. Providing personal persistent storage to each user 348 Amazon FSx for Windows File Server Windows User Guide 6. Once the image builder is available, connect to the image builder and login using your domain administrator account. 7. Install your applications. To link Amazon FSx file shares with AppStream 2.0 1. In the image builder, create a batch script with the following command and store it in a known file location (for example: C:\Scripts\map-fs.bat). The following example uses S: as the drive letter to map the shared folder on your Amazon FSx file system. You use the DNS name of your Amazon FSx file system or a DNS alias associated with the file system in this script, which you can get from the file system details view in the Amazon FSx console. If you're using the file system's DNS name: @echo off net use S: /delete net use S: \\file-system-DNS-name\users\%username% If you're using a DNS alias associated with the file system: @echo off net use S: /delete net use S: \\fqdn-DNS-alias\users\%username% 2. Open a PowerShell prompt and run gpedit.msc. 3. From User Configuration choose Windows Settings and then Logon. 4. Navigate to the batch script that you created in the first step of this procedure, and choose it. 5. From Computer Configuration, choose Windows Administrative Templates, System, and then Group Policy. 6. Choose the policy Configure Logon Script delay. Enable the policy and reduce the time delay to 0. This setting helps to ensure that the user logon script is executed immediately when the user starts a streaming session. 7. Create your image and assign it to an AppStream 2.0 fleet. Ensure that you also join the AppStream 2.0 fleet to the same Active Directory domain that you used for image builder. Launch the fleet in the same VPC that is used by your Amazon FSx file system. The VPC security groups that you associate with the fleet must provide access to your Amazon FSx file system. Providing personal persistent storage to each user 349 Amazon FSx for Windows File Server Windows User Guide 8. Launch a streaming session using SAML SSO. To connect to an fleet that is joined to Active Directory, configure single sign-on federation using a SAML provider. For more information, see Single Sign-on Access to AppStream 2.0 Using SAML 2.0 in the Amazon AppStream 2.0 Administration Guide. 9. Your Amazon FSx file share is mapped to the S: drive letter within the streaming session. Providing a shared folder across users You can use Amazon FSx to provide a shared folder to users in your organization. A shared folder can be used to maintain common files (for example, demo files, code examples, instruction manuals, etc.) needed by all users. There are three procedures you'll need to perform to complete this task. To create a shared folder using Amazon FSx 1. Create an Amazon FSx file system. For more information, see Getting started with Amazon FSx for Windows File Server. 2. Every Amazon FSx file system includes a shared folder by default that you can access using the address \\file-system-DNS-name\share, or \\fqdn-DNS-alias\share if you are using DNS aliases. You can use the default share or create a different shared folder. For more information, see Creating, updating, removing file shares. To launch an AppStream 2.0 image builder 1. From the AppStream 2.0 console, launch a new image builder or connect to an existing image builder. Launch the image builder in the same VPC that is used by your Amazon FSx file system. The VPC security groups that you associate with the image builder must allow access to your Amazon FSx file system. 2. Once the image builder is available, connect to the image builder as the Administrator user. 3. Install or update your applications as Administrator. To link the shared folder with AppStream 2.0 |
WindowsGuide-138 | WindowsGuide.pdf | 138 | see Creating, updating, removing file shares. To launch an AppStream 2.0 image builder 1. From the AppStream 2.0 console, launch a new image builder or connect to an existing image builder. Launch the image builder in the same VPC that is used by your Amazon FSx file system. The VPC security groups that you associate with the image builder must allow access to your Amazon FSx file system. 2. Once the image builder is available, connect to the image builder as the Administrator user. 3. Install or update your applications as Administrator. To link the shared folder with AppStream 2.0 1. Create a batch script, as described in the previous procedure, to automatically mount the shared folder whenever a user launches a streaming session. To complete the script, you need the file system's DNS name or a DNS alias that is associated with the file system (which you Providing a shared folder across users 350 Amazon FSx for Windows File Server Windows User Guide can obtain from the file system details view in the Amazon FSx Console), and credentials for accessing the shared folder. If you're using the file system's DNS name: @echo off net use S: /delete net use S: \\file-system-DNS-name\share /user:username password If you're using a DNS alias associated with the file system: @echo off net use S: /delete net use S: \\fqdn-DNS-alias\share /user:username password 2. Create a Group Policy to execute this batch script at every user logon. You can follow the same instructions as described in the previous section. 3. Create your image and assign it to your fleet. 4. Launch a streaming session. You should now see the shared folder automatically mapped to the drive letter. Using FSx for Windows File Server with Amazon Kendra Amazon Kendra is a highly accurate and intelligent search service. FSx for Windows File Server file systems can be used as data sources for Amazon Kendra, allowing you to index and intelligently search for information contained in documents stored on your file system. • For more information about Amazon Kendra, see What is Amazon Kendra in the Amazon Kendra Developer's Guide. • For more information about how to add your file system as an Amazon Kendra data source, see Getting started with an Amazon FSx data source (console) in the Amazon Kendra Developer's Guide. • For overview information about Amazon Kendra, see the Amazon Kendra website. Using FSx for Windows File Server with Amazon Kendra 351 Amazon FSx for Windows File Server Windows User Guide • For a walkthrough of how to search your file system using Amazon Kendra, see Securely search unstructured data on Windows file systems with the Amazon Kendra connector for Amazon FSx for Windows File Server on the AWS Machine Learning Blog. File system performance When you add an FSx for Windows File Server file system as a data source, Amazon Kendra crawls the files and folders on the file system on a regular sync frequency to create and maintain its search index. (You can select the sync frequency when you establish the integration.) This file access activity from Amazon Kendra will consume file system resources, similar to activity from your own workloads accessing the file system. Ensure your file system is configured with sufficient resources such that your workload performance is not impacted. Specifically, if you are planning to index a large number of files, we recommend using a file system with SSD storage type, which provides higher maximum throughput and IOPS levels for requests that need to access the storage volumes. For more information about the Amazon FSx performance model, see FSx for Windows File Server performance. File system performance 352 Amazon FSx for Windows File Server Windows User Guide Quotas Following, you can find out about quotas when working with Amazon FSx for Windows File Server. Topics • Quotas that you can increase • Resource quotas for each file system • Additional considerations • Quotas specific to Microsoft Windows Quotas that you can increase Following are the quotas for Amazon FSx for Windows File Server for each AWS account, per AWS Region, that you can increase. Resource Default Description Windows file systems 100 Windows throughput capacity 10240 Windows HDD storage capacity 524288 Windows SSD storage capacity 524288 The maximum number of Amazon FSx for Windows Server file systems that you can create in this account. The total amount of throughput capacity (in MBps) allowed for all Amazon FSx for Windows file systems in this account. The maximum amount of HDD storage capacity (in GiB) allowed for all Amazon FSx for Windows File Server file systems in this account. The maximum amount of SSD storage capacity (in GiB) Quotas that you can increase 353 Amazon FSx for Windows File Server Windows User Guide Resource Default Description allowed for all Amazon FSx for Windows File |
WindowsGuide-139 | WindowsGuide.pdf | 139 | SSD storage capacity 524288 The maximum number of Amazon FSx for Windows Server file systems that you can create in this account. The total amount of throughput capacity (in MBps) allowed for all Amazon FSx for Windows file systems in this account. The maximum amount of HDD storage capacity (in GiB) allowed for all Amazon FSx for Windows File Server file systems in this account. The maximum amount of SSD storage capacity (in GiB) Quotas that you can increase 353 Amazon FSx for Windows File Server Windows User Guide Resource Default Description allowed for all Amazon FSx for Windows File Server file systems in this account. The total amount of SSD IOPS allowed for all Amazon FSx for Windows File Server file systems in this account. The maximum number of user-initiated backups for all Amazon FSx for Windows File Server file systems that you can have in this account. Windows total SSD IOPS 500,000 Windows backups 500 To request a quota increase 1. Open the Service Quotas console. 2. In the navigation pane, choose AWS services. 3. Choose Amazon FSx. 4. Choose a quota. 5. Choose Request quota increase, and follow the directions to request a quota increase. 6. To view the status of the quota request, choose Quota request history in the console navigation pane. For more information, see Requesting a quota increase in the Service Quotas User Guide. Resource quotas for each file system Following are the quotas on Amazon FSx for Windows File Server resources for each file system in an AWS Region. Resource quotas for each file system 354 Amazon FSx for Windows File Server Windows User Guide Resource Limit per file system Maximum number of tags 50 Maximum retention period for automated backups 90 days Maximum number of backup copy requests in progress to a single destination Region per account. 5 Minimum storage capacity, SSD file systems 32 GiB Minimum storage capacity, HDD file systems 2,000 GiB Maximum storage capacity, SSD and HDD Minimum SSD IOPS Maximum SSD IOPS Minimum throughput capacity Maximum throughput capacity Maximum number of file shares Additional considerations In addition, note the following: 64 TiB 96 400,000 8 MBps 12,288 MBps 100,000 • You can use each AWS Key Management Service (AWS KMS) key on up to 125 Amazon FSx file systems. • For a list of AWS Regions where you can create file systems, see Amazon FSx Endpoints and Quotas in the AWS General Reference. • You map your file shares from Amazon EC2 instances in your virtual private cloud (VPC) with their Domain Name Service (DNS) names. Additional considerations 355 Amazon FSx for Windows File Server Windows User Guide Quotas specific to Microsoft Windows For more information, see NTFS limits on the Microsoft Windows Dev Center. Quotas specific to Microsoft Windows 356 Amazon FSx for Windows File Server Windows User Guide Troubleshooting Amazon FSx Use the following sections to help troubleshoot problems you have with Amazon FSx. If you encounter problems not listed following while using Amazon FSx, try asking a question in the Amazon FSx forum. Topics • You can't access your file system • Creating a new Amazon FSx file system fails • File system is in a misconfigured state • You can't configure DFS-R on a Multi-AZ or Single-AZ 2 file system • Storage or throughput capacity updates fail You can't access your file system There are a number of potential causes for being unable to access your file system, each with their own resolution, as follows. Topics • The file system elastic network interface was modified or deleted • The Elastic IP address attached to the file system elastic network interface was deleted • The file system security group lacks the required inbound or outbound rules. • The compute instance's security group lacks the required outbound rules • Compute instance not joined to an Active Directory • The file share doesn't exist • Active Directory user lacks required permissions • Allow Full control NTFS ACL permissions removed • Can't access a file system using an on-premises client • New file system is not registered in DNS • Can't access the file system using a DNS alias • Can't access the file system using an IP address You can't access your file system 357 Amazon FSx for Windows File Server Windows User Guide The file system elastic network interface was modified or deleted You must not modify or delete the file system's elastic network interface. Modifying or deleting the network interface can cause a permanent loss of connection between your VPC and your file system. Create a new file system, and do not modify or delete the Amazon FSx elastic network interface. For more information, see File system access control with Amazon VPC. The Elastic IP address attached to the file system elastic network interface was |
WindowsGuide-140 | WindowsGuide.pdf | 140 | address You can't access your file system 357 Amazon FSx for Windows File Server Windows User Guide The file system elastic network interface was modified or deleted You must not modify or delete the file system's elastic network interface. Modifying or deleting the network interface can cause a permanent loss of connection between your VPC and your file system. Create a new file system, and do not modify or delete the Amazon FSx elastic network interface. For more information, see File system access control with Amazon VPC. The Elastic IP address attached to the file system elastic network interface was deleted Amazon FSx doesn't support accessing file systems from the public internet. Amazon FSx automatically detaches any Elastic IP address, which is a public IP address reachable from the internet, that gets attached to a file system's elastic network interface. For more information, see Accessing your data. The file system security group lacks the required inbound or outbound rules. Review the inbound rules specified in Amazon VPC Security Groups, and make sure that the security group associated with your file system has the corresponding inbound rules. The compute instance's security group lacks the required outbound rules Review the outbound rules specified in Amazon VPC Security Groups, and make sure that the security group associated with your compute instance has the corresponding outbound rules. Compute instance not joined to an Active Directory Your compute instances might not be correctly joined to one of two types of Active Directory: • The AWS Managed Microsoft AD directory to which your file system is joined. • A Microsoft Active Directory directory that has a one-way forest trust relationship established with the AWS Managed Microsoft AD directory. Make sure that your compute instances are joined to one of two types of directory. One type is the AWS Managed Microsoft AD directory to which your file system is joined. The other type is a The file system elastic network interface was modified or deleted 358 Amazon FSx for Windows File Server Windows User Guide Microsoft Active Directory directory that has a one-way forest trust relationship established with the AWS Managed Microsoft AD directory. For more information, see Using Amazon FSx with AWS Directory Service for Microsoft Active Directory. The file share doesn't exist The Microsoft Windows file share that you're attempting to access doesn't exist. If you're using an existing file share, make sure that the file system DNS name and the share name are correctly specified. To manage your file shares, see Creating, updating, removing file shares. Active Directory user lacks required permissions The Active Directory user that you're accessing the file share as lacks the necessary access permissions. Make sure that the access permissions for the file share and Windows access control lists (ACLs) for the shared folder allow access to the Active Directory users that need to access it. Allow Full control NTFS ACL permissions removed If you remove Allow Full control NTFS ACL permissions for the SYSTEM user on a folder that you shared, that share can become inaccessible and any file system backups taken from that point onwards may not be usable. You will need to re-create the affected file share. For more information, see Creating, updating, removing file shares. After you recreate the folder or share, you can map and use the Windows file shares from your compute instances. Can't access a file system using an on-premises client You're using your Amazon FSx file system from on-premises using AWS Direct Connect or VPN, and you're using a non-private IP address range for the on-premises client. Amazon FSx only supports access from on-premises clients with non-private IP addresses on file systems created after December 17, 2020. If you need to access your FSx for Windows File Server file system that was created before December 17, 2020 using a non-private IP address range, you can create a new file system by restoring a backup of the file system. For more information, see Protecting your data with backups. The file share doesn't exist 359 Amazon FSx for Windows File Server Windows User Guide New file system is not registered in DNS For file systems joined to a self-managed Active Directory, Amazon FSx did not register the file system DNS when it was created because the customer network does not use Microsoft DNS. Amazon FSx does not register file systems in DNS if your network uses a third-party DNS service instead of Microsoft DNS. You must manually set up DNS A entries for your Amazon FSx file systems. For Single-AZ 1 file systems, you will need to add one DNS A entry; for Single-AZ 2 and Multi-AZ file systems, you will need to add two DNS A entries. Use the following procedure to obtain the file system IP address or addresses to use when |
WindowsGuide-141 | WindowsGuide.pdf | 141 | not register the file system DNS when it was created because the customer network does not use Microsoft DNS. Amazon FSx does not register file systems in DNS if your network uses a third-party DNS service instead of Microsoft DNS. You must manually set up DNS A entries for your Amazon FSx file systems. For Single-AZ 1 file systems, you will need to add one DNS A entry; for Single-AZ 2 and Multi-AZ file systems, you will need to add two DNS A entries. Use the following procedure to obtain the file system IP address or addresses to use when manually adding the DNS A entries. 1. In the https://console.aws.amazon.com/fsx/, choose the file system that you want to obtain the IP address of to display the file system details page. 2. In the Network & security tab do one of the following: • For a Single-AZ 1 file system: • In the Subnet panel, choose the elastic network interface shown under Network interface to open the Network Interfaces page in the Amazon EC2 . • The IP address for the Single-AZ 1 file system to use is shown in the Primary private IPv4 IP column. • For a Single-AZ 2 or Multi-AZ file system: • In the Preferred subnet panel, choose the elastic network interface shown under Network interface to open the Network Interfaces page in the Amazon EC2 . • The IP address for the preferred subnet to use is shown in the Secondary private IPv4 IP column. • In the Amazon FSx Standby subnet panel, choose the elastic network interface shown under Network interface to open the Network Interfaces page in the Amazon EC2 console. • The IP address for the standby subnet to use is shown in the Secondary private IPv4 IP column. Can't access the file system using a DNS alias If you're unable to access a file system using a DNS alias, use the following procedure to troubleshoot the issue. New file system is not registered in DNS 360 Amazon FSx for Windows File Server Windows User Guide 1. Verify that the alias is associated with the file system by doing either of the following steps: a. Using the Amazon FSx console – Choose the file system that you're trying to access. On the File system details page, the DNS aliases are shown on the Network & security tab. b. Using the CLI or API – Use the describe-file-system-aliases CLI command, or the DescribeFileSystemAliases API operation to retrieve the aliases currently associated with the file system. 2. If the DNS alias is not listed, you must associate it with the file system. For more information, see Managing DNS aliases on existing file systems. 3. If the DNS alias is associated with the file system, verify that you've also configured the following required items: • Created service principal names (SPNs) corresponding to the DNS alias on your Amazon FSx file system's Active Directory computer object. For more information, see Configure service principal names (SPNs) for Kerberos. • Created a DNS CNAME record for the DNS alias that resolves to the default DNS name of the Amazon FSx file system. For more information, see Update or create a DNS CNAME record. 4. If you created valid SPNs and a DNS CNAME record, verify that the client's DNS has the DNS CNAME record that resolves to the correct file system. a. Run nslookup to confirm that the record exists and that it resolves to the file system's default DNS name. b. If the DNS CNAME resolves to another file system, wait for the client's DNS cache to refresh, and then check the CNAME record again. You can accelerate the process by flushing the client's DNS cache using the following command. ipconfig /flushdns 5. If the DNS CNAME record resolves to the Amazon FSx file system's default DNS, and the client is still unable to access the file system, see You can't access your file system for additional troubleshooting steps. Can't access the file system using a DNS alias 361 Amazon FSx for Windows File Server Windows User Guide Can't access the file system using an IP address If you're unable to access your file system using an IP address, try using the DNS name or associated DNS alias instead. You can find the file system's DNS name and any associated DNS aliases on the Amazon FSx console by choosing Windows File Server, Network & security. Or, you can find them in the response of the CreateFileSystem or DescribeFileSystems API operation. For more information about using DNS aliases, see Managing DNS aliases. • For a Single-AZ file system joined to an AWS Managed Microsoft Active Directory, the DNS name looks like the following. fs-0123456789abcdef0.ad-domain.com • For all Multi-AZ file systems, and Single-AZ file systems joined to a self-managed Active |
WindowsGuide-142 | WindowsGuide.pdf | 142 | address, try using the DNS name or associated DNS alias instead. You can find the file system's DNS name and any associated DNS aliases on the Amazon FSx console by choosing Windows File Server, Network & security. Or, you can find them in the response of the CreateFileSystem or DescribeFileSystems API operation. For more information about using DNS aliases, see Managing DNS aliases. • For a Single-AZ file system joined to an AWS Managed Microsoft Active Directory, the DNS name looks like the following. fs-0123456789abcdef0.ad-domain.com • For all Multi-AZ file systems, and Single-AZ file systems joined to a self-managed Active Directory, the DNS name looks like the following. amznfsxaa11bb22.ad-domain.com Creating a new Amazon FSx file system fails There are a number of potential causes when a file system creation request fails, as described in the following section. Topics • Misconfigured VPC security group and network ACLs • Duplicate file system administrators group names • DNS servers or domain controllers unreachable • Invalid service account credentials • Insufficient service account permissions • Service account capacity exceeded • Amazon FSx can't access the organizational unit (OU) • Service account can't access the administrators group • Amazon FSx lost connectivity in domain Can't access the file system using an IP address 362 Amazon FSx for Windows File Server Windows User Guide • Service account does not have correct permissions • Unicode characters used in creation parameters • Switching storage type to HDD while restoring a backup fails Misconfigured VPC security group and network ACLs Make sure that the VPC security groups and network ACLs are configured using the recommended security group configuration. For more information, see Creating security groups. Duplicate file system administrators group names Creating a file system joined to your self-managed Active Directory fails with the following error message: File system creation failed. Amazon FSx is unable to apply your Microsoft Active Directory configuration with the specified file system administrators group. Please ensure that your Active Directory does not contain multiple domain groups with the name: domain_group. Amazon FSx did not create the file system because there are multiple administrator groups in the domain with the same name. If you don't specify a group name, Amazon FSx will attempt to use the default value "Domain Admins" as the administrator group. The request will fail if there is more than one group using the default "Domain Admins" name. Use the following steps to resolve the issue. 1. Review the prerequisites for joining your file system to your self-managed Active Directory. 2. Use the Amazon FSx Active Directory Validation Tool to validate your self-managed Active Directory configuration prior to creating an FSx for Windows File Server file system that's joined to a self-managed Active Directory. 3. Create a new file system using the AWS Management Console or AWS CLI. For more information, see Joining an Amazon FSx file system to a self-managed Microsoft Active Directory domain. 4. Provide a name for the file system administrator group that is unique in the domain for your self-managed Active Directory. Misconfigured VPC security group 363 Amazon FSx for Windows File Server Windows User Guide DNS servers or domain controllers unreachable Creating a file system joined to your self-managed Active Directory fails with the following error message: Amazon FSx can't reach the DNS servers provided or the domain controllers for your self-managed directory in Microsoft Active Directory. File system creation failed. Amazon FSx is unable to communicate with your Microsoft Active Directory domain controllers. This is because Amazon FSx can't reach the DNS servers provided or domain controllers for your domain. To fix this problem, delete your file system and create a new one with valid DNS servers and networking configuration that allows traffic from the file system to the domain controller. Use the following steps to troubleshoot and resolve the issue. 1. Verify that you followed the prerequisites for having network connectivity and routing established between the subnet where you're creating an Amazon FSx file system, and your self-managed Active Directory. For more information, see Prerequisites. Use the Amazon FSx Active Directory Validation tool to test and verify these network settings. Note If you have multiple Active Directory sites defined, ensure that the subnets in the VPC associated with your Amazon FSx file system are defined in an Active Directory site and that no IP conflicts exist between the subnets in your VPC and the subnets in your other sites. You can view and change these settings using the Active Directory Sites and Services MMC snap-in. 2. Verify that you configured the VPC security groups that you associated with your Amazon FSx file system, along with any VPC network ACLs, to allow outbound network traffic on all ports. Note If you want to implement least privilege, you can allow outbound traffic only to the specific ports |
WindowsGuide-143 | WindowsGuide.pdf | 143 | VPC associated with your Amazon FSx file system are defined in an Active Directory site and that no IP conflicts exist between the subnets in your VPC and the subnets in your other sites. You can view and change these settings using the Active Directory Sites and Services MMC snap-in. 2. Verify that you configured the VPC security groups that you associated with your Amazon FSx file system, along with any VPC network ACLs, to allow outbound network traffic on all ports. Note If you want to implement least privilege, you can allow outbound traffic only to the specific ports required for communication with the Active Directory domain controllers. For more information, see the Microsoft Active Directory documentation. DNS servers or domain controllers unreachable 364 Amazon FSx for Windows File Server Windows User Guide 3. Verify that the values for Microsoft Windows file server or network administrative properties do not contain non-Latin-1 characters. For example, the file system creation fails if you use Domänen-Admins as the name of the file system administrators group. 4. Verify that your Active Directory domain's DNS servers and domain controllers are active and able to respond to requests for the domain provided. 5. Ensure that the functional level of your Active Directory domain is Windows Server 2008 R2 or higher. 6. Make sure that the firewall rules on your Active Directory domain's domain controllers allow traffic from your Amazon FSx file system. For more information, see the Microsoft Active Directory documentation. Invalid service account credentials Creating a file system joined to a self-managed Active Directory fails with the following error message: Amazon FSx is unable to establish a connection with your Microsoft Active Directory domain controllers because the service account credentials provided are invalid. To fix this problem, delete your file system and create a new one using a valid service account. Use the following steps to troubleshoot and resolve the issue. 1. Verify that you're entering only the user name as input for the Service account username, such as ServiceAcct, in the self-managed Active Directory configuration. Important DO NOT include a domain prefix (corp.com\ServiceAcct) or domain suffix ([email protected]) when entering the service account user name. DO NOT use the distinguished name (DN) when entering the service account user name (CN=ServiceAcct,OU=example,DC=corp,DC=com). 2. Verify that the service account that you provided exists in your Active Directory domain. 3. Make sure that you delegated the required permissions to the service account that you provided. The service account must be able to create and delete computer objects in the OU Invalid service account credentials 365 Amazon FSx for Windows File Server Windows User Guide in the domain to which you're joining the file system. The service account also needs, at a minimum, to have permissions to do the following: • Reset passwords • Restrict accounts from reading and writing data • Validated ability to write to the DNS hostname • Validated ability to write to the service principal name For more information about creating a service account with correct permissions, see Amazon FSx service account. Insufficient service account permissions Creating a file system joined to your self-managed Active Directory fails with the following error message: Amazon FSx is unable to establish a connection with your Microsoft Active Directory domain controllers. This is because the service account provided does not have permission to join the file system to the domain with the specified organizational unit. To fix this problem, delete your file system and create a new one using a service account with permission to join the file system to the domain with the specified organizational unit. Use the following procedure to troubleshoot and resolve the issue. • Make sure that you delegated the required permissions to the service account that you provided. The service account must be able to create and delete computer objects in the OU in the domain to which you're joining the file system. The service account also needs, at a minimum, to have permissions to do the following: • Reset passwords • Restrict accounts from reading and writing data • Validated ability to write to the DNS hostname • Validated ability to write to the service principal name Insufficient service account permissions 366 Amazon FSx for Windows File Server Windows User Guide For more information about creating a service account with correct permissions, see Amazon FSx service account. Service account capacity exceeded Creating a file system joined to your self-managed Active Directory fails with the following error message: Amazon FSx can't establish a connection with your Microsoft Active Directory domain controllers. This is because the service account provided has reached the maximum number of computers that it can join to the domain. To fix this problem, delete your file system and create a new one, supplying a service account that is able to join |
WindowsGuide-144 | WindowsGuide.pdf | 144 | FSx for Windows File Server Windows User Guide For more information about creating a service account with correct permissions, see Amazon FSx service account. Service account capacity exceeded Creating a file system joined to your self-managed Active Directory fails with the following error message: Amazon FSx can't establish a connection with your Microsoft Active Directory domain controllers. This is because the service account provided has reached the maximum number of computers that it can join to the domain. To fix this problem, delete your file system and create a new one, supplying a service account that is able to join new computers to the domain. To resolve the issue, verify that the service account you provided has reached the maximum number of computers it can join to the domain. If it has reached the maximum limit, create a new service account with the correct permissions. Use the new service account and create a new file system. For more information, see Amazon FSx service account. Amazon FSx can't access the organizational unit (OU) Creating a file system joined to your self-managed Active Directory fails with the following error message: Amazon FSx can't establish a connection with your Microsoft Active Directory domain controller(s). This is because the organizational unit you specified either doesn't exist or isn't accessible to the service account provided. To fix this problem, delete your file system and create a new one specifying an organizational unit to which the service account can join the file system. Use the following steps to troubleshoot and resolve the issue. 1. Verify that the OU you provided is in your Active Directory domain. 2. Make sure that you have delegated the required permissions to the service account that you provided. The service account must be able to create and delete computer objects in the OU in Service account capacity exceeded 367 Amazon FSx for Windows File Server Windows User Guide the domain that you're joining the file system to. The service account also needs to have, at a minimum, permissions to do the following: • Reset passwords • Restrict accounts from reading and writing data • Validated ability to write to the DNS hostname • Validated ability to write to the service principal name • Be delegated control to create and delete computer objects • Validated ability to read and write Account Restrictions For more information about creating a service account with the correct permissions, see Amazon FSx service account. Service account can't access the administrators group Creating a file system joined to your self-managed Active Directory fails with the following error message: Amazon FSx is unable to apply your Microsoft Active Directory configuration. This is because the file system administrators group you provided either doesn't exist or isn't accessible to the service account you provided. To fix this problem, delete your file system and create a new one specifying a file system administrators group in the domain that is accessible to the service account provided. Use the following steps to troubleshoot and resolve the issue. 1. Ensure that you’re providing just the name of the group as a string for the administrators group parameter. Important DO NOT include a domain prefix (corp.com\FSxAdmins) or domain suffix ([email protected]) when providing the group name parameter. Bad file system admin group 368 Amazon FSx for Windows File Server Windows User Guide DO NOT use the distinguished name (DN) for the group. An example of a distinguished name is CN=FSxAdmins,OU=example,DC=corp,DC=com. 2. Ensure that the administrators group provided exists in the same Active Directory domain as the one that you want to join the file system to. 3. If you did not provide an administrator group parameter, Amazon FSx attempts to use the Builtin Domain Admins group in your Active Directory domain. If the name of this group has been changed, or if you’re using a different group for domain administration, you need to provide that name for the group. Amazon FSx lost connectivity in domain Creating a file system joined to your self-managed Active Directory fails with the following error message: Amazon FSx is unable to apply your Microsoft Active Directory configuration. To fix this problem, delete your file system and create a new one meeting the pre-requisites described in the Amazon FSx user guide. When creating your file system, Amazon FSx was able to reach your Active Directory domain’s DNS servers and domain controllers, and join the file system successfully to your Active Directory domain. However, while completing file system creation, Amazon FSx lost connectivity to or membership in your domain. Use the following steps to troubleshoot and resolve the issue. 1. Ensure that network connectivity continues to exist between your Amazon FSx file system and your Active Directory. And, ensure that network traffic continues to be allowed between them by using routing rules, VPC security |
WindowsGuide-145 | WindowsGuide.pdf | 145 | pre-requisites described in the Amazon FSx user guide. When creating your file system, Amazon FSx was able to reach your Active Directory domain’s DNS servers and domain controllers, and join the file system successfully to your Active Directory domain. However, while completing file system creation, Amazon FSx lost connectivity to or membership in your domain. Use the following steps to troubleshoot and resolve the issue. 1. Ensure that network connectivity continues to exist between your Amazon FSx file system and your Active Directory. And, ensure that network traffic continues to be allowed between them by using routing rules, VPC security group rules, VPC network ACLs, and domain controller firewall rules. 2. Ensure that the computer objects created by Amazon FSx for your file systems in your Active Directory domain are still active, and were not deleted or otherwise manipulated. Service account does not have correct permissions Creating a file system joined to your self-managed Active Directory fails with the following error message: Amazon FSx lost connectivity in domain 369 Amazon FSx for Windows File Server Windows User Guide File system creation failed. Amazon FSx is unable to establish a connection with your Microsoft Active Directory domain controller(s). This is because the service account provided does not have permission to join the file system to the domain with the specified organizational unit (OU). To fix this problem, delete your file system and create a new one using a service account with permission to create computer objects and reset passwords within the specified organizational unit. Make sure that you have delegated the required permissions to the service account that you provided. Use the following steps to troubleshoot and resolve the issue. The service account needs to have, at a minimum, the following permissions: • Be delegated control to create and delete computer objects in the OU that you’re joining the file system to • Have the following permissions in the OU that you’re joining the file system to: • Ability to reset passwords • Ability to restrict accounts from reading and writing data • Validated ability to write to the DNS hostname • Validated ability to write to the service principal name • Ability (can be delegated) to create and delete computer objects • Validated ability to read and write Account Restrictions • Ability to modify permissions For more information about creating a service account with the correct permissions, see Amazon FSx service account. Unicode characters used in creation parameters Creating a file system joined to your self-managed Active Directory fails with the following error message: File system creation failed. Amazon FSx is unable to create a file system within the specified Microsoft Active Directory. To fix this problem, please delete your file system and create a new one Unicode characters used in creation parameters 370 Amazon FSx for Windows File Server Windows User Guide meeting the pre-requisites described in the FSx for ONTAP User Guide. Amazon FSx does not support Unicode characters. Verify that none of the creation parameters have Unicode characters, such as accent marks. This includes parameters that can be left blank where a default value is filled in automatically. Ensure the corresponding default values in your Active Directory also do not contain Unicode characters. Switching storage type to HDD while restoring a backup fails Creating a file system from a backup fails with the following error message: Switching storage type to HDD while creating a file system from backup backup_id is not supported because a storage scaling activity was still under way on the source file system to increase storage capacity from less than 2000 GiB when the backup backup_id was taken, and the minimum storage capacity for HDD storage is 2000 GiB. This issue occurs when restoring a backup and you have changed the storage type from SSD to HDD. The restore from backup fails because the backup that you are restoring was taken while a storage capacity increase was still in progress on the original file system. The file system's SSD storage capacity before the increase request was less than 2000 GiB, which is the minimum storage capacity required to create an HDD file system. Use the following procedure to resolve this issue. 1. Wait for the storage capacity increase request to complete and the file system has at least 2000 GiB of SSD storage capacity. For more information, see Monitoring storage capacity increases. 2. Take a user-initiated backup of the file system. For more information, see Working with user- initiated backups. 3. Restore the user-initiated backup to a new file system using HDD storage. For more information, see Restoring backups to new file system. File system is in a misconfigured state An FSx for Windows File Server file system can get into a Misconfigured state due to a change in your Active Directory environment. In |
WindowsGuide-146 | WindowsGuide.pdf | 146 | the storage capacity increase request to complete and the file system has at least 2000 GiB of SSD storage capacity. For more information, see Monitoring storage capacity increases. 2. Take a user-initiated backup of the file system. For more information, see Working with user- initiated backups. 3. Restore the user-initiated backup to a new file system using HDD storage. For more information, see Restoring backups to new file system. File system is in a misconfigured state An FSx for Windows File Server file system can get into a Misconfigured state due to a change in your Active Directory environment. In this state, your file system is either currently unavailable or at risk of losing availability, and backups may not succeed. Switching storage type to HDD while restoring a backup fails 371 Amazon FSx for Windows File Server Windows User Guide The Misconfigured state includes an error message and recommended corrective action that you can access using the Amazon FSx console, API, or AWS CLI. After taking the corrective action, verify that your file system's state eventually changes to Available – note that this change can take several minutes to complete. Your file system can get into a Misconfigured state for several reasons, such as the following: • The DNS Server IP addresses are no longer valid. • The service account credentials are no longer valid, or lack required permissions. • The Active Directory domain controller is not reachable due to network connectivity issues, such as invalid VPC Security Groups, VPC Network ACL or routing table configuration, or domain controller firewall settings. Important Do not move computer objects that Amazon FSx creates in the OU after your file system is created. Doing so will cause your file system to become misconfigured. (For the full list of Active Directory requirements, see Prerequisites. You can also validate that your Active Directory environment is properly configured to meet these requirements by using the Amazon FSx Active Directory Validation tool.) Resolving some of these issues requires directly updating one or more parameters in your file system’s Active Directory configuration, such as changing DNS Server IP addresses, or changing the service account username or password. In these cases, your corrective action will necessarily involve using the Amazon FSx console, API, or AWS CLI to update the required configuration parameters. Other issues may not require changing any Active Directory configuration parameters, such as changing your domain controller firewall settings or VPC Security Groups. In these cases, however, you will need to take further action before the file system can become Available. After ensuring your Active Directory environment is configured properly, select the Attempt Recovery button next to the Misconfigured status in the Amazon FSx console, or use the StartMisconfiguredStateRecovery command in the Amazon FSx console, API, or AWS CLI. Topics • Misconfigured file system: Amazon FSx can't reach either the DNS servers or domain controllers for your domain. File system is in a misconfigured state 372 Amazon FSx for Windows File Server Windows User Guide • Misconfigured file system: The service account credentials are invalid • Misconfigured file system: The service account provided doesn't have permission to join the file system to the domain • Misconfigured file system: The service account can't join any more computers to domain • Misconfigured file system: The service account doesn't have access to the OU Misconfigured file system: Amazon FSx can't reach either the DNS servers or domain controllers for your domain. A file system will go into a Misconfigured state when Amazon FSx can't communicate with your Microsoft Active Directory domain controller or controllers. To resolve this situation, do the following: 1. Make sure that your networking configuration allows traffic from the file system to the domain controller. 2. Use the Amazon FSx Active Directory Validation tool to test and verify the network settings for your self-managed Active Directory. For more information, see Using a self-managed Microsoft Active Directory. 3. Review the file system's self-managed Active Directory configuration in the Amazon FSx console. 4. To update the file system's self-managed Active Directory configuration, you can use the Amazon FSx console. a. On the navigation pane, choose File systems, and choose the file system to update; the File system details page appears. b. On File system details page, choose Update on the Networking and security tab. You can also use the Amazon FSx CLI update-file-system command or the API operation UpdateFileSystem. Misconfigured file system: Amazon FSx can't reach either the DNS servers or domain controllers for your domain. 373 Amazon FSx for Windows File Server Windows User Guide Misconfigured file system: The service account credentials are invalid Amazon FSx can't establish a connection with your Microsoft Active Directory domain controller or controllers. This is because the service account credentials provided are invalid. For more information, see Using a self-managed Microsoft Active |
WindowsGuide-147 | WindowsGuide.pdf | 147 | appears. b. On File system details page, choose Update on the Networking and security tab. You can also use the Amazon FSx CLI update-file-system command or the API operation UpdateFileSystem. Misconfigured file system: Amazon FSx can't reach either the DNS servers or domain controllers for your domain. 373 Amazon FSx for Windows File Server Windows User Guide Misconfigured file system: The service account credentials are invalid Amazon FSx can't establish a connection with your Microsoft Active Directory domain controller or controllers. This is because the service account credentials provided are invalid. For more information, see Using a self-managed Microsoft Active Directory. To resolve the misconfiguration, do the following: 1. Verify that you are using the correct service account, and you are using the correct credentials for that account. 2. Then update the file system's configuration with the correct service account or account credentials using the Amazon FSx console. a. On the navigation pane, choose File systems, and choose the misconfigured file system to update. b. On the File system details page, choose Update in the Networking and security tab. You can also use the Amazon FSx API operation update-file-system. To learn more, see the UpdateFileSystem in the Amazon FSx API Reference. Misconfigured file system: The service account provided doesn't have permission to join the file system to the domain Amazon FSx can't establish a connection to your Microsoft Active Directory domain controllers. This is because the service account provided doesn't have permission to join the file system to the domain with the specified OU. To resolve the misconfiguration, do the following: 1. Add the required permissions to the Amazon FSx service account, or create a new service account with the required permissions. For more information about doing this, see Amazon FSx service account. 2. Then update the file system's self-managed Active Directory configuration with the new service account credentials. To update the configuration, you can use the Amazon FSx console. a. On the navigation pane, choose File systems, and choose the file system to update; the File system details page appears. Misconfigured file system: The service account credentials are invalid 374 Amazon FSx for Windows File Server Windows User Guide b. On File system details page, choose Update on the Networking and security tab. You can also use the Amazon FSx API operation update-file-system. To learn more, see the UpdateFileSystem in the Amazon FSx API Reference. Misconfigured file system: The service account can't join any more computers to domain Amazon FSx can't establish a connection to your Microsoft Active Directory domain controllers. In this case, this is because the service account provided has reached the maximum number of computers that it can join to the domain. To resolve the misconfiguration, do the following: 1. Identify another service account or create a new service account that can join new computers to the domain. 2. Then update the file system's self-managed Active Directory configuration with the new service account credentials using the Amazon FSx console. a. On the navigation pane, choose File systems, and choose the file system to update; the File system details page appears. b. On File system details page, choose Update on the Networking and security tab. You can also use the Amazon FSx API operation update-file-system. To learn more, see the UpdateFileSystem in the Amazon FSx API Reference. Misconfigured file system: The service account doesn't have access to the OU Amazon FSx can't establish a connection to your Microsoft Active Directory domain controllers because the service account provided doesn't have access to the OU specified. To resolve the misconfiguration, do the following: 1. Identify another service account or create a new service account that has access to the OU. Misconfigured file system: The service account can't join any more computers to domain 375 Amazon FSx for Windows File Server Windows User Guide 2. Then update the file system's self-managed Active Directory configuration with the new service account credentials. a. On the navigation pane, choose File systems, and choose the file system to update; the File system details page appears. b. On File system details page, choose Update on the Networking and security tab. You can also use the Amazon FSx API operation update-file-system. To learn more, see the UpdateFileSystem in the Amazon FSx API Reference. You can't configure DFS-R on a Multi-AZ or Single-AZ 2 file system Microsoft Distributed File System Replication (DFS-R) is not supported on Multi-AZ and Single-AZ 2 file systems. Multi-AZ file systems are configured for redundancy across multiple access zones natively. Use the Multi-AZ deployment type for high availability across multiple Availability Zones. For more information, see Availability and durability: Single-AZ and Multi-AZ file systems. Storage or throughput capacity updates fail There are a number of potential causes for file system storage and throughput capacity update requests to fail, each with their own resolution. |
WindowsGuide-148 | WindowsGuide.pdf | 148 | UpdateFileSystem in the Amazon FSx API Reference. You can't configure DFS-R on a Multi-AZ or Single-AZ 2 file system Microsoft Distributed File System Replication (DFS-R) is not supported on Multi-AZ and Single-AZ 2 file systems. Multi-AZ file systems are configured for redundancy across multiple access zones natively. Use the Multi-AZ deployment type for high availability across multiple Availability Zones. For more information, see Availability and durability: Single-AZ and Multi-AZ file systems. Storage or throughput capacity updates fail There are a number of potential causes for file system storage and throughput capacity update requests to fail, each with their own resolution. Storage capacity increase fails because Amazon FSx can't access the file system's AWS KMS key A storage capacity increase request failed because Amazon FSx was unable to access the KMS key used to encrypt file system. You need to ensure that Amazon FSx has access to the KMS key used to encrypt the file system in order to run the administrative action. Use the following information to resolve the key access issue. You can't configure DFS-R on a Multi-AZ or Single-AZ 2 file system 376 Amazon FSx for Windows File Server Windows User Guide • If the KMS key has been deleted, the file system and any of its backups using the deleted KMS key are unrecoverable. For more information, see Deleting AWS KMS keys in the AWS Key Management Service Developer Guide. • If the KMS key is disabled, and it is a customer managed key, you will need to re-enable it, and then retry the storage capacity increase request. For more information, see Enabling and disabling keys in the AWS Key Management Service Developer Guide. • If the key is invalid because of its pending deletion, you must cancel the key deletion while it is still in a PendingDeletion state. You can retry the request once the KMS key is Enabled. • If the key is invalid because of its pending import, you must wait until the import has completed, and then retry the storage increase request. • If the key's grant limit has been exceeded, you must request an increase in the number of grants for the key. For more information, see Resource quotas in the AWS Key Management Service Developer Guide. When the quota increase is granted, retry the storage increase request. Storage or throughput capacity update fails because the self-managed Active Directory is misconfigured The storage capacity or throughput capacity update request failed because your file system's self- managed Active Directory is in a misconfigured state. To resolve the specific misconfigured state, see File system is in a misconfigured state. Storage capacity increase fails because of insufficient throughput capacity The storage capacity increase request failed because the file system's throughput capacity is set to 8 MBps. Increase the file system's throughput capacity to a minimum of 16 MBps, then retry the request. For more information, see Managing throughput capacity. Throughput capacity update to 8 MBps fails A request to modify a file system's throughput capacity to 8 MBps failed. Storage or throughput capacity update fails because the self-managed Active Directory is misconfigured 377 Amazon FSx for Windows File Server Windows User Guide This can occur when a storage capacity increase request is pending or in progress. Storage capacity increases require a minimum throughput of 16 MBps. Wait until the storage capacity increase request has completed, and then retry the throughput capacity modification request. Throughput capacity update to 8 MBps fails 378 Amazon FSx for Windows File Server Windows User Guide Document history • API version: 2018-03-01 • Latest documentation update: February 25th, 2025 The following table describes important changes to the Amazon FSx Windows User Guide. For notifications about documentation updates, you can subscribe to the RSS feed. Change Description Date Amazon FSx updated the AmazonFSxConsoleRe Amazon FSx updated the AmazonFSxConsoleRe adOnlyAccess AWS managed adOnlyAccess policy to add February 25, 2025 policy the ec2:DescribeNetwor kInterfaces permissio n. For more information, see the AmazonFSxConsoleRe adOnlyAccess policy. Support added for dual-stac k VPC interface endpoints for You can now create dual-stac k VPC interface endpoints February 7, 2025 Amazon FSx Support added for dual-stack API endpoints for Amazon FSx with both IPv4 and IPv6 IP addresses and DNS names. For more information, see FSx for Windows File Server and interface VPC endpoints. The Amazon FSx service API for creating and managing file systems have new dual-stack endpoints. For more informati on, see API endpoints in the Amazon FSx API Reference. February 7, 2025 379 Amazon FSx for Windows File Server Windows User Guide Amazon FSx updated the AmazonFSxConsoleFullAccess Amazon FSx updated the AmazonFSxConsoleFullAccess February 7, 2025 AWS managed policy policy to add the ec2:Descr ibeNetworkInterfac es permission. For more information, see AmazonFSx ConsoleFullAccess policy. Updated version of the FSx for Windows File Server An updated version of |
WindowsGuide-149 | WindowsGuide.pdf | 149 | DNS names. For more information, see FSx for Windows File Server and interface VPC endpoints. The Amazon FSx service API for creating and managing file systems have new dual-stack endpoints. For more informati on, see API endpoints in the Amazon FSx API Reference. February 7, 2025 379 Amazon FSx for Windows File Server Windows User Guide Amazon FSx updated the AmazonFSxConsoleFullAccess Amazon FSx updated the AmazonFSxConsoleFullAccess February 7, 2025 AWS managed policy policy to add the ec2:Descr ibeNetworkInterfac es permission. For more information, see AmazonFSx ConsoleFullAccess policy. Updated version of the FSx for Windows File Server An updated version of the FSx for Windows File Server Active Directory Validation Active Directory Validation November 6, 2024 tool tool is available. For more information, see Validatin g your Active Directory configuration Support added for higher levels of IOPS on file systems FSx for Windows File Server is increasing maximum with throughput capacities of IOPS from 130K to 150K 4 GBps and higher for file systems with 4 GBps January 17, 2024 of throughput capacity or higher, from 175K to 200K for file systems with 6 GBps of throughput capacity or higher, from 260K to 300K for file systems with 9 GBps of throughput capacity or higher, and from 350K to 400K for file systems with 12 GBps of throughput capacity or higher. For more informati on, see FSx for Windows File Server performance. 380 Amazon FSx for Windows File Server Windows User Guide January 9, 2024 Amazon FSx updated the AmazonFSxFullAccess, Amazon FSx updated the AmazonFSxFullAccess, AmazonFSxConsoleFu AmazonFSxConsoleFu llAccess, AmazonFSx llAccess, AmazonFSx ReadOnlyAccess, AmazonFSx ReadOnlyAccess, AmazonFSx ConsoleReadOnlyAccess, and ConsoleReadOnlyAccess, AmazonFSxServiceRolePolicy and AmazonFSxServiceRo AWS managed policies lePolicy policies to add the ec2:GetSecurityGro upsForVpc permission. For more information, see Amazon FSx updates to AWS managed policies. Amazon FSx updated the AmazonFSxFullAccess and the Amazon FSx updated the AmazonFSxFullAccess and AmazonFSxConsoleFullAccess AmazonFSxConsoleFu AWS managed policies llAccess policies to add the December 20, 2023 ManageCrossAccount DataReplication For more information, see action. Amazon FSx updates to AWS managed policies. Amazon FSx updated the AmazonFSxFullAccess and the Amazon FSx updated the AmazonFSxFullAccess and AmazonFSxConsoleFullAccess AmazonFSxConsoleFu AWS managed policies llAccess policies to add the November 26, 2023 fsx:CopySnapshotAn dUpdateVolume n. For more information, see permissio Amazon FSx updates to AWS managed policies. 381 Amazon FSx for Windows File Server Windows User Guide Amazon FSx updated the AmazonFSxFullAccess and the Amazon FSx updated the AmazonFSxFullAccess and AmazonFSxConsoleFullAccess AmazonFSxConsoleFu AWS managed policies llAccess policies to add the November 14, 2023 fsx:DescribeShared VPCConfiguration and fsx:UpdateSharedVP CConfiguration permissions. For more information, see Amazon FSx updates to AWS managed policies. Support added for updating file system storage type FSx for Windows File Server file systems now support August 9, 2023 Support added for higher maximum throughput capacity Support added for SSD IOPS provisioning updating from HDD storage type to SSD storage type. For more information, see Managing storage type. FSx for Windows File Server file systems now support up to 12 GBps throughput capacity. For more informati on, see FSx for Windows File Server performance. FSx for Windows File Server file systems now support SSD IOPS provisioning independe ntly of storage capacity, up to a maximum of 350,000 IOPS. For more information, see Managing SSD IOPS. August 9, 2023 August 9, 2023 382 Amazon FSx for Windows File Server Windows User Guide Amazon FSx updated the AmazonFSxServiceRolePolicy AWS managed policy Amazon FSx updated the July 24, 2023 cloudwatch:PutMetr icData permission in the AmazonFSxServiceRolePolicy. For more information, see AmazonFSxServiceRolePolicy. Amazon FSx updated the AmazonFSxFullAccess AWS Amazon FSx updated the AmazonFSxFullAccess July 13, 2023 managed policy policy to remove the fsx:* permission and add specific fsx actions. For more information, see AmazonFSx FullAccess policy. Amazon FSx updated the AmazonFSxConsoleFullAccess Amazon FSx updated the AmazonFSxConsoleFu July 13, 2023 AWS managed policy llAccess policy to remove the fsx:* permission and add specific fsx actions. For more information, see AmazonFSx ConsoleFullAccess policy. Support added for new CloudWatch metrics for FSx for Windows File Server now provides additional Amazon FSx for Windows File CloudWatch metrics that September 22, 2022 Server monitor file server and storage volume performance and capacity usage. For more information, see Metrics and dimensions. 383 Amazon FSx for Windows File Server Windows User Guide Support added for file system performance warnings September 22, 2022 Amazon FSx now provides warnings in the Performance & monitoring window when any of a set of CloudWatc h metrics approach or cross predetermined threshold s for these metrics. Each warning also provides an actionable recommendation for improving the file system's performance. For more information, see Performan ce warnings and recommend ations. Support added for enhanced file system performance The Amazon FSx console file system monitoring dashboard September 22, 2022 monitoring Support added for AWS PrivateLink interface VPC endpoints. for FSx for Windows File Server file systems includes new Summary, Storage, and Performance |
WindowsGuide-150 | WindowsGuide.pdf | 150 | file system performance warnings September 22, 2022 Amazon FSx now provides warnings in the Performance & monitoring window when any of a set of CloudWatc h metrics approach or cross predetermined threshold s for these metrics. Each warning also provides an actionable recommendation for improving the file system's performance. For more information, see Performan ce warnings and recommend ations. Support added for enhanced file system performance The Amazon FSx console file system monitoring dashboard September 22, 2022 monitoring Support added for AWS PrivateLink interface VPC endpoints. for FSx for Windows File Server file systems includes new Summary, Storage, and Performance sections. These sections display graphs of new CloudWatch metrics that provide you with enhanced performance monitoring. For more information, see Monitoring metrics with CloudWatch. You can now use interface VPC endpoints to access the Amazon FSx API from your VPC without sending traffic over the internet. For more information, see Amazon FSx and interface VPC endpoints. April 5, 2022 384 Amazon FSx for Windows File Server Windows User Guide Support added for Amazon Kendra You can now use your FSx for Windows File Server file March 26, 2022 system as a data source for Amazon Kendra, allowing you to index and search for information contained in documents stored on your file system. For more information, see Using FSx for Windows File Server with Amazon Kendra. Support added for file access auditing You can now enable auditing of end-user accesses on files, June 8, 2021 folders,and file shares. You can choose to send audit event logs to the Amazon CloudWatch Logs or Amazon Data Firehose services. For more information, see File access auditing. Support added for copying backups You can now use Amazon FSx to copy backups within April 12, 2021 the same AWS account to another AWS Region (cross- Region copies) or within the same AWS Region (in-Region copies). For more information, see Copying backups. 385 Amazon FSx for Windows File Server Windows User Guide Automatically increase a file system's storage capacity Use an AWS-developed customizable AWS CloudForm February 17, 2021 Support added for client access using non-private IP addresses December 17, 2020 ation template to automatic ally increase your file system's stoage capacity when its capacity reaches a threshold that you specify. For more information, see Increasing storage capacity dynamically. You can access FSx for Windows File Server file systems with on-premis es clients using non-priva te IP addresses. For more information, see Supported environments. You can join FSx for Windows File Server file system to a self-managed Microsoft Active Directory with DNS servers and AD domain controllers that use non-private IP addresses. For more information, see Using Amazon FSx with Your Self- Managed Microsoft Active Directory. 386 Amazon FSx for Windows File Server Windows User Guide Support added for using DNS aliases You can now associate DNS aliases with your FSx for November 9, 2020 Windows File Server file systems that you can use to access the data on your file system. For more informati on, see Managing DNS aliases and Walkthrough 5: Using DNS aliases to access your file system. Support added for Amazon Elastic Container Service You can now use FSx for Windows File Server with November 9, 2020 Amazon ECS. For more information, see Supported Clients. Amazon FSx is now integrated with AWS Backup You can now use AWS Backup to back up and restore your November 9, 2020 FSx file systems in addition to using native Amazon FSx backups. For more informati on, see Using AWS Backup with Amazon FSx. Support added for throughpu t capacity scaling You can now modify the throughput capacity for June 1, 2020 existing FSx for Windows File Server file systems as your throughput requirements evolve. For more informati on, see Managing Throughput Capacity. 387 Amazon FSx for Windows File Server Windows User Guide Support added for storage capacity scaling You can now increase the storage capacity for existing June 1, 2020 FSx for Windows File Server file systems as your storage requirements evolve. For more information, see Managing Storage Capacity. Support added for hard disk drive (HDD) storage HDD storage gives you price and performance March 26, 2020 flexibility when using FSx for Windows File Server. For more information, see Optimizing Costs with Amazon FSx. Support added for file transfer using AWS DataSync You can now use AWS DataSync to transfer files February 4, 2020 to and from your FSx for Windows File Server. For more information, see Migrate Files to Amazon FSx for Windows File Server Using AWS DataSync. FSx for Windows File Server releases support for additiona You can now manage and administer file shares, data l Windows file system deduplication, storage quotas, November 20, 2019 administration tasks and encryption in transit for your file shares using the Amazon FSx CLI for remote management on PowerShel |
WindowsGuide-151 | WindowsGuide.pdf | 151 | information, see Optimizing Costs with Amazon FSx. Support added for file transfer using AWS DataSync You can now use AWS DataSync to transfer files February 4, 2020 to and from your FSx for Windows File Server. For more information, see Migrate Files to Amazon FSx for Windows File Server Using AWS DataSync. FSx for Windows File Server releases support for additiona You can now manage and administer file shares, data l Windows file system deduplication, storage quotas, November 20, 2019 administration tasks and encryption in transit for your file shares using the Amazon FSx CLI for remote management on PowerShel l. For more information, see Administering File Systems. 388 Amazon FSx for Windows File Server Windows User Guide FSx for Windows File Server releases native Multi-AZ You can use Multi-AZ deployment for FSx for November 20, 2019 support Windows File Server to more easily create file systems with high availability that span multiple Availability Zones (AZs). For more information, see Availability and Durabilit y: Single-AZ and Multi-AZ File Systems. FSx for Windows File Server releases support for You can now use the Shared Folders tool native to managing user sessions and Microsoft Windows to October 17, 2019 open files manage user sessions and open files on your FSx for Windows File Server file systems. For more informati on, see Managing User Sessions and Open Files. Amazon FSx releases support for Microsoft Windows You can now configure Windows shadow copies on July 31, 2019 shadow copies your FSx for Windows File Server file systems. Shadow copies enable your users to easily undo file changes and compare file versions by restoring files to previous versions. For more informati on, see Working with Shadow Copies. 389 Amazon FSx for Windows File Server Windows User Guide Amazon FSx releases shared Microsoft Active Directory You can now join FSx for Windows File Server file June 25, 2019 support systems to AWS Managed Microsoft AD directories that are in a different VPC or in a different AWS account than the file system. For more information, see Active Directory Support. Amazon FSx releases enhanced Microsoft Active You can now join FSx for Windows File Server file Directory support systems to your self-mana June 24, 2019 ged Microsoft Active Directory domains, either on-premis es or in the cloud. For more information, see Active Directory Support. Amazon FSx complies with SOC certification Amazon FSx has been assessed to comply with May 16, 2019 Added clarifying note regarding AWS Direct Connect, VPN, and inter-reg ion VPC peering connection support SOC certification. For more information, see Security and Data Protection. Amazon FSx file systems created after February 22, 2019 are accessible using AWS Direct Connect, VPN, and inter-region VPC peering. For more information, see Supported Access Methods. February 25, 2019 390 Amazon FSx for Windows File Server Windows User Guide AWS Direct Connect, VPN, and inter-region VPC peering You can now access Amazon FSx for Windows File Server connection support added file systems from on-premises February 22, 2019 resources and from resources in a different Amazon VPC or AWS account. For more information, see Supported Access Methods. Amazon FSx is now generally available Amazon FSx for Windows File Server provides Microsoft November 28, 2018 Windows file servers that are fully managed, backed by a fully native Windows file system. Amazon FSx for Windows File Server provides the features, performance, and compatibility to easily lift and shift enterprise applicati ons to AWS. 391 |
workdocs-ag-001 | workdocs-ag.pdf | 1 | Administration Guide Amazon WorkDocs Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon WorkDocs Administration Guide Amazon WorkDocs: Administration Guide Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon WorkDocs Table of Contents Administration Guide ......................................................................................................................................................... vi What is Amazon WorkDocs? ........................................................................................................... 1 Accessing Amazon WorkDocs ..................................................................................................................... 1 Pricing ............................................................................................................................................................. 2 How to get started ...................................................................................................................................... 2 Migrating data out of WorkDocs .................................................................................................... 3 Method 1: Downloading files in bulk ....................................................................................................... 3 Downloading files from the web ......................................................................................................... 3 Downloading folders from the web .................................................................................................... 5 Using WorkDocs Drive to download files and folders ..................................................................... 5 Method 2: Use the migration tool ............................................................................................................ 6 Prerequisites ............................................................................................................................................. 6 Limitations ................................................................................................................................................ 9 Running the migration tool ................................................................................................................ 10 Downloading migrated data from Amazon S3 ............................................................................... 14 Troubleshooting migrations ................................................................................................................ 15 Viewing your migration history ......................................................................................................... 15 Prerequisites .................................................................................................................................. 17 Sign up for an AWS account ................................................................................................................... 17 Create a user with administrative access .............................................................................................. 17 Security .......................................................................................................................................... 19 Identity and access management ........................................................................................................... 20 Audience .................................................................................................................................................. 20 Authenticating with identities ............................................................................................................ 21 Managing access using policies .......................................................................................................... 23 How Amazon WorkDocs works with IAM ......................................................................................... 26 Identity-based policy examples ......................................................................................................... 29 Troubleshooting .................................................................................................................................... 33 Logging and monitoring ........................................................................................................................... 35 Exporting the site-wide activity feed ............................................................................................... 35 CloudTrail logging ................................................................................................................................. 36 Compliance validation ............................................................................................................................... 39 Resilience ...................................................................................................................................................... 40 Infrastructure security ............................................................................................................................... 41 iii Amazon WorkDocs Administration Guide Getting started .............................................................................................................................. 42 Creating an Amazon WorkDocs site ....................................................................................................... 43 Before you begin .................................................................................................................................. 43 Creating an Amazon WorkDocs site .................................................................................................. 43 Enabling single sign-on ............................................................................................................................ 45 Enabling multi-factor authentication .................................................................................................... 46 Promoting a user to administrator ........................................................................................................ 46 Managing Amazon WorkDocs from the AWS console ................................................................. 48 Setting site administrators ....................................................................................................................... 48 Resending invitation emails ..................................................................................................................... 48 Managing multifactor authentication .................................................................................................... 49 Setting site URLs ........................................................................................................................................ 49 Managing notifications ............................................................................................................................. 50 Deleting a site ............................................................................................................................................. 51 Managing Amazon WorkDocs from the site admin control panel .............................................. 53 Deploying Amazon WorkDocs Drive to multiple computers ....................................................... 60 Inviting and managing users ........................................................................................................ 61 User roles ..................................................................................................................................................... 61 Starting the admin control panel ........................................................................................................... 63 Turning off Auto activation ...................................................................................................................... 63 Managing link sharing ............................................................................................................................... 64 Controlling user invitations with Auto activation enabled ................................................................ 65 Inviting new users ...................................................................................................................................... 66 Editing users ................................................................................................................................................ 66 Disabling users ............................................................................................................................................ 67 Deleting pending users ........................................................................................................................ 68 Transferring document ownership .......................................................................................................... 68 Downloading user lists .............................................................................................................................. 69 Sharing and collaboration ............................................................................................................ 71 Sharing links ................................................................................................................................................ 71 Sharing by invite ........................................................................................................................................ 72 External sharing .......................................................................................................................................... 72 Permissions .................................................................................................................................................. 73 User roles ................................................................................................................................................ 73 Permissions for shared folders .......................................................................................................... 74 Permissions for files in shared folders ............................................................................................. 75 iv Amazon WorkDocs Administration Guide Permissions for files not in shared folders ...................................................................................... 77 Enabling collaborative editing ................................................................................................................. 78 Enabling Hancom ThinkFree ............................................................................................................... 78 Enabling Open with Office Online .................................................................................................... 79 Migrating files ................................................................................................................................ 81 Step 1: Preparing content for migration .............................................................................................. 82 Step 2: Uploading files to Amazon S3 .................................................................................................. 83 Step 3: Scheduling a migration .............................................................................................................. 83 Step 4: Tracking a migration ................................................................................................................... 85 Step 5: Cleaning up resources ................................................................................................................. 86 Troubleshooting ............................................................................................................................. 87 Can't set up my Amazon WorkDocs site in a specific AWS Region .................................................. 87 Want to set up my Amazon WorkDocs site in an existing Amazon VPC ......................................... 87 User needs to reset their password ....................................................................................................... 87 User accidentally shared a sensitive document ................................................................................... 87 User left the organization and didn't transfer document ownership .............................................. 88 Need to deploy Amazon WorkDocs Drive or Amazon WorkDocs Companion to multiple users .............................................................................................................................................................. 88 Online editing isn't working .................................................................................................................... 53 Managing Amazon WorkDocs for Amazon Business ................................................................... 89 IP address and domains to add to your allow list ....................................................................... 91 Document history .......................................................................................................................... 92 v Amazon WorkDocs Administration Guide Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. vi Amazon WorkDocs Administration Guide What is Amazon WorkDocs? Amazon WorkDocs is a fully managed, secure enterprise storage and sharing service with strong administrative controls and feedback capabilities that improve user productivity. Files are stored in the cloud, safely and securely. Your user's files are only visible to them, and their designated contributors and viewers. Other members of your organization do not have access to other user's files unless they are specifically granted access. Users can share their files with other members of your organization for collaboration or |
workdocs-ag-002 | workdocs-ag.pdf | 2 | Learn about migration steps here: How to migrate data from Amazon WorkDocs. vi Amazon WorkDocs Administration Guide What is Amazon WorkDocs? Amazon WorkDocs is a fully managed, secure enterprise storage and sharing service with strong administrative controls and feedback capabilities that improve user productivity. Files are stored in the cloud, safely and securely. Your user's files are only visible to them, and their designated contributors and viewers. Other members of your organization do not have access to other user's files unless they are specifically granted access. Users can share their files with other members of your organization for collaboration or review. The Amazon WorkDocs client applications can be used to view many different types of files, depending on the Internet media type of the file. Amazon WorkDocs supports all common document and image formats, and support for additional media types is constantly being added. For more information, see Amazon WorkDocs. Accessing Amazon WorkDocs Administrators use the Amazon WorkDocs console to create and deactivate Amazon WorkDocs sites. With the admin control panel, they can manage users, storage, and security settings. For more information, see Managing Amazon WorkDocs from the site admin control panel and Inviting and managing Amazon WorkDocs users. Non-administrative users use the client applications to access their files. They never use the Amazon WorkDocs console or the administration dashboard. Amazon WorkDocs offers several different client applications and utilities: • A web application used for document management and reviewing. • Native apps for mobile devices used for document review. • Amazon WorkDocs Drive, an app that synchronizes a folder on your macOS or Windows desktop with your Amazon WorkDocs files. For more information about how users can download Amazon WorkDocs clients, edit their files, and use folders, see the following topics in the Amazon WorkDocs User Guide: • Getting started with Amazon WorkDocs • Working with files Accessing Amazon WorkDocs 1 Amazon WorkDocs • Working with folders Pricing Administration Guide With Amazon WorkDocs, there are no upfront fees or commitments. You pay only for active user accounts, and the storage you use. For more information, see Pricing. How to get started To get started with Amazon WorkDocs, see Creating an Amazon WorkDocs site. Pricing 2 Amazon WorkDocs Administration Guide Migrating data out of Amazon WorkDocs Amazon WorkDocs provides two methods for migrating data out of a WorkDocs site. This section provides an overview of these methods and links to detailed steps to run, troubleshoot and optimize each migration method. Customers will have two options to offboard their data from Amazon WorkDocs: the existing Bulk Download functionality (method 1) or our new Data Migration Tool (method 2). The following topics explain how to use both methods. Topics • Method 1: Downloading files in bulk • Method 2: Use the migration tool Method 1: Downloading files in bulk If you want to control which files you migrate, you can manually download them in bulk. This method allows you to select just the files you want and download them to another location, such as your local drive. You can download files and folders from your WorkDocs web site or from Amazon WorkDocs Drive. Remember the following: • Your site users can download files by following the steps listed below. If you'd prefer, you can set up a shared folder, have your users move the files to that folder, then download the folder to another location. You can also transfer ownership to yourself and perform the downloads. • To download Microsoft Word documents with comments, see Downloading Word documents with feedback, in the Amazon WorkDocs User Guide. • You must use Amazon WorkDocs Drive to download files larger than 5 GB. • When you use Amazon WorkDocs Drive to download files and folders, your directory structures, file names, and file content remain intact. File ownership, permissions, and versions are not retained. Downloading files from the web You use this method to download files when: Method 1: Downloading files in bulk 3 Amazon WorkDocs Administration Guide • You only want to download some of the files from a site. • You want to download Word documents with comments, and have those comments stay with their respective documents. The migration tool downloads all comments, but it writes them to a separate XML file. Site users may then have trouble associating comments with their Word documents. To download files from the web 1. Sign in to Amazon WorkDocs. 2. As needed, open the folder that contains the files that you want to download. 3. Select the checkbox next to the files that you want to download. —OR— Select the checkbox at the top of the list to choose all the files in the folder. 4. Open the Actions menu and choose Download.. On a PC, downloaded files land by default in Downloads/WorkDocsDownloads/folder name. On a Macintosh, files |
workdocs-ag-003 | workdocs-ag.pdf | 3 | writes them to a separate XML file. Site users may then have trouble associating comments with their Word documents. To download files from the web 1. Sign in to Amazon WorkDocs. 2. As needed, open the folder that contains the files that you want to download. 3. Select the checkbox next to the files that you want to download. —OR— Select the checkbox at the top of the list to choose all the files in the folder. 4. Open the Actions menu and choose Download.. On a PC, downloaded files land by default in Downloads/WorkDocsDownloads/folder name. On a Macintosh, files land by default in hard drive name/Users/user name/ WorkDocsDownloads. Downloading files from the web 4 Amazon WorkDocs Administration Guide Downloading folders from the web Note When you download folders, you also download all the files in the folders. If you only want to download some of the files in a folder, move the unwanted files to another location, or to the Recycle Bin, then download the folder. To download folders from the web 1. 2. Sign in to Amazon WorkDocs Select the checkbox next to each of the folders that you want to download. —OR— Open the folders and select the check boxes next to any subfolders that you want to download. 3. Open the Actions menu and choose Download.. On a PC, downloaded folders land by default in Downloads/WorkDocsDownloads/folder name. On a Macintosh, files land by default in hard drive name/Users/user name/ WorkDocsDownloads. Using WorkDocs Drive to download files and folders Note You must install Amazon WorkDocs Drive to complete the following steps. For more information, see Installing Amazon WorkDocs Drive, in the Amazon WorkDocs Drive User Guide. To download files and folders from WorkDocs Drive 1. 2. Start File Explorer or Finder and open your W: drive. Select the folders or files that you want to download. Downloading folders from the web 5 Amazon WorkDocs Administration Guide 3. Tap and hold (right-click) the selected items and choose Copy, then paste the copied items into their new location. —OR— Drag the selected items to their new location. 4. Delete the original files from Amazon WorkDocs Drive. Method 2: Use the migration tool You use the Amazon WorkDocs migration tool when you want to migrate all the data off of a WorkDocs site. The migration tool moves the data from a site to an Amazon Simple Storage Service bucket. The tool creates a compressed ZIP file for each user. The zipped file includes all files and folders, versions, permissions, comments, and annotations for each of the end users on your WorkDocs site. Topics • Prerequisites • Limitations • Running the migration tool • Downloading migrated data from Amazon S3 • Troubleshooting migrations • Viewing your migration history Prerequisites You must have the following items in order to use the migration tool. • An Amazon S3 bucket. For information about creating an Amazon S3 bucket, see Creating a bucket, in the Amazon S3 User Guide. Your bucket must use the same IAM account and reside in the same Region as your WorkDocs site. Also, you must block public access to the bucket. For more information about doing that, see Blocking public access to your Amazon S3 storage, in the Amazon S3 User Guide. Method 2: Use the migration tool 6 Amazon WorkDocs Administration Guide To grant Amazon WorkDocs permission to upload your files, configure the bucket policy as shown in the following example. The policy uses the aws:SourceAccount and aws:SourceArn condition keys to reduce the policy's scope, a security best practice. { "Version": "2012-10-17", "Statement": [ { "Sid": "AllowWorkDocsFileUpload", "Effect": "Allow", "Principal": { "Service": "workdocs.amazonaws.com" }, "Action": "s3:PutObject", "Resource": "arn:aws:s3:::BUCKET-NAME/*", "Condition": { "StringEquals": { "aws:SourceAccount": "AWS-ACCOUNT-ID" }, "ArnLike": { "aws:SourceArn": "arn:aws:workdocs:REGION:AWS-ACCOUNT- ID:organization/WORKDOCS-DIRECTORY-ID" } } } ] } Note • WORKDOCS-DIRECTORY-ID is the organization ID of your WorkDocs site. This can be found in the “My Sites” table in the AWS WorkDocs Console • For more information about configuring a bucket policy, see Adding a bucket policy by using the Amazon S3 console • An IAM policy. To start a migration on the WorkDocs console, the IAM calling principal must have the following policy attached to its permissions set: { "Version": "2012-10-17", Prerequisites 7 Amazon WorkDocs "Statement": [ { "Sid": "AllowStartWorkDocsMigration", "Effect": "Allow", "Action": [ "workdocs:StartInstanceExport" ], "Resource": [ Administration Guide "arn:aws:workdocs:REGION:AWS-ACCOUNT-ID:organization/WORKDOCS- DIRECTORY-ID" ] }, { "Sid": "AllowDescribeWorkDocsMigrations", "Effect": "Allow", "Action": [ "workdocs:DescribeInstanceExports", "workdocs:DescribeInstances" ], "Resource": [ "*" ] }, { "Sid": "AllowS3Validations", "Effect": "Allow", "Action": [ "s3:HeadBucket", "s3:ListBucket", "s3:GetBucketPublicAccessBlock", "kms:ListAliases" ], "Resource": [ "arn:aws:s3:::BUCKET-NAME" ] }, { "Sid": "AllowS3ListMyBuckets", "Effect": "Allow", "Action": [ "s3:ListAllMyBuckets" ], "Resource": [ "*" Prerequisites 8 Amazon WorkDocs ] } ] } Administration Guide • Optionally, you can use an AWS KMS key to encrypt the at-rest data in your bucket. If you don't provide a key, |
workdocs-ag-004 | workdocs-ag.pdf | 4 | Prerequisites 7 Amazon WorkDocs "Statement": [ { "Sid": "AllowStartWorkDocsMigration", "Effect": "Allow", "Action": [ "workdocs:StartInstanceExport" ], "Resource": [ Administration Guide "arn:aws:workdocs:REGION:AWS-ACCOUNT-ID:organization/WORKDOCS- DIRECTORY-ID" ] }, { "Sid": "AllowDescribeWorkDocsMigrations", "Effect": "Allow", "Action": [ "workdocs:DescribeInstanceExports", "workdocs:DescribeInstances" ], "Resource": [ "*" ] }, { "Sid": "AllowS3Validations", "Effect": "Allow", "Action": [ "s3:HeadBucket", "s3:ListBucket", "s3:GetBucketPublicAccessBlock", "kms:ListAliases" ], "Resource": [ "arn:aws:s3:::BUCKET-NAME" ] }, { "Sid": "AllowS3ListMyBuckets", "Effect": "Allow", "Action": [ "s3:ListAllMyBuckets" ], "Resource": [ "*" Prerequisites 8 Amazon WorkDocs ] } ] } Administration Guide • Optionally, you can use an AWS KMS key to encrypt the at-rest data in your bucket. If you don't provide a key, the bucket's standard encryption setting applies. For more information, see Creating keys, in the AWS Key Management Service Developer Guide. To use an AWS KMS key, add the following statements to the IAM policy. You must use an active key of the SYMMETRIC_DEFAULT type. { "Sid": "AllowKMSMigration", "Effect": "Allow", "Action": [ "kms:CreateGrant", "kms:DescribeKey" ], "Resource": [ "arn:aws:kms:REGION:AWS-ACCOUNT-ID:key/KEY-RESOURCE-ID" ] } Limitations The migration tool has the following limitations: • The tool writes all user permissions, comments, and annotations to separate CSV files. You must map that data to the corresponding files manually. • You can only migrate active sites. • The tool is limited to one successful migration per a site for each 24-hour period. • You can't run concurrent migrations of the same site, but you can run concurrent migrations for different sites. • Each zip file will be at most 50GB. Users with more than 50GB of data in WorkDocs will have multiple zip files exported into Amazon S3. Limitations 9 Amazon WorkDocs Administration Guide • The tool does not export files larger than 50 GB. The tool lists any files larger than 50 GB in a CSV file that has the same prefix as the ZIP files. For example, /workdocs/site- alias/created-timestamp-UTC/skippedFiles.csv. You can download the listed files programmatically or manually. For information about downloading programmatically, see https://docs.aws.amazon.com/workdocs/latest/developerguide/download-documents.html, in the Amazon WorkDocs Developer Guide. For information about downloading the files manually, see the steps in Method 1, earlier in this topic. • Each user’s zip file will only contain files and/or folders that they own. Any files and/or folders that have been shared with the user will be in the zip file of the user that owns the files and/or folders. • If a folder is empty (contains no nested files/folders) in WorkDocs, it will not be exported. • It is not guaranteed that any data (files, folders, versions, comments, annotations) created after the migration job has been initiated, will be included in the exported data in S3. • You can migrate multiple sites to an Amazon S3 bucket. You do not need to create one bucket per site. However, you must ensure that your IAM and bucket policies allow multiple sites. • Migrating increases your Amazon S3 costs, depending on the amount of data that you migrate to the bucket. For more information, see the Amazon S3 pricing page. Running the migration tool The following steps explain how to run the Amazon WorkDocs migration tool. To migrate a site 1. Open the Amazon WorkDocs console at https://console.aws.amazon.com/zocalo/. 2. In the navigation pane, choose My sites, then select the radio button next to the site that you want to migrate. 3. Open the Actions list and choose Migrate Data. 4. On the Migrate Data site-name page, enter the URI of your Amazon S3 bucket. —OR— Choose Browse S3 and follow these steps: a. As needed, search for the bucket. b. Select the radio button next to the bucket name, then select Choose. Running the migration tool 10 Amazon WorkDocs Administration Guide 5. 6. 7. (Optional) Under Notifications, enter a maximum of five email addresses. The tool sends migration status emails to each recipient. (Optional) Under Advanced Settings, select a KMS key to encrypt your stored data. Enter migrate in the text box to confirm the migration, then choose Start Migration. An indicator appears and displays the status of the migration. Migration times vary, depending on the amount of data in a site. Running the migration tool 11 Amazon WorkDocs Administration Guide Running the migration tool 12 Amazon WorkDocs When the migration finishes: Administration Guide • The tool sends "success" emails to the addresses entered during setup, if any. • Your Amazon S3 bucket will contain a /workdocs/site-alias/created-timestamp-UTC/ folder. That folder contains a zipped folder for each user that had data on the site. Each zipped folder contains the user's folders and files, including the permissions and comments mapping CSV files. • If a user removes all their files before the migration, no zipped folder appears for that user. • Versions – Documents with multiple versions have a _version_creation timestamp identifier. The timestamp uses epoch milliseconds. For example, a document named “TestFile.txt” with 2 versions appears as follows: TestFile.txt (version |
workdocs-ag-005 | workdocs-ag.pdf | 5 | emails to the addresses entered during setup, if any. • Your Amazon S3 bucket will contain a /workdocs/site-alias/created-timestamp-UTC/ folder. That folder contains a zipped folder for each user that had data on the site. Each zipped folder contains the user's folders and files, including the permissions and comments mapping CSV files. • If a user removes all their files before the migration, no zipped folder appears for that user. • Versions – Documents with multiple versions have a _version_creation timestamp identifier. The timestamp uses epoch milliseconds. For example, a document named “TestFile.txt” with 2 versions appears as follows: TestFile.txt (version 2 - latest version) TestFile_version_1707437230000.txt • Permissions – The following example shows the content of a typical permissions CSV file. PathToFile,PrincipalName,PrincipalType,Role /mydocs/Projects,[email protected],USER,VIEWER /mydocs/Personal,[email protected],USER,VIEWER /mydocs/Documentation/Onboarding_Guide.xml,[email protected],USER,CONTRIBUTOR /mydocs/Documentation/Onboarding_Guide.xml,[email protected],USER,CONTRIBUTOR /mydocs/Projects/Initiative,[email protected],USER,CONTRIBUTOR /mydocs/Notes,[email protected],USER,COOWNER /mydocs/Notes,[email protected],USER,COOWNER /mydocs/Projects/Initiative/Structures.xml,[email protected],USER,COOWNER • Comments – The following example shows the content of a typical comments CSV file. PathToFile,PrincipalName,PostedTimestamp,Text /mydocs/Documentation/ Onboarding_Guide.xml,[email protected],2023-12-28T20:57:40.781Z,TEST ANNOTATION 1 /mydocs/Documentation/ Onboarding_Guide.xml,[email protected],2023-12-28T22:18:09.812Z,TEST ANNOTATION 2 /mydocs/Documentation/ Onboarding_Guide.xml,[email protected],2023-12-28T22:20:04.099Z,TEST ANNOTATION 3 /mydocs/Documentation/ Onboarding_Guide.xml,[email protected],2023-12-28T20:56:27.390Z,TEST COMMENT 1 Running the migration tool 13 Amazon WorkDocs /mydocs/Documentation/ Administration Guide Onboarding_Guide.xml,[email protected],2023-12-28T22:17:10.348Z,TEST COMMENT 2 /mydocs/Documentation/ Onboarding_Guide.xml,[email protected],2023-12-28T22:19:42.821Z,TEST COMMENT 3 /mydocs/Projects/Agora/ Threat_Model.xml,[email protected],2023-12-28T22:21:09.930Z,TEST ANNOTATION 4 /mydocs/Projects/Agora/ Threat_Model.xml,[email protected],2023-12-28T20:57:04.931Z,TEST COMMENT 4 • Skipped files – The following example shows the content of a typical skipped files CSV file. We shortened the ID and skipped reason values for better readability. FileOwner,PathToFile,DocumentId,VersionId,SkippedReason [email protected],/mydocs/LargeFile1.mp4,45e433b5469...,170899345...,The file is too large. Please notify the document owner... [email protected],/mydocs/LargeFile2.pdf,e87f725898c1...,170899696...,The file is too large. Please notify the document owner... Downloading migrated data from Amazon S3 Because migrating increases your Amazon S3 costs, you can download the migrated data from Amazon S3 to another storage solution. This topic explains how to download your migrated data, and it provides suggestions for uploading data to a storage solution. Note The following steps explain how to download one file or folder at a time. For information about other ways to download files, see Downloading objects, in the Amazon S3 User Guide. To download data 1. Open the Amazon S3 console at https://console.aws.amazon.com/s3/. 2. 3. Select the target bucket and navigate to the site alias. Select the checkbox next to the zipped folder. —OR— Open the zipped folder and select the checkbox next to the file or folder for an individual user. Downloading migrated data from Amazon S3 14 Amazon WorkDocs 4. Choose Download. Suggestions for storage solutions Administration Guide For large sites, we recommend provisioning an EC2 instance using a compliant Linux-based Amazon Machine Image to programmatically download your data from Amazon S3, unzip the data, then upload it to your storage provider or local disk. Troubleshooting migrations Try these steps to ensure you have configured your environment correctly: • If a migration fails, an error message appears on the Migration history tab in the WorkDocs console. Review the error message. • Check your Amazon S3 bucket settings. • Rerun the migration. If the issue persists, contact AWS Support. Include the WorkDocs Site URL and the Migration Job ID, located in the migration history table. Viewing your migration history The following steps explain how to view your migration history. To view your history 1. Open the Amazon WorkDocs console at https://console.aws.amazon.com/zocalo/. 2. Select the radio button next to the desired WorkDocs site. 3. Open the Actions list and choose Migrate Data. 4. On the Migrate Data site-name page, choose Ongoing Migrations and History. The migration history appears under Migrations. The following image shows a typical history. Troubleshooting migrations 15 Amazon WorkDocs Administration Guide Viewing your migration history 16 Amazon WorkDocs Administration Guide Prerequisites for Amazon WorkDocs To set up new Amazon WorkDocs sites, or manage existing sites, you must complete the following tasks. Sign up for an AWS account If you do not have an AWS account, complete the following steps to create one. To sign up for an AWS account 1. Open https://portal.aws.amazon.com/billing/signup. 2. Follow the online instructions. Part of the sign-up procedure involves receiving a phone call and entering a verification code on the phone keypad. When you sign up for an AWS account, an AWS account root user is created. The root user has access to all AWS services and resources in the account. As a security best practice, assign administrative access to a user, and use only the root user to perform tasks that require root user access. AWS sends you a confirmation email after the sign-up process is complete. At any time, you can view your current account activity and manage your account by going to https://aws.amazon.com/ and choosing My Account. Create a user with administrative access After you sign up for an AWS account, secure your AWS account root user, enable AWS IAM Identity Center, and create an administrative user so that you don't use the root user for everyday tasks. Secure your AWS account root user 1. Sign in to the AWS Management Console as the account owner by choosing Root |
workdocs-ag-006 | workdocs-ag.pdf | 6 | require root user access. AWS sends you a confirmation email after the sign-up process is complete. At any time, you can view your current account activity and manage your account by going to https://aws.amazon.com/ and choosing My Account. Create a user with administrative access After you sign up for an AWS account, secure your AWS account root user, enable AWS IAM Identity Center, and create an administrative user so that you don't use the root user for everyday tasks. Secure your AWS account root user 1. Sign in to the AWS Management Console as the account owner by choosing Root user and entering your AWS account email address. On the next page, enter your password. For help signing in by using root user, see Signing in as the root user in the AWS Sign-In User Guide. Sign up for an AWS account 17 Amazon WorkDocs Administration Guide 2. Turn on multi-factor authentication (MFA) for your root user. For instructions, see Enable a virtual MFA device for your AWS account root user (console) in the IAM User Guide. Create a user with administrative access 1. Enable IAM Identity Center. For instructions, see Enabling AWS IAM Identity Center in the AWS IAM Identity Center User Guide. 2. In IAM Identity Center, grant administrative access to a user. For a tutorial about using the IAM Identity Center directory as your identity source, see Configure user access with the default IAM Identity Center directory in the AWS IAM Identity Center User Guide. Sign in as the user with administrative access • To sign in with your IAM Identity Center user, use the sign-in URL that was sent to your email address when you created the IAM Identity Center user. For help signing in using an IAM Identity Center user, see Signing in to the AWS access portal in the AWS Sign-In User Guide. Assign access to additional users 1. In IAM Identity Center, create a permission set that follows the best practice of applying least- privilege permissions. For instructions, see Create a permission set in the AWS IAM Identity Center User Guide. 2. Assign users to a group, and then assign single sign-on access to the group. For instructions, see Add groups in the AWS IAM Identity Center User Guide. Create a user with administrative access 18 Amazon WorkDocs Administration Guide Security in Amazon WorkDocs Cloud security at AWS is the highest priority. As an AWS customer, you benefit from a data center and network architecture that is built to meet the requirements of the most security-sensitive organizations. Security is a shared responsibility between AWS and you. The shared responsibility model describes this as security of the cloud and security in the cloud: • Security of the cloud – AWS is responsible for protecting the infrastructure that runs AWS services in the AWS Cloud. AWS also provides you with services that you can use securely. Third- party auditors regularly test and verify the effectiveness of our security as part of the AWS compliance programs. To learn about the compliance programs that apply to Amazon WorkDocs, see AWS Services in Scope by Compliance Program. • Security in the cloud – The AWS service that you use determines your responsibility. You are also responsible for other factors, including the sensitivity of your data, your company’s requirements, and applicable laws and regulations. The topics in this section help you understand how to apply the shared responsibility model when using Amazon WorkDocs. Note The users in a WorkDocs organization can collaborate with users outside that organization by sending a link or invitation to a file. However, this only applies to sites that use an Active Directory Connector. See the the shared link settings for your site and select the option that best meets your company’s requirements. The following topics show you how to configure Amazon WorkDocs to meet your security and compliance objectives. You also learn how to use other AWS services that help you to monitor and secure your Amazon WorkDocs resources. Topics • Identity and access management for Amazon WorkDocs • Logging and monitoring in Amazon WorkDocs • Compliance validation for Amazon WorkDocs • Resilience in Amazon WorkDocs 19 Amazon WorkDocs Administration Guide • Infrastructure security in Amazon WorkDocs Identity and access management for Amazon WorkDocs AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use Amazon WorkDocs resources. IAM is an AWS service that you can use with no additional charge. Topics • Audience • Authenticating with identities • Managing access using policies • How Amazon WorkDocs works with IAM • Amazon WorkDocs identity-based policy examples • Troubleshooting Amazon WorkDocs identity and access Audience How you use AWS Identity and |
workdocs-ag-007 | workdocs-ag.pdf | 7 | in Amazon WorkDocs Identity and access management for Amazon WorkDocs AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use Amazon WorkDocs resources. IAM is an AWS service that you can use with no additional charge. Topics • Audience • Authenticating with identities • Managing access using policies • How Amazon WorkDocs works with IAM • Amazon WorkDocs identity-based policy examples • Troubleshooting Amazon WorkDocs identity and access Audience How you use AWS Identity and Access Management (IAM) differs, depending on the work that you do in Amazon WorkDocs. Service user – If you use the Amazon WorkDocs service to do your job, then your administrator provides you with the credentials and permissions that you need. As you use more Amazon WorkDocs features to do your work, you might need additional permissions. Understanding how access is managed can help you request the right permissions from your administrator. If you cannot access a feature in Amazon WorkDocs, see Troubleshooting Amazon WorkDocs identity and access. Service administrator – If you're in charge of Amazon WorkDocs resources at your company, you probably have full access to Amazon WorkDocs. It's your job to determine which Amazon WorkDocs features and resources your service users should access. You must then submit requests to your IAM administrator to change the permissions of your service users. Review the information on this page to understand the basic concepts of IAM. To learn more about how your company can use IAM with Amazon WorkDocs, see How Amazon WorkDocs works with IAM. Identity and access management 20 Amazon WorkDocs Administration Guide IAM administrator – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to Amazon WorkDocs. To view example Amazon WorkDocs identity-based policies that you can use in IAM, see Amazon WorkDocs identity-based policy examples. Authenticating with identities Authentication is how you sign in to AWS using your identity credentials. You must be authenticated (signed in to AWS) as the AWS account root user, as an IAM user, or by assuming an IAM role. You can sign in to AWS as a federated identity by using credentials provided through an identity source. AWS IAM Identity Center (IAM Identity Center) users, your company's single sign-on authentication, and your Google or Facebook credentials are examples of federated identities. When you sign in as a federated identity, your administrator previously set up identity federation using IAM roles. When you access AWS by using federation, you are indirectly assuming a role. Depending on the type of user you are, you can sign in to the AWS Management Console or the AWS access portal. For more information about signing in to AWS, see How to sign in to your AWS account in the AWS Sign-In User Guide. If you access AWS programmatically, AWS provides a software development kit (SDK) and a command line interface (CLI) to cryptographically sign your requests by using your credentials. If you don't use AWS tools, you must sign requests yourself. For more information about using the recommended method to sign requests yourself, see AWS Signature Version 4 for API requests in the IAM User Guide. Regardless of the authentication method that you use, you might be required to provide additional security information. For example, AWS recommends that you use multi-factor authentication (MFA) to increase the security of your account. To learn more, see Multi-factor authentication in the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. IAM users and groups An IAM user is an identity within your AWS account that has specific permissions for a single person or application. Where possible, we recommend relying on temporary credentials instead of creating IAM users who have long-term credentials such as passwords and access keys. However, if you have specific use cases that require long-term credentials with IAM users, we recommend that you rotate Authenticating with identities 21 Amazon WorkDocs Administration Guide access keys. For more information, see Rotate access keys regularly for use cases that require long- term credentials in the IAM User Guide. An IAM group is an identity that specifies a collection of IAM users. You can't sign in as a group. You can use groups to specify permissions for multiple users at a time. Groups make permissions easier to manage for large sets of users. For example, you could have a group named IAMAdmins and give that group permissions to administer IAM resources. Users are different from roles. A user is uniquely associated with one person or application, but a role is intended to be assumable by anyone who needs it. Users have permanent long-term |
workdocs-ag-008 | workdocs-ag.pdf | 8 | credentials in the IAM User Guide. An IAM group is an identity that specifies a collection of IAM users. You can't sign in as a group. You can use groups to specify permissions for multiple users at a time. Groups make permissions easier to manage for large sets of users. For example, you could have a group named IAMAdmins and give that group permissions to administer IAM resources. Users are different from roles. A user is uniquely associated with one person or application, but a role is intended to be assumable by anyone who needs it. Users have permanent long-term credentials, but roles provide temporary credentials. To learn more, see Use cases for IAM users in the IAM User Guide. IAM roles An IAM role is an identity within your AWS account that has specific permissions. It is similar to an IAM user, but is not associated with a specific person. To temporarily assume an IAM role in the AWS Management Console, you can switch from a user to an IAM role (console). You can assume a role by calling an AWS CLI or AWS API operation or by using a custom URL. For more information about methods for using roles, see Methods to assume a role in the IAM User Guide. IAM roles with temporary credentials are useful in the following situations: • Federated user access – To assign permissions to a federated identity, you create a role and define permissions for the role. When a federated identity authenticates, the identity is associated with the role and is granted the permissions that are defined by the role. For information about roles for federation, see Create a role for a third-party identity provider (federation) in the IAM User Guide. If you use IAM Identity Center, you configure a permission set. To control what your identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM. For information about permissions sets, see Permission sets in the AWS IAM Identity Center User Guide. • Temporary IAM user permissions – An IAM user or role can assume an IAM role to temporarily take on different permissions for a specific task. • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a different account to access resources in your account. Roles are the primary way to grant cross- account access. However, with some AWS services, you can attach a policy directly to a resource (instead of using a role as a proxy). To learn the difference between roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. Authenticating with identities 22 Amazon WorkDocs Administration Guide • Cross-service access – Some AWS services use features in other AWS services. For example, when you make a call in a service, it's common for that service to run applications in Amazon EC2 or store objects in Amazon S3. A service might do this using the calling principal's permissions, using a service role, or using a service-linked role. • Forward access sessions (FAS) – When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. • Service role – A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. • Service-linked role – A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. • Applications running on Amazon EC2 – You can use an IAM role to manage temporary credentials for applications that are running on an EC2 instance and making AWS CLI or AWS API requests. This is preferable to storing access keys within the EC2 instance. To assign an AWS role to an EC2 instance and make it available to all of its applications, you |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.