Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
storagegateway-fsxfile-ug-048	storagegateway-fsxfile-ug.pdf	48	connecting to Support, and more. • Conﬁguring your Amazon EC2 gateway network settings - Learn how to use the local console to view and conﬁgure network settings such as DNS and hostname for a gateway on an Amazon EC2 instance. Logging in to your Amazon EC2 gateway local console You log in to the gateway local console on an Amazon EC2 instance by using a Secure Shell (SSH) client. For detailed information, see Connect to your instance in the Amazon EC2 User Guide. To connect this way, you need the SSH key pair that you speciﬁed when you launched your instance. For information about Amazon EC2 key pairs, see Amazon EC2 key pairs in the Amazon EC2 User Guide. To log in to the gateway local console 1. Connect to the Amazon EC2 instance using SSH and log in as the admin user. 2. After you log in, you see the AWS Appliance Activation - Conﬁguration main menu, from which you can perform various tasks. To Learn About This Task See This Topic Conﬁgure an HTTP proxy for your gateway Routing your gateway deployed on Amazon EC2 through an HTTP proxy Conﬁgure network settings for your gateway Conﬁguring your Amazon EC2 gateway network settings Test network connectivity Testing your gateway's network connectivity View a system resource check Viewing your gateway system resource statu s. Performing tasks on the EC2 local console API Version 2021-03-31 129 AWS Storage Gateway Amazon FSx File Gateway User Guide To Learn About This Task See This Topic Run Storage Gateway console commands Running Storage Gateway commands on the l ocal console for an Amazon EC2 gateway To shut down the gateway, enter 0. To exit the conﬁguration session, enter X. Routing your gateway deployed on Amazon EC2 through an HTTP proxy Storage Gateway supports the conﬁguration of a Socket Secure version 5 (SOCKS5) proxy between your gateway deployed on Amazon EC2 and AWS. If your gateway must use a proxy server to communicate to the internet, then you need to conﬁgure the HTTP proxy settings for your gateway. You do this by specifying an IP address and port number for the host running your proxy. After you do so, Storage Gateway routes all AWS endpoint traﬃc through your proxy server. Communications between the gateway and endpoints is encrypted, even when using the HTTP proxy. To route your gateway internet traﬃc through a local proxy server 1. Log in to your gateway's local console. For instructions, see Logging in to your Amazon EC2 gateway local console. 2. 3. From the AWS Appliance Activation - Conﬁguration main menu, enter the corresponding numeral to select Conﬁgure HTTP Proxy. From the AWS Appliance Activation HTTP Proxy Conﬁguration menu, enter the corresponding numeral for the task you want to perform: • Conﬁgure HTTP proxy - You will need to supply a host name and port to complete conﬁguration. • View current HTTP proxy conﬁguration - If an HTTP proxy is not conﬁgured, the message HTTP Proxy not configured is displayed. If an HTTP proxy is conﬁgured, the host name and port of the proxy are displayed. • Remove an HTTP proxy conﬁguration - The message HTTP Proxy Configuration Removed is displayed. Performing tasks on the EC2 local console API Version 2021-03-31 130 AWS Storage Gateway Amazon FSx File Gateway User Guide Testing your gateway's network connectivity You can use your gateway's local console to test your network connectivity. This test can be useful when you are troubleshooting network issues with your gateway. To test your gateway's connectivity 1. Log in to your gateway's local console. For instructions, see Logging in to your Amazon EC2 gateway local console. 2. From the AWS Appliance Activation - Conﬁguration main menu, enter the corresponding numeral to select Test Network Connectivity. If your gateway has already been activated, the connectivity test begins immediately. For gateways that have not yet been activated, you must specify the endpoint type and AWS Region as described in the following steps. 3. If your gateway is not yet activated, enter the corresponding numeral to select the endpoint type for your gateway. 4. If you selected the public endpoint type, enter the corresponding numeral to select the AWS Region that you want to test. For supported AWS Regions and a list of AWS service endpoints you can use with Storage Gateway, see AWS Storage Gateway endpoints and quotas in the AWS General Reference. As the test progresses, each endpoint displays either [PASSED] or [FAILED], indicating the status of the connection as follows: Message [PASSED] [FAILED] Description Storage Gateway has network connectivity. Storage Gateway does not have network connectivity. Viewing your gateway system resource status When your File Gateway starts, it checks its virtual CPU cores, root volume size, and RAM. It then determines whether the available system resources are suﬃcient for
storagegateway-fsxfile-ug-049	storagegateway-fsxfile-ug.pdf	49	want to test. For supported AWS Regions and a list of AWS service endpoints you can use with Storage Gateway, see AWS Storage Gateway endpoints and quotas in the AWS General Reference. As the test progresses, each endpoint displays either [PASSED] or [FAILED], indicating the status of the connection as follows: Message [PASSED] [FAILED] Description Storage Gateway has network connectivity. Storage Gateway does not have network connectivity. Viewing your gateway system resource status When your File Gateway starts, it checks its virtual CPU cores, root volume size, and RAM. It then determines whether the available system resources are suﬃcient for your gateway to function properly. You can view the results of the system resource check by using the gateway local console. Performing tasks on the EC2 local console API Version 2021-03-31 131 AWS Storage Gateway Amazon FSx File Gateway User Guide To view the status of a system resource check 1. Log in to the local console on your Amazon EC2 File Gateway. For instructions, see Logging in to your Amazon EC2 gateway local console. 2. From the AWS Appliance Activation - Conﬁguration main menu, enter the corresponding numeral to select View System Resource Check. The gateway local console displays [OK], [WARNING], or [FAIL] to indicate the status of the resource as follows: Message [OK] [WARNING] [FAIL] Description The resource has passed the system resource check. The resource does not meet the recommend ed requirements, but your gateway can continue to function. The gateway local console displays a message that describes the results of the resource check. The resource does not meet the minimum requirements. Your gateway might not function properly. The gateway local console displays a message that describes the results of the resource check. The local console also displays the number of errors and warnings next to the resource check menu option. Running Storage Gateway commands on the local console for an Amazon EC2 gateway The AWS Storage Gateway console helps provide a secure environment for conﬁguring and diagnosing issues with your gateway. Using the console commands, you can perform maintenance tasks such as saving routing tables or connecting to Support. Performing tasks on the EC2 local console API Version 2021-03-31 132 AWS Storage Gateway Amazon FSx File Gateway User Guide To run a conﬁguration or diagnostic command 1. Log in to your gateway's local console. For instructions, see Logging in to your Amazon EC2 gateway local console. 2. From the AWS Appliance Activation - Conﬁguration main menu, enter the corresponding numeral to select Gateway Console. 3. From the gateway console command prompt, enter h. The console displays the AVAILABLE COMMANDS menu, which lists the available commands: Command Function dig exit h Collect output from dig for DNS troublesh ooting. Return to Conﬁguration menu. Display available command list. ifconﬁg View or conﬁgure network interfaces. Note We recommend conﬁguring network or IP settings using the Storage Gateway console or the dedicated local console menu option. For instructions, see Conﬁguring your gateway network settings. ip Show / manipulate routing, devices, and tunnels. Note We recommend conﬁguring network or IP settings using the Storage Gateway console or the dedicated Performing tasks on the EC2 local console API Version 2021-03-31 133 AWS Storage Gateway Command iptables ncport nping Amazon FSx File Gateway User Guide Function local console menu option. For instructions, see Conﬁguring your gateway network settings. Administration tool for IPv4 packet ﬁltering and NAT. Test connectivity to a speciﬁc TCP port on a network. Collect output from nping for network t roubleshooting. open-support-channel Connect to AWS Support. save-iptables Persist IP tables. save-routing-table Save newly added routing table entry. tcptraceroute Collect traceroute output on TCP traﬃc to a destination. 4. From the gateway console command prompt, enter the corresponding command for the function you want to use, and follow the instructions. To learn about a command, enter man + command name at the command prompt. Conﬁguring your Amazon EC2 gateway network settings You can view and conﬁgure the network settings for your Amazon EC2 File Gateway by using the gateway local console. To conﬁgure your network settings 1. Log in to the local console on your Amazon EC2 File Gateway. For instructions, see Logging in to your Amazon EC2 gateway local console. 2. From the AWS Appliance Activation - Conﬁguration main menu, enter the corresponding numeral to select Network Conﬁguration. Performing tasks on the EC2 local console API Version 2021-03-31 134 AWS Storage Gateway Amazon FSx File Gateway User Guide 3. From the AWS Appliance Activation - Network Conﬁguration menu, enter the corresponding numeral for the task that you want to perform: • Edit DNS Conﬁguration - The gateway local console displays the available adapters for the primary and secondary DNS servers. The console then prompts you to provide the new IP address. • View DNS Conﬁguration - The gateway local console
storagegateway-fsxfile-ug-050	storagegateway-fsxfile-ug.pdf	50	2. From the AWS Appliance Activation - Conﬁguration main menu, enter the corresponding numeral to select Network Conﬁguration. Performing tasks on the EC2 local console API Version 2021-03-31 134 AWS Storage Gateway Amazon FSx File Gateway User Guide 3. From the AWS Appliance Activation - Network Conﬁguration menu, enter the corresponding numeral for the task that you want to perform: • Edit DNS Conﬁguration - The gateway local console displays the available adapters for the primary and secondary DNS servers. The console then prompts you to provide the new IP address. • View DNS Conﬁguration - The gateway local console displays the available adapters for the primary and secondary DNS servers. • Conﬁgure Hostname - The gateway local console prompts you to choose whether the gateway will use a static hostname that you specify, or if it will aquire a hostname automatically through DCHP or rDNS. Note If you choose to conﬁgure a static hostname for your gateway, you must create an A record in your DNS system that points the IP address of the gateway to its static hostname. • View Hostname Conﬁguration - The gateway local console displays hostname, aquisition mode, domain, and Active Directory realm for your Amazon EC2 File Gateway. Shutting down your gateway VM You might need to shutdown or reboot your VM for maintenance, such as when applying a patch to your hypervisor. You shut down on-premises gateway VMs using your hypervisor interface, and Amazon EC2 instances using the Amazon EC2 console. Important If you stop and start an Amazon EC2 gateway that uses ephemeral storage, the gateway will be permanently oﬄine. This happens because the physical storage disk is replaced. There is no work-around for this issue. The only resolution is to delete the gateway and activate a new one on a new EC2 instance. Shutting down your gateway VM API Version 2021-03-31 135 AWS Storage Gateway Amazon FSx File Gateway User Guide Replacing your existing FSx File Gateway with a new instance You can replace an existing FSx File Gateway with a new instance as your data and performance needs grow, or if you receive an AWS notiﬁcation to migrate your gateway. You might need to do this if you want to move your gateway to a better host platform or newer Amazon EC2 instances, or to refresh the underlying server hardware. Note Migration can only be performed between gateways of the same type. For example, you cannot migrate settings or data from an FSx File Gateway to an S3 File Gateway. To replace your FSx File Gateway gateway with a new instance with an empty cache disk and a new Gateway ID: 1. Stop any applications that are writing to the existing FSx File Gateway. Verify that the CachePercentDirty metric on the Monitoring tab is 0 before you set up ﬁle system associations on the new gateway. 2. Use the AWS Command Line Interface (AWS CLI) to gather and save the conﬁguration information about your existing FSx File Gateway and associated ﬁle systems by doing the following: a. Save the gateway conﬁguration information for the FSx File Gateway. aws storagegateway describe-gateway-information --gateway-arn "arn:aws:storagegateway:us-east-2:123456789012:gateway/sgw-12A3456B" This command outputs a JSON block that contains metadata about the gateway, such as its name, network interfaces, conﬁgured time zone, and its state (whether the gateway is running). b. Save the Server Message Block (SMB) settings of the FSx File Gateway. aws storagegateway describe-smb-settings --gateway-arn "arn:aws:storagegateway:us-east-2:123456789012:gateway/sgw-12A3456B" This command outputs a JSON block that contains the domain name of the Microsoft Active Directory that the gateway is joined to. Replacing your existing FSx File Gateway with a new instance API Version 2021-03-31 136 AWS Storage Gateway Amazon FSx File Gateway User Guide c. Save ﬁle share information for each ﬁle system associated with the FSx File Gateway: Use the following command for each associated ﬁle system. aws storagegateway describe-file-system-associations --file-system- association-arn-list "arn:aws:storagegateway:us-east-2:123456789012:fs- association/fsa-987A654B" This command outputs a JSON block that contains metadata about the ﬁle system, such as its location ARN, audit log destination, cache refresh attributes, conﬁgured IP addresses, and tags. 3. Create a new FSx File Gateway with the same settings and conﬁguration as the old gateway. If necessary, refer to the information you saved in Step 2. 4. Create new ﬁle system associations for the new gateway with the same settings and conﬁguration as the ﬁle systems that were conﬁgured on the old gateway. If necessary, refer to the information you saved in Step 2. 5. Conﬁrm that your new gateway is working correctly, then remap/cut-over your clients from the old ﬁle systems to the new ﬁle systems in the manner that best suits your environment. 6. Conﬁrm that your new gateway is working correctly, then delete the old gateway from the Storage Gateway console. Important Before you delete an FSx File Gateway, make sure
storagegateway-fsxfile-ug-051	storagegateway-fsxfile-ug.pdf	51	Step 2. 4. Create new ﬁle system associations for the new gateway with the same settings and conﬁguration as the ﬁle systems that were conﬁgured on the old gateway. If necessary, refer to the information you saved in Step 2. 5. Conﬁrm that your new gateway is working correctly, then remap/cut-over your clients from the old ﬁle systems to the new ﬁle systems in the manner that best suits your environment. 6. Conﬁrm that your new gateway is working correctly, then delete the old gateway from the Storage Gateway console. Important Before you delete an FSx File Gateway, make sure that there are no applications currently writing to that gateway's cache. If you delete a gateway while it is in use, data loss can occur. Warning When a gateway is deleted, there is no way to recover it. 7. Delete the old gateway VM or Amazon EC2 instance. Replacing your existing FSx File Gateway with a new instance API Version 2021-03-31 137 AWS Storage Gateway Amazon FSx File Gateway User Guide Deleting your gateway and removing associated resources If you don't plan to continue using your gateway, consider deleting the gateway and its associated resources. Removing resources avoids incurring charges for resources you don't plan to continue using and helps reduce your monthly bill. When you delete a gateway, it no longer appears on the AWS Storage Gateway Management Console and its ﬁle system connections are closed. The procedure for deleting a gateway is the same for all gateway types; however, depending on the type of gateway you want to delete and the host it is deployed on, you follow speciﬁc instructions to remove associated resources. You can delete a gateway using the Storage Gateway console or programmatically. You can ﬁnd information following about how to delete a gateway using the Storage Gateway console. If you want to programmatically delete your gateway, see AWS Storage Gateway API Reference. Deleting Your Gateway by Using the Storage Gateway Console The procedure for deleting a gateway is the same for all gateway types. However, depending on the type of gateway you want to delete and the host the gateway is deployed on, you might have to perform additional tasks to remove resources associated with the gateway. Removing these resources helps you avoid paying for resources you don't plan to use. Note For gateways deployed on an Amazon EC2 instance, the instance continues to exist until you delete it. For gateways deployed on a virtual machine (VM), after you delete your gateway the gateway VM still exists in your virtualization environment. To remove the VM, use the VMware vSphere client, Microsoft Hyper-V Manager, or Linux Kernel-based Virtual Machine (KVM) client to connect to the host and remove the VM. Note that you can't reuse the deleted gateway's VM to activate a new gateway. To delete a gateway 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. Choose Gateways, then select one or more gateways to delete. Deleting your gateway and removing resources API Version 2021-03-31 138 AWS Storage Gateway Amazon FSx File Gateway User Guide 3. For Actions, choose Delete gateway. The conﬁrmation dialog box appears. Warning Before you do this step, make sure that there are no applications currently writing to the gateway's volumes. If you delete the gateway while it is in use, data loss can occur. When a gateway is deleted, there is no way to get it back. 4. Verify that you want to delete the speciﬁed gateways, then type the word delete in the conﬁrmation box, and choose Delete. 5. (Optional) If you want to provide feedback about your deleted gateway, complete the feedback dialog box, then choose Submit. Otherwise, choose Skip. Important You no longer pay software charges after you delete a gateway, but resources such as Amazon S3 bucket and Amazon EC2 instances persist. You can remove the gateway Amazon EC2 instance after the ﬁle gateway is removed. Deleting Your Gateway by Using the Storage Gateway Console API Version 2021-03-31 139 AWS Storage Gateway Amazon FSx File Gateway User Guide Performance and optimization This section describes guidance and best practices for optimizing File Gateway performance. Topics • Basic performance guidance for FSx File Gateway • Optimizing gateway performance • Maximizing S3 File Gateway throughput Basic performance guidance for FSx File Gateway In this section, you can ﬁnd guidance for provisioning hardware for your FSx File Gateway VM. The instance conﬁgurations that are listed in the table are examples, and are provided for reference. For best performance, the cache disk size must be tuned to the size of the active working set. Using multiple local disks for the cache increases write performance by parallelizing access to data and leads to higher IOPS. Note We don't recommend using ephemeral storage. For information about using ephemeral storage, see Using
storagegateway-fsxfile-ug-052	storagegateway-fsxfile-ug.pdf	52	gateway performance • Maximizing S3 File Gateway throughput Basic performance guidance for FSx File Gateway In this section, you can ﬁnd guidance for provisioning hardware for your FSx File Gateway VM. The instance conﬁgurations that are listed in the table are examples, and are provided for reference. For best performance, the cache disk size must be tuned to the size of the active working set. Using multiple local disks for the cache increases write performance by parallelizing access to data and leads to higher IOPS. Note We don't recommend using ephemeral storage. For information about using ephemeral storage, see Using ephemeral storage with EC2 gateways. The suggested size limit for individual directories in the ﬁle systems that you connect to File Gateway is 10,000 ﬁles per directory. You can use File Gateway with directories that have more than 10,000 ﬁles, but performance might be impacted. In the following tables, cache hit read operations are reads from the ﬁle data that is served from cache. Cache miss read operations are reads from the ﬁle data that is served from Amazon FSx for Windows File Server. The following table shows an example FSx File Gateway conﬁguration. Basic performance guidance for FSx File Gateway API Version 2021-03-31 140 AWS Storage Gateway Amazon FSx File Gateway User Guide FSx File Gateway performance on Windows clients Example Conﬁguration Protocol Write throughput (ﬁle Cache hit read throughput Cache miss read throughput sizes 1 GB) Root disk: 80 GB, io1 SSD, 4,000 SMBv3 - 1 thread 162 MiB/sec (1.4 Gbps) 403 MiB/sec (3.4 Gbps) 288 MiB/sec (2.4 Gbps) SMBv3 - 8 threads 511 MiB/sec (4.3 Gbps) 571 MiB/sec (4.8 Gbps) 567 MiB/sec (4.8 Gbps) IOPS Cache disks: 2 x 2 TiB NVME Minimum network performance: 10 Gbps CPU: 32 vCPU \| RAM: 244 GB Note Your performance might vary based on your host platform conﬁguration and network bandwidth. Write throughput performance decreases with ﬁle size, with the highest achievable throughput for small ﬁles (less than 32MiB) being 16 ﬁles per second. Optimizing gateway performance You can ﬁnd information following about how to optimize the performance of your gateway. The guidance is based on adding resources to your gateway and adding resources to your application server. FSx File Gateway performance on Windows clients API Version 2021-03-31 141 AWS Storage Gateway Amazon FSx File Gateway User Guide Add Resources to Your Gateway You can optimize gateway performance by adding resources to your gateway in one or more of the following ways. Use higher-performance disks To optimize gateway performance, you can add high-performance disks such as solid-state drives (SSDs) and a NVMe controller. You can also attach virtual disks to your VM directly from a storage area network (SAN) instead of the Microsoft Hyper-V NTFS. Improved disk performance generally results in better throughput and more input/output operations per second (IOPS). For information about adding disks, see Conﬁguring additional cache storage. To measure throughput, use the ReadBytes and WriteBytes metrics with the Samples Amazon CloudWatch statistic. For example, the Samples statistic of the ReadBytes metric over a sample period of 5 minutes divided by 300 seconds gives you the IOPS. As a general rule, when you review these metrics for a gateway, look for low throughput and low IOPS trends to indicate disk-related bottlenecks. Note CloudWatch metrics are not available for all gateways. For information about gateway metrics, see Monitoring your FSx File Gateway. Add CPU resources to your gateway host The minimum requirement for a gateway host server is four virtual processors. To optimize gateway performance, conﬁrm that the four virtual processors that are assigned to the gateway VM are backed by four cores. In addition, conﬁrm that you are not oversubscribing the CPUs of the host server. When you add additional CPUs to your gateway host server, you increase the processing capability of the gateway. Doing this allows your gateway to deal with, in parallel, both storing data from your application to your local storage and uploading this data to FSx for Windows File Server. Additional CPUs also help ensure that your gateway gets enough CPU resources when the host is shared with other VMs. Providing enough CPU resources has the general eﬀect of improving throughput. Add Resources to Your Gateway API Version 2021-03-31 142 AWS Storage Gateway Amazon FSx File Gateway User Guide Storage Gateway supports using 24 CPUs in your gateway host server. You can use 24 CPUs to signiﬁcantly improve the performance of your gateway. We recommend the following gateway conﬁguration for your gateway host server: • 24 CPUs. • 16 GiB of reserved RAM for File Gateways • 16 GiB of reserved RAM for gateways with cache size up to 16 TiB • 32 GiB of reserved RAM for gateways with cache size 16 TiB to 32 TiB • 48 GiB of reserved RAM for
storagegateway-fsxfile-ug-053	storagegateway-fsxfile-ug.pdf	53	Your Gateway API Version 2021-03-31 142 AWS Storage Gateway Amazon FSx File Gateway User Guide Storage Gateway supports using 24 CPUs in your gateway host server. You can use 24 CPUs to signiﬁcantly improve the performance of your gateway. We recommend the following gateway conﬁguration for your gateway host server: • 24 CPUs. • 16 GiB of reserved RAM for File Gateways • 16 GiB of reserved RAM for gateways with cache size up to 16 TiB • 32 GiB of reserved RAM for gateways with cache size 16 TiB to 32 TiB • 48 GiB of reserved RAM for gateways with cache size 32 TiB to 64 TiB • Disk 1 attached to paravirtual controller 1, to be used as the gateway cache as follows: • SSD using an NVMe controller. • Network adapter 1 conﬁgured on VM network 1: • Use VM network 1 and add VMXnet3 (10 Gbps) to be used for ingestion. • Network adapter 2 conﬁgured on VM network 2: • Use VM network 2 and add a VMXnet3 (10 Gbps) to be used to connect to AWS. Back gateway virtual disks with separate physical disks When you provision gateway disks, we strongly recommend that you don't provision local disks for local storage that use the same underlying physical storage disk. For example, for VMware ESXi, the underlying physical storage resources are represented as a data store. When you deploy the gateway VM, you choose a data store on which to store the VM ﬁles. When you provision a virtual disk (for example, as an upload buﬀer), you can store the virtual disk in the same data store as the VM or a diﬀerent data store. If you have more than one data store, then we strongly recommend that you choose one data store for each type of local storage you are creating. A data store that is backed by only one underlying physical disk can lead to poor performance. An example is when you use such a disk to back both the cache storage and upload buﬀer in a gateway setup. Similarly, a data store that is backed by a less high-performing RAID conﬁguration such as RAID 1 can lead to poor performance. Add Resources to Your Gateway API Version 2021-03-31 143 AWS Storage Gateway Amazon FSx File Gateway User Guide Add Resources to Your Application Environment Increase the bandwidth between your application server and your gateway To optimize gateway performance, ensure that the network bandwidth between your application and the gateway can sustain your application needs. You can use the ReadBytes and WriteBytes metrics of the gateway to measure the total data throughput. For your application, compare the measured throughput with the desired throughput. If the measured throughput is less than the desired throughput, then increasing the bandwidth between your application and gateway can improve performance if the network is the bottleneck. Similarly, you can increase the bandwidth between your VM and your local disks, if they're not direct-attached. Add CPU resources to your application environment If your application can use additional CPU resources, then adding more CPUs can help your application to scale its I/O load. Some ﬁle operations on the FSx File Gateway, such as top-level folder renames or permission changes, can result in multiple ﬁle operations that lead to a high I/O load on your FSx for Windows File Server ﬁle system. If your ﬁle system doesn't have enough performance resources for your workload, the ﬁle system might delete shadow copies because it prioritizes availability for ongoing I/O over historical shadow copy retention. In the Amazon FSx console, check the Monitoring and performance page to see if your ﬁle system is under-provisioned. If it is, you can switch to SSD storage, increase throughput capacity, or increase SSD IOPS to handle your workload. Maximizing S3 File Gateway throughput The the following sections describe best practices for maximizing throughput between your NFS and SMB clients, S3 File Gateway, and Amazon S3. The guidance provided in each section contributes incrementally to improving overall throughput. While none of these recommendations are required, and they are not interdependent, they have been selected and ordered in a logical way that Support uses to test and tune S3 File Gateway implementations. As you implement and test these suggestions, keep in mind that each S3 File Gateway deployment is unique, so your results may vary. Add Resources to Your Application Environment API Version 2021-03-31 144 AWS Storage Gateway Amazon FSx File Gateway User Guide S3 File Gateway provides a ﬁle interface to store and retrieve Amazon S3 objects using industry- standard NFS or SMB ﬁle protocols, with a native 1:1 mapping between ﬁle and object. You deploy S3 File Gateway as a virtual machine either on-premises in your VMware, Microsoft Hyper-V, or Linux KVM environment, or in the
storagegateway-fsxfile-ug-054	storagegateway-fsxfile-ug.pdf	54	S3 File Gateway implementations. As you implement and test these suggestions, keep in mind that each S3 File Gateway deployment is unique, so your results may vary. Add Resources to Your Application Environment API Version 2021-03-31 144 AWS Storage Gateway Amazon FSx File Gateway User Guide S3 File Gateway provides a ﬁle interface to store and retrieve Amazon S3 objects using industry- standard NFS or SMB ﬁle protocols, with a native 1:1 mapping between ﬁle and object. You deploy S3 File Gateway as a virtual machine either on-premises in your VMware, Microsoft Hyper-V, or Linux KVM environment, or in the AWS cloud as an Amazon EC2 instance. S3 File Gateway is not designed to act as a full enterprise NAS replacement. S3 File Gateway emulates a ﬁle system, but it is not a ﬁle system. Using Amazon S3 as durable backend storage creates additional overhead on each I/O operation, so evaluating S3 File Gateway performance against an existing NAS or ﬁle server is not an equivalent comparison. Deploy your gateway in the same location as your clients We recommend deploying your S3 File Gateway virtual appliance in a physical location with as little network latency as possible between it and your NFS or SMB clients. When choosing a location for your gateway, consider the following: • Lower network latency to the gateway can help improve performance of NFS or SMB clients. • S3 File Gateway is designed to tolerate higher network latency between the gateway and Amazon S3 than between the gateway and the clients. • For S3 File Gateway instances deployed in Amazon EC2, we recommend keeping the gateway and NFS or SMB clients in the same placement group. For more information, see Placement groups for your Amazon EC2 instances in the Amazon Elastic Compute Cloud User Guide. Reduce bottlenecks caused by slow disks We recommend monitoring the IoWaitPercent CloudWatch metric to identify performance bottlenecks that can result from slow storage disks on your S3 File Gateway. When attempting to optimize disk-related performance issues, consider the following: • IoWaitPercent reports the percentage of time that the CPU is waiting for a response from the root or cache disks. • When IoWaitPercent is greater than 5-10%, this usually indicates a gateway performance bottleneck caused by underperforming disks. This metric should be as close to 0% as possible - meaning that the gateway is never waiting on the disk - which helps to optimize CPU resources. • You can check IoWaitPercent on the Monitoring tab of the Storage Gateway console, or conﬁgure recommended CloudWatch alarms to notify you automatically if the metric spikes above a speciﬁc threshold. For more information, see Creating recommended CloudWatch alarms for your gateway. Deploy your gateway in the same location as your clients API Version 2021-03-31 145 AWS Storage Gateway Amazon FSx File Gateway User Guide • We recommend using either NVMe or SSD for your gateway's root and cache disks to minimize IoWaitPercent. Adjust virtual machine resource allocation for CPU, RAM, and cache disks When attempting to optimize throughput for your S3 File Gateway, it is important to allocate suﬃcient resources to the gateway VM, including CPU, RAM, and cache disks. The minimum virtual resource requirements of 4 CPUs, 16GB RAM, and 150GB cache storage are typically only suitable for smaller workloads. When allocating virtual resources for larger workloads, we recommend the following: • Increase the allocated number of CPUs to between 16 and 48, depending on the typical CPU usage generated by your S3 File Gateway. You can monitor CPU usage using the UserCpuPercent metric. For more information, see Understanding gateway metrics. • Increase the allocated RAM to between 32 and 64 GB. Note S3 File Gateway cannot utilize more than 64 GB of RAM. • Use NVMe or SSD for root disks and cache disk, and size your cache disks to align with the peak working data set that you plan to write to the gateway. For more information, see S3 File Gateway cache sizing best practices on the oﬃcial Amazon Web Services YouTube channel. • Add at least 4 virtual cache disks to the gateway, rather than using a single large disk. Multiple virtual disks can improve performance even if they share the same underlying physical disk, but improvements are typically greater when the virtual disks are located on diﬀerent underlying physical disks. For example, if you want to deploy 12TB of cache, you could use one of the following conﬁgurations: • 4 x 3 TB cache disks • 8 x 1.5 TB cache disks • 12 x 1 TB cache disks Adjust virtual machine resource allocation for CPU, RAM, and cache disks API Version 2021-03-31 146 AWS Storage Gateway Amazon FSx File Gateway User Guide In addition to performance, this allows for more eﬃcient management of the virtual machine over time.
storagegateway-fsxfile-ug-055	storagegateway-fsxfile-ug.pdf	55	the same underlying physical disk, but improvements are typically greater when the virtual disks are located on diﬀerent underlying physical disks. For example, if you want to deploy 12TB of cache, you could use one of the following conﬁgurations: • 4 x 3 TB cache disks • 8 x 1.5 TB cache disks • 12 x 1 TB cache disks Adjust virtual machine resource allocation for CPU, RAM, and cache disks API Version 2021-03-31 146 AWS Storage Gateway Amazon FSx File Gateway User Guide In addition to performance, this allows for more eﬃcient management of the virtual machine over time. As your workload changes, you can incrementally increase the number of cache disks and your overall cache capacity, while maintaining the original size of each individual virtual disk to preserve gateway integrity. For more information, see Deciding the amount of local disk storage. When deploying S3 File Gateway as an Amazon EC2 instance, consider the following: • The instance type you choose can signiﬁcantly impact gateway performance. Amazon EC2 provides broad ﬂexibility for adjusting the resource allocation for your S3 File Gateway instance. • For recommended Amazon EC2 instance types for S3 File Gateway, see Requirements for Amazon EC2 instance types. • You can change the Amazon EC2 instance type that hosts an active S3 File Gateway. This allows you to easily adjust the Amazon EC2 hardware generation and resource allocation to ﬁnd an ideal price-to-performance ratio. To change the instance type, use the following procedure in the Amazon EC2 console: 1. Stop the Amazon EC2 instance. 2. Change the Amazon EC2 instance type. 3. Power on the Amazon EC2 instance. Note Stopping an instance that hosts an S3 File Gateway will temporarily disrupt ﬁle share access. Make sure to schedule a maintenance window if necessary. • The price-to-performance ratio of an Amazon EC2 instance refers to how much computing power you get for the price you pay. Typically, newer generation Amazon EC2 instances oﬀer the best price-to-performance ratio, with newer hardware and improved performance at a relatively lower cost compared to older generations. Factors such as instance type, region, and usage patterns impact this ratio, so it is important to select the right instance for your speciﬁc workload to optimize cost-eﬀectiveness. Adjust virtual machine resource allocation for CPU, RAM, and cache disks API Version 2021-03-31 147 AWS Storage Gateway Amazon FSx File Gateway User Guide Adjust the SMB security level The SMBv3 protocol allows for both SMB signing and SMB encryption, which have some trade- oﬀs in performance and security. To optimize throughput, you can adjust your gateway's SMB security level to specify which of these security features are enforced for client connections. For more information, see Set a security level for your gateway. When adjusting the SMB security level, consider the following: • The default security level for S3 File Gateway is Enforce encryption. This setting enforces both encryption and signing for SMB client connections to gateway ﬁle shares, meaning that all traﬃc from the client to the gateway is encrypted. This setting does not aﬀect traﬃc from the gateway to AWS, which is always encrypted. The gateway limits each encrypted client connection to a single vCPU. For example, if you have only 1 encrypted client, then that client will be limited to only 1 vCPU, even if 4 or more vCPUs are allocated to the gateway. Because of this, throughput for encrypted connections from a single client to S3 File Gateway is typically bottlenecked between 40-60 MB/s. • If your security requirements allow for a more relaxed posture, you can change the security level to Client negotiated, which will disable SMB encryption and enforce SMB signing only. With this setting, client connections to the gateway can utilize multiple vCPUs, which typically results in increased throughput performance. Note After you change the SMB security level for your S3 File Gateway, you must wait for the ﬁle share status to change from Updating to Available in the Storage Gateway console, and then disconnect and reconnect your SMB clients for the new setting to take eﬀect. Use multiple threads and clients to parallelize write operations It is diﬃcult to achieve maximum throughput performance with an S3 File Gateway that uses only one NFS or SMB client to write one ﬁle at a time, because sequential writing from a single client is a single-threaded operation. Instead, we recommend using multiple threads from each NFS or SMB client to write multiple ﬁles in parallel, and using multiple NFS or SMB clients simultaneously to your S3 File Gateway to maximize the gateway throughput. Adjust the SMB security level API Version 2021-03-31 148 AWS Storage Gateway Amazon FSx File Gateway User Guide Using multiple threads can signiﬁcantly improve performance. However, using more threads requires more system resources, which can negatively impact performance if the
storagegateway-fsxfile-ug-056	storagegateway-fsxfile-ug.pdf	56	only one NFS or SMB client to write one ﬁle at a time, because sequential writing from a single client is a single-threaded operation. Instead, we recommend using multiple threads from each NFS or SMB client to write multiple ﬁles in parallel, and using multiple NFS or SMB clients simultaneously to your S3 File Gateway to maximize the gateway throughput. Adjust the SMB security level API Version 2021-03-31 148 AWS Storage Gateway Amazon FSx File Gateway User Guide Using multiple threads can signiﬁcantly improve performance. However, using more threads requires more system resources, which can negatively impact performance if the gateway is not sized to meet the increased load. In a typical deployment, you can expect to achieve better throughput performance as you add more threads and clients, until you reach the maximum hardware and bandwidth limitations for your gateway. We recommend experimenting with diﬀerent thread counts to ﬁnd the optimal balance between speed and system resource usage for your speciﬁc hardware and network conﬁguration. Consider the following information about common tools that can help you test your thread and client conﬁguration: • You can test multithreaded write performance by using tools such as robocopy to copy a set of ﬁles to a ﬁle share on your gateway. By default, robocopy uses 8 threads when copying ﬁles, but you can specify up to 128 threads. To use multiple threads with robocopy, add the /MT:n switch to your command, where n is the number of threads you want to use. For example: robocopy C:\source D:\destination /MT:64 This command will use 64 threads for the copy operation. Note We don't recommend using Windows Explorer to drag and drop ﬁles when testing for maximum throughput, as this method is limited to a single thread and copies the ﬁles sequentially. For more information, see robocopy on the Microsoft Learn website. • You can also conduct tests using common storage benchmarking tools such as DISKSPD, or FIO. These tools have options to adjust the number of threads, I/O depth, and other parameters to match your speciﬁc workload requirements. DiskSpd allows you to control the number of threads using the -t parameter. For example: diskspd -c10G -d300 -r -w50 -t64 -o32 -b1M -h -L C:\testfile.dat This example command does the following: Use multiple threads and clients to parallelize write operations API Version 2021-03-31 149 AWS Storage Gateway Amazon FSx File Gateway User Guide • Creates a 10GB test ﬁle (-c1G) • Runs for 300 seconds (-d300) • Performs random I/O test with 50% reads 50% writes (-r -w50) • Uses 64 threads (-t64) • Sets queue depth to 32 per thread (-o32) • Uses 1MB block size (-b1M) • Disables hardware and software caching (-h -L) For more information, see Use DISKSPD to test workload storage performance on the Microsoft Learn website. • FIO uses the numjobs parameter to control the number of parallel threads. For example: fio --name=mixed_test --rw=randrw --rwmixread=70 --bs=1M -- iodepth=64 --size=10G --runtime=300 --numjobs=64 --ioengine=libaio --direct=1 -- group_reporting This example command does the following: • Performs random I/O test (--rw=randrw) • Performs 70% reads and 30% writes (--rwmixread=70) • Uses 1MB block size (--bs=1M) • Sets I/O depth to 64 (--iodepth=64) • Tests on a 10 GB ﬁle (--size=10G) • Runs for 5 minutes (--runtime=300) • Creates 64 parallel jobs (threads) (--numjobs=64) • Uses asynchronous I/O engine (--ioengine=libaio) • Groups results for easier analysis (--group_reporting) For more information, see the ﬁo Linux man page. • Turn oﬀ automated cache refresh The automated cache refresh feature allows your S3 File Gateway to refresh its metadata automatically, which can help capture any changes that users or applications make to your ﬁle Turn oﬀ automated cache refresh API Version 2021-03-31 150 AWS Storage Gateway Amazon FSx File Gateway User Guide set by writing to the Amazon S3 bucket directly, rather than through the gateway. For more information, see Refreshing Amazon S3 bucket object cache. To optimize gateway throughput, we recommend turning this feature oﬀ in deployments where all reads and writes to the Amazon S3 bucket will be performed through your S3 File Gateway. When conﬁguring automated cache refresh, consider the following: • If you need to use automated cache refresh because users or applications in your deployment do occasionally write to Amazon S3 directly, then we recommend conﬁguring the longest possible time interval between refreshes that is still practical for your business needs. A longer cache refresh interval helps reduce the number of metadata operations that the gateway needs to perform when browsing directories or modifying ﬁles. For example: set automated cache refresh to 24 hours, rather than 5 minutes, if that is tolerable for your workload. • The minimum time interval is 5 minutes. The maximum interval is 30 days. • If you choose to set a very short cache refresh interval, we recommend
storagegateway-fsxfile-ug-057	storagegateway-fsxfile-ug.pdf	57	your deployment do occasionally write to Amazon S3 directly, then we recommend conﬁguring the longest possible time interval between refreshes that is still practical for your business needs. A longer cache refresh interval helps reduce the number of metadata operations that the gateway needs to perform when browsing directories or modifying ﬁles. For example: set automated cache refresh to 24 hours, rather than 5 minutes, if that is tolerable for your workload. • The minimum time interval is 5 minutes. The maximum interval is 30 days. • If you choose to set a very short cache refresh interval, we recommend testing the directory browsing experience for your NFS and SMB clients. The time it takes to refresh the gateway cache can increase substantially depending on the number of ﬁles and subdirectories in your Amazon S3 bucket. Increase the number of Amazon S3 uploader threads By default, S3 File Gateway opens 8 threads for Amazon S3 data upload, which provides suﬃcient upload capacity for most typical deployments. However, it is possible for a gateway to receive data from NFS and SMB clients at a higher rate than it can upload to Amazon S3 with the standard 8 thread capacity, which can cause the local cache to reach its storage limit. In speciﬁc circumstances, Support can increase the Amazon S3 upload thread pool count for your gateway from 8 to 40, which allows more data to be uploaded in parallel. Depending on bandwidth and other factors speciﬁc to your deployment, this can signiﬁcantly increase upload performance and help reduce the amount of cache storage needed to support your workload. We recommend using the CachePercentDirty CloudWatch metric to monitor the amount of data stored on the local gateway cache disks that has not yet been uploaded to Amazon S3, and contacting Support to help determine if increasing the upload thread pool count might improve throughput for your S3 File Gateway. For more information, see Understanding gateway metrics. Increase the number of Amazon S3 uploader threads API Version 2021-03-31 151 AWS Storage Gateway Amazon FSx File Gateway User Guide Note This setting consumes additional gateway CPU resources. We recommend monitoring gateway CPU usage and increasing allocated CPU resources if necessary. Increase SMB timeout settings When S3 File Gateway copies large ﬁles to an SMB ﬁle share, the SMB client connection can timeout after an extended period of time. We recommend extending the SMB session timeout setting for your SMB clients to 20 minutes or more, depending on the size of the ﬁles and the write speed of your gateway. The default is 300 seconds, or 5 minutes. For more information, see Your gateway backup job fails or there are errors when writing to your gateway. Turn on opportunistic locking for compatible applications Opportunistic locking, or "oplocks", is enabled by default for each new S3 File Gateway. When using oplocks with compatible applications, the client batches multiple smaller operations into larger ones, which is more eﬃcient for the client, the gateway, and the network. We recommend keeping opportunistic locking turned on if you use applications that leverage client-side local caching, such as Microsoft Oﬃce, Adobe Suite, and many others, because it can signiﬁcanty improve performance. If you turn opportunistic locking oﬀ, applications that support oplocks will typically open large ﬁles (50 MB or larger) much more slowly. This delay occurs because the gateway sends data in 4 KB parts, which results in high I/O and low throughput. Adjust gateway capacity according to the size of the working ﬁle set The gateway capacity parameter speciﬁes the maximum number of ﬁles for which your gateway will store metadata in its local cache. By default, gateway capacity is set to Small, which means the gateway stores metadata for up to 5 million ﬁles. The default setting works well for most workloads, even if there are hundreds of millions, or even billions of objects in Amazon S3, because only a small subset of ﬁles are actively accessed at a given time in a typical deployment. This group of ﬁles is referred to as the "working set". Increase SMB timeout settings API Version 2021-03-31 152 AWS Storage Gateway Amazon FSx File Gateway User Guide If your workload regularly accesses a working set of ﬁles greater than 5 million, then your gateway will need to perform frequent cache evictions, which are small I/O operations that are stored in RAM and persisted on the root disk. This can negatively impact gateway performance as the gateway fetches fresh data from Amazon S3. You can monitor the IndexEvictions metric to determine the number of ﬁles whose metadata was evicted from the cache to make room for new entries. For more information, see Understanding gateway metrics. We recommend using the UpdateGatewayInformation API action to increase the gateway capacity to correspond with the number of ﬁles
storagegateway-fsxfile-ug-058	storagegateway-fsxfile-ug.pdf	58	working set of ﬁles greater than 5 million, then your gateway will need to perform frequent cache evictions, which are small I/O operations that are stored in RAM and persisted on the root disk. This can negatively impact gateway performance as the gateway fetches fresh data from Amazon S3. You can monitor the IndexEvictions metric to determine the number of ﬁles whose metadata was evicted from the cache to make room for new entries. For more information, see Understanding gateway metrics. We recommend using the UpdateGatewayInformation API action to increase the gateway capacity to correspond with the number of ﬁles in your typical working set. For more information, see UpdateGatewayInformation. Note Increasing the gateway capacity requires additional RAM and root disk capacity. • Small (5 million ﬁles) requires at least 16 GB of RAM and 80 GB root disk. • Medium (10 million ﬁles) requires at least 32 GB of RAM and 160 GB root disk. • Large (20 million ﬁles) requires 64 GB of RAM and 240 GB root disk. Important Gateway capacity cannot be decreased. Deploy multiple gateways for larger workloads We recommend splitting your workload across multiple gateways when possible, rather than consolidating many ﬁle shares on a single large gateway. For example, you could isolate one heavily-used ﬁle share on one gateway, while grouping the less frequently used ﬁle shares together on another gateway. When planning a deployment with multiple gateways and ﬁle shares, consider the following: • The maximum number of ﬁle shares on a single gateway is 50, but the number of ﬁle shares managed by a gateway can impact the gateway's performance. For more information, see Performance guidance for gateways with multiple ﬁle shares. Deploy multiple gateways for larger workloads API Version 2021-03-31 153 AWS Storage Gateway Amazon FSx File Gateway User Guide • Resources on each S3 File Gateway are shared across all ﬁle shares, without partitioning. • A single ﬁle share with heavy usage can impact the performance of other ﬁle shares on the gateway. Note We do not recommended creating multiple ﬁle shares that are mapped to the same Amazon S3 location from multiple gateways, unless at least one of them is read-only. Simultaneous writes to the same ﬁle from multiple gateways is considered a multi-writer scenario, which can cause data integrity issues. Deploy multiple gateways for larger workloads API Version 2021-03-31 154 AWS Storage Gateway Amazon FSx File Gateway User Guide Security in AWS Storage Gateway Cloud security at AWS is the highest priority. As an AWS customer, you beneﬁt 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 eﬀectiveness of our security as part of the AWS Compliance Programs. To learn about the compliance programs that apply to AWS Storage Gateway, 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 Storage Gateway. The following topics show you how to conﬁgure Storage Gateway to meet your security and compliance objectives. You also learn how to use other AWS services that help you to monitor and secure your Storage Gateway resources. Data protection in AWS Storage Gateway The AWS shared responsibility model applies to data protection in AWS Storage Gateway. 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 conﬁguration 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 fulﬁll their job duties. We also recommend that you secure your data in the following ways: Data protection API Version 2021-03-31 155 AWS Storage Gateway Amazon FSx File
storagegateway-fsxfile-ug-059	storagegateway-fsxfile-ug.pdf	59	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 fulﬁll their job duties. We also recommend that you secure your data in the following ways: Data protection API Version 2021-03-31 155 AWS Storage Gateway Amazon FSx File Gateway User Guide • 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 conﬁdential or sensitive information, such as your customers' email addresses, into tags or free-form text ﬁelds such as a Name ﬁeld. This includes when you work with Storage Gateway or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into tags or free-form text ﬁelds 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 encryption using AWS KMS Amazon FSx File Gateway supports SMB encryption up to the latest SMB v3.1.1 speciﬁcation, including AES 128 CCM and AES 128 GCM. Compatible clients will connect using encryption automatically. Additionally, FSx File Gateway uses SMB encryption when it communicates with FSx for Windows File Server in AWS. You must conﬁgure an AWS Direct Connect link to AWS, and set appropriate policies to allow SMB traﬃc and management traﬃc to pass through to AWS. Encrypting a ﬁle system For information see, Data Encryption in Amazon FSx in the Amazon FSx for Windows File Server User Guide. When using AWS KMS to encrypt your data, keep the following in mind: • Your data is encrypted at rest in the cloud. That is, the data is encrypted in Amazon FSx. Data encryption API Version 2021-03-31 156 AWS Storage Gateway Amazon FSx File Gateway User Guide • IAM users must have the required permissions to call the AWS KMS API operations. For more information, see Using IAM policies with AWS KMS in the AWS Key Management Service Developer Guide. Important When you use an AWS KMS key for server-side encryption, you must choose a symmetric key. Storage Gateway does not support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the AWS Key Management Service Developer Guide. For more information about AWS KMS, see What is AWS Key Management Service? Identity and access management for AWS Storage Gateway 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 AWS SGW resources. IAM is an AWS service that you can use with no additional charge. Topics • Audience • Authenticating with identities • Managing access using policies • How AWS Storage Gateway works with IAM • Identity-based policy examples for AWS Storage Gateway • Troubleshooting AWS Storage Gateway identity and access • Using tags to control access to your gateway and resources Audience How you use AWS Identity and Access Management (IAM) diﬀers, depending on the work that you do in AWS SGW. Service user – If you use the AWS SGW service to do your job, then your administrator provides you with the credentials and permissions that you need. As you use more AWS SGW features to do your Identity and access management API Version 2021-03-31 157 AWS Storage Gateway Amazon FSx File Gateway User Guide 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 AWS SGW, see Troubleshooting AWS Storage Gateway identity and access. Service administrator – If you're in charge of AWS SGW resources
storagegateway-fsxfile-ug-060	storagegateway-fsxfile-ug.pdf	60	If you use the AWS SGW service to do your job, then your administrator provides you with the credentials and permissions that you need. As you use more AWS SGW features to do your Identity and access management API Version 2021-03-31 157 AWS Storage Gateway Amazon FSx File Gateway User Guide 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 AWS SGW, see Troubleshooting AWS Storage Gateway identity and access. Service administrator – If you're in charge of AWS SGW resources at your company, you probably have full access to AWS SGW. It's your job to determine which AWS SGW 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 AWS SGW, see How AWS Storage Gateway 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 AWS SGW. To view example AWS SGW identity-based policies that you can use in IAM, see Identity-based policy examples for AWS Storage Gateway. 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 Authenticating with identities API Version 2021-03-31 158 AWS Storage Gateway Amazon FSx File Gateway User Guide 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
storagegateway-fsxfile-ug-061	storagegateway-fsxfile-ug.pdf	61	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 speciﬁc 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 speciﬁc 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. An IAM group is an identity that speciﬁes 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 Authenticating with identities API Version 2021-03-31 159 AWS Storage Gateway Amazon FSx File Gateway User Guide 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 diﬀerent 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 speciﬁc permissions. It is similar to an IAM user, but is not associated with a speciﬁc 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 deﬁne permissions for the role. When a federated identity authenticates, the identity is associated with the role and is granted the permissions that are deﬁned 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 conﬁgure 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 diﬀerent permissions for a speciﬁc task. • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a diﬀerent 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 diﬀerence 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 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. Authenticating with identities API Version 2021-03-31 160 AWS Storage Gateway Amazon FSx File Gateway User Guide • 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 diﬀerent 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
storagegateway-fsxfile-ug-062	storagegateway-fsxfile-ug.pdf	62	2021-03-31 160 AWS Storage Gateway Amazon FSx File Gateway User Guide • 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 diﬀerent 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 create an instance proﬁle that is attached to the instance. An instance proﬁle 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, deﬁnes 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. 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. Managing access using policies API Version 2021-03-31 161 AWS Storage Gateway Amazon FSx File Gateway User Guide 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 deﬁne 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 Deﬁne 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 speciﬁc resource. For the resource where the policy is attached, the policy deﬁnes what actions a speciﬁed principal can perform on that resource and
storagegateway-fsxfile-ug-063	storagegateway-fsxfile-ug.pdf	63	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 speciﬁc resource. For the resource where the policy is attached, the policy deﬁnes what actions a speciﬁed 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 API Version 2021-03-31 162 AWS Storage Gateway Amazon FSx File Gateway User Guide Access control lists (ACLs) 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 ﬁeld 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 eﬀective 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 API Version 2021-03-31 163 AWS Storage Gateway Amazon FSx File Gateway 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 AWS Storage Gateway works with IAM Before you use IAM to manage access to AWS SGW, learn what IAM features are available to use with AWS SGW. IAM features you can use with AWS Storage Gateway IAM feature AWS SGW support Identity-based policies Resource-based policies Policy actions Policy resources Policy condition keys (service-speciﬁc) ACLs Yes No Yes Yes Yes No ABAC (tags in policies) Partial Temporary credentials Forward access sessions (FAS) Service roles Service-linked roles Yes Yes Yes Yes How AWS Storage Gateway works with IAM API Version 2021-03-31 164 AWS Storage Gateway Amazon FSx File Gateway User Guide To get a high-level view of how
storagegateway-fsxfile-ug-064	storagegateway-fsxfile-ug.pdf	64	Before you use IAM to manage access to AWS SGW, learn what IAM features are available to use with AWS SGW. IAM features you can use with AWS Storage Gateway IAM feature AWS SGW support Identity-based policies Resource-based policies Policy actions Policy resources Policy condition keys (service-speciﬁc) ACLs Yes No Yes Yes Yes No ABAC (tags in policies) Partial Temporary credentials Forward access sessions (FAS) Service roles Service-linked roles Yes Yes Yes Yes How AWS Storage Gateway works with IAM API Version 2021-03-31 164 AWS Storage Gateway Amazon FSx File Gateway User Guide To get a high-level view of how AWS SGW 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 AWS SGW 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 Deﬁne 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 AWS SGW To view examples of AWS SGW identity-based policies, see Identity-based policy examples for AWS Storage Gateway. Resource-based policies within AWS SGW 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 speciﬁc resource. For the resource where the policy is attached, the policy deﬁnes what actions a speciﬁed 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 AWS Storage Gateway works with IAM API Version 2021-03-31 165 AWS Storage Gateway Amazon FSx File Gateway User Guide are in diﬀerent 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 AWS SGW 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 AWS SGW actions, see Actions Deﬁned by AWS Storage Gateway in the Service Authorization Reference. Policy actions in AWS SGW use the following preﬁx before the action: sgw To specify multiple actions in a single statement, separate them with commas. "Action": [ "sgw:action1", "sgw:action2" ] To view examples of AWS SGW identity-based policies, see Identity-based policy examples for AWS Storage Gateway. How AWS Storage Gateway works with IAM API Version 2021-03-31 166 AWS Storage Gateway Amazon FSx File Gateway User Guide Policy resources for AWS SGW Supports policy resources: 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 Resource JSON policy element speciﬁes 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
storagegateway-fsxfile-ug-065	storagegateway-fsxfile-ug.pdf	65	identity-based policies, see Identity-based policy examples for AWS Storage Gateway. How AWS Storage Gateway works with IAM API Version 2021-03-31 166 AWS Storage Gateway Amazon FSx File Gateway User Guide Policy resources for AWS SGW Supports policy resources: 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 Resource JSON policy element speciﬁes 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 speciﬁc 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 AWS SGW resource types and their ARNs, see Resources Deﬁned by AWS Storage Gateway in the Service Authorization Reference. To learn with which actions you can specify the ARN of each resource, see Actions Deﬁned by AWS Storage Gateway . To view examples of AWS SGW identity-based policies, see Identity-based policy examples for AWS Storage Gateway. Policy condition keys for AWS SGW Supports service-speciﬁc 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 eﬀect. 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 AWS Storage Gateway works with IAM API Version 2021-03-31 167 AWS Storage Gateway Amazon FSx File Gateway 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-speciﬁc 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 AWS SGW condition keys, see Condition Keys for AWS Storage Gateway in the Service Authorization Reference. To learn with which actions and resources you can use a condition key, see Actions Deﬁned by AWS Storage Gateway . To view examples of AWS SGW identity-based policies, see Identity-based policy examples for AWS Storage Gateway. ACLs in AWS SGW 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 AWS SGW Supports ABAC (tags in policies): Partial Attribute-based access control (ABAC) is an authorization strategy that deﬁnes 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 ﬁrst 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 AWS Storage Gateway works with IAM API Version 2021-03-31 168 AWS Storage Gateway Amazon FSx File Gateway User Guide For more information about ABAC, see Deﬁne 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 AWS SGW 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
storagegateway-fsxfile-ug-066	storagegateway-fsxfile-ug.pdf	66	resource types, then the value is Partial. How AWS Storage Gateway works with IAM API Version 2021-03-31 168 AWS Storage Gateway Amazon FSx File Gateway User Guide For more information about ABAC, see Deﬁne 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 AWS SGW 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 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 AWS SGW 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 diﬀerent 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 AWS SGW Supports service roles: Yes How AWS Storage Gateway works with IAM API Version 2021-03-31 169 AWS Storage Gateway Amazon FSx File Gateway 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 AWS SGW functionality. Edit service roles only when AWS SGW provides guidance to do so. Service-linked roles for AWS SGW 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 service-linked roles, see AWS services that work with IAM. Find a service in the table that includes a Yes in the Service-linked role column. Choose the Yes link to view the service-linked role documentation for that service. Identity-based policy examples for AWS Storage Gateway By default, users and roles don't have permission to create or modify AWS SGW 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 deﬁned by AWS SGW, including the format of the ARNs for each of the resource types, see Actions, Resources, and Condition Keys for AWS Storage Gateway in the Service Authorization Reference. Topics Identity-based policy examples API Version 2021-03-31 170 AWS Storage Gateway • Policy best practices • Using the AWS SGW console • Allow users to view their own permissions Policy best practices Amazon FSx File Gateway User Guide Identity-based policies determine whether someone can create, access, or delete AWS SGW 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
storagegateway-fsxfile-ug-067	storagegateway-fsxfile-ug.pdf	67	Storage Gateway in the Service Authorization Reference. Topics Identity-based policy examples API Version 2021-03-31 170 AWS Storage Gateway • Policy best practices • Using the AWS SGW console • Allow users to view their own permissions Policy best practices Amazon FSx File Gateway User Guide Identity-based policies determine whether someone can create, access, or delete AWS SGW 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 deﬁning AWS customer managed policies that are speciﬁc 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 deﬁning the actions that can be taken on speciﬁc resources under speciﬁc 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 speciﬁc 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 API Version 2021-03-31 171 AWS Storage Gateway Amazon FSx File Gateway User Guide For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide. Using the AWS SGW console To access the AWS Storage Gateway console, you must have a minimum set of permissions. These permissions must allow you to list and view details about the AWS SGW 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 AWS SGW console, also attach the AWS SGW ConsoleAccess or ReadOnly 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 API Version 2021-03-31 172 AWS Storage Gateway Amazon FSx File Gateway User Guide "Effect": "Allow", "Action": [ "iam:GetGroupPolicy", "iam:GetPolicyVersion", "iam:GetPolicy", "iam:ListAttachedGroupPolicies", "iam:ListGroupPolicies", "iam:ListPolicyVersions", "iam:ListPolicies", "iam:ListUsers" ], "Resource": "" } ] } Troubleshooting AWS Storage Gateway identity and access Use the following information to help you diagnose and ﬁx common issues that you might encounter when working with AWS SGW and IAM. Topics • I am not authorized to perform an action in AWS SGW • I am not authorized to perform iam:PassRole • I want to allow people outside of my AWS account to
storagegateway-fsxfile-ug-068	storagegateway-fsxfile-ug.pdf	68	{ "Sid": "NavigateInConsole", Identity-based policy examples API Version 2021-03-31 172 AWS Storage Gateway Amazon FSx File Gateway User Guide "Effect": "Allow", "Action": [ "iam:GetGroupPolicy", "iam:GetPolicyVersion", "iam:GetPolicy", "iam:ListAttachedGroupPolicies", "iam:ListGroupPolicies", "iam:ListPolicyVersions", "iam:ListPolicies", "iam:ListUsers" ], "Resource": "*" } ] } Troubleshooting AWS Storage Gateway identity and access Use the following information to help you diagnose and ﬁx common issues that you might encounter when working with AWS SGW and IAM. Topics • I am not authorized to perform an action in AWS SGW • I am not authorized to perform iam:PassRole • I want to allow people outside of my AWS account to access my AWS SGW resources I am not authorized to perform an action in AWS SGW 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 ﬁctional my-example-widget resource but doesn't have the ﬁctional sgw:GetWidget permissions. User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: sgw:GetWidget on resource: my-example-widget Troubleshooting API Version 2021-03-31 173 AWS Storage Gateway Amazon FSx File Gateway User Guide In this case, the policy for the mateojackson user must be updated to allow access to the my- example-widget resource by using the sgw: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 AWS SGW. 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. The following example error occurs when an IAM user named marymajor tries to use the console to perform an action in AWS SGW. 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. Important Storage Gateway can assume existing service roles that are passed using the iam:PassRole policy action, but it does not support IAM policies that use the iam:PassedToService context key to limit the action to speciﬁc services. For more information, see the following topics in the AWS Identity and Access Management User Guide: • IAM: Pass an IAM role to a speciﬁc AWS service • Granting a user permissions to pass a role to an AWS service • Available keys for IAM Troubleshooting API Version 2021-03-31 174 AWS Storage Gateway Amazon FSx File Gateway User Guide I want to allow people outside of my AWS account to access my AWS SGW 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 AWS SGW supports these features, see How AWS Storage Gateway 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 diﬀerence 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 to control access to your gateway and resources To control access to gateway 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 gateway 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, see Controlling Access Using Tags. Controlling Access Based on Tags on a Resource To
storagegateway-fsxfile-ug-069	storagegateway-fsxfile-ug.pdf	69	see Cross account resource access in IAM in the IAM User Guide. Using tags to control access to your gateway and resources To control access to gateway 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 gateway 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, see Controlling Access Using Tags. Controlling Access Based on Tags on a Resource To control what actions a user or role can perform on a gateway resource, you can use tags on the gateway resource. For example, you might want to allow or deny speciﬁc API operations on a ﬁle gateway resource based on the key-value pair of the tag on the resource. Using tags to control access to resources API Version 2021-03-31 175 AWS Storage Gateway Amazon FSx File Gateway User Guide The following example allows a user or a role to perform the ListTagsForResource, ListFileShares, and DescribeNFSFileShares actions on all resources. The policy applies only if the tag on the resource has its key set to allowListAndDescribe and the value set to yes. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "storagegateway:ListTagsForResource", "storagegateway:ListFileShares", "storagegateway:DescribeNFSFileShares" ], "Resource": "", "Condition": { "StringEquals": { "aws:ResourceTag/allowListAndDescribe": "yes" } } }, { "Effect": "Allow", "Action": [ "storagegateway:" ], "Resource": "arn:aws:storagegateway:region:account-id:/" } ] } Controlling Access Based on Tags in an IAM Request To control what an user can do on a gateway resource, you can use conditions in an IAM policy based on tags. For example, you can write a policy that allows or denies an user the ability to perform speciﬁc API operations based on the tag they provided when they created the resource. In the following example, the ﬁrst statement allows a user to create a gateway only if the key- value pair of the tag they provided when creating the gateway is Department and Finance. When using the API operation, you add this tag to the activation request. Using tags to control access to resources API Version 2021-03-31 176 AWS Storage Gateway Amazon FSx File Gateway User Guide The second statement allows the user to create an Network File System (NFS) or Server Message Block (SMB) ﬁle share on a gateway only if the key-value pair of the tag on the gateway matches Departmentand Finance. Additionally, the user must add a tag to the ﬁle share, and the key-value pair of the tag must be Department and Finance. You add tags to a ﬁle share when creating the ﬁle share. There aren't permissions for the AddTagsToResource or RemoveTagsFromResource operations, so the user can't perform these operations on the gateway or the ﬁle share. { "Version":"2012-10-17", "Statement":[ { "Effect":"Allow", "Action":[ "storagegateway:ActivateGateway" ], "Resource":"", "Condition":{ "StringEquals":{ "aws:RequestTag/Department":"Finance" } } }, { "Effect":"Allow", "Action":[ "storagegateway:CreateNFSFileShare", "storagegateway:CreateSMBFileShare" ], "Resource":"", "Condition":{ "StringEquals":{ "aws:ResourceTag/Department":"Finance", "aws:RequestTag/Department":"Finance" } } } ] } Using tags to control access to resources API Version 2021-03-31 177 AWS Storage Gateway Amazon FSx File Gateway User Guide Compliance validation for AWS Storage Gateway Third-party auditors assess the security and compliance of AWS Storage Gateway as part of multiple AWS compliance programs. These include SOC, PCI, ISO, FedRAMP, HIPAA, MTCS, C5, K- ISMS, ENS High, OSPAR, and HITRUST CSF. For a list of AWS services in scope of speciﬁc compliance programs, see AWS Services in Scope by Compliance Program. 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 Storage Gateway 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 and Compliance Quick Start Guides – These deployment guides discuss architectural considerations and provide steps for deploying security- and compliance-focused baseline environments on AWS. • Architecting for HIPAA Security and Compliance Whitepaper – This whitepaper describes how companies can use AWS to create HIPAA-compliant applications. • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. • Evaluating resources with rules in the AWS Conﬁg Developer Guide – The AWS Conﬁg service assesses how well your resource conﬁgurations comply with internal practices, industry guidelines, and regulations. • AWS Security Hub – This AWS service provides a comprehensive view of your security state within AWS that helps you check your compliance with security industry standards and best practices. Resilience in AWS Storage Gateway The AWS global infrastructure is built around AWS Regions and Availability Zones. An AWS Region is a physical location around the world where data centers are clustered. Each
storagegateway-fsxfile-ug-070	storagegateway-fsxfile-ug.pdf	70	apply to your industry and location. • Evaluating resources with rules in the AWS Conﬁg Developer Guide – The AWS Conﬁg service assesses how well your resource conﬁgurations comply with internal practices, industry guidelines, and regulations. • AWS Security Hub – This AWS service provides a comprehensive view of your security state within AWS that helps you check your compliance with security industry standards and best practices. Resilience in AWS Storage Gateway The AWS global infrastructure is built around AWS Regions and Availability Zones. An AWS Region is a physical location around the world where data centers are clustered. Each group of logical data centers is called an Availability Zone (AZ). Each AWS Region consists of a minimum of three isolated and physically separate AZs within a geographic area. Unlike other cloud providers, who often deﬁne a region as a single data center, the multiple AZ design of every Compliance validation API Version 2021-03-31 178 AWS Storage Gateway Amazon FSx File Gateway User Guide AWS Region oﬀers distinct advantages. Each AZ has independent power, cooling, and physical security and is connected via redundant, ultra-low-latency networks. If your deployment requires a focus on high availability, you can conﬁgure services and resources to in multiple AZs to achieve greater fault-tolerance. AWS Regions meet the highest levels of infrastructure security, compliance, and data protection. All traﬃc between AZs is encrypted. The network performance is suﬃcient to accomplish synchronous replication between AZs. AZs make partitioning services and resources for high availability easy. If your deployment is partitioned across AZs, your resources are better isolated and protected from issues such as power outages, lightning strikes, tornadoes, earthquakes, and more. AZs are physically separated by a meaningful distance from any other AZ, although all are within 100 km (60 miles) of each other. For more information about AWS Regions and Availability Zones, see AWS Global Infrastructure. In addition to the AWS global infrastructure, Storage Gateway supports VMware vSphere High Availability (VMware HA) to help protect storage workloads against hardware, hypervisor, or network failures. For more information, see Using VMware vSphere High Availability with Storage Gateway. Infrastructure security in AWS Storage Gateway As a managed service, AWS Storage Gateway is protected by the AWS global network security procedures that are described in Security Pillar - AWS Well-Architected Framework. You use AWS published API calls to access Storage Gateway through the network. Clients must support Transport Layer Security (TLS) 1.2. Clients must also support cipher suites with perfect forward secrecy (PFS) such as Ephemeral Diﬃe-Hellman (DHE) or Elliptic Curve Ephemeral Diﬃe- Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes. Additionally, requests must be signed by using an access key ID and a secret access key that is associated with an IAM principal. Or you can use the AWS Security Token Service (AWS STS) to generate temporary security credentials to sign requests. Note You should treat the AWS Storage Gateway appliance as a managed virtual machine, and should not attempt to access or modify its installation in any way. Attempting to install scanning software or update any software packages using methods other than the normal Infrastructure security API Version 2021-03-31 179 AWS Storage Gateway Amazon FSx File Gateway User Guide gateway update mechanism, may cause the gateway to malfunction and could impact our ability to support or ﬁx the gateway. AWS reviews, analyzes, and remediates CVEs on a regular basis. We incorporate ﬁxes for these issues into Storage Gateway as part of our normal software release cycle. These ﬁxes are typically applied as part of the normal gateway update process during scheduled maintenance windows. For more information about gateway updates, see Managing gateway updates using the AWS Storage Gateway console. AWS Security Best Practices AWS provides a number of security features to consider as you develop and implement your own security policies. These best practices are general guidelines and don’t represent a complete security solution. Because these practices might not be appropriate or suﬃcient for your environment, treat them as helpful considerations rather than prescriptions. For more information, see AWS Security Best Practices. Logging and monitoring in AWS Storage Gateway Storage Gateway is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in Storage Gateway. CloudTrail captures all API calls for Storage Gateway as events. The calls captured include calls from the Storage Gateway console and code calls to the Storage Gateway API operations. If you create a trail, you can turn on continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Storage Gateway. If you don't conﬁgure 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
storagegateway-fsxfile-ug-071	storagegateway-fsxfile-ug.pdf	71	of actions taken by a user, role, or an AWS service in Storage Gateway. CloudTrail captures all API calls for Storage Gateway as events. The calls captured include calls from the Storage Gateway console and code calls to the Storage Gateway API operations. If you create a trail, you can turn on continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Storage Gateway. If you don't conﬁgure 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 Storage Gateway, 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. Storage Gateway information in CloudTrail CloudTrail is activated on your AWS account when you create the account. When activity occurs in Storage Gateway, 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. AWS Security Best Practices API Version 2021-03-31 180 AWS Storage Gateway Amazon FSx File Gateway User Guide For an ongoing record of events in your AWS account, including events for Storage Gateway, create a trail. A trail allows CloudTrail to deliver log ﬁles 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 ﬁles to the Amazon S3 bucket that you specify. Additionally, you can conﬁgure 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 • Conﬁguring Amazon SNS Notiﬁcations for CloudTrail • Receiving CloudTrail Log Files from Multiple Regions and Receiving CloudTrail Log Files from Multiple Accounts All of the Storage Gateway actions are logged and are documented in the Actions topic. For example, calls to the ActivateGateway, ListGateways, and ShutdownGateway actions generate entries in the CloudTrail log ﬁles. 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. Understanding Storage Gateway log ﬁle entries A trail is a conﬁguration that allows delivery of events as log ﬁles to an Amazon S3 bucket that you specify. CloudTrail log ﬁles 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 ﬁles aren't an ordered stack trace of the public API calls, so they don't appear in any speciﬁc order. The following example shows a CloudTrail log entry that demonstrates the action. Understanding Storage Gateway log ﬁle entries API Version 2021-03-31 181 AWS Storage Gateway Amazon FSx File Gateway User Guide { "Records": [{ "eventVersion": "1.02", "userIdentity": { "type": "IAMUser", "principalId": "AIDAII5AUEPBH2M7JTNVC", "arn": "arn:aws:iam::111122223333:user/StorageGateway-team/JohnDoe", "accountId": "111122223333", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "userName": "JohnDoe" }, "eventTime": "2014-12-04T16:19:00Z", "eventSource": "storagegateway.amazonaws.com", "eventName": "ActivateGateway", "awsRegion": "us-east-2", "sourceIPAddress": "192.0.2.0", "userAgent": "aws-cli/1.6.2 Python/2.7.6 Linux/2.6.18-164.el5", "requestParameters": { "gatewayTimezone": "GMT-5:00", "gatewayName": "cloudtrailgatewayvtl", "gatewayRegion": "us-east-2", "activationKey": "EHFBX-1NDD0-P0IVU-PI259- DHK88", "gatewayType": "VTL" }, "responseElements": { "gatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/cloudtrailgatewayvtl" }, "requestID": "54BTFGNQI71987UJD2IHTCT8NF1Q8GLLE1QEU3KPGG6F0KSTAUU0", "eventID": "635f2ea2-7e42-45f0- bed1-8b17d7b74265", "eventType": "AwsApiCall", "apiVersion": "20130630", "recipientAccountId": "444455556666" }] } The following example shows a CloudTrail log entry that demonstrates the ListGateways action. { "Records": [{ "eventVersion": "1.02", Understanding Storage Gateway log ﬁle entries API Version 2021-03-31 182 AWS Storage Gateway Amazon FSx File Gateway User Guide "userIdentity": { "type": "IAMUser", "principalId": "AIDAII5AUEPBH2M7JTNVC", "arn": "arn:aws:iam::111122223333:user/StorageGateway- team/JohnDoe", "accountId:" 111122223333", " accessKeyId ":" AKIAIOSFODNN7EXAMPLE", " userName ":" JohnDoe " }, " eventTime ":" 2014 - 12 - 03T19: 41: 53Z ", " eventSource ":" storagegateway.amazonaws.com ", " eventName ":" ListGateways ", " awsRegion ":" us-east-2 ", " sourceIPAddress ":" 192.0.2.0 ", " userAgent ":" aws - cli / 1.6.2 Python / 2.7.6 Linux / 2.6.18 - 164.el5 ", " requestParameters ":null, " responseElements ":null, "requestID ":" 6U2N42CU37KAO8BG6V1I23FRSJ1Q8GLLE1QEU3KPGG6F0KSTAUU0 ", " eventID ":" f76e5919 - 9362 - 48ff - a7c4 - d203a189ec8d ", " eventType ":" AwsApiCall ", " apiVersion ":" 20130630 ", " recipientAccountId ":" 444455556666" }] } Understanding Storage Gateway log ﬁle entries API Version 2021-03-31 183 AWS Storage Gateway Amazon FSx File Gateway User Guide Troubleshooting problems with
storagegateway-fsxfile-ug-072	storagegateway-fsxfile-ug.pdf	72	53Z ", " eventSource ":" storagegateway.amazonaws.com ", " eventName ":" ListGateways ", " awsRegion ":" us-east-2 ", " sourceIPAddress ":" 192.0.2.0 ", " userAgent ":" aws - cli / 1.6.2 Python / 2.7.6 Linux / 2.6.18 - 164.el5 ", " requestParameters ":null, " responseElements ":null, "requestID ":" 6U2N42CU37KAO8BG6V1I23FRSJ1Q8GLLE1QEU3KPGG6F0KSTAUU0 ", " eventID ":" f76e5919 - 9362 - 48ff - a7c4 - d203a189ec8d ", " eventType ":" AwsApiCall ", " apiVersion ":" 20130630 ", " recipientAccountId ":" 444455556666" }] } Understanding Storage Gateway log ﬁle entries API Version 2021-03-31 183 AWS Storage Gateway Amazon FSx File Gateway User Guide Troubleshooting problems with your Storage Gateway deployment Following, you can ﬁnd information about best practices and troubleshooting issues related to gateways, host platforms, ﬁle systems, high availability, data recovery, and snapshots. The on-premises gateway troubleshooting information covers gateways deployed on supported virtualization platforms. The troubleshooting information for high availability issues covers gateways running on VMware vSphere High Availability (HA) platform. Topics • Troubleshooting: gateway oﬄine issues - Learn how to diagnose problems that can cause your gateway to appear oﬄine in the Storage Gateway console. • Troubleshooting: Active Directory issues - Learn what to do if you receive error messages such as NETWORK_ERROR, TIMEOUT, or ACCESS_DENIED when trying to join your File Gateway to a Microsoft Active Directory domain. • Troubleshooting: gateway activation issues - Learn what to do if you receive an internal error message when attempting to activate your Storage Gateway. • Troubleshooting: on-premises gateway issues - Learn about typical issues that you might encounter working with your on-premises gateways, and how to allow Support to connect to your gateway to assist with troubleshooting. • Troubleshooting: Microsoft Hyper-V setup issues - Learn about typical issues that you might encounter when deploying Storage Gateway on the Microsoft Hyper-V platform. • Troubleshooting: Amazon EC2 gateway issues - Find information about typical issues that you might encounter when working with gateways deployed on Amazon EC2. • Troubleshooting: hardware appliance issues - Learn how to resolve issues that you might encounter with the AWS Storage Gateway Hardware Appliance. • Troubleshooting: File Gateway issues - Find information that can help you understand the cause of errors and health notiﬁcations that appear in your File Gateway's CloudWatch logs. • Troubleshooting: high availability issues - Learn what to do if you experience issues with gateways that are deployed in a VMware HA environment. API Version 2021-03-31 184 AWS Storage Gateway Amazon FSx File Gateway User Guide Troubleshooting: gateway oﬄine in the Storage Gateway console Use the following troubleshooting information to determine what to do if the AWS Storage Gateway console shows that your gateway is oﬄine. Your gateway might be showing as oﬄine for one or more of the following reasons: • The gateway can't reach the Storage Gateway service endpoints. • The gateway shut down unexpectedly. • A cache disk associated with the gateway has been disconnected or modiﬁed, or has failed. To bring your gateway back online, identify and resolve the issue that caused your gateway to go oﬄine. Check the associated ﬁrewall or proxy If you conﬁgured your gateway to use a proxy, or you placed your gateway behind a ﬁrewall, then review the access rules of the proxy or ﬁrewall. The proxy or ﬁrewall must allow traﬃc to and from the network ports and service endpoints required by Storage Gateway. For more information, see Network and ﬁrewall requirements. Check for an ongoing SSL or deep-packet inspection of your gateway's traﬃc If an SSL or deep-packet inspection is currently being performed on the network traﬃc between your gateway and AWS, then your gateway might not be able to communicate with the required service endpoints. To bring your gateway back online, you must disable the inspection. Check the IOWaitPercent metric after a reboot or software update After a reboot or software update, check to see if the IOWaitPercent metric for your File Gateway is 10 or greater. This might cause your gateway to be slow to respond while it rebuilds the index cache to RAM. For more information, see Troubleshooting: Using CloudWatch metrics. Troubleshooting: gateway oﬄine issues API Version 2021-03-31 185 AWS Storage Gateway Amazon FSx File Gateway User Guide Check for a power outage or hardware failure on the hypervisor host A power outage or hardware failure on the hypervisor host of your gateway can cause your gateway to shut down unexpectedly and become unreachable. After you restore the power and network connectivity, your gateway will become reachable again. After your gateway is back online, be sure to take steps to recover your data. For more information, see Best practices: recovering your data. Check for issues with an associated cache disk Your gateway can go oﬄine if at least one of the cache disks associated with your gateway was removed, changed, or resized, or if
storagegateway-fsxfile-ug-073	storagegateway-fsxfile-ug.pdf	73	hardware failure on the hypervisor host A power outage or hardware failure on the hypervisor host of your gateway can cause your gateway to shut down unexpectedly and become unreachable. After you restore the power and network connectivity, your gateway will become reachable again. After your gateway is back online, be sure to take steps to recover your data. For more information, see Best practices: recovering your data. Check for issues with an associated cache disk Your gateway can go oﬄine if at least one of the cache disks associated with your gateway was removed, changed, or resized, or if it is corrupted. If a working cache disk was removed from the hypervisor host: 1. Shut down the gateway. 2. Re-add the disk. Note Make sure you add the disk to the same disk node. 3. Restart the gateway. If a cache disk is corrupted, was replaced, or was resized: • Follow the Method 2 procedure described in Replacing your existing S3 File Gateway with a new instance to set up a new gateway and re-download cache disk information from the AWS cloud. Troubleshooting: issues joining gateway to Active Directory Use the following troubleshooting information to determine what to do if you receive error messages such as NETWORK_ERROR, TIMEOUT, or ACCESS_DENIED when trying to join your File Gateway to a Microsoft Active Directory domain. To resolve these errors, perform the following checks and conﬁgurations. Check for a power outage or hardware failure on the hypervisor host API Version 2021-03-31 186 AWS Storage Gateway Amazon FSx File Gateway User Guide Conﬁrm that the gateway can reach the domain controller by running an nping test To run an nping test: 1. Connect to the gateway local console using your hypervisor management software (VMware, Hyper-V, or KVM) for on-premises gateways, or using ssh for Amazon EC2 gateways. 2. Enter the corresponding numeral to select Gateway Console, and then enter h to list all available commands. To test the connectivity between the Storage Gateway virtual machine and the domain, run the following command: nping -d corp.domain.com -p 389 -c 1 -t tcp Note Replace corp.domain.com with your Active Directory domain DNS name and replace 389 with the LDAP port for your environment. Verify that you have opened the required ports within your ﬁrewall. The following is an example of a successful nping test where the gateway was able to reach the domain controller: nping -d corp.domain.com -p 389 -c 1 -t tcp Starting Nping 0.6.40 ( http://nmap.org/nping ) at 2022-06-30 16:24 UTC SENT (0.0553s) TCP 10.10.10.21:9783 > 10.10.10.10:389 S ttl=64 id=730 iplen=40 seq=2597195024 win=1480 RCVD (0.0556s) TCP 10.10.10.10:389 > 10.10.10.21:9783 SA ttl=128 id=22332 iplen=44 seq=4170716243 win=8192 <mss 8961> Max rtt: 0.310ms \| Min rtt: 0.310ms \| Avg rtt: 0.310ms Raw packets sent: 1 (40B) \| Rcvd: 1 (44B) \| Lost: 0 (0.00%) Nping done: 1 IP address pinged in 1.09 seconds<br> The following is an example of an nping test where there is no connectivity to or response from the corp.domain.com destination: nping -d corp.domain.com -p 389 -c 1 -t tcp Conﬁrm that the gateway can reach the domain controller by running an nping test API Version 2021-03-31 187 AWS Storage Gateway Amazon FSx File Gateway User Guide Starting Nping 0.6.40 ( http://nmap.org/nping ) at 2022-06-30 16:26 UTC SENT (0.0421s) TCP 10.10.10.21:47196 > 10.10.10.10:389 S ttl=64 id=30318 iplen=40 seq=1762671338 win=1480 Max rtt: N/A \| Min rtt: N/A \| Avg rtt: N/A Raw packets sent: 1 (40B) \| Rcvd: 0 (0B) \| Lost: 1 (100.00%) Nping done: 1 IP address pinged in 1.07 seconds Check the DHCP options set for the VPC of your Amazon EC2 gateway instance If the File Gateway is running on an Amazon EC2 instance, then you must make sure a DHCP options set is properly conﬁgured and attached to the Amazon Virtual Private Cloud (VPC) that contains the gateway instance. For more information, see DHCP option sets in Amazon VPC. Conﬁrm that the gateway can resolve the domain by running a dig query If the domain isn't resolvable by the gateway, then the gateway can't join the domain. To run a dig query: 1. Connect to the gateway local console using your hypervisor management software (VMware, Hyper-V, or KVM) for on-premises gateways, or using ssh for Amazon EC2 gateways. 2. Enter the corresponding numeral to select Gateway Console, and then enter h to list all available commands. To test whether the gateway can resolve the domain, run the following command: dig -d corp.domain.com Note Replace corp.domain.com with your Active Directory domain DNS name. The following is an example of a successful response: ; <<>> DiG 9.11.4-P2-RedHat-9.11.4-26.P2.amzn2.5.2 <<>> corp.domain.com Check the DHCP options set for the VPC of your Amazon EC2 gateway instance API Version 2021-03-31 188 AWS Storage Gateway ;; global options: +cmd Amazon FSx File Gateway User Guide ;;
storagegateway-fsxfile-ug-074	storagegateway-fsxfile-ug.pdf	74	on-premises gateways, or using ssh for Amazon EC2 gateways. 2. Enter the corresponding numeral to select Gateway Console, and then enter h to list all available commands. To test whether the gateway can resolve the domain, run the following command: dig -d corp.domain.com Note Replace corp.domain.com with your Active Directory domain DNS name. The following is an example of a successful response: ; <<>> DiG 9.11.4-P2-RedHat-9.11.4-26.P2.amzn2.5.2 <<>> corp.domain.com Check the DHCP options set for the VPC of your Amazon EC2 gateway instance API Version 2021-03-31 188 AWS Storage Gateway ;; global options: +cmd Amazon FSx File Gateway User Guide ;; Got answer: ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 24817 ;; flags: qr aa rd ra; QUERY: 1, ANSWER: 2, AUTHORITY: 0, ADDITIONAL: 1 ;; OPT PSEUDOSECTION: ; EDNS: version: 0, flags:; udp: 4000 ;; QUESTION SECTION: ;corp.domain.com. IN A ;; ANSWER SECTION: corp.domain.com. 600 IN A 10.10.10.10 corp.domain.com. 600 IN A 10.10.20.10 ;; Query time: 0 msec ;; SERVER: 10.10.20.228#53(10.10.20.228) ;; WHEN: Thu Jun 30 16:36:32 UTC 2022 ;; MSG SIZE rcvd: 78 Check the domain controller settings and roles Verify that the domain controller isn't set to read-only, and that the domain controller has enough roles for computers to join. To test this, try joining other servers from the same VPC subnet as the gateway VM to the domain. Check that the gateway is joined to the nearest domain controller As a best practice, we recommend joining your gateway to a domain controller that is geographically close to the gateway appliance. If the gateway appliance can't communicate with the domain controller within 20 seconds due to network latency, then the domain joining process can time out. For example, the process might time out if the gateway appliance is in the US East (N. Virginia) AWS Region and the domain controller is in the Asia Paciﬁc (Singapore) AWS Region. Note To increase the default timeout value of 20 seconds, you can run the join-domain command in the AWS Command Line Interface (AWS CLI) and include the --timeout-in-seconds option to increase the time. You can also use the JoinDomain API call and include the TimeoutInSeconds parameter to increase the time. The maximum timeout value is 3,600 seconds. Check the domain controller settings and roles API Version 2021-03-31 189 AWS Storage Gateway Amazon FSx File Gateway User Guide If you receive errors when running AWS CLI commands, make sure that you’re using the most recent AWS CLI version. Conﬁrm that Active Directory creates new computer objects in the default organizational unit (OU) Make sure Microsoft Active Directory does not have any Group Policy Objects that create new computer objects in any location other than the default OU. Before you can join your gateway to the Active Directory domain, a new computer object must exist in the default OU. Some Active Directory environments are customized to have diﬀerent OUs for newly created objects. To guarantee that a new computer object for the gateway VM exists in the default OU, try creating the computer object manually on your domain controller before you join the gateway to the domain. You can also run the join-domain command using the AWS CLI. Then, specify the option for -- organizational-unit. Note The process of creating the computer object is called pre-staging. Check your domain controller event logs If you can't join the gateway to the domain after trying all other checks and conﬁgurations described in the previous sections, we recommend examining your domain controller event logs. Check for any errors in the event viewer of the domain controller. Verify that the gateway queries have reached the domain controller. Troubleshooting: internal error during gateway activation Storage Gateway activation requests traverse two network paths. Incoming activation requests sent by a client connect to the gateway's virtual machine (VM) or Amazon Elastic Compute Cloud (Amazon EC2) instance over port 80. If the gateway successfully receives the activation request, then the gateway communicates with the Storage Gateway endpoints to receive an activation key. If the gateway can't reach the Storage Gateway endpoints, then the gateway responds to the client with an internal error message. Conﬁrm that Active Directory creates new computer objects in the default organizational unit (OU) API Version 2021-03-31 190 AWS Storage Gateway Amazon FSx File Gateway User Guide Use the following troubleshooting information to determine what to do if you receive an internal error message when attempting to activate your AWS Storage Gateway. Note • Make sure you deploy new gateways using the latest virtual machine image ﬁle or Amazon Machine Image (AMI) version. You will receive an internal error if you attempt to activate a gateway that uses an outdated AMI. • Make sure that you select the correct gateway type that you intend to deploy before you download the AMI. The .ova ﬁles and AMIs for
storagegateway-fsxfile-ug-075	storagegateway-fsxfile-ug.pdf	75	190 AWS Storage Gateway Amazon FSx File Gateway User Guide Use the following troubleshooting information to determine what to do if you receive an internal error message when attempting to activate your AWS Storage Gateway. Note • Make sure you deploy new gateways using the latest virtual machine image ﬁle or Amazon Machine Image (AMI) version. You will receive an internal error if you attempt to activate a gateway that uses an outdated AMI. • Make sure that you select the correct gateway type that you intend to deploy before you download the AMI. The .ova ﬁles and AMIs for each gateway type are diﬀerent, and they are not interchangeable. Resolve errors when activating your gateway using a public endpoint To resolve activation errors when activating your gateway using a public endpoint, perform the following checks and conﬁgurations. Check the required ports For gateways deployed on-premises, check that the ports are open on your local ﬁrewall. For gateways deployed on an Amazon EC2 instance, check that the ports are open on the instance's security group. To conﬁrm that the ports are open, run a telnet command on the public endpoint from a server. This server must be in the same subnet as the gateway. For example, the following telnet commands test the connection to port 443: telnet d4kdq0yaxexbo.cloudfront.net 443 telnet storagegateway.region.amazonaws.com 443 telnet dp-1.storagegateway.region.amazonaws.com 443 telnet proxy-app.storagegateway.region.amazonaws.com 443 telnet client-cp.storagegateway.region.amazonaws.com 443 telnet anon-cp.storagegateway.region.amazonaws.com 443 To conﬁrm that the gateway itself can reach the endpoint, access the gateway's local VM console (for gateways deployed on-premises). Or, you can SSH to the gateway's instance (for gateways deployed on Amazon EC2). Then, run a network connectivity test. Conﬁrm that the test returns [PASSED]. For more information, see Testing your gateway's network connectivity. Resolve errors when activating your gateway using a public endpoint API Version 2021-03-31 191 AWS Storage Gateway Amazon FSx File Gateway User Guide Note The default login user name for the gateway console is admin, and the default password is password. Make sure ﬁrewall security does not modify packets sent from the gateway to the public endpoints SSL inspections, deep packet inspections, or other forms of ﬁrewall security can interfere with packets sent from the gateway. The SSL handshake fails if the SSL certiﬁcate is modiﬁed from what the activation endpoint expects. To conﬁrm that there's no SSL inspection in progress, run an OpenSSL command on the main activation endpoint ( anon- cp.storagegateway.region.amazonaws.com) on port 443. You must run this command from a machine that's in the same subnet as the gateway: $ openssl s_client -connect anon-cp.storagegateway.region.amazonaws.com:443 - servername anon-cp.storagegateway.region.amazonaws.com Note Replace region with your AWS Region. If there's no SSL inspection in progress, then the command returns a response similar to the following: $ openssl s_client -connect anon-cp.storagegateway.us-east-2.amazonaws.com:443 - servername anon-cp.storagegateway.us-east-2.amazonaws.com CONNECTED(00000003) depth=2 C = US, O = Amazon, CN = Amazon Root CA 1 verify return:1 depth=1 C = US, O = Amazon, OU = Server CA 1B, CN = Amazon verify return:1 depth=0 CN = anon-cp.storagegateway.us-east-2.amazonaws.com verify return:1 --- Certificate chain 0 s:/CN=anon-cp.storagegateway.us-east-2.amazonaws.com Resolve errors when activating your gateway using a public endpoint API Version 2021-03-31 192 AWS Storage Gateway Amazon FSx File Gateway User Guide i:/C=US/O=Amazon/OU=Server CA 1B/CN=Amazon 1 s:/C=US/O=Amazon/OU=Server CA 1B/CN=Amazon i:/C=US/O=Amazon/CN=Amazon Root CA 1 2 s:/C=US/O=Amazon/CN=Amazon Root CA 1 i:/C=US/ST=Arizona/L=Scottsdale/O=Starfield Technologies, Inc./CN=Starfield Services Root Certificate Authority - G2 3 s:/C=US/ST=Arizona/L=Scottsdale/O=Starfield Technologies, Inc./CN=Starfield Services Root Certificate Authority - G2 i:/C=US/O=Starfield Technologies, Inc./OU=Starfield Class 2 Certification Authority --- If there is an ongoing SSL inspection, then the response shows an altered certiﬁcate chain, similar to the following: $ openssl s_client -connect anon-cp.storagegateway.ap-southeast-1.amazonaws.com:443 - servername anon-cp.storagegateway.ap-southeast-1.amazonaws.com CONNECTED(00000003) depth=0 DC = com, DC = amazonaws, OU = AWS, CN = anon-cp.storagegateway.ap- southeast-1.amazonaws.com verify error:num=20:unable to get local issuer certificate verify return:1 depth=0 DC = com, DC = amazonaws, OU = AWS, CN = anon-cp.storagegateway.ap- southeast-1.amazonaws.com verify error:num=21:unable to verify the first certificate verify return:1 --- Certificate chain 0 s:/DC=com/DC=amazonaws/OU=AWS/CN=anon-cp.storagegateway.ap-southeast-1.amazonaws.com i:/C=IN/O=Company/CN=Admin/ST=KA/L=New town/OU=SGW/[email protected] --- The activation endpoint accepts SSL handshakes only if it recognizes the SSL certiﬁcate. This means that the gateway's outbound traﬃc to the endpoints must be exempt from inspections performed by ﬁrewalls in your network. These inspections might be an SSL inspection or a deep packet inspection. Check gateway time synchronization Excessive time skews can cause SSL handshake errors. For on-premises gateways, you can use the gateway's local VM console to check your gateway's time synchronization. The time skew should be no larger than 60 seconds. For more information, see Synchronizing Your Gateway VM Time. Resolve errors when activating your gateway using a public endpoint API Version 2021-03-31 193 AWS Storage Gateway Amazon FSx File Gateway User Guide The System Time Management option isn't available on gateways that are hosted on Amazon EC2 instances. To make sure Amazon EC2 gateways can properly synchronize time, conﬁrm that the Amazon
storagegateway-fsxfile-ug-076	storagegateway-fsxfile-ug.pdf	76	gateway time synchronization Excessive time skews can cause SSL handshake errors. For on-premises gateways, you can use the gateway's local VM console to check your gateway's time synchronization. The time skew should be no larger than 60 seconds. For more information, see Synchronizing Your Gateway VM Time. Resolve errors when activating your gateway using a public endpoint API Version 2021-03-31 193 AWS Storage Gateway Amazon FSx File Gateway User Guide The System Time Management option isn't available on gateways that are hosted on Amazon EC2 instances. To make sure Amazon EC2 gateways can properly synchronize time, conﬁrm that the Amazon EC2 instance can connect to the following NTP server pool list over ports UDP and TCP 123: • 0.amazon.pool.ntp.org • 1.amazon.pool.ntp.org • 2.amazon.pool.ntp.org • 3.amazon.pool.ntp.org Resolve errors when activating your gateway using an Amazon VPC endpoint To resolve activation errors when activating your gateway using an Amazon Virtual Private Cloud (Amazon VPC) endpoint, perform the following checks and conﬁgurations. Check the required ports Make sure the required ports within your local ﬁrewall (for gateways deployed on-premises) or security group (for gateways deployed in Amazon EC2) are open. The ports required for connecting a gateway to a Storage Gateway VPC endpoint diﬀer from those required when connecting a gateway to public endpoints. The following ports are required for connecting to a Storage Gateway VPC endpoint: • TCP 443 • TCP 1026 • TCP 1027 • TCP 1028 • TCP 1031 • TCP 2222 For more information, see Creating a VPC endpoint for Storage Gateway. Additionally, check the security group that's attached to your Storage Gateway VPC endpoint. The default security group attached to the endpoint might not allow the required ports. Create a new Resolve errors when activating your gateway using an Amazon VPC endpoint API Version 2021-03-31 194 AWS Storage Gateway Amazon FSx File Gateway User Guide security group that allows traﬃc from your gateway's IP address range over the required ports. Then, attach that security group to the VPC endpoint. Note Use the Amazon VPC console to verify the security group that's attached to the VPC endpoint. View your Storage Gateway VPC endpoint from the console, and then choose the Security Groups tab. To conﬁrm that the required ports are open, you can run telnet commands on the Storage Gateway VPC Endpoint. You must run these commands from a server that's in the same subnet as the gateway. You can run the tests on the ﬁrst DNS name that doesn't specify an Availability Zone. For example, the following telnet commands test the required port connections using the DNS name vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com: telnet vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com 443 telnet vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com 1026 telnet vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com 1027 telnet vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com 1028 telnet vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com 1031 telnet vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com 2222 Make sure ﬁrewall security does not modify packets sent from the gateway to your Storage Gateway Amazon VPC endpoint SSL inspections, deep packet inspections, or other forms of ﬁrewall security can interfere with packets sent from the gateway. The SSL handshake fails if the SSL certiﬁcate is modiﬁed from what the activation endpoint expects. To conﬁrm that there's no SSL inspection in progress, run an OpenSSL command on your Storage Gateway VPC endpoint. You must run this command from a machine that's in the same subnet as the gateway. Run the command for each required port: $ openssl s_client -connect vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us- east-1.vpce.amazonaws.com:443 -servername vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com $ openssl s_client -connect vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us- east-1.vpce.amazonaws.com:1026 -servername vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com Resolve errors when activating your gateway using an Amazon VPC endpoint API Version 2021-03-31 195 AWS Storage Gateway Amazon FSx File Gateway User Guide $ openssl s_client -connect vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us- east-1.vpce.amazonaws.com:1027 -servername vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com $ openssl s_client -connect vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us- east-1.vpce.amazonaws.com:1028 -servername vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com $ openssl s_client -connect vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us- east-1.vpce.amazonaws.com:1031 -servername vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com $ openssl s_client -connect vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us- east-1.vpce.amazonaws.com:2222 -servername vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com If there's no SSL inspection in progress, then the command returns a response similar to the following: openssl s_client -connect vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us- east-1.vpce.amazonaws.com:1027 -servername vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com CONNECTED(00000005) depth=2 C = US, O = Amazon, CN = Amazon Root CA 1 verify return:1 depth=1 C = US, O = Amazon, OU = Server CA 1B, CN = Amazon verify return:1 depth=0 CN = anon-cp.storagegateway.us-east-1.amazonaws.com verify return:1 --- Certificate chain 0 s:CN = anon-cp.storagegateway.us-east-1.amazonaws.com i:C = US, O = Amazon, OU = Server CA 1B, CN = Amazon 1 s:C = US, O = Amazon, OU = Server CA 1B, CN = Amazon i:C = US, O = Amazon, CN = Amazon Root CA 1 2 s:C = US, O = Amazon, CN = Amazon Root CA 1 i:C = US, ST = Arizona, L = Scottsdale, O = "Starfield Technologies, Inc.", CN = Starfield Services Root Certificate Authority - G2 3 s:C = US, ST = Arizona, L = Scottsdale, O = "Starfield Technologies, Inc.", CN = Starfield Services Root Certificate Authority - G2 i:C = US, O = "Starfield Technologies, Inc.", OU = Starfield Class
storagegateway-fsxfile-ug-077	storagegateway-fsxfile-ug.pdf	77	Amazon 1 s:C = US, O = Amazon, OU = Server CA 1B, CN = Amazon i:C = US, O = Amazon, CN = Amazon Root CA 1 2 s:C = US, O = Amazon, CN = Amazon Root CA 1 i:C = US, ST = Arizona, L = Scottsdale, O = "Starfield Technologies, Inc.", CN = Starfield Services Root Certificate Authority - G2 3 s:C = US, ST = Arizona, L = Scottsdale, O = "Starfield Technologies, Inc.", CN = Starfield Services Root Certificate Authority - G2 i:C = US, O = "Starfield Technologies, Inc.", OU = Starfield Class 2 Certification Authority --- Resolve errors when activating your gateway using an Amazon VPC endpoint API Version 2021-03-31 196 AWS Storage Gateway Amazon FSx File Gateway User Guide If there is an ongoing SSL inspection, then the response shows an altered certiﬁcate chain, similar to the following: openssl s_client -connect vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us- east-1.vpce.amazonaws.com:1027 -servername vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com CONNECTED(00000005) depth=2 C = US, O = Amazon, CN = Amazon Root CA 1 verify return:1 depth=1 C = US, O = Amazon, OU = Server CA 1B, CN = Amazon verify return:1 depth=0 DC = com, DC = amazonaws, OU = AWS, CN = anon-cp.storagegateway.us- east-1.amazonaws.com verify error:num=21:unable to verify the first certificate verify return:1 --- Certificate chain 0 s:/DC=com/DC=amazonaws/OU=AWS/CN=anon-cp.storagegateway.us-east-1.amazonaws.com i:/C=IN/O=Company/CN=Admin/ST=KA/L=New town/OU=SGW/[email protected] --- The activation endpoint accepts SSL handshakes only if it recognizes the SSL certiﬁcate. This means that the gateway's outbound traﬃc to your VPC endpoint over required ports is exempt from inspections performed by your network ﬁrewalls. These inspections might be SSL inspections or deep packet inspections. Check gateway time synchronization Excessive time skews can cause SSL handshake errors. For on-premises gateways, you can use the gateway's local VM console to check your gateway's time synchronization. The time skew should be no larger than 60 seconds. For more information, see Synchronizing Your Gateway VM Time. The System Time Management option isn't available on gateways that are hosted on Amazon EC2 instances. To make sure Amazon EC2 gateways can properly synchronize time, conﬁrm that the Amazon EC2 instance can connect to the following NTP server pool list over ports UDP and TCP 123: • 0.amazon.pool.ntp.org • 1.amazon.pool.ntp.org • 2.amazon.pool.ntp.org Resolve errors when activating your gateway using an Amazon VPC endpoint API Version 2021-03-31 197 AWS Storage Gateway • 3.amazon.pool.ntp.org Amazon FSx File Gateway User Guide Check for an HTTP proxy and conﬁrm associated security group settings Before activation, check if you have an HTTP proxy on Amazon EC2 conﬁgured on the on-premises gateway VM as a Squid proxy on port 3128. In this case, conﬁrm the following: • The security group attached to the HTTP proxy on Amazon EC2 must have an inbound rule. This inbound rule must allow Squid proxy traﬃc on port 3128 from the gateway VM's IP address. • The security group attached to the Amazon EC2 VPC endpoint must have inbound rules. These inbound rules must allow traﬃc on ports 1026-1028, 1031, 2222, and 443 from the IP address of the HTTP proxy on Amazon EC2. Resolve errors when activating your gateway using a public endpoint and there is a Storage Gateway VPC endpoint in the same VPC To resolve errors when activating your gateway using a public endpoint when there is a Amazon Virtual Private Cloud (Amazon VPC) enpoint in the same VPC, perform the following checks and conﬁgurations. Conﬁrm that the Enable Private DNS Name setting isn't enabled on your Storage Gateway VPC endpoint If Enable Private DNS Name is enabled, you can't activate any gateways from that VPC to the public endpoint. To disable the private DNS name option: 1. Open the Amazon VPC console. 2. In the navigation pane, choose Endpoints. 3. Choose your Storage Gateway VPC endpoint. 4. Choose Actions. 5. Choose Manage Private DNS Names. 6. For Enable Private DNS Name, clear Enable for this Endpoint. 7. Choose Modify Private DNS Names to save the setting. Resolve errors when activating your gateway using a public endpoint and there is a Storage Gateway VPC endpoint in the same VPC API Version 2021-03-31 198 AWS Storage Gateway Amazon FSx File Gateway User Guide Troubleshooting: on-premises gateway issues You can ﬁnd information following about typical issues that you might encounter working with your on-premises gateways, and how to allow Support to connect to your gateway to assist with troubleshooting. The following table lists typical issues that you might encounter working with your on-premises gateways. Issue Action to Take You cannot ﬁnd the IP address of your gateway. Use the hypervisor client to connect to your host to ﬁnd the gateway IP address. • For VMware ESXi, the VM's IP address can be found in the vSphere client on the Summary tab. • For Microsoft Hyper-V, the VM's IP address can be found by logging into the local
storagegateway-fsxfile-ug-078	storagegateway-fsxfile-ug.pdf	78	you might encounter working with your on-premises gateways, and how to allow Support to connect to your gateway to assist with troubleshooting. The following table lists typical issues that you might encounter working with your on-premises gateways. Issue Action to Take You cannot ﬁnd the IP address of your gateway. Use the hypervisor client to connect to your host to ﬁnd the gateway IP address. • For VMware ESXi, the VM's IP address can be found in the vSphere client on the Summary tab. • For Microsoft Hyper-V, the VM's IP address can be found by logging into the local console. If you are still having trouble ﬁnding the gateway IP address: • Check that the VM is turned on. Only when the VM is turned on does an IP address get assigned to your gateway. • Wait for the VM to ﬁnish startup. If you just turned on your VM, then it might take several minutes for the gateway to ﬁnish its boot sequence. • Allow the appropriate ports for your gateway. • If you use a ﬁrewall or router to ﬁlter or limit network traﬃc, you must conﬁgure your ﬁrewall and router to allow these service endpoints for outbound communication to AWS. For more information about network and ﬁrewall requirements, see Network and ﬁrewall requirements. • Check that the gateway VM can be accessed by pinging the VM from your client. You're having network or ﬁrewall problems. Your gateway's activatio n fails when you click the Proceed to Activation Troubleshooting: on-premises gateway issues API Version 2021-03-31 199 AWS Storage Gateway Amazon FSx File Gateway User Guide Issue Action to Take button in the Storage • Check that your VM has network connectivity to the internet. Gateway Management Console. Otherwise, you'll need to conﬁgure a SOCKS proxy. For more information on doing so, see Testing your gateway's network connectivity. • Check that the host has the correct time, that the host is conﬁgured to synchronize its time automatically to a Network Time Protocol (NTP) server, and that the gateway VM has the correct time. For information about synchronizing the time of hypervisor hosts and VMs, see Conﬁguring a Network Time Protocol (NTP) server for your gateway. • After performing these steps, you can retry the gateway deployment using the Storage Gateway console and the Setup and Activate Gateway wizard. • Check that your VM has at least 16 GB of RAM. Gateway allocation fails if there is less than 16 GB of RAM. For more information, see File Gateway setup requirements. You need to improve bandwidth between your You can improve the bandwidth from your gateway to AWS by setting up your internet connection to AWS on a network adapter gateway and AWS. (NIC) separate from that connecting your applications and the gateway VM. Taking this approach is useful if you have a high- bandwidth connection to AWS and you want to avoid bandwidth contention, especially during a snapshot restore. For high-thro ughput workload needs, you can use AWS Direct Connect to establish a dedicated network connection between your on-premis es gateway and AWS. To measure the bandwidth of the connectio n from your gateway to AWS, use the CloudBytesDownload metrics of the gateway. ed and CloudBytesUploaded For more on this subject, see Performance and optimization. Improving your internet connectivity helps to ensure that your upload buﬀer does not ﬁll up. Troubleshooting: on-premises gateway issues API Version 2021-03-31 200 AWS Storage Gateway Amazon FSx File Gateway User Guide Issue Action to Take Throughput to or from your gateway drops to • On the Gateway tab of the Storage Gateway console, verify that the IP addresses for your gateway VM are the same that you zero. see using your hypervisor client software (that is, the VMware vSphere client or Microsoft Hyper-V Manager). If you ﬁnd a mismatch, restart your gateway from the Storage Gateway console, as shown in Shutting down your gateway VM. After the restart, the addresses in the IP Addresses list in the Storage Gateway console's Gateway tab should match the IP addresses for your gateway, which you determine from the hypervisor client. • For VMware ESXi, the VM's IP address can be found in the vSphere client on the Summary tab. • For Microsoft Hyper-V, the VM's IP address can be found by logging into the local console. • Check your gateway's connectivity to AWS as described in Testing your gateway's network connectivity. • Check your gateway's network adapter conﬁguration in your hypervisor management client and ensure that all the interfaces you intend to use for the gateway are activated. • Check your gateway's network adapter conﬁguration in the gateway local console. For instructions, see Conﬁguring your gateway network settings. You can view the throughput to and from your gateway from the Amazon CloudWatch console. For more
storagegateway-fsxfile-ug-079	storagegateway-fsxfile-ug.pdf	79	on the Summary tab. • For Microsoft Hyper-V, the VM's IP address can be found by logging into the local console. • Check your gateway's connectivity to AWS as described in Testing your gateway's network connectivity. • Check your gateway's network adapter conﬁguration in your hypervisor management client and ensure that all the interfaces you intend to use for the gateway are activated. • Check your gateway's network adapter conﬁguration in the gateway local console. For instructions, see Conﬁguring your gateway network settings. You can view the throughput to and from your gateway from the Amazon CloudWatch console. For more information about measuring throughput to and from your gateway to AWS, see Performance and optimization. See Troubleshooting: Microsoft Hyper-V setup, which discusses some of the common issues of deploying a gateway on Microsoft Hyper-V. You are having trouble importing (deploying) Storage Gateway on Microsoft Hyper-V. Troubleshooting: on-premises gateway issues API Version 2021-03-31 201 AWS Storage Gateway Amazon FSx File Gateway User Guide Issue Action to Take You receive a message that says: "The data that You receive this message if your gateway VM was created from a clone or snapshot of another gateway VM. If this isn’t the case, has been written to the contact Support. volume in your gateway isn't securely stored at AWS". Turning on Support access to help troubleshoot your gateway hosted on-premises Storage Gateway provides a local console you can use to perform several maintenance tasks, including allowing Support to access your gateway to assist you with troubleshooting gateway issues. By default, Support access to your gateway is turned oﬀ. You turn on this access through the host's local console. To give Support access to your gateway, you ﬁrst log in to the local console for the host, navigate to the Storage Gateway's console, and then connect to the support server. To turn on Support access to your gateway 1. Log in to your host's local console. • VMware ESXi – for more information, see Accessing the Gateway Local Console with VMware ESXi. • Microsoft Hyper-V – for more information, see Access the Gateway Local Console with Microsoft Hyper-V. 2. At the prompt, enter the corresponding numeral to select Gateway Console. 3. Enter h to open the list of available commands. 4. Do one of the following: • If your gateway is using a public endpoint, in the AVAILABLE COMMANDS window, enter open-support-channel to connect to customer support for Storage Gateway. Allow TCP port 22 so you can open a support channel to AWS. When you connect to customer support, Storage Gateway assigns you a support number. Make a note of your support number. • If your gateway is using a VPC endpoint, in the AVAILABLE COMMANDS window, enter open-support-channel. If your gateway is not activated, provide the VPC endpoint or IP Turning on Support access to help troubleshoot your gateway API Version 2021-03-31 202 AWS Storage Gateway Amazon FSx File Gateway User Guide address to connect to customer support for Storage Gateway. Allow TCP port 22 so you can open a support channel to AWS. When you connect to customer support, Storage Gateway assigns you a support number. Make a note of your support number. Note The channel number is not a Transmission Control Protocol/User Datagram Protocol (TCP/UDP) port number. Instead, the gateway makes a Secure Shell (SSH) (TCP 22) connection to Storage Gateway servers and provides the support channel for the connection. 5. After the support channel is established, provide your support service number to Support so Support can provide troubleshooting assistance. 6. When the support session is completed, enter q to end it. Don't close the session until Amazon Web Services Support notiﬁes you that the support session is complete. 7. 8. Enter exit to log out of the Storage Gateway console. Follow the prompts to exit the local console. Troubleshooting: Microsoft Hyper-V setup The following table lists typical issues that you might encounter when deploying Storage Gateway on the Microsoft Hyper-V platform. Issue Action to Take You try to import a gateway and receive the following error message: "A server error occurred while attempting to import the virtual machine. Import failed. Unable to ﬁnd virtual machine import ﬁles under location [...]. You This error can occur for the following reasons: • If you are not pointing to the root of the unzipped gateway source ﬁles. The last part of the location you specify in the Import Virtual Machine dialog box should be AWS-Storage- Gateway . For example: C:\prod-gateway\unzippedSourceVM\AWS- Storage-Gateway\ . • If you have already deployed a gateway and you did not select the Copy the virtual machine option and check the Duplicate Troubleshooting: Microsoft Hyper-V setup issues API Version 2021-03-31 203 AWS Storage Gateway Amazon FSx File Gateway User Guide Issue Action to Take can import a virtual machine only if
storagegateway-fsxfile-ug-080	storagegateway-fsxfile-ug.pdf	80	This error can occur for the following reasons: • If you are not pointing to the root of the unzipped gateway source ﬁles. The last part of the location you specify in the Import Virtual Machine dialog box should be AWS-Storage- Gateway . For example: C:\prod-gateway\unzippedSourceVM\AWS- Storage-Gateway\ . • If you have already deployed a gateway and you did not select the Copy the virtual machine option and check the Duplicate Troubleshooting: Microsoft Hyper-V setup issues API Version 2021-03-31 203 AWS Storage Gateway Amazon FSx File Gateway User Guide Issue Action to Take can import a virtual machine only if you used Hyper-V to create and all ﬁles option in the Import Virtual Machine dialog box, then the VM was created in the location where you have the unzipped gateway ﬁles and you cannot import from this export it." location again. To ﬁx this problem, get a fresh copy of the unzipped gateway source ﬁles and copy to a new location. Use the new location as the source of the import. If you plan on creating multiple gateways from one unzipped source ﬁles location, you must select Copy the virtual machine and check the Duplicate all ﬁles box in the Import Virtual Machine dialog box. If you have already deployed a gateway and you try to reuse the default folders that store the virtual hard disk ﬁles and virtual machine conﬁguration ﬁles, then this error will occur. To ﬁx this problem, specify new locations under Server in the panel on the left side of the Hyper-V Settings dialog box. You try to import a gateway and receive the following error message: "A server error occurred while attempting to import the virtual machine. Import failed. Import task failed to copy ﬁle from [...]: The ﬁle exists. (0x80070050)" Troubleshooting: Microsoft Hyper-V setup issues API Version 2021-03-31 204 AWS Storage Gateway Amazon FSx File Gateway User Guide Issue Action to Take When you import the gateway make sure you select Copy the virtual machine and check the Duplicate all ﬁles box in the Import Virtual Machine dialog box to create a new unique ID for the VM. You try to import a gateway and receive the following error message: "A server error occurred while attempting to import the virtual machine. Import failed. Import failed because the virtual machine must have a new identiﬁer. Select a new identiﬁer and try the import again." You try to start a gateway VM and receive the This error is likely caused by a CPU discrepancy between the required CPUs for the gateway and the available CPUs on the host. following error message: Ensure that the VM CPU count is supported by the underlying "An error occurred while hypervisor. attempting to start the For more information about the requirements for Storage selected virtual machine(s Gateway, see File Gateway setup requirements. ). The child partition processor setting is incompatible with parent partition. 'AWS-Stor age-Gateway' could not initialize. (Virtual machine ID [...])" Troubleshooting: Microsoft Hyper-V setup issues API Version 2021-03-31 205 AWS Storage Gateway Amazon FSx File Gateway User Guide Issue Action to Take You try to start a gateway VM and receive the This error is likely caused by a RAM discrepancy between the required RAM for the gateway and the available RAM on the host. following error message: "An error occurred while Gateway, see File Gateway setup requirements. For more information about the requirements for Storage attempting to start the selected virtual machine(s ). 'AWS-Storage-Gatew ay' could not initializ e. (Virtual machine ID [...]) Failed to create partition: Insuﬃcient system resources exist to complete the requested service. (0x800705AA)" Your snapshots and gateway software updates The gateway VM's clock might be oﬀset from the actual time, known as clock drift. Check and correct the VM's time using are occurring at slightly local gateway console's time synchronization option. For more diﬀerent times than information, see Conﬁguring a Network Time Protocol (NTP) expected. server for your gateway. You need to put the unzipped Microsoft Hyper- V Storage Gateway ﬁles on the host ﬁle system. Access the host as you do a typical Microsoft Windows server. For example, if the hypervisor host is name hyperv-server , then you can use the following UNC path \\hyperv-server\c$ , which assumes that the name hyperv-server can be resolved or is deﬁned in your local hosts ﬁle. You are prompted for credentials when connecting to hypervisor. Add your user credentials as a local administrator for the hypervisor host by using the Sconﬁg.cmd tool. Troubleshooting: Microsoft Hyper-V setup issues API Version 2021-03-31 206 AWS Storage Gateway Amazon FSx File Gateway User Guide Issue Action to Take You may notice poor network performance For information about a workaround, see the Microsoft documentation, see Poor network performance on virtual if you turn on virtual machines on a Windows Server
storagegateway-fsxfile-ug-081	storagegateway-fsxfile-ug.pdf	81	UNC path \\hyperv-server\c$ , which assumes that the name hyperv-server can be resolved or is deﬁned in your local hosts ﬁle. You are prompted for credentials when connecting to hypervisor. Add your user credentials as a local administrator for the hypervisor host by using the Sconﬁg.cmd tool. Troubleshooting: Microsoft Hyper-V setup issues API Version 2021-03-31 206 AWS Storage Gateway Amazon FSx File Gateway User Guide Issue Action to Take You may notice poor network performance For information about a workaround, see the Microsoft documentation, see Poor network performance on virtual if you turn on virtual machines on a Windows Server 2012 Hyper-V host if VMQ is machine queue (VMQ) turned on. for a Hyper-V host that's using a Broadcom network adapter. Troubleshooting: Amazon EC2 gateway issues In the following sections, you can ﬁnd typical issues that you might encounter working with your gateway deployed on Amazon EC2. For more information about the diﬀerence between an on- premises gateway and a gateway deployed in Amazon EC2, see Deploy a default Amazon EC2 host for FSx File Gateway. Topics • Your gateway activation hasn't occurred after a few moments • You can't ﬁnd your EC2 gateway instance in the instance list • You want to connect to your gateway instance using the Amazon EC2 serial console • You want Support to help troubleshoot your Amazon EC2 gateway Your gateway activation hasn't occurred after a few moments Check the following in the Amazon EC2 console: • Port 80 is open in the security group that you associated with the instance. For more information about adding a security group rule, see Adding a security group rule in the Amazon EC2 User Guide. • The gateway instance is marked as running. In the Amazon EC2 console, the State value for the instance should be RUNNING. • Make sure that your Amazon EC2 instance type meets the minimum requirements, as described in Storage requirements. Troubleshooting: Amazon EC2 gateway issues API Version 2021-03-31 207 AWS Storage Gateway Amazon FSx File Gateway User Guide After correcting the problem, try activating the gateway again. To do this, open the Storage Gateway console, choose Deploy a new Gateway on Amazon EC2, and re-enter the IP address of the instance. You can't ﬁnd your EC2 gateway instance in the instance list If you didn't give your instance a resource tag and you have many instances running, it can be hard to tell which instance you launched. In this case, you can take the following actions to ﬁnd the gateway instance: • Check the name of the Amazon Machine Image (AMI) on the Description tab of the instance. An instance based on the Storage Gateway AMI should start with the text aws-storage-gateway- ami. • If you have several instances based on the Storage Gateway AMI, check the instance launch time to ﬁnd the correct instance. You want to connect to your gateway instance using the Amazon EC2 serial console You can use the Amazon EC2 serial console to troubleshoot boot, network conﬁguration, and other issues. For instructions and troubleshooting tips, see Amazon EC2 Serial Console in the Amazon Elastic Compute Cloud User Guide. You want Support to help troubleshoot your Amazon EC2 gateway Storage Gateway provides a local console you can use to perform several maintenance tasks, including allowing Support to access your gateway to assist you with troubleshooting gateway issues. By default, Support access to your gateway is turned oﬀ. You turn on this access through the Amazon EC2 local console. You log in to the Amazon EC2 local console through a Secure Shell (SSH). To successfully log in through SSH, your instance's security group must have a rule that opens TCP port 22. Note If you add a new rule to an existing security group, the new rule applies to all instances that use that security group. For more information about security groups and how to add a security group rule, see Amazon EC2 security groups in the Amazon EC2 User Guide. Can't ﬁnd the EC2 gateway instance in the instance list API Version 2021-03-31 208 AWS Storage Gateway Amazon FSx File Gateway User Guide To let Support connect to your gateway, you ﬁrst log in to the local console for the Amazon EC2 instance, navigate to the Storage Gateway's console, and then provide the access. To turn on Support access for a gateway deployed on an Amazon EC2 instance 1. Log in to the local console for your Amazon EC2 instance. For instructions, go to Connect to your instance in the Amazon EC2 User Guide. You can use the following command to log in to the EC2 instance's local console. ssh –i PRIVATE-KEY admin@INSTANCE-PUBLIC-DNS-NAME Note The PRIVATE-KEY is the .pem ﬁle containing the private certiﬁcate of the EC2 key pair that you used to launch the Amazon EC2 instance.
storagegateway-fsxfile-ug-082	storagegateway-fsxfile-ug.pdf	82	for the Amazon EC2 instance, navigate to the Storage Gateway's console, and then provide the access. To turn on Support access for a gateway deployed on an Amazon EC2 instance 1. Log in to the local console for your Amazon EC2 instance. For instructions, go to Connect to your instance in the Amazon EC2 User Guide. You can use the following command to log in to the EC2 instance's local console. ssh –i PRIVATE-KEY admin@INSTANCE-PUBLIC-DNS-NAME Note The PRIVATE-KEY is the .pem ﬁle containing the private certiﬁcate of the EC2 key pair that you used to launch the Amazon EC2 instance. For more information, see Retrieving the public key for your key pair in the Amazon EC2 User Guide. The INSTANCE-PUBLIC-DNS-NAME is the public Domain Name System (DNS) name of your Amazon EC2 instance that your gateway is running on. You obtain this public DNS name by selecting the Amazon EC2 instance in the EC2 console and clicking the Description tab. 2. At the prompt, enter 6 - Command Prompt to open the Support Channel console. 3. Enter h to open the AVAILABLE COMMANDS window. 4. Do one of the following: • If your gateway is using a public endpoint, in the AVAILABLE COMMANDS window, enter open-support-channel to connect to customer support for Storage Gateway. Allow TCP port 22 so you can open a support channel to AWS. When you connect to customer support, Storage Gateway assigns you a support number. Make a note of your support number. • If your gateway is using a VPC endpoint, in the AVAILABLE COMMANDS window, enter open-support-channel. If your gateway is not activated, provide the VPC endpoint or IP address to connect to customer support for Storage Gateway. Allow TCP port 22 so you can open a support channel to AWS. When you connect to customer support, Storage Gateway assigns you a support number. Make a note of your support number. Turning on Support access to help troubleshoot the gateway API Version 2021-03-31 209 AWS Storage Gateway Amazon FSx File Gateway User Guide Note The channel number is not a Transmission Control Protocol/User Datagram Protocol (TCP/UDP) port number. Instead, the gateway makes a Secure Shell (SSH) (TCP 22) connection to Storage Gateway servers and provides the support channel for the connection. 5. After the support channel is established, provide your support service number to Support so Support can provide troubleshooting assistance. 6. When the support session is completed, enter q to end it. Don't close the session until Amazon Web Services Support notiﬁes you that the support session is complete. 7. 8. Enter exit to exit the Storage Gateway console. Follow the console menus to log out of the Storage Gateway instance. Troubleshooting: hardware appliance issues The following topics discuss issues that you might encounter with the AWS Storage Gateway Hardware Appliance, and suggestions on troubleshooting these. Topics • You can't determine the service IP address • How do you perform a factory reset? • How do you perform a remote restart? • Where do you obtain Dell iDRAC support? • You can't ﬁnd the hardware appliance serial number • Where to obtain hardware appliance support You can't determine the service IP address When attempting to connect to your service, make sure that you are using the service's IP address and not the host IP address. Conﬁgure the service IP address in the service console, and the host IP address in the hardware console. You see the hardware console when you start the hardware appliance. To go to the service console from the hardware console, choose Open Service Console. Troubleshooting: hardware appliance issues API Version 2021-03-31 210 AWS Storage Gateway Amazon FSx File Gateway User Guide How do you perform a factory reset? If you need to perform a factory reset on your appliance, contact the AWS Storage Gateway Hardware Appliance team for support, as described in the Support section following. How do you perform a remote restart? If you need to perform a remote restart of your appliance, you can do so using the Dell iDRAC management interface. For more information, see iDRAC9 Virtual Power Cycle: Remotely power cycle Dell EMC PowerEdge Servers on the Dell Technologies InfoHub website. Where do you obtain Dell iDRAC support? The Dell PowerEdge server comes with the Dell iDRAC management interface. We recommend the following: • If you use the iDRAC management interface, you should change the default password. For more information about the iDRAC credentials, see Dell PowerEdge - What is the default sign-in credentials for iDRAC?. • Make sure that the ﬁrmware is up-to-date to prevent security breaches. • Moving the iDRAC network interface to a normal (em) port can cause performance issues or prevent the normal functioning of the appliance. You can't ﬁnd the hardware appliance serial number You can ﬁnd the serial number
storagegateway-fsxfile-ug-083	storagegateway-fsxfile-ug.pdf	83	Dell iDRAC support? The Dell PowerEdge server comes with the Dell iDRAC management interface. We recommend the following: • If you use the iDRAC management interface, you should change the default password. For more information about the iDRAC credentials, see Dell PowerEdge - What is the default sign-in credentials for iDRAC?. • Make sure that the ﬁrmware is up-to-date to prevent security breaches. • Moving the iDRAC network interface to a normal (em) port can cause performance issues or prevent the normal functioning of the appliance. You can't ﬁnd the hardware appliance serial number You can ﬁnd the serial number for your AWS Storage Gateway Hardware Appliance using the Storage Gateway console. To ﬁnd the hardware appliance serial number: 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. Choose Hardware from the navigation menu on the left side of the page. 3. 4. Select your hardware appliance from the list. Locate the Serial Number ﬁeld on the Details tab for your appliance. How to perform a factory reset API Version 2021-03-31 211 AWS Storage Gateway Amazon FSx File Gateway User Guide Where to obtain hardware appliance support To contact AWS about technical support for your hardware appliance, see Support. The Support team might ask you to activate the support channel to troubleshoot your gateway issues remotely. You don't need this port to be open for the normal operation of your gateway, but it is required for troubleshooting. You can activate the support channel from the hardware console as shown in the procedure following. To open a support channel for AWS 1. Open the hardware console. 2. Choose Open Support Channel at the bottom of the main page of the hardware console, and then press Enter. The assigned port number should appear within 30 seconds if there are no network connectivity or ﬁrewall issues. For example: Status: Open on port 19599 3. Note the port number and provide it to Support. Troubleshooting: File Gateway issues You can conﬁgure your File Gateway to write log entries to a Amazon CloudWatch log group. If you do, you receive notiﬁcations about gateway health status and about any errors that the gateway encounters. You can ﬁnd information about these error and health notiﬁcations in CloudWatch Logs. In the following sections, you can ﬁnd information that can help you understand the cause of each error and health notiﬁcation and how to ﬁx issues. Topics • Error: FileMissing • Error: FsxFileSystemAuthenticationFailure • Error: FsxFileSystemConnectionFailure • Error: FsxFileSystemFull • Error: GatewayClockOutOfSync How to get hardware appliance support API Version 2021-03-31 212 Amazon FSx File Gateway User Guide AWS Storage Gateway • Error: InvalidFileState • Error: ObjectMissing • Error: DroppedNotiﬁcations • Notiﬁcation: HardReboot • Notiﬁcation: Reboot • Troubleshooting: Active Directory domain issues • Troubleshooting: Using CloudWatch metrics Error: FileMissing The FileMissing error is similar to the ObjectMissing error, and the steps to resolve it are identical. You can get a FileMissing error when a writer other than the speciﬁed File Gateway deletes the speciﬁed ﬁle from the Amazon FSx. Any subsequent uploads to Amazon FSx or retrievals from Amazon FSx for the object fail. To resolve a FileMissing error 1. Save the latest copy of the ﬁle to the local ﬁle system of your SMB client (you need this ﬁle copy in step 3). 2. Delete the ﬁle from the File Gateway using your SMB client. 3. Copy the latest version of the ﬁle that you saved in step 1 Amazon FSx using your SMB client. Do this through your File Gateway. Error: FsxFileSystemAuthenticationFailure You can get an FsxFileSystemAuthenticationFailure error when the credentials provided while attaching the ﬁlesystem expired or, its privileges have been revoked. To resolve an FsxFileSystemAuthenticationFailure error 1. Ensure that the credentials provided at the time of attaching the Amazon FSx ﬁle system are still valid. 2. Ensure that the user has all necessary permissions as described in Attach an Amazon FSx for Windows File Server ﬁle system. Error: FileMissing API Version 2021-03-31 213 AWS Storage Gateway Amazon FSx File Gateway User Guide Error: FsxFileSystemConnectionFailure You can get an FsxFileSystemConnectionFailure error when the Amazon FSx server is inaccessible from the gateway machine. To resolve an FsxFileSystemConnectionFailure error 1. Ensure that all the ﬁrewall and VPC rules are allowing the connection between the gateway machine and the Amazon FSx server. 2. Ensure that the Amazon FSx server is running. Error: FsxFileSystemFull You can get an FsxFileSystemFull error when there is not enough free disk space in the Amazon FSx ﬁle system. To resolve an FsxFileSystemFull error • Increase the storage space for the Amazon FSx ﬁle system. Error: GatewayClockOutOfSync You can get a GatewayClockOutOfSync error when the gateway detects a diﬀerence of 5 minutes or more between the local system time and the time reported by the AWS Storage Gateway servers. Clock synchronization issues can negatively
storagegateway-fsxfile-ug-084	storagegateway-fsxfile-ug.pdf	84	rules are allowing the connection between the gateway machine and the Amazon FSx server. 2. Ensure that the Amazon FSx server is running. Error: FsxFileSystemFull You can get an FsxFileSystemFull error when there is not enough free disk space in the Amazon FSx ﬁle system. To resolve an FsxFileSystemFull error • Increase the storage space for the Amazon FSx ﬁle system. Error: GatewayClockOutOfSync You can get a GatewayClockOutOfSync error when the gateway detects a diﬀerence of 5 minutes or more between the local system time and the time reported by the AWS Storage Gateway servers. Clock synchronization issues can negatively impact connectivity between the gateway and AWS. If the gateway clock is out of sync, I/O errors might occur for NFS and SMB connections, and SMB users might experience authentication errors. To resolve a GatewayClockOutOfSync error • Check the network conﬁguration between the gateway and the NTP server. For more information about synchronizing the gateway VM time and updating the NTP server conﬁguration, see Conﬁguring a Network Time Protocol (NTP) server for your gateway. Error: InvalidFileState You can get an InvalidFileState error when a writer other than the speciﬁed gateway modiﬁes the speciﬁed ﬁle in the speciﬁed ﬁle share. As a result, the state of the ﬁle on the gateway doesn’t Error: FsxFileSystemConnectionFailure API Version 2021-03-31 214 AWS Storage Gateway Amazon FSx File Gateway User Guide match its state in Amazon FSx. Any subsequent uploads or retrievals of the ﬁle from Amazon FSx could fail. To resolve an InvalidFileState error 1. Save the latest copy of the ﬁle to the local ﬁle system of your SMB client (you need this ﬁle to copy in step 4). If the version of the ﬁle in Amazon FSx is the latest, download that version. You can do this by directly accessing the Amazon FSx share using any SMB client. 2. Delete the ﬁle in Amazon FSx directly. 3. Delete the ﬁle from the gateway using your SMB client. 4. Using your SMB client, copy the latest version of the ﬁle that you saved in step 1, through your File Gateway,to Amazon FSx. Error: ObjectMissing You can get an ObjectMissing error when a writer other than the speciﬁed File Gateway deletes the speciﬁed ﬁle from the Amazon FSx. Any subsequent uploads to Amazon FSx or retrievals from Amazon FSx for the object fail. To resolve an ObjectMissing error 1. Save the latest copy of the ﬁle to the local ﬁle system of your SMB client (you need this ﬁle copy in step 3). 2. Delete the ﬁle from the File Gateway using your SMB client. 3. Copy the latest version of the ﬁle that you saved in step 1 Amazon FSx using your SMB client. Do this through your File Gateway. Error: DroppedNotiﬁcations You might see a DroppedNotifications error instead of other expected types of CloudWatch log entries when free storage space on your gateway's root disk is less than 1 GB, or if more than 100 health notiﬁcations are generated within a 1 minute interval. In these circumstances, the gateway stops generating detailed CloudWatch log notiﬁcations as a precautionary measure. To resolve a DroppedNotiﬁcations error Error: ObjectMissing API Version 2021-03-31 215 AWS Storage Gateway Amazon FSx File Gateway User Guide 1. Check the Root Disk Usage metric on the Monitoring tab for your gateway in the Storage Gateway console to determine whether available root disk space is running low. 2. Increase the size of the gateway's root storage disk if available space is less than 1 GB. Refer to your virtual machine hypervisor's documentation for instructions. To increase root disk size for Amazon EC2 gateways, see Request modiﬁcations to your EBS volumes in the Amazon Elastic Compute Cloud User Guide. Note It is not possible to increase the root disk size for the AWS Storage Gateway Hardware Appliance. 3. Restart your gateway. Notiﬁcation: HardReboot You can get a HardReboot notiﬁcation when the gateway VM is restarted unexpectedly. Such a restart can be due to loss of power, a hardware failure, or another event. For VMware gateways, a reset by vSphere High Availability Application Monitoring can cause this event. When your gateway runs in such an environment, check for the presence of the HealthCheckFailure notiﬁcation and consult the VMware events log for the VM. Notiﬁcation: Reboot You can get a reboot notiﬁcation when the gateway VM is restarted. You can restart a gateway VM by using the VM Hypervisor Management console or the Storage Gateway console. You can also restart by using the gateway software during the gateway's maintenance cycle. If the time of the reboot is within 10 minutes of the gateway's conﬁgured maintenance start time, this reboot is probably a normal occurrence and not a sign of any problem. If the reboot occurred signiﬁcantly outside the maintenance window, check whether the gateway
storagegateway-fsxfile-ug-085	storagegateway-fsxfile-ug.pdf	85	notiﬁcation and consult the VMware events log for the VM. Notiﬁcation: Reboot You can get a reboot notiﬁcation when the gateway VM is restarted. You can restart a gateway VM by using the VM Hypervisor Management console or the Storage Gateway console. You can also restart by using the gateway software during the gateway's maintenance cycle. If the time of the reboot is within 10 minutes of the gateway's conﬁgured maintenance start time, this reboot is probably a normal occurrence and not a sign of any problem. If the reboot occurred signiﬁcantly outside the maintenance window, check whether the gateway was restarted manually. Troubleshooting: Active Directory domain issues FSx File Gateway doesn't generate speciﬁc log messages for Active Directory domain issues. If you have trouble joining your gateway to your Active Directory domain, do the following: Notiﬁcation: HardReboot API Version 2021-03-31 216 AWS Storage Gateway Amazon FSx File Gateway User Guide • Verify that the gateway is not attempting to use a read-only domain controller (RODC) to join the domain. • Verify that the gateway is conﬁgured to use the correct DNS servers. For example, if you are trying to join an Amazon EC2 gateway instance to an AWS-managed Active Directory, verify that the DHCP option set for your EC2 VPC speciﬁes the AWS-managed Active Directory DNS servers. DNS servers that you conﬁgure through the VPC DHCP options set are provided to the all EC2 instances in the VPC. If you want to specify a DNS server for an individual gateway, you can do so using that gateway's EC2 local console. For on-premises gateways, you specify a DNS server using the VM local console. • Verify gateway network connectivity by running the following commands from the command prompt in the gateway's local console. Replace the highlighted variables with the actual domain name and IP addresses from your deployment. dig -d ExampleDomainName ncport -d ExampleDomainControllerIPAddress -p 445 ncport -d ExampleDomainControllerIPAddress -p 389 • Verify that your Active Directory service account has the requisite permissions. For more information, see Active Directory service account permission requirements. • Verify that the gateway joins the correct Organizational Unit (OU). Joining a domain creates an Active Directory computer account in the default computers container (which is not an OU), using the gateway's Gateway ID as the account name (for example, SGW-1234ADE). It is not possible to customize the name of this account. If your Active Directory environment has a designated OU for new computer objects, you must specify that OU when joining the domain. If you encounter access denied errors when attempting to join the designated OU, check with your Active Directory domain administrator. The administrator may need to pre-stage the gateway's computer account before it can join the domain. For more information, see How can I troubleshoot issues with joining my Storage Gateway ﬁle gateway to a domain for Microsoft Active Directory authentication?. Troubleshooting Active Directory domain issues API Version 2021-03-31 217 AWS Storage Gateway Amazon FSx File Gateway User Guide • Verify that your gateway's hostname is resolvable in DNS by running the following command from the command prompt in the gateway's local console. Replace the highlighted variable with the actual hostname for your gateway. dig -d ExampleHostName -r A If you conﬁgured a custom hostname for your gateway, you must manually add a DNS A-record that points to its IP address. • Verify that network latency between the gateway and the domain controller is reasonably low. The query to join a domain can time out if the gateway does not receive a response from the domain controller within 20 seconds. If you join the gateway to the domain using the JoinDomain CLI command, you can can add the --timeout-in-seconds ﬂag to increase the timeout to a maximum of 3,600 seconds. • Verify that the Active Directory user you are using to join the gateway to the domain has the privileges required to do so. Troubleshooting: Using CloudWatch metrics You can ﬁnd information following about actions to address issues using Amazon CloudWatch metrics with Storage Gateway. Topics • Your gateway reacts slowly when browsing directories • Your gateway isn't responding • You do not see ﬁles in your Amazon FSx ﬁle system • You do not see older snapshots in your Amazon FSx ﬁle system • Your gateway is slow transferring data to Amazon FSx • Your gateway backup job fails or there are errors when writing to your gateway Your gateway reacts slowly when browsing directories If your File Gateway reacts slowly when you run the ls command or browse directories, check the IndexFetch and IndexEviction CloudWatch metrics: Troubleshooting with CloudWatch metrics API Version 2021-03-31 218 AWS Storage Gateway Amazon FSx File Gateway User Guide • If the IndexFetch metric is greater than 0 when you run an ls command or browse directories,
storagegateway-fsxfile-ug-086	storagegateway-fsxfile-ug.pdf	86	do not see older snapshots in your Amazon FSx ﬁle system • Your gateway is slow transferring data to Amazon FSx • Your gateway backup job fails or there are errors when writing to your gateway Your gateway reacts slowly when browsing directories If your File Gateway reacts slowly when you run the ls command or browse directories, check the IndexFetch and IndexEviction CloudWatch metrics: Troubleshooting with CloudWatch metrics API Version 2021-03-31 218 AWS Storage Gateway Amazon FSx File Gateway User Guide • If the IndexFetch metric is greater than 0 when you run an ls command or browse directories, your File Gateway started without information on the contents of the directory aﬀected and had to access FSx for Windows File Server. Subsequent eﬀorts to list the contents of that directory should go faster. • If the IndexEviction metric is greater than 0, it means that your File Gateway has reached the limit of what it can manage in its cache at that time. In this case, your File Gateway has to free some storage space from the least recently accessed directory to list a new directory. If this occurs frequently and there is a performance impact, contact Support. Discuss with Support the contents of the related Amazon FSx ﬁle system and recommendations to improve performance based on your use case. Your gateway isn't responding If your File Gateway isn't responding, do the following: • If there was a recent reboot or software update, then check the IOWaitPercent metric. This metric shows the percentage of time that the CPU is idle when there is an outstanding disk I/O request. In some cases, this might be high (10 or greater) and might have risen after the server was rebooted or updated. In these cases, then your File Gateway might be bottlenecked by a slow root disk as it rebuilds the index cache to RAM. You can address this issue by using a faster physical disk for the root disk. • If the MemUsedBytes metric is at or nearly the same as the MemTotalBytes metric, then your File Gateway is running out of available RAM. Make sure that your File Gateway has at least the minimum required RAM. If it already does, consider adding more RAM to your File Gateway based on your workload and use case. If the ﬁle share is SMB, the issue might also be due to the number of SMB clients connected to the ﬁle share. To see the number of clients connected at any given time, check the SMBV(1/2/3)Sessions metric. If there are many clients connected, you might need to add more RAM to your File Gateway. You do not see ﬁles in your Amazon FSx ﬁle system If you notice that ﬁles on the gateway are not reﬂected in the Amazon FSx ﬁle system, check the FilesFailingUpload metric. If the metric reports that some ﬁles are failing upload, check Troubleshooting with CloudWatch metrics API Version 2021-03-31 219 AWS Storage Gateway Amazon FSx File Gateway User Guide your health notiﬁcations. When ﬁles fail to upload, the gateway generates a health notiﬁcation containing more details on the issue. You do not see older snapshots in your Amazon FSx ﬁle system Some ﬁle operations on the FSx File Gateway, such as top-level folder renames or permission changes, can result in multiple ﬁle operations that lead to a high I/O load on your FSx for Windows File Server ﬁle system. If your ﬁle system doesn't have enough performance resources for your workload, the ﬁle system might delete shadow copies because it prioritizes availability for ongoing I/O over historical shadow copy retention. In the Amazon FSx console, check the Monitoring and performance page to see if your ﬁle system is under-provisioned. If it is, you can switch to SSD storage, increase throughput capacity, or increase SSD IOPS to handle your workload. Your gateway is slow transferring data to Amazon FSx If your File Gateway is slow transferring data to Amazon FSx for Windows File Server, do the following: • If the CachePercentDirty metric is 80 or greater, your File Gateway is writing data faster to disk than it can upload the data to Amazon FSx for Windows File Server. Consider increasing the bandwidth for upload from your File Gateway, adding one or more cache disks, or slowing down client writes, or increase the throughput capacity for associated Amazon FSx for Windows File Server. • If the CachePercentDirty metric is low, check the IoWaitPercent metric. If IoWaitPercent is greater than 10, your File Gateway might be bottlenecked by the speed of the local cache disk. We recommend local solid state drive (SSD) disks for your cache, preferably NVM Express (NVMe). If such disks aren't available, try using multiple cache disks from separate physical disks for a performance improvement. Your gateway backup job
storagegateway-fsxfile-ug-087	storagegateway-fsxfile-ug.pdf	87	the bandwidth for upload from your File Gateway, adding one or more cache disks, or slowing down client writes, or increase the throughput capacity for associated Amazon FSx for Windows File Server. • If the CachePercentDirty metric is low, check the IoWaitPercent metric. If IoWaitPercent is greater than 10, your File Gateway might be bottlenecked by the speed of the local cache disk. We recommend local solid state drive (SSD) disks for your cache, preferably NVM Express (NVMe). If such disks aren't available, try using multiple cache disks from separate physical disks for a performance improvement. Your gateway backup job fails or there are errors when writing to your gateway If your File Gateway backup job fails or there are errors when writing to your File Gateway, do the following: • If the CachePercentDirty metric is 90 percent or greater, your File Gateway can't accept new writes to disk because there is not enough available space on the cache disk. To see how fast Troubleshooting with CloudWatch metrics API Version 2021-03-31 220 AWS Storage Gateway Amazon FSx File Gateway User Guide your File Gateway is uploading to FSx for Windows File Server, view the CloudBytesUploaded metric. Compare that metric with the WriteBytes metric, which shows how fast the client is writing ﬁles to your File Gateway. If the SMB client is writing to your File Gateway faster than it can upload to FSx for Windows File Server, add more cache disks to cover the size of the backup job at a minimum. Or, increase the upload bandwidth. • If a large ﬁle copy such as backup job fails but the CachePercentDirty metric is less than 80 percent, your File Gateway might be hitting a client-side session timeout. For SMB, you can increase this timeout using the PowerShell command Set-SmbClientConfiguration - SessionTimeout 300. Running this command sets the timeout to 300 seconds. High Availability Health Notiﬁcations When running your gateway on the VMware vSphere High Availability (HA) platform, you may receive health notiﬁcations. For more information about health notiﬁcations, see Troubleshooting: high availability issues. Troubleshooting: high availability issues You can ﬁnd information following about actions to take if you experience availability issues. Topics • Health notiﬁcations • Metrics Health notiﬁcations When you run your gateway on VMware vSphere HA, all gateways produce the following health notiﬁcations to your conﬁgured Amazon CloudWatch log group. These notiﬁcations go into a log stream called AvailabilityMonitor. Topics • Notiﬁcation: Reboot • Notiﬁcation: HardReboot • Notiﬁcation: HealthCheckFailure • Notiﬁcation: AvailabilityMonitorTest High Availability Health Notiﬁcations API Version 2021-03-31 221 AWS Storage Gateway Notiﬁcation: Reboot Amazon FSx File Gateway User Guide You can get a reboot notiﬁcation when the gateway VM is restarted. You can restart a gateway VM by using the VM Hypervisor Management console or the Storage Gateway console. You can also restart by using the gateway software during the gateway's maintenance cycle. Action to Take If the time of the reboot is within 10 minutes of the gateway's conﬁgured maintenance start time, this is probably a normal occurrence and not a sign of any problem. If the reboot occurred signiﬁcantly outside the maintenance window, check whether the gateway was restarted manually. Notiﬁcation: HardReboot You can get a HardReboot notiﬁcation when the gateway VM is restarted unexpectedly. Such a restart can be due to loss of power, a hardware failure, or another event. For VMware gateways, a reset by vSphere High Availability Application Monitoring can cause this event. Action to Take When your gateway runs in such an environment, check for the presence of the HealthCheckFailure notiﬁcation and consult the VMware events log for the VM. Notiﬁcation: HealthCheckFailure For a gateway on VMware vSphere HA, you can get a HealthCheckFailure notiﬁcation when a health check fails and a VM restart is requested. This event also occurs during a test to monitor availability, indicated by an AvailabilityMonitorTest notiﬁcation. In this case, the HealthCheckFailure notiﬁcation is expected. Note This notiﬁcation is for VMware gateways only. Action to Take If this event repeatedly occurs without an AvailabilityMonitorTest notiﬁcation, check your VM infrastructure for issues (storage, memory, and so on). If you need additional assistance, contact Support. Health notiﬁcations API Version 2021-03-31 222 AWS Storage Gateway Amazon FSx File Gateway User Guide Notiﬁcation: AvailabilityMonitorTest For a gateway on VMware vSphere HA, you can get an AvailabilityMonitorTest notiﬁcation when you run a test of the Availability and application monitoring system in VMware. Metrics The AvailabilityNotifications metric is available on all gateways. This metric is a count of the number of availability-related health notiﬁcations generated by the gateway. Use the Sum statistic to observe whether the gateway is experiencing any availability-related events. Consult with your conﬁgured CloudWatch log group for details about the events. Metrics API Version 2021-03-31 223 AWS Storage Gateway Amazon FSx File Gateway User Guide Best practices for File
storagegateway-fsxfile-ug-088	storagegateway-fsxfile-ug.pdf	88	User Guide Notiﬁcation: AvailabilityMonitorTest For a gateway on VMware vSphere HA, you can get an AvailabilityMonitorTest notiﬁcation when you run a test of the Availability and application monitoring system in VMware. Metrics The AvailabilityNotifications metric is available on all gateways. This metric is a count of the number of availability-related health notiﬁcations generated by the gateway. Use the Sum statistic to observe whether the gateway is experiencing any availability-related events. Consult with your conﬁgured CloudWatch log group for details about the events. Metrics API Version 2021-03-31 223 AWS Storage Gateway Amazon FSx File Gateway User Guide Best practices for File Gateway This section contains the following topics, which provide information about the best practices for working with gateways, ﬁle shares, buckets, and data. We recommend that you familiarize yourself with the information outlined in this section, and attempt to follow these guidelines in order to avoid problems with your AWS Storage Gateway. For additional guidance on diagnosing and solving common issues you might encounter with your deployment, see Troubleshooting problems with your Storage Gateway deployment. Topics • Best practices: recovering your data • Restoring from backups or snapshots directly on Amazon FSx • Clean up unnecessary resources Best practices: recovering your data Although it is rare, your gateway might encounter an unrecoverable failure. Such a failure can occur in your virtual machine (VM), the gateway itself, the local storage, or elsewhere. If a failure occurs, we recommend that you follow the instructions in the appropriate section following to recover your data. Important Storage Gateway doesn’t support recovering a gateway VM from a snapshot that is created by your hypervisor or from your Amazon EC2 Amazon Machine Image (AMI). If your gateway VM malfunctions, activate a new gateway and recover your data to that gateway using the instructions following. Recovering from an unexpected virtual machine shutdown If your VM shuts down unexpectedly, for example during a power outage, your gateway becomes unreachable. When power and network connectivity are restored, your gateway becomes reachable and starts to function normally. Following are some steps you can take at that point to help recover your data: Recovering your data API Version 2021-03-31 224 AWS Storage Gateway Amazon FSx File Gateway User Guide • If an outage causes network connectivity issues, you can troubleshoot the issue. For information about how to test network connectivity, see Testing your gateway's network connectivity. Recovering your data from a malfunctioning cache disk If your cache disk encounters a failure, we recommend you use the following steps to recover your data depending on your situation: • If the malfunction occurred because a cache disk was removed from your host, shut down the gateway, re-add the disk, and restart the gateway. Recovering your data from an inaccessible data center If your gateway or data center becomes inaccessible for some reason, you can recover your data to another gateway in a diﬀerent data center or recover to a gateway hosted on an Amazon EC2 instance. If you don't have access to another data center, we recommend creating the gateway on an Amazon EC2 instance. The steps you follow depends on the gateway type you are covering the data from. To recover data from a File Gateway in an inaccessible data center For File Gateway, you map a new ﬁle system to the FSx for Windows File Server that contains the data you want to recover. 1. Create and activate a new File Gateway on an Amazon EC2 host. For more information, see Deploy a default Amazon EC2 host for FSx File Gateway. 2. Create a new ﬁle system on the EC2 gateway you created. For more information, see Create an FSx for Windows File Server ﬁle system. 3. Mount your ﬁle system on your client and map it to the FSx for Windows File Server that contains the data that you want to recover. For more information, see Mount and use your ﬁle share. Restoring from backups or snapshots directly on Amazon FSx In some cases, you might need to restore data on your Amazon FSx ﬁle system directly, using a backup or snapshot from an earlier point in time. In these instances, there is a risk of creating a dual-writer scenario between the backup application and the FSx File Gateway, which can result in Recovering data from a malfunctioning cache disk API Version 2021-03-31 225 AWS Storage Gateway Amazon FSx File Gateway User Guide stuck or mis-matched ﬁles. To avoid problems when restoring your Amazon FSx ﬁle system from backups or snapshots, use the following procedure. Note Any cached data currently stored on your FSx File Gateway will not be valid after you restore your Amazon FSx ﬁle system from a backup or snapshot using this procedure. To avoid problems when restoring your Amazon FSx ﬁle system from backups or snapshots
storagegateway-fsxfile-ug-089	storagegateway-fsxfile-ug.pdf	89	between the backup application and the FSx File Gateway, which can result in Recovering data from a malfunctioning cache disk API Version 2021-03-31 225 AWS Storage Gateway Amazon FSx File Gateway User Guide stuck or mis-matched ﬁles. To avoid problems when restoring your Amazon FSx ﬁle system from backups or snapshots, use the following procedure. Note Any cached data currently stored on your FSx File Gateway will not be valid after you restore your Amazon FSx ﬁle system from a backup or snapshot using this procedure. To avoid problems when restoring your Amazon FSx ﬁle system from backups or snapshots 1. Detach the Amazon FSx ﬁle system from the FSx File Gateway using the Storage Gateway console. 2. Restore the backup or snapshot directly on your Amazon FSx ﬁle system. 3. Reattach the Amazon FSx ﬁle system to the FSx File Gateway using the Storage Gateway console. Clean up unnecessary resources As a best practice, we recommend cleaning up Storage Gateway resources to avoid unexpected or unnecessary charges. For example, if you created a gateway as a demonstration exercise or a test, consider deleting it and its virtual appliance from your deployment. Use the following procedure to clean up resources. To clean up resources you don't need 1. If you no longer plan to continue using a gateway, delete it. For more information, see Deleting your gateway and removing associated resources. 2. Delete the Storage Gateway VM from your on-premises host. If you created your gateway on an Amazon EC2 instance, terminate the instance. Clean up unnecessary resources API Version 2021-03-31 226 AWS Storage Gateway Amazon FSx File Gateway User Guide Additional Storage Gateway resources This section contains the following topics, which provide additional information and resources related to setting up and using AWS Storage Gateway: Topics • Host setup - Learn how to deploy and conﬁgure a virtual machine host for your gateway. • Using Storage Gateway with VMware HA - Learn how to set up Storage Gateway to work with VMware vSphere high availability features. • Getting activation key - Learn where to ﬁnd the activation key that you need to provide when you deploy a new gateway. • Using AWS Direct Connect - Learn how to create a dedicated network connection between your on-premises gateway and the AWS cloud. • Active Directory permissions - Learn which permissions your service account must have to be able to join your gateway to your Active Directory domain. • Getting the IP address for your gateway appliance - Learn where to ﬁnd the gateway's virtual machine host IP address, which you need to provide when you deploy a new gateway. • Understanding resources and resource IDs - Learn how AWS identiﬁes the resources and subresources that are created by Storage Gateway. • Tagging your resources - Learn how to use metadata tags to categorize your resources and make them easier to manage. • Open-source components - Learn about the third-party tools and licenses that are used to deliver Storage Gateway functionality. • Quotas - Learn about limits and quotas for File Gateway, including minimum and maximum limitations for ﬁle shares and local cache disks. Deploying and conﬁguring the gateway VM host The following topics provide information about setting up the virtual machine host platform for your gateway. Topics • Deploy a default Amazon EC2 host for FSx File Gateway Host setup API Version 2021-03-31 227 AWS Storage Gateway Amazon FSx File Gateway User Guide • Deploy a customized Amazon EC2 host for FSx File Gateway • Modify Amazon EC2 instance metadata options • Synchronize VM time with Hyper-V or Linux KVM host time • Synchronize VM time with VMware host time • Conﬁguring network adapters for your gateway • Using VMware vSphere High Availability with Storage Gateway Deploy a default Amazon EC2 host for FSx File Gateway This topic lists the steps to deploy an Amazon EC2 host using the default speciﬁcations. You can deploy and activate an Amazon FSx File Gateway on an Amazon Elastic Compute Cloud (Amazon EC2) instance. The AWS Storage Gateway Amazon Machine Image (AMI) is available as a community AMI. Note Storage Gateway community AMIs are published and fully supported by AWS. You can see that the publisher is AWS, a veriﬁed provider. 1. 2. To set up the Amazon EC2 instance, choose Amazon EC2 as the Host platform in the Platform options section of the workﬂow. For instructions on conﬁguring the Amazon EC2 instance, see Deploying an Amazon EC2 instance to host your Amazon FSx File Gateway. Select Launch instance to open the AWS Storage Gateway AMI template in the Amazon EC2 console and customize additional settings such as Instance types, Network settings and Conﬁgure storage. 3. Optionally, you can select Use default settings in the Storage Gateway console to deploy an Amazon EC2 instance
storagegateway-fsxfile-ug-090	storagegateway-fsxfile-ug.pdf	90	the publisher is AWS, a veriﬁed provider. 1. 2. To set up the Amazon EC2 instance, choose Amazon EC2 as the Host platform in the Platform options section of the workﬂow. For instructions on conﬁguring the Amazon EC2 instance, see Deploying an Amazon EC2 instance to host your Amazon FSx File Gateway. Select Launch instance to open the AWS Storage Gateway AMI template in the Amazon EC2 console and customize additional settings such as Instance types, Network settings and Conﬁgure storage. 3. Optionally, you can select Use default settings in the Storage Gateway console to deploy an Amazon EC2 instance with the default conﬁguration. The Amazon EC2 instance that Use default settings creates has the following default speciﬁcations: • Instance type — m5.xlarge • Network Settings • For VPC, select the VPC that you want your EC2 instance to run in. Deploy a default Amazon EC2 host for File Gateway API Version 2021-03-31 228 AWS Storage Gateway Amazon FSx File Gateway User Guide • For Subnet, specify the subnet that your EC2 instance should be launched in. Note VPC subnets will appear in the drop down only if they have the auto-assign public IPv4 address setting activated from the VPC management console. • Auto-assign Public IP — Activated • An EC2 security group is created and associated with the EC2 Instance. The security group has the following inbound port rules: Note You will need Port 80 open during gateway activation. The port is closed immediately following activation. Thereafter, your EC2 instance can only be accessed over the other ports from the selected VPC. The ﬁle shares on your gateway are only accessible from the hosts in the same VPC as the gateway. If the ﬁle shares need to be accessed from hosts outside of the VPC, you should update the appropriate security group rules. You can edit security groups at any time by navigating to the Amazon EC2 instance details page, selecting Security, navigating to Security group details, and choosing the security group ID. Port Protocol 80 TCP UDP UDP 137 138 139 TCP, UDP SMB File System Protocol HTTP access for activation NetBIOS NetBIOS Deploy a default Amazon EC2 host for File Gateway API Version 2021-03-31 229 AWS Storage Gateway Amazon FSx File Gateway User Guide Port Protocol 389 445 TCP TCP • Conﬁgure storage File System Protocol LDAP SMB Default Settings AMI Root Volume Volume 2 Cache Device Name '/dev/sdb' Size 80 Gib 165 GiB Volume Type gp3 gp3 IOPS 3000 3000 Yes Yes Delete on terminati on Encrypted No Throughpu t 125 No 125 Deploy a customized Amazon EC2 host for FSx File Gateway You can deploy and activate an Amazon FSx File Gateway on an Amazon Elastic Compute Cloud (Amazon EC2) instance. The AWS Storage Gateway Amazon Machine Image (AMI) is available as a community AMI. Deploy a customized Amazon EC2 host for File Gateway API Version 2021-03-31 230 AWS Storage Gateway Amazon FSx File Gateway User Guide Note Storage Gateway community AMIs are published and fully supported by AWS. You can see that the publisher is AWS, a veriﬁed provider. FSx File Gateway AMIs use the following naming convention. The version number appended to the AMI name changes with each version release. aws-storage-gateway-FILE_FSX_SMB-2.2.3 To deploy an Amazon EC2 instance to host your Amazon FSx File Gateway 1. Start setting up a new gateway using the Storage Gateway console. For instructions, see Set up an Amazon FSx File Gateway. When you reach the Platform options section, choose Amazon EC2 as the Host platform, then use the following steps to launch the Amazon EC2 instance that will host your File Gateway. 2. Choose Launch instance to open the AWS Storage Gateway AMI template in the Amazon EC2 console, where you can conﬁgure additional settings. Use Quicklaunch to launch the Amazon EC2 instance with default settings. For more information on Amazon EC2 Quicklaunch default speciﬁcations, see Quicklaunch Conﬁguration Speciﬁcations for Amazon EC2. 3. 4. For Name, enter a name for the Amazon EC2 instance. After the instance is deployed, you can search for this name to ﬁnd your instance on list pages in the Amazon EC2 console. In the Instance type section, for Instance type, choose the hardware conﬁguration for your instance. The hardware conﬁguration must meet certain minimum requirements to support your gateway. We recommend starting with the m5.xlarge instance type, which meets the minimum hardware requirements for your gateway to function properly. For more information, see Requirements for Amazon EC2 instance types. You can resize your instance after you launch, if necessary. For more information, see Resizing your instance in the Amazon EC2 User Guide. Note Certain instance types, particularly i3 EC2, use NVMe SSD disks. These can cause problems when you start or stop File Gateway; for example, you can lose data from the cache.
storagegateway-fsxfile-ug-091	storagegateway-fsxfile-ug.pdf	91	conﬁguration for your instance. The hardware conﬁguration must meet certain minimum requirements to support your gateway. We recommend starting with the m5.xlarge instance type, which meets the minimum hardware requirements for your gateway to function properly. For more information, see Requirements for Amazon EC2 instance types. You can resize your instance after you launch, if necessary. For more information, see Resizing your instance in the Amazon EC2 User Guide. Note Certain instance types, particularly i3 EC2, use NVMe SSD disks. These can cause problems when you start or stop File Gateway; for example, you can lose data from the cache. Monitor the CachePercentDirty Amazon CloudWatch metric, and only start Deploy a customized Amazon EC2 host for File Gateway API Version 2021-03-31 231 AWS Storage Gateway Amazon FSx File Gateway User Guide or stop your system when that parameter is 0. To learn more about monitoring metrics for your gateway, see Storage Gateway metrics and dimensions in the CloudWatch documentation. 5. In the Key pair (login) section, for Key pair name - required, select the key pair you want to use to securely connect to your instance. You can create a new key pair if necessary. For more information, see Create a key pair in the Amazon Elastic Compute Cloud User Guide for Linux Instances. 6. In the Network settings section, review the preconﬁgured settings and choose Edit to make changes to the following ﬁelds: a. b. For VPC - required, choose the VPC where you want to launch your Amazon EC2 instance. For more information, see How Amazon VPC works in the Amazon Virtual Private Cloud User Guide. (Optional) For Subnet, choose the subnet where you want to launch your Amazon EC2 instance. c. For Auto-assign Public IP, choose Enable. 7. In the Firewall (security groups) subsection, review the preconﬁgured settings. You can change the default name and description of the new security group to be created for your Amazon EC2 instance if you want, or choose to apply ﬁrewall rules from an existing security group instead. 8. In the Inbound security groups rules subsection, add ﬁrewall rules to open the ports that clients will use to connect to your instance. For more information on the ports required for Amazon FSx File Gateway, see Port requirements. For more information on adding ﬁrewall rules, see Security group rules in the Amazon Elastic Compute Cloud User Guide for Linux Instances. Note Amazon FSx File Gateway requires TCP port 80 to be open for inbound traﬃc and one- time HTTP access during gateway activation. After activation, you can close this port. Additionally, you must open TCP port 445 for SMB access, UDP port 137 for NetBIOS access, UDP port 138 for NetBIOS access, and TCP port 389 for LDAP access. 9. In the Advanced network conﬁguration subsection, review the preconﬁgured settings and make changes if necessary. Deploy a customized Amazon EC2 host for File Gateway API Version 2021-03-31 232 AWS Storage Gateway Amazon FSx File Gateway User Guide 10. In the Conﬁgure storage section, choose Add new volume to add storage to your gateway instance. Important You must add at least one Amazon EBS volume with at least 150 GiB capacity for cache storage in addition to the preconﬁgured Root volume. For increased performance, we recommend allocating multiple EBS volumes for cache storage with at least 150 GiB each. 11. In the Advanced details section, review the preconﬁgured settings and make changes if necessary. 12. Choose Launch instance to launch your new Amazon EC2 gateway instance with the conﬁgured settings. 13. To verify that your new instance launched successfully, navigate to the Instances page in the Amazon EC2 console and search for your new instance by name. Ensure that that Instance state displays Running with a green check mark, and that the Status check is complete, and shows a green check mark. 14. Select your instance from the details page. Copy the Public IPv4 address from the Instance summary section, then return to the Set up gateway page in the Storage Gateway console to resume setting up your Amazon FSx File Gateway. You can determine the AMI ID to use for launching a File Gateway by using the Storage Gateway console or by querying the AWS Systems Manager parameter store. To determine the AMI ID, do one of the following: • Start setting up a new gateway using the Storage Gateway console. For instructions, see Set up an Amazon FSx File Gateway. When you reach the Platform options section, choose Amazon EC2 as the Host platform, then choose Launch instance to open the AWS Storage Gateway AMI template in the Amazon EC2 console. You are redirected to the EC2 community AMI page, where you can see the AMI ID for your AWS Region in the URL. • Query the Systems Manager parameter store.
storagegateway-fsxfile-ug-092	storagegateway-fsxfile-ug.pdf	92	querying the AWS Systems Manager parameter store. To determine the AMI ID, do one of the following: • Start setting up a new gateway using the Storage Gateway console. For instructions, see Set up an Amazon FSx File Gateway. When you reach the Platform options section, choose Amazon EC2 as the Host platform, then choose Launch instance to open the AWS Storage Gateway AMI template in the Amazon EC2 console. You are redirected to the EC2 community AMI page, where you can see the AMI ID for your AWS Region in the URL. • Query the Systems Manager parameter store. You can use the AWS CLI or Storage Gateway API to query the Systems Manager public parameter under the namespace /aws/service/ Deploy a customized Amazon EC2 host for File Gateway API Version 2021-03-31 233 AWS Storage Gateway Amazon FSx File Gateway User Guide storagegateway/ami/FILE_FSX_SMB/latest. For example, using the following CLI command returns the ID of the current AMI in the AWS Region you specify. aws --region us-east-2 ssm get-parameter --name /aws/service/storagegateway/ami/ FILE_FSX_SMB/latest The CLI command returns output similar to the following. { "Parameter": { "Type": "String", "LastModifiedDate": 1561054105.083, "Version": 18, "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/storagegateway/ami/ FILE_FSX_SMB/latest", "Name": "/aws/service/storagegateway/ami/FILE_FSX_SMB/latest",, "Value": "ami-033d1edba5606cffb" } } Modify Amazon EC2 instance metadata options The instance metadata service (IMDS) is an on-instance component that provides secure access to Amazon EC2 instance metadata. An instance can be conﬁgured to accept incoming metadata requests that use IMDS Version 1 (IMDSv1) or require that all metadata requests use IMDS Version 2 (IMDSv2). IMDSv2 uses session-oriented requests and mitigates several types of vulnerabilities that could be used to try to access the IMDS. For information about IMDSv2, see How Instance Metadata Service Version 2 works in the Amazon Elastic Compute Cloud User Guide. We recommend that you require IMDSv2 for all Amazon EC2 instances that host Storage Gateway. IMDSv2 is required by default on all newly launched gateway instances. If you have existing instances that are still conﬁgured to accept IMDSv1 metadata requests, see Require the use of IMDSv2 in the Amazon Elastic Compute Cloud User Guide for instructions to modify your instance metadata options to require the use of IMDSv2. Applying this change does not require an instance reboot. Modify Amazon EC2 instance metadata options API Version 2021-03-31 234 AWS Storage Gateway Amazon FSx File Gateway User Guide Synchronize VM time with Hyper-V or Linux KVM host time For a gateway deployed on VMware ESXi, setting the hypervisor host time and synchronizing the virtual machine time to the host is suﬃcient to avoid time drift. For more information, see Synchronize VM time with VMware host time. For a gateway deployed on Microsoft Hyper-V or Linux KVM, we recommend that you periodically check the virtual machine time using the procedure described following. To view and synchronize the time of a hypervisor gateway virtual machine to a Network Time Protocol (NTP) server 1. Log in to your gateway's local console: • For more information on logging in to the Microsoft Hyper-V local console, see Access the Gateway Local Console with Microsoft Hyper-V. • For more information on logging in to the local console for Linux Kernel-based Virtual Machine (KVM), see Accessing the Gateway Local Console with Linux KVM. 2. On the Storage Gateway Conﬁguration main menu screen, enter the corresponding numeral to select System Time Management. 3. On the System Time Management menu screen, enter the corresponding numeral to select View and Synchronize System Time. The gateway local console displays the current system time and compares it with the time reported by the NTP server, then reports the exact discrepancy between the two times in seconds. 4. If the time discrepancy is greater than 60 seconds, enter y to synchronize the system time with NTP time. Otherwise, enter n. Time synchronization might take a few moments. Synchronize VM time with VMware host time To successfully activate your gateway, you must ensure that your VM time is synchronized to the host time, and that the host time is correctly set. In this section, you ﬁrst synchronize the time on the VM to the host time. Then you check the host time and, if needed, set the host time and conﬁgure the host to synchronize its time automatically to a Network Time Protocol (NTP) server. Synchronize VM time with Hyper-V or Linux KVM host time API Version 2021-03-31 235 AWS Storage Gateway Amazon FSx File Gateway User Guide Important Synchronizing the VM time with the host time is required for successful gateway activation. To synchronize VM time with host time 1. Conﬁgure your VM time. a. In the vSphere client, right-click on the name of your gateway VM in panel on the left side of the application window to open the context menu for the VM, and then choose Edit Settings. The Virtual Machine Properties dialog
storagegateway-fsxfile-ug-093	storagegateway-fsxfile-ug.pdf	93	time automatically to a Network Time Protocol (NTP) server. Synchronize VM time with Hyper-V or Linux KVM host time API Version 2021-03-31 235 AWS Storage Gateway Amazon FSx File Gateway User Guide Important Synchronizing the VM time with the host time is required for successful gateway activation. To synchronize VM time with host time 1. Conﬁgure your VM time. a. In the vSphere client, right-click on the name of your gateway VM in panel on the left side of the application window to open the context menu for the VM, and then choose Edit Settings. The Virtual Machine Properties dialog box opens. b. Choose the Options tab, and then choose VMware Tools from the options list. c. Check the Synchronize guest time with host option in the Advanced section on the right side of the Virtual Machine Properties dialog box, and then choose OK. The VM synchronizes its time with the host. 2. Conﬁgure the host time. It is important to make sure that your host clock is set to the correct time. If you have not conﬁgured your host clock, perform the following steps to set and synchronize it with an NTP server. a. In the VMware vSphere client, select the vSphere host node in the left panel, and then choose the Conﬁguration tab. b. Select Time Conﬁguration in the Software panel, and then choose the Properties link. The Time Conﬁguration dialog box appears. c. Under Date and Time, set the date and time for your vSphere host. d. Conﬁgure the host to synchronize its time automatically to an NTP server. i. ii. iii. Choose Options in the Time Conﬁguration dialog box, and then in the NTP Daemon (ntpd) Options dialog box, choose NTP Settings in the left panel. Choose Add to add a new NTP server. In the Add NTP Server dialog box, type the IP address or the fully qualiﬁed domain name of an NTP server, and then choose OK. Synchronize VM time with VMware host time API Version 2021-03-31 236 AWS Storage Gateway Amazon FSx File Gateway User Guide You can use pool.ntp.org as the domain name. iv. In the NTP Daemon (ntpd) Options dialog box, choose General in the left panel. v. Under Service Commands, choose Start to start the service. Note that if you change this NTP server reference or add another later, you will need to restart the service to use the new server. e. f. Choose OK to close the NTP Daemon (ntpd) Options dialog box. Choose OK to close the Time Conﬁguration dialog box. Conﬁguring network adapters for your gateway Storage Gateway uses a single VMXNET3 (10 GbE) network adapter by default, but you can conﬁgure your gateway to use more than one network adapter so that it can be accessed by multiple IP addresses. You might want to do this in the following situations: • Maximizing throughput– You might want to maximize throughput to a gateway when network adapters are a bottleneck. • Application separation – You might need to separate how your applications write to a gateway's volumes. For example, you might choose to have a critical storage application exclusively use one particular adapter deﬁned for your gateway. • Network constraints – Your application environment might require that you keep your ﬁle shares and the initiators that connect to them in an isolated network. This network is diﬀerent from the network by which the gateway communicates with AWS. In a typical multiple-adapter use case, one adapter is conﬁgured as the route by which the gateway communicates with AWS (that is, as the default gateway). Except for this one adapter, initiators must be in the same subnet as the adapter that contains the ﬁle shares to which they connect. Otherwise, communication with the intended targets might not be possible. If a target is conﬁgured on the same adapter that is used for communication with AWS, then ﬁle share traﬃc for that target and AWS traﬃc ﬂows through the same adapter. In some cases, you might conﬁgure one adapter to connect to the Storage Gateway console and then add a second adapter. In such a case, Storage Gateway automatically conﬁgures the route table to use the second adapter as the preferred route. For instructions on how to conﬁgure multiple adapters, see the following topics: Conﬁguring network adapters for your gateway API Version 2021-03-31 237 AWS Storage Gateway Topics Amazon FSx File Gateway User Guide • Conﬁguring Your Gateway for Multiple NICs on a VMware ESXi Host • Conﬁguring Your Gateway for Multiple NICs in Microsoft Hyper-V Host Conﬁguring Your Gateway for Multiple NICs on a VMware ESXi Host The following procedure assumes that your gateway VM already has one network adapter deﬁned, and describes how to add an adapter on VMware ESXi. To conﬁgure your gateway to use an additional network
storagegateway-fsxfile-ug-094	storagegateway-fsxfile-ug.pdf	94	route. For instructions on how to conﬁgure multiple adapters, see the following topics: Conﬁguring network adapters for your gateway API Version 2021-03-31 237 AWS Storage Gateway Topics Amazon FSx File Gateway User Guide • Conﬁguring Your Gateway for Multiple NICs on a VMware ESXi Host • Conﬁguring Your Gateway for Multiple NICs in Microsoft Hyper-V Host Conﬁguring Your Gateway for Multiple NICs on a VMware ESXi Host The following procedure assumes that your gateway VM already has one network adapter deﬁned, and describes how to add an adapter on VMware ESXi. To conﬁgure your gateway to use an additional network adapter in VMware ESXi host 1. 2. 3. Shut down the gateway. In the VMware vSphere client, select your gateway VM. The VM can remain turned on for this procedure. In the client, open the context (right-click) menu for your gateway VM, and choose Edit Settings. 4. On the Hardware tab of the Virtual Machine Properties dialog box, choose Add to add a device. 5. Follow the Add Hardware wizard to add a network adapter. a. b. In the Device Type pane, choose Ethernet Adapter to add an adapter, and then choose Next. In the Network Type pane, ensure that Connect at power on is selected for Type, and then choose Next. We recommend that you use the VMXNET3 network adapter with Storage Gateway. For more information on the adapter types that might appear in the adapter list, see Network Adapter Types in the ESXi and vCenter Server Documentation. c. In the Ready to Complete pane, review the information, and then choose Finish. 6. Choose the Summary tab for the VM, and choose View All next to the IP Address box. The Virtual Machine IP Addresses window displays all the IP addresses you can use to access the gateway. Conﬁrm that a second IP address is listed for the gateway. Conﬁguring network adapters for your gateway API Version 2021-03-31 238 AWS Storage Gateway Amazon FSx File Gateway User Guide Note It might take several moments for the adapter changes to take eﬀect and the VM summary information to refresh. 7. 8. In the Storage Gateway console, turn on the gateway. In the Navigation pane of the Storage Gateway console, choose Gateways and choose the gateway to which you added the adapter. Conﬁrm that the second IP address is listed in the Details tab. For information about local console tasks common to VMware, Hyper-V, and KVM hosts, see Performing tasks on the virtual machine local console Conﬁguring Your Gateway for Multiple NICs in Microsoft Hyper-V Host The following procedure assumes that your gateway VM already has one network adapter deﬁned and that you are adding a second adapter. This procedure shows how to add an adapter for a Microsoft Hyper-V host. To conﬁgure your gateway to use an additional network adapter in a Microsoft Hyper-V Host 1. On the Storage Gateway console, turn oﬀ the gateway. 2. 3. In the Microsoft Hyper-V Manager, select your gateway VM from the Virtual Machines panel. If the gateway VM isn't turned oﬀ already, right-click the VM name to open the context menu, and then choose Turn Oﬀ. 4. Right-click the gateway VM name to open the context menu, and then choose Settings. 5. 6. In the Settings dialog box, under Hardware, choose Add Hardware. In the Add Hardware panel on the right side of the Settings dialog box, choose Network Adapter, and then choose Add to add a device. 7. Conﬁgure the network adapter, and then choose Apply to apply settings. 8. In the Settings dialog box, under Hardware, conﬁrm that the new network adapter was added to the hardware list, and then choose OK. 9. Turn on the gateway using the Storage Gateway console. Conﬁguring network adapters for your gateway API Version 2021-03-31 239 AWS Storage Gateway Amazon FSx File Gateway User Guide 10. In the Navigation panel of the Storage Gateway console, choose Gateways, then select the gateway to which you added the adapter. Conﬁrm that a second IP address is listed in the Details tab. For information about local console tasks common to VMware, Hyper-V, and KVM hosts, see Performing tasks on the virtual machine local console Using VMware vSphere High Availability with Storage Gateway Storage Gateway provides high availability on VMware through a set of application-level health checks integrated with VMware vSphere High Availability (VMware HA). This approach helps protect storage workloads against hardware, hypervisor, or network failures. It also helps protect against software errors, such as connection timeouts and ﬁle share or volume unavailability. With this integration, a gateway deployed in a VMware environment on-premises or in a VMware Cloud on AWS automatically recovers from most service interruptions. It generally does this in under 60 seconds with no data loss. Note We recommend doing the following things if you
storagegateway-fsxfile-ug-095	storagegateway-fsxfile-ug.pdf	95	Availability with Storage Gateway Storage Gateway provides high availability on VMware through a set of application-level health checks integrated with VMware vSphere High Availability (VMware HA). This approach helps protect storage workloads against hardware, hypervisor, or network failures. It also helps protect against software errors, such as connection timeouts and ﬁle share or volume unavailability. With this integration, a gateway deployed in a VMware environment on-premises or in a VMware Cloud on AWS automatically recovers from most service interruptions. It generally does this in under 60 seconds with no data loss. Note We recommend doing the following things if you deploy Storage Gateway in a VMware HA cluster: • Deploy the VMware ESX .ova downloadable package that contains the Storage Gateway VM on only one host in a cluster. • When deploying the .ova package, select a data store that is not local to one host. Instead, use a data store that is accessible to all hosts in the cluster. If you select a data store that is local to a host and the host fails, then the data source might not be accessible to other hosts in the cluster and failover to another host might not succeed. • With clustering, if you deploy the .ova package to the cluster, select a host when you are prompted to do so. Alternately, you can deploy directly to a host in a cluster. The following topics describe how to deploy Storage Gateway in a VMware HA cluster: Topics • Conﬁgure Your vSphere VMware HA Cluster • Set Up Your Gateway Type Using Storage Gateway with VMware HA API Version 2021-03-31 240 Amazon FSx File Gateway User Guide AWS Storage Gateway • Deploy the Gateway • (Optional) Add Override Options for Other VMs on Your Cluster • Activate Your Gateway • Test Your VMware High Availability Conﬁguration Conﬁgure Your vSphere VMware HA Cluster First, if you haven’t already created a VMware cluster, create one. For information about how to create a VMware cluster, see Create a vSphere HA Cluster in the VMware documentation. Next, conﬁgure your VMware cluster to work with Storage Gateway. To conﬁgure your VMware cluster 1. On the Edit Cluster Settings page in VMware vSphere, make sure that VM monitoring is conﬁgured for VM and application monitoring. To do so, set the following values for each option: • Host Failure Response: Restart VMs • Response for Host Isolation: Shut down and restart VMs • Datastore with PDL: Disabled • Datastore with APD: Disabled • VM Monitoring: VM and Application Monitoring 2. Fine-tune the sensitivity of the cluster by adjusting the following values: • Failure interval – After this interval, the VM is restarted if a VM heartbeat isn't received. • Minimum uptime – The cluster waits this long after a VM starts to begin monitoring for VM tools' heartbeats. • Maximum per-VM resets – The cluster restarts the VM a maximum of this many times within the maximum resets time window. • Maximum resets time window – The window of time in which to count the maximum resets per-VM resets. If you aren't sure what values to set, use these example settings: • Failure interval: 30 seconds Using Storage Gateway with VMware HA API Version 2021-03-31 241 AWS Storage Gateway Amazon FSx File Gateway User Guide • Minimum uptime: 120 seconds • Maximum per-VM resets: 3 • Maximum resets time window: 1 hour If you have other VMs running on the cluster, you might want to set these values speciﬁcally for your VM. You can't do this until you deploy the VM from the .ova. For more information on setting these values, see (Optional) Add Override Options for Other VMs on Your Cluster. Set Up Your Gateway Type Use the following procedure to set up the gateway To download the .ova image for your gateway type • Download the .ova image for your gateway type from one of the following: • File Gateway – Create and activate an Amazon FSx File Gateway Deploy the Gateway In your conﬁgured cluster, deploy the .ova image to one of the cluster's hosts. For instructions, see Deploy an OVF or OVA Template in the VMware vSphere online documentation. To deploy the gateway .ova image 1. Deploy the .ova image to one of the hosts in the cluster. 2. Make sure the data stores that you choose for the root disk and the cache are available to all hosts in the cluster. (Optional) Add Override Options for Other VMs on Your Cluster If you have other VMs running on your cluster, you might want to set the cluster values speciﬁcally for each VM. For instructions, see Customize an Individual Virtual Machine in the VMware vSphere online documentation. Using Storage Gateway with VMware HA API Version 2021-03-31 242 AWS Storage Gateway Amazon FSx File Gateway User
storagegateway-fsxfile-ug-096	storagegateway-fsxfile-ug.pdf	96	1. Deploy the .ova image to one of the hosts in the cluster. 2. Make sure the data stores that you choose for the root disk and the cache are available to all hosts in the cluster. (Optional) Add Override Options for Other VMs on Your Cluster If you have other VMs running on your cluster, you might want to set the cluster values speciﬁcally for each VM. For instructions, see Customize an Individual Virtual Machine in the VMware vSphere online documentation. Using Storage Gateway with VMware HA API Version 2021-03-31 242 AWS Storage Gateway Amazon FSx File Gateway User Guide To add override options for other VMs on your cluster 1. On the Summary page in VMware vSphere, choose your cluster to open the cluster page, and then choose Conﬁgure. 2. Choose the Conﬁguration tab, and then choose VM Overrides. 3. Add a new VM override option to change each value. Set the following values for each option under vSphere HA - VM Monitoring: • VM Monitoring: Override Enabled - VM and Application Monitoring • VM monitoring sensitivity: Override Enabled - VM and Application Monitoring • VM Monitoring: Custom • Failure interval: 30 seconds • Minimum uptime: 120 seconds • Maximum per-VM resets: 5 • Maximum resets time window: Within 1 hrs Activate Your Gateway After the .ova is deployed in your VMware environment, activate your gateway using the Storage Gateway console. For instructions, see Review settings and activate your Amazon FSx File Gateway. Test Your VMware High Availability Conﬁguration After you activate your gateway, test your conﬁguration. To test your VMware HA conﬁguration 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. On the navigation pane, choose Gateways, and then choose the gateway that you want to test for VMware HA. For Actions, choose Verify VMware HA. In the Verify VMware High Availability Conﬁguration box that appears, choose OK. 3. 4. Using Storage Gateway with VMware HA API Version 2021-03-31 243 AWS Storage Gateway Amazon FSx File Gateway User Guide Note Testing your VMware HA conﬁguration reboots your gateway VM and interrupts connectivity to your gateway. The test might take a few minutes to complete. If the test is successful, the status of Veriﬁed appears in the details tab of the gateway in the console. 5. Choose Exit. You can ﬁnd information about VMware HA events in the Amazon CloudWatch log groups. For more information, see Getting FSx File Gateway health logs with CloudWatch log groups. Getting an activation key for your gateway To receive an activation key for your gateway, make a web request to the gateway virtual machine (VM). The VM returns a redirect that contains the activation key, which is passed as one of the parameters for the ActivateGateway API action to specify the conﬁguration of your gateway. For more information, see ActivateGateway in the Storage Gateway API Reference. Note Gateway activation keys expire in 30 minutes if unused. The request that you make to the gateway VM includes the AWS Region where the activation occurs. The URL that's returned by the redirect in the response contains a query string parameter called activationkey. This query string parameter is your activation key. The format of the query string looks like the following: http://gateway_ip_address/? activationRegion=activation_region. The output of this query returns both activation region and key. The URL also includes vpcEndpoint, the VPC Endpoint ID for gateways that connect using the VPC endpoint type. Getting activation key API Version 2021-03-31 244 AWS Storage Gateway Amazon FSx File Gateway User Guide Note The AWS Storage Gateway Hardware Appliance, VM image templates, and Amazon EC2 Amazon Machine Images (AMI) come preconﬁgured with the HTTP services necessary to receive and respond to the web requests described on this page. It's not required or recommended to install any additional services on your gateway. Topics • Linux (curl) • Linux (bash/zsh) • Microsoft Windows PowerShell • Using your local console Linux (curl) The following examples show you how to get an activation key using Linux (curl). Note Replace the highlighted variables with actual values for your gateway. Acceptable values are as follows: • gateway_ip_address - The IPv4 address of your gateway, for example 172.31.29.201 • gateway_type - The type of gateway you want to activate, such as STORED, CACHED, VTL, FILE_S3, or FILE_FSX_SMB. • region_code - The Region where you want to activate your gateway. See Regional endpoints in the AWS General Reference Guide. If this parameter is not speciﬁed, or if the value provided is misspelled or doesn't match a valid region, the command will default to the us-east-1 region. • vpc_endpoint - The VPC endpoint name for your gateway, for example vpce-050f90485f28f2fd0-iep0e8vq.storagegateway.us- west-2.vpce.amazonaws.com. Linux (curl) API Version 2021-03-31 245 AWS Storage Gateway Amazon FSx File Gateway User Guide To get the activation key for a public endpoint: curl "http://gateway_ip_address/?activationRegion=region_code&no_redirect"
storagegateway-fsxfile-ug-097	storagegateway-fsxfile-ug.pdf	97	you want to activate, such as STORED, CACHED, VTL, FILE_S3, or FILE_FSX_SMB. • region_code - The Region where you want to activate your gateway. See Regional endpoints in the AWS General Reference Guide. If this parameter is not speciﬁed, or if the value provided is misspelled or doesn't match a valid region, the command will default to the us-east-1 region. • vpc_endpoint - The VPC endpoint name for your gateway, for example vpce-050f90485f28f2fd0-iep0e8vq.storagegateway.us- west-2.vpce.amazonaws.com. Linux (curl) API Version 2021-03-31 245 AWS Storage Gateway Amazon FSx File Gateway User Guide To get the activation key for a public endpoint: curl "http://gateway_ip_address/?activationRegion=region_code&no_redirect" To get the activation key for a VPC endpoint: curl "http://gateway_ip_address/? activationRegion=region_code&vpcEndpoint=vpc_endpoint&no_redirect" Linux (bash/zsh) The following example shows you how to use Linux (bash/zsh) to fetch the HTTP response, parse HTTP headers, and get the activation key. function get-activation-key() { local ip_address=$1 local activation_region=$2 if [[ -z "$ip_address" \|\| -z "$activation_region" \|\| -z "$gateway_type" ]]; then echo "Usage: get-activation-key ip_address activation_region gateway_type" return 1 fi if redirect_url=$(curl -f -s -S -w '%{redirect_url}' "http://$ip_address/? activationRegion=$activation_region&gatewayType=$gateway_type"); then activation_key_param=$(echo "$redirect_url" \| grep -oE 'activationKey=[A-Z0-9-]+') echo "$activation_key_param" \| cut -f2 -d= else return 1 fi } Microsoft Windows PowerShell The following example shows you how to use Microsoft Windows PowerShell to fetch the HTTP response, parse HTTP headers, and get the activation key. function Get-ActivationKey { [CmdletBinding()] Param( Linux (bash/zsh) API Version 2021-03-31 246 AWS Storage Gateway Amazon FSx File Gateway User Guide [parameter(Mandatory=$true)][string]$IpAddress, [parameter(Mandatory=$true)][string]$ActivationRegion, [parameter(Mandatory=$true)][string]$GatewayType ) PROCESS { $request = Invoke-WebRequest -UseBasicParsing -Uri "http://$IpAddress/? activationRegion=$ActivationRegion&gatewayType=$GatewayType" -MaximumRedirection 0 - ErrorAction SilentlyContinue if ($request) { $activationKeyParam = $request.Headers.Location \| Select-String -Pattern "activationKey=([A-Z0-9-]+)" $activationKeyParam.Matches.Value.Split("=")[1] } } } Using your local console The following example shows you how to use your local console to generate and display an activation key. To get an activation key for your gateway from your local console 1. Log in to your local console. If you are connecting to your Amazon EC2 instance from a Windows computer, log in as admin. 2. After you log in and see the AWS Appliance Activation - Conﬁguration main menu, select 0 to choose Get activation key. 3. Select Storage Gateway for gateway family option. 4. When prompted, enter the AWS Region where you want to activate your gateway. 5. 6. Enter 1 for Public or 2 for VPC endpoint as the network type. Enter 1 for Standard or 2 for Federal Information Processing Standard (FIPS) as the endpoint Type. Using AWS Direct Connect with Storage Gateway AWS Direct Connect links your internal network to the Amazon Web Services Cloud. By using AWS Direct Connect with Storage Gateway, you can create a connection for high-throughput workload needs, providing a dedicated network connection between your on-premises gateway and AWS. Using your local console API Version 2021-03-31 247 AWS Storage Gateway Amazon FSx File Gateway User Guide Storage Gateway uses public endpoints. With an AWS Direct Connect connection in place, you can create a public virtual interface to allow traﬃc to be routed to the Storage Gateway endpoints. The public virtual interface bypasses internet service providers in your network path. The Storage Gateway service public endpoint can be in the same AWS Region as the AWS Direct Connect location, or it can be in a diﬀerent AWS Region. The following illustration shows an example of how AWS Direct Connect works with Storage Gateway. network architecture showing Storage Gateway connected to the cloud using AWS direct connect. The following procedure assumes that you have created a functioning gateway. To use AWS Direct Connect with Storage Gateway 1. Create and establish an AWS Direct Connect connection between your on-premises data center and your Storage Gateway endpoint. For more information about how to create a connection, see Getting Started with AWS Direct Connect in the AWS Direct Connect User Guide. 2. Connect your on-premises Storage Gateway appliance to the AWS Direct Connect router. 3. Create a public virtual interface, and conﬁgure your on-premises router accordingly. For more information, see Creating a Virtual Interface in the AWS Direct Connect User Guide. For details about AWS Direct Connect, see What is AWS Direct Connect? in the AWS Direct Connect User Guide. Active Directory service account permission requirements If you plan to use Microsoft Active directory to provide user authenticated access to the ﬁle systems on your AWS Storage Gateway, you need to make sure that you have an Active Directory service account, and that the service account has delegated permissions to join computers to your domain. A service account is an Active Directory user account that has been delegated permission to perform certain tasks. You provide the username and password credentials for this account when you join a Storage Gateway to your Active Directory domain. The Active Directory service account must be delegated the following permissions in the OU to which you are
storagegateway-fsxfile-ug-098	storagegateway-fsxfile-ug.pdf	98	Active directory to provide user authenticated access to the ﬁle systems on your AWS Storage Gateway, you need to make sure that you have an Active Directory service account, and that the service account has delegated permissions to join computers to your domain. A service account is an Active Directory user account that has been delegated permission to perform certain tasks. You provide the username and password credentials for this account when you join a Storage Gateway to your Active Directory domain. The Active Directory service account must be delegated the following permissions in the OU to which you are joining your gateway: • Ability to create and delete computer objects • Ability to reset passwords Active Directory permissions API Version 2021-03-31 248 AWS Storage Gateway Amazon FSx File Gateway User Guide • Ability to modify permissions • Ability to restrict accounts from reading and writing data • Validated ability to read and write Account Restrictions • Validated ability to write to the service principal name • Validated ability to write to the DNS host name These represent the minimum set of permissions that are required to join computer objects to your Active Directory. For more information, see the Microsoft Windows Server documentation topic Error: Access is denied when non-administrator users who have been delegated control try to join computers to a domain controller. Getting the IP address for your gateway appliance After you choose a host and deploy your gateway VM, you connect and activate your gateway. To do this, you need the IP address of your gateway VM. You get the IP address from your gateway's local console. You log in to the local console and get the IP address from the top of the console page. For gateways deployed on-premises, you can also get the IP address from your hypervisor. For Amazon EC2 gateways, you can also get the IP address of your Amazon EC2 instance from the Amazon EC2 Management Console. To ﬁnd how to get your gateway's IP address, see one of the following: • VMware host: Accessing the Gateway Local Console with VMware ESXi • HyperV host: Access the Gateway Local Console with Microsoft Hyper-V • Linux Kernel-based Virtual Machine (KVM) host: Accessing the Gateway Local Console with Linux KVM • EC2 host: Getting an IP Address from an Amazon EC2 Host When you locate the IP address, take note of it. Then return to the Storage Gateway console and type the IP address into the console. Getting the gateway IP address API Version 2021-03-31 249 AWS Storage Gateway Amazon FSx File Gateway User Guide Getting an IP Address from an Amazon EC2 Host To get the IP address of the Amazon EC2 instance your gateway is deployed on, log in to the EC2 instance's local console. Then get the IP address from the top of the console page. For instructions, see . You can also get the IP address from the Amazon EC2 Management Console. We recommend using the public IP address for activation. To get the public IP address, use procedure 1. If you choose to use the elastic IP address instead, see procedure 2. Procedure 1: To connect to your gateway using the public IP address 1. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/. 2. In the navigation pane, choose Instances, and then select the EC2 instance that your gateway is deployed on. 3. Choose the Description tab at the bottom, and then note the public IP. You use this IP address to connect to the gateway. Return to the Storage Gateway console and type in the IP address. If you want to use the elastic IP address for activation, use the procedure following. Procedure 2: To connect to your gateway using the elastic IP address 1. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/. 2. In the navigation pane, choose Instances, and then select the EC2 instance that your gateway is deployed on. 3. Choose the Description tab at the bottom, and then note the Elastic IP value. You use this elastic IP address to connect to the gateway. Return to the Storage Gateway console and type in the elastic IP address. 4. After your gateway is activated, choose the gateway that you just activated, and then choose the VTL devices tab in the bottom panel. 5. Get the names of all your VTL devices. 6. For each target, run the following command to conﬁgure the target. iscsiadm -m node -o new -T [$TARGET_NAME] -p [$Elastic_IP]:3260 7. For each target, run the following command to log in. iscsiadm -m node -p [$ELASTIC_IP]:3260 --login Getting an IP Address from an Amazon EC2 Host API Version 2021-03-31 250 AWS Storage Gateway Amazon FSx File Gateway User Guide Your gateway is now connected using the elastic IP address of the EC2 instance. Understanding Storage
storagegateway-fsxfile-ug-099	storagegateway-fsxfile-ug.pdf	99	that you just activated, and then choose the VTL devices tab in the bottom panel. 5. Get the names of all your VTL devices. 6. For each target, run the following command to conﬁgure the target. iscsiadm -m node -o new -T [$TARGET_NAME] -p [$Elastic_IP]:3260 7. For each target, run the following command to log in. iscsiadm -m node -p [$ELASTIC_IP]:3260 --login Getting an IP Address from an Amazon EC2 Host API Version 2021-03-31 250 AWS Storage Gateway Amazon FSx File Gateway User Guide Your gateway is now connected using the elastic IP address of the EC2 instance. Understanding Storage Gateway resources and resource IDs In Storage Gateway, the primary resource is a gateway but other resource types is ﬁle share. File shares are referred to as subresources and they don't exist unless they are associated with a gateway. These resources and subresources have unique Amazon Resource Names (ARNs) associated with them as shown in this table. Resource Type Gateway ARN File Share ARN ARN Format arn:aws:storagegateway: region:account-id :gateway/ gateway- id arn:aws:storagegateway: region:account-id :share/share-id Working with Resource IDs When you create a resource, Storage Gateway assigns the resource a unique resource ID. This resource ID is part of the resource ARN. A resource ID takes the form of a resource identiﬁer, followed by a hyphen, and a unique combination of eight letters and numbers. For example, a gateway ID is of the form sgw-12A3456B where sgw is the resource identiﬁer for gateways. Storage Gateway resource IDs are in uppercase. However, when you use these resource IDs with the Amazon EC2 API, Amazon EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be vol-1122AABB. When you use this ID with the EC2 API, you must change it to vol-1122aabb. Otherwise, the EC2 API might not behave as expected. Important IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and Understanding resources and resource IDs API Version 2021-03-31 251 AWS Storage Gateway Amazon FSx File Gateway User Guide snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS Resource IDs. For example, a volume ARN with the longer volume ID format will look like this: arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABBCCDDEEFFG. A snapshot ID with the longer ID format will look like this: snap-78e226633445566ee. For more information, see Announcement: Heads-up – Longer Storage Gateway volume and snapshot IDs coming in 2016. Tagging Storage Gateway resources In Storage Gateway, you can use tags to manage your resources. Tags let you add metadata to your resources and categorize your resources to make them easier to manage. Each tag consists of a key- value pair, which you deﬁne. You can add tags to gateways, volumes, and virtual tapes. You can search and ﬁlter these resources based on the tags you add. As an example, you can use tags to identify Storage Gateway resources used by each department in your organization. You might tag gateways and volumes used by your accounting department like this: (key=department and value=accounting). You can then ﬁlter with this tag to identify all gateways and volumes used by your accounting department and use the information to determine cost. For more information, see Using Cost Allocation Tags and Working with Tag Editor. If you archive a virtual tape that is tagged, the tape maintains its tags in the archive. Similarly, if you retrieve a tape from the archive to another gateway, the tags are maintained in the new gateway. For File Gateway, you can use tags to control access to resources. For information about how to do this, see Using tags to control access to your gateway and resources. Tags don’t have any semantic meaning but rather are interpreted as strings of characters. The following restrictions apply to tags: • Tag keys and values are case-sensitive. • The maximum number of tags for each resource is 50. • Tag keys cannot begin with aws:. This preﬁx is reserved for AWS use. Tagging your resources API Version 2021-03-31 252 AWS Storage Gateway Amazon FSx File Gateway User Guide • Valid characters for the key property are UTF-8 letters and numbers, space, and special characters + - = . _ : / and @. Working with tags You can work with tags by using the Storage Gateway console, the Storage Gateway API, or the Storage Gateway Command Line Interface (CLI). The following procedures show you how to add, edit, and delete a tag on the console. To add a tag
storagegateway-fsxfile-ug-100	storagegateway-fsxfile-ug.pdf	100	Tag keys cannot begin with aws:. This preﬁx is reserved for AWS use. Tagging your resources API Version 2021-03-31 252 AWS Storage Gateway Amazon FSx File Gateway User Guide • Valid characters for the key property are UTF-8 letters and numbers, space, and special characters + - = . _ : / and @. Working with tags You can work with tags by using the Storage Gateway console, the Storage Gateway API, or the Storage Gateway Command Line Interface (CLI). The following procedures show you how to add, edit, and delete a tag on the console. To add a tag 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. In the navigation pane, choose the resource you want to tag. For example, to tag a gateway, choose Gateways, and then choose the gateway you want to tag from the list of gateways. 3. Choose Tags, and then choose Add/edit tags. 4. 5. In the Add/edit tags dialog box, choose Create tag. Type a key for Key and a value for Value. For example, you can type Department for the key and Accounting for the value. Note You can leave the Value box blank. 6. Choose Create Tag to add more tags. You can add multiple tags to a resource. 7. When you’re done adding tags, choose Save. To edit a tag 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. Choose the resource whose tag you want to edit. 3. Choose Tags to open the Add/edit tags dialog box. 4. Choose the pencil icon next to the tag you want to edit, and then edit the tag. Working with tags API Version 2021-03-31 253 AWS Storage Gateway Amazon FSx File Gateway User Guide 5. When you’re done editing the tag, choose Save. To delete a tag 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. Choose the resource whose tag you want to delete. 3. Choose Tags, and then choose Add/edit tags to open the Add/edit tags dialog box. 4. Choose the X icon next to the tag you want to delete, and then choose Save. Working with open-source components for AWS Storage Gateway This section describes the third-party tools and licenses that we depend on to deliver AWS Storage Gateway functionality. Topics • Open-source components for Storage Gateway • Open-source components for Amazon FSx File Gateway Open-source components for Storage Gateway Several third-party tools and licenses are used to deliver functionality for Volume Gateway, Tape Gateway, and Amazon S3 File Gateway. Use the following links to download source code for certain open-source software components that are included with AWS Storage Gateway software: • For Storage Gateway appliances deployed on VMware ESXi: sources.tar • For Storage Gateway appliances deployed on Microsoft Hyper-V: sources_hyperv.tar • For Storage Gateway appliances deployed on Linux Kernel-based Virtual Machine (KVM): sources_KVM.tar Open-source components API Version 2021-03-31 254 AWS Storage Gateway Amazon FSx File Gateway User Guide This product includes software developed by the OpenSSL project for use in the OpenSSL Toolkit (http://www.openssl.org/). For the relevant licenses for all dependent third-party tools, see Third- Party Licenses. Open-source components for Amazon FSx File Gateway Several third-party tools and licenses are used to deliver Amazon FSx File Gateway (FSx File Gateway) functionality. Use the following links to download the source code for certain open-source software components that are included with FSx File Gateway software: • For Amazon FSx File Gateway 2021-07-07 Release: sgw-ﬁle-fsx-smb-open-source.tgz • For Amazon FSx File Gateway 2021-04-06 Release: sgw-ﬁle-fsx-smb-20210406-open-source.tgz This product includes software developed by the OpenSSL project for use in the OpenSSL Toolkit (http://www.openssl.org/). For the relevant licenses for all dependent third-party tools, see the following links: • For Amazon FSx File Gateway 2021-07-07 Release: Third-Party License. • For Amazon FSx File Gateway 2021-04-06 Release: Third-Party License. Limits and quotas for Amazon FSx File Gateway Quotas for Amazon FSx ﬁle systems The following table lists minimum and maximum limits and quotas for Amazon FSx ﬁle systems. Resource Limit per Amazon FSx ﬁle system Maximum number of tags Maximum retention period for automated backups 50 tags 90 days Maximum number of backup copy requests in progress to a single destination Region per 5 requests account. Open-source components for Amazon FSx File Gateway API Version 2021-03-31 255 AWS Storage Gateway Resource Amazon FSx File Gateway User Guide Limit per Amazon FSx ﬁle system Minimum storage capacity for SSD ﬁle systems 32 GiB Minimum storage capacity for HDD ﬁle systems 2,000 GiB Maximum storage capacity for SSD and HDD ﬁle systems 64 TiB Minimum throughput capacity 8 MBps Maximum throughput capacity 2,048 MBps Maximum number of Amazon FSx ﬁle shares 100,000 Recommended local disk sizes for your gateway The following table recommends sizes for local disk storage for each AWS Storage Gateway in your deployment. Gateway Type Cache (Minimum) Cache (Maximum) Other Required Local
storagegateway-fsxfile-ug-101	storagegateway-fsxfile-ug.pdf	101	API Version 2021-03-31 255 AWS Storage Gateway Resource Amazon FSx File Gateway User Guide Limit per Amazon FSx ﬁle system Minimum storage capacity for SSD ﬁle systems 32 GiB Minimum storage capacity for HDD ﬁle systems 2,000 GiB Maximum storage capacity for SSD and HDD ﬁle systems 64 TiB Minimum throughput capacity 8 MBps Maximum throughput capacity 2,048 MBps Maximum number of Amazon FSx ﬁle shares 100,000 Recommended local disk sizes for your gateway The following table recommends sizes for local disk storage for each AWS Storage Gateway in your deployment. Gateway Type Cache (Minimum) Cache (Maximum) Other Required Local Disks FSx File Gateway 150 GiB 64 TiB — Note You can conﬁgure one or more local drives for your cache up to the maximum capacity. When adding cache to an existing FSx File Gateway, it is important to create new disks on your virtual host (hypervisor or Amazon EC2 instance). Do not change the size of existing disks if the disks have been previously allocated as a cache. Recommended local disk sizes for your gateway API Version 2021-03-31 256 AWS Storage Gateway Amazon FSx File Gateway User Guide API Reference for Storage Gateway In addition to using the console, you can use the AWS Storage Gateway API to programmatically conﬁgure and manage your gateways. This section describes the AWS Storage Gateway operations, request signing for authentication and the error handling. For information about the regions and endpoints available for Storage Gateway, see AWS Storage Gateway Endpoints and Quotas in the AWS General Reference. Note You can also use the AWS SDKs when developing applications with Storage Gateway. The AWS SDKs for Java, .NET, and PHP wrap the underlying Storage Gateway API, simplifying your programming tasks. For information about downloading the SDK libraries, see Sample Code Libraries. Topics • AWS Storage Gateway Required Request Headers • Signing Requests • Error Responses • Storage Gateway API Actions AWS Storage Gateway Required Request Headers This section describes the required headers that you must send with every POST request to AWS Storage Gateway. You include HTTP headers to identify key information about the request including the operation you want to invoke, the date of the request, and information that indicates the authorization of you as the sender of the request. Headers are case insensitive and the order of the headers is not important. The following example shows headers that are used in the ActivateGateway operation. POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com Content-Type: application/x-amz-json-1.1 Required Request Headers API Version 2021-03-31 257 AWS Storage Gateway Amazon FSx File Gateway User Guide Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/ storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2 x-amz-date: 20120912T120000Z x-amz-target: StorageGateway_20120630.ActivateGateway The following are the headers that must include with your POST requests to AWS Storage Gateway. Headers shown below that begin with "x-amz" are AWS-speciﬁc headers. All other headers listed are common header used in HTTP transactions. Header Description Authorization The authorization header contains several of pieces of information about the request that allow AWS Storage Gateway to determine if the request is a valid action for the requester. The format of this header is as follows (line breaks added for readability): Authorization: AWS4-HMAC_SHA456 Credentials= YourAccessKey /yyymmdd/region/storagegateway/aw s4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-targ et, Signature= CalculatedSignature In the preceding syntax, you specify YourAccessKey, the year, month, and day (yyyymmdd), the region, and the CalculatedSignature. The format of the authorization header is dictated by the requirements of the AWS V4 Signing process. The details of signing are discussed in the topic Signing Requests. Content-Type Use application/x-amz-json-1.1 requests to AWS Storage Gateway. as the content type for all Content-Type: application/x-amz-json-1.1 Host Use the host header to specify the AWS Storage Gateway endpoint where you send your request. For example, storagegateway.us- Required Request Headers API Version 2021-03-31 258 AWS Storage Gateway Amazon FSx File Gateway User Guide Header Description x-amz-date east-2.amazonaws.com region. For more information about the endpoints available for AWS Storage Gateway, see AWS Storage Gateway Endpoints and Quotas in is the endpoint for the US East (Ohio) the AWS General Reference. Host: storagegateway. region.amazonaws.com You must provide the time stamp in either the HTTP Date header or the AWS x-amz-date header. (Some HTTP client libraries don't let you set the Date header.) When an x-amz-date header is present, the AWS Storage Gateway ignores any Date header during the request authentication. The x-amz-date format must be ISO8601 Basic in the YYYYMMDD'T'HHMMSS'Z' format. If both the Date and x-amz- date header are used, the format of the Date header does not have to be ISO8601. x-amz-date: YYYYMMDD'T'HHMMSS'Z' x-amz-target This header speciﬁes the version of the API and the operation that you are requesting. The target header values are formed by concatenating the API version with the API name and are in the following format. x-amz-target: StorageGateway_ APIversion .operationName The operationName value (e.g. "ActivateGateway") can be found from the API list, API Reference
storagegateway-fsxfile-ug-102	storagegateway-fsxfile-ug.pdf	102	Storage Gateway ignores any Date header during the request authentication. The x-amz-date format must be ISO8601 Basic in the YYYYMMDD'T'HHMMSS'Z' format. If both the Date and x-amz- date header are used, the format of the Date header does not have to be ISO8601. x-amz-date: YYYYMMDD'T'HHMMSS'Z' x-amz-target This header speciﬁes the version of the API and the operation that you are requesting. The target header values are formed by concatenating the API version with the API name and are in the following format. x-amz-target: StorageGateway_ APIversion .operationName The operationName value (e.g. "ActivateGateway") can be found from the API list, API Reference for Storage Gateway. Signing Requests Storage Gateway requires that you authenticate every request you send by signing the request. To sign a request, you calculate a digital signature using a cryptographic hash function. A cryptographic hash is a function that returns a unique hash value based on the input. The input to Signing Requests API Version 2021-03-31 259 AWS Storage Gateway Amazon FSx File Gateway User Guide the hash function includes the text of your request and your secret access key. The hash function returns a hash value that you include in the request as your signature. The signature is part of the Authorization header of your request. After receiving your request, Storage Gateway recalculates the signature using the same hash function and input that you used to sign the request. If the resulting signature matches the signature in the request, Storage Gateway processes the request. Otherwise, the request is rejected. Storage Gateway supports authentication using AWS Signature Version 4. The process for calculating a signature can be broken into three tasks: • Task 1: Create a Canonical Request Rearrange your HTTP request into a canonical format. Using a canonical form is necessary because Storage Gateway uses the same canonical form when it recalculates a signature to compare with the one you sent. • Task 2: Create a String to Sign Create a string that you will use as one of the input values to your cryptographic hash function. The string, called the string to sign, is a concatenation of the name of the hash algorithm, the request date, a credential scope string, and the canonicalized request from the previous task. The credential scope string itself is a concatenation of date, region, and service information. • Task 3: Create a Signature Create a signature for your request by using a cryptographic hash function that accepts two input strings: your string to sign and a derived key. The derived key is calculated by starting with your secret access key and using the credential scope string to create a series of Hash-based Message Authentication Codes (HMACs). Example Signature Calculation The following example walks you through the details of creating a signature for ListGateways. The example could be used as a reference to check your signature calculation method. The example assumes the following: • The time stamp of the request is "Mon, 10 Sep 2012 00:00:00" GMT. • The endpoint is the US East (Ohio) region. Example Signature Calculation API Version 2021-03-31 260 AWS Storage Gateway Amazon FSx File Gateway User Guide The general request syntax (including the JSON body) is: POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20120910T000000Z Authorization: SignatureToBeCalculated Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20120630.ListGateways {} The canonical form of the request calculated for Task 1: Create a Canonical Request is: POST / content-type:application/x-amz-json-1.1 host:storagegateway.us-east-2.amazonaws.com x-amz-date:20120910T000000Z x-amz-target:StorageGateway_20120630.ListGateways content-type;host;x-amz-date;x-amz-target 44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a The last line of the canonical request is the hash of the request body. Also, note the empty third line in the canonical request. This is because there are no query parameters for this API (or any Storage Gateway APIs). The string to sign for Task 2: Create a String to Sign is: AWS4-HMAC-SHA256 20120910T000000Z 20120910/us-east-2/storagegateway/aws4_request 92c0effa6f9224ac752ca179a04cecbede3038b0959666a8160ab452c9e51b3e The ﬁrst line of the string to sign is the algorithm, the second line is the time stamp, the third line is the credential scope, and the last line is a hash of the canonical request from Task 1. For Task 3: Create a Signature, the derived key can be represented as: Example Signature Calculation API Version 2021-03-31 261 AWS Storage Gateway Amazon FSx File Gateway User Guide derived key = HMAC(HMAC(HMAC(HMAC("AWS4" + YourSecretAccessKey,"20120910"),"us- east-2"),"storagegateway"),"aws4_request") If the secret access key, wJalrXUtnFEMI/K7MDENG/bPxRﬁCYEXAMPLEKEY, is used, then the calculated signature is: 6d4c40b8f2257534dbdca9f326f147a0a7a419b63aff349d9d9c737c9a0f4c81 The ﬁnal step is to construct the Authorization header. For the demonstration access key AKIAIOSFODNN7EXAMPLE, the header (with line breaks added for readability) is: Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120910/us-east-2/ storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=6d4c40b8f2257534dbdca9f326f147a0a7a419b63aff349d9d9c737c9a0f4c81 Error Responses Topics • Exceptions • Operation Error Codes • Error Responses This section provides reference information about AWS Storage Gateway errors. These errors are represented by an error exception and an operation error code. For example, the error exception InvalidSignatureException is returned by any API response if there is a problem with the request signature. However, the operation
storagegateway-fsxfile-ug-103	storagegateway-fsxfile-ug.pdf	103	access key, wJalrXUtnFEMI/K7MDENG/bPxRﬁCYEXAMPLEKEY, is used, then the calculated signature is: 6d4c40b8f2257534dbdca9f326f147a0a7a419b63aff349d9d9c737c9a0f4c81 The ﬁnal step is to construct the Authorization header. For the demonstration access key AKIAIOSFODNN7EXAMPLE, the header (with line breaks added for readability) is: Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120910/us-east-2/ storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=6d4c40b8f2257534dbdca9f326f147a0a7a419b63aff349d9d9c737c9a0f4c81 Error Responses Topics • Exceptions • Operation Error Codes • Error Responses This section provides reference information about AWS Storage Gateway errors. These errors are represented by an error exception and an operation error code. For example, the error exception InvalidSignatureException is returned by any API response if there is a problem with the request signature. However, the operation error code ActivationKeyInvalid is returned only for the ActivateGateway API. Depending on the type of error, Storage Gateway may return only just an exception, or it may return both an exception and an operation error code. Examples of error responses are shown in the Error Responses. Error Responses API Version 2021-03-31 262 AWS Storage Gateway Exceptions Amazon FSx File Gateway User Guide The following table lists AWS Storage Gateway API exceptions. When an AWS Storage Gateway operation returns an error response, the response body contains one of these exceptions. The InternalServerError and InvalidGatewayRequestException return one of the operation error codes Operation Error Codes message codes that give the speciﬁc operation error code. Exception Message HTTP Status Code IncompleteSignatur The speciﬁed signature is incomplete. 400 Bad Request eException InternalFailure The request processing has failed due to some unknown error, exception or 500 Internal Server Error failure. InternalServerError One of the operation error code messages Operation Error Codes. 500 Internal Server Error InvalidAction The requested action or operation is invalid. 400 Bad Request InvalidClientTokenId The X.509 certiﬁcate or AWS Access Key ID provided does not exist in our 403 Forbidden records. InvalidGatewayRequ estException One of the operation error code messages in Operation Error Codes. 400 Bad Request InvalidSignatureEx ception The request signature we calculate d does not match the signature you provided. Check your AWS Access Key and signing method. 400 Bad Request MissingAction The request is missing an action or operation parameter. 400 Bad Request Exceptions API Version 2021-03-31 263 AWS Storage Gateway Amazon FSx File Gateway User Guide Exception Message HTTP Status Code MissingAuthenticat ionToken The request must contain either a valid (registered) AWS Access Key ID 403 Forbidden RequestExpired SerializationException or X.509 certiﬁcate. The request is past the expiration date or the request date (either with 15 minute padding), or the request date occurs more than 15 minutes in the future. An error occurred during serializa tion. Check that your JSON payload is well-formed. 400 Bad Request 400 Bad Request ServiceUnavailable The request has failed due to a temporary failure of the server. 503 Service Unavailable SubscriptionRequir edException The AWS Access Key Id needs a subscription for the service. 400 Bad Request ThrottlingException Rate exceeded. 400 Bad Request TooManyRequests Too many requests. UnknownOperationEx ception An unknown operation was speciﬁed. Valid operations are listed in Storage Gateway API Actions. 429 Too Many Requests 400 Bad Request UnrecognizedClient Exception The security token included in the request is invalid. 400 Bad Request ValidationException The value of an input parameter is bad or out of range. 400 Bad Request Exceptions API Version 2021-03-31 264 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Codes The following table shows the mapping between AWS Storage Gateway operation error codes and APIs that can return the codes. All operation error codes are returned with one of two general exceptions—InternalServerError and InvalidGatewayRequestException—described in Exceptions. Operation Error Code Message Operations That Return this Error Code ActivationKeyExpired The speciﬁed activatio n key has expired. ActivateGateway ActivationKeyInvalid The speciﬁed activatio n key is invalid. ActivateGateway ActivationKeyNotFound The speciﬁed activatio n key was not found. ActivateGateway BandwidthThrottleS cheduleNotFound The speciﬁed bandwidth throttle was not found. DeleteBandwidthRateLimit CannotExportSnapshot The speciﬁed snapshot cannot be exported. CreateCachediSCSIVolume CreateStorediSCSIVolume InitiatorNotFound DiskAlreadyAllocated The speciﬁed initiator was not found. The speciﬁed disk is already allocated. DeleteChapCredentials AddCache AddUploadBuﬀer AddWorkingStorage CreateStorediSCSIVolume DiskDoesNotExist The speciﬁed disk does not exist. AddCache AddUploadBuﬀer Operation Error Codes API Version 2021-03-31 265 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message DiskSizeNotGigAligned DiskSizeGreaterTha nVolumeMaxSize DiskSizeLessThanVo lumeSize DuplicateCertifica teInfo FileSystemAssociationEndpoi ntConﬁgurationConﬂict FileSystemAssociationEndpoi ntIpAddressAlreadyInUse FileSystemAssociationEndpoi ntIpAddressMissing The speciﬁed disk is not gigabyte-aligned. The speciﬁed disk size is greater than the maximum volume size. The speciﬁed disk size is less than the volume size. The speciﬁed certiﬁca te information is a duplicate. Existing File System Association endpoint conﬁguration conﬂicts with speciﬁed conﬁguration. The speciﬁed endpoint IP address is already in use. File System Associati on Endpoint IP address is missing. Operations That Return this Error Code AddWorkingStorage CreateStorediSCSIVolume CreateStorediSCSIVolume CreateStorediSCSIVolume CreateStorediSCSIVolume ActivateGateway AssociateFileSystem AssociateFileSystem AssociateFileSystem Operation Error Codes API Version 2021-03-31 266 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message FileSystemAssociationNotFound The speciﬁed ﬁle system
storagegateway-fsxfile-ug-104	storagegateway-fsxfile-ug.pdf	104	is not gigabyte-aligned. The speciﬁed disk size is greater than the maximum volume size. The speciﬁed disk size is less than the volume size. The speciﬁed certiﬁca te information is a duplicate. Existing File System Association endpoint conﬁguration conﬂicts with speciﬁed conﬁguration. The speciﬁed endpoint IP address is already in use. File System Associati on Endpoint IP address is missing. Operations That Return this Error Code AddWorkingStorage CreateStorediSCSIVolume CreateStorediSCSIVolume CreateStorediSCSIVolume CreateStorediSCSIVolume ActivateGateway AssociateFileSystem AssociateFileSystem AssociateFileSystem Operation Error Codes API Version 2021-03-31 266 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message FileSystemAssociationNotFound The speciﬁed ﬁle system association was not found. Operations That Return this Error Code UpdateFileSystemAssociation DisassociateFileSystem DescribeFileSystemAssociations FileSystemNotFound The speciﬁed ﬁle system was not found. AssociateFileSystem Operation Error Codes API Version 2021-03-31 267 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message Operations That Return this Error Code GatewayInternalError A gateway internal error occurred. AddCache AddUploadBuﬀer AddWorkingStorage CreateCachediSCSIVolume CreateSnapshot CreateStorediSCSIVolume CreateSnapshotFromVolumeRec overyPoint DeleteBandwidthRateLimit DeleteChapCredentials DeleteVolume DescribeBandwidthRateLimit DescribeCache DescribeCachediSCSIVolumes DescribeChapCredentials DescribeGatewayInformation DescribeMaintenanceStartTime DescribeSnapshotSchedule DescribeStorediSCSIVolumes DescribeWorkingStorage ListLocalDisks Operation Error Codes API Version 2021-03-31 268 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message Operations That Return this Error Code ListVolumes ListVolumeRecoveryPoints ShutdownGateway StartGateway UpdateBandwidthRateLimit UpdateChapCredentials UpdateMaintenanceStartTime UpdateGatewaySoftwareNow UpdateSnapshotSchedule Operation Error Codes API Version 2021-03-31 269 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message Operations That Return this Error Code GatewayNotConnected The speciﬁed gateway is not connected. AddCache AddUploadBuﬀer AddWorkingStorage CreateCachediSCSIVolume CreateSnapshot CreateStorediSCSIVolume CreateSnapshotFromVolumeRec overyPoint DeleteBandwidthRateLimit DeleteChapCredentials DeleteVolume DescribeBandwidthRateLimit DescribeCache DescribeCachediSCSIVolumes DescribeChapCredentials DescribeGatewayInformation DescribeMaintenanceStartTime DescribeSnapshotSchedule DescribeStorediSCSIVolumes DescribeWorkingStorage ListLocalDisks Operation Error Codes API Version 2021-03-31 270 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message Operations That Return this Error Code ListVolumes ListVolumeRecoveryPoints ShutdownGateway StartGateway UpdateBandwidthRateLimit UpdateChapCredentials UpdateMaintenanceStartTime UpdateGatewaySoftwareNow UpdateSnapshotSchedule Operation Error Codes API Version 2021-03-31 271 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message Operations That Return this Error Code GatewayNotFound The speciﬁed gateway was not found. AddCache AddUploadBuﬀer AddWorkingStorage CreateCachediSCSIVolume CreateSnapshot CreateSnapshotFromVolumeRec overyPoint CreateStorediSCSIVolume DeleteBandwidthRateLimit DeleteChapCredentials DeleteGateway DeleteVolume DescribeBandwidthRateLimit DescribeCache DescribeCachediSCSIVolumes DescribeChapCredentials DescribeGatewayInformation DescribeMaintenanceStartTime DescribeSnapshotSchedule DescribeStorediSCSIVolumes DescribeWorkingStorage Operation Error Codes API Version 2021-03-31 272 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message Operations That Return this Error Code ListLocalDisks ListVolumes ListVolumeRecoveryPoints ShutdownGateway StartGateway UpdateBandwidthRateLimit UpdateChapCredentials UpdateMaintenanceStartTime UpdateGatewaySoftwareNow UpdateSnapshotSchedule Operation Error Codes API Version 2021-03-31 273 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message Operations That Return this Error Code GatewayProxyNetwor kConnectionBusy The speciﬁed gateway proxy network connection is busy. AddCache AddUploadBuﬀer AddWorkingStorage CreateCachediSCSIVolume CreateSnapshot CreateSnapshotFromVolumeRec overyPoint CreateStorediSCSIVolume DeleteBandwidthRateLimit DeleteChapCredentials DeleteVolume DescribeBandwidthRateLimit DescribeCache DescribeCachediSCSIVolumes DescribeChapCredentials DescribeGatewayInformation DescribeMaintenanceStartTime DescribeSnapshotSchedule DescribeStorediSCSIVolumes DescribeWorkingStorage ListLocalDisks Operation Error Codes API Version 2021-03-31 274 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message Operations That Return this Error Code ListVolumes ListVolumeRecoveryPoints ShutdownGateway StartGateway UpdateBandwidthRateLimit UpdateChapCredentials UpdateMaintenanceStartTime UpdateGatewaySoftwareNow UpdateSnapshotSchedule Operation Error Codes API Version 2021-03-31 275 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message Operations That Return this Error Code InternalError An internal error occurred. ActivateGateway AddCache AddUploadBuﬀer AddWorkingStorage CreateCachediSCSIVolume CreateSnapshot CreateSnapshotFromVolumeRec overyPoint CreateStorediSCSIVolume DeleteBandwidthRateLimit DeleteChapCredentials DeleteGateway DeleteVolume DescribeBandwidthRateLimit DescribeCache DescribeCachediSCSIVolumes DescribeChapCredentials DescribeGatewayInformation DescribeMaintenanceStartTime DescribeSnapshotSchedule DescribeStorediSCSIVolumes Operation Error Codes API Version 2021-03-31 276 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message Operations That Return this Error Code DescribeWorkingStorage ListLocalDisks ListGateways ListVolumes ListVolumeRecoveryPoints ShutdownGateway StartGateway UpdateBandwidthRateLimit UpdateChapCredentials UpdateMaintenanceStartTime UpdateGatewayInformation UpdateGatewaySoftwareNow UpdateSnapshotSchedule Operation Error Codes API Version 2021-03-31 277 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message Operations That Return this Error Code InvalidParameters The speciﬁed request contains invalid parameters. ActivateGateway AddCache AddUploadBuﬀer AddWorkingStorage CreateCachediSCSIVolume CreateSnapshot CreateSnapshotFromVolumeRec overyPoint CreateStorediSCSIVolume DeleteBandwidthRateLimit DeleteChapCredentials DeleteGateway DeleteVolume DescribeBandwidthRateLimit DescribeCache DescribeCachediSCSIVolumes DescribeChapCredentials DescribeGatewayInformation DescribeMaintenanceStartTime DescribeSnapshotSchedule DescribeStorediSCSIVolumes Operation Error Codes API Version 2021-03-31 278 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message Operations That Return this Error Code DescribeWorkingStorage ListLocalDisks ListGateways ListVolumes ListVolumeRecoveryPoints ShutdownGateway StartGateway UpdateBandwidthRateLimit UpdateChapCredentials UpdateMaintenanceStartTime UpdateGatewayInformation UpdateGatewaySoftwareNow UpdateSnapshotSchedule LocalStorageLimitE xceeded The local storage limit was exceeded. AddCache AddUploadBuﬀer AddWorkingStorage LunInvalid The speciﬁed LUN is invalid. CreateStorediSCSIVolume Operation Error Codes API Version 2021-03-31 279 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message MaximumVolumeCount Exceeded The maximum volume count was exceeded. Operations That Return this Error Code CreateCachediSCSIVolume CreateStorediSCSIVolume DescribeCachediSCSIVolumes DescribeStorediSCSIVolumes NetworkConfigurati onChanged The gateway network conﬁguration has changed. CreateCachediSCSIVolume CreateStorediSCSIVolume Operation Error Codes API Version 2021-03-31 280 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message Operations That Return this Error Code NotSupported The speciﬁed operation is not supported. ActivateGateway AddCache AddUploadBuﬀer AddWorkingStorage CreateCachediSCSIVolume CreateSnapshot CreateSnapshotFromVolumeRec overyPoint CreateStorediSCSIVolume DeleteBandwidthRateLimit DeleteChapCredentials DeleteGateway DeleteVolume DescribeBandwidthRateLimit DescribeCache DescribeCachediSCSIVolumes DescribeChapCredentials DescribeGatewayInformation DescribeMaintenanceStartTime DescribeSnapshotSchedule DescribeStorediSCSIVolumes Operation Error Codes API Version 2021-03-31 281 AWS Storage Gateway Amazon FSx File Gateway User
storagegateway-fsxfile-ug-105	storagegateway-fsxfile-ug.pdf	105	Error Code Message MaximumVolumeCount Exceeded The maximum volume count was exceeded. Operations That Return this Error Code CreateCachediSCSIVolume CreateStorediSCSIVolume DescribeCachediSCSIVolumes DescribeStorediSCSIVolumes NetworkConfigurati onChanged The gateway network conﬁguration has changed. CreateCachediSCSIVolume CreateStorediSCSIVolume Operation Error Codes API Version 2021-03-31 280 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message Operations That Return this Error Code NotSupported The speciﬁed operation is not supported. ActivateGateway AddCache AddUploadBuﬀer AddWorkingStorage CreateCachediSCSIVolume CreateSnapshot CreateSnapshotFromVolumeRec overyPoint CreateStorediSCSIVolume DeleteBandwidthRateLimit DeleteChapCredentials DeleteGateway DeleteVolume DescribeBandwidthRateLimit DescribeCache DescribeCachediSCSIVolumes DescribeChapCredentials DescribeGatewayInformation DescribeMaintenanceStartTime DescribeSnapshotSchedule DescribeStorediSCSIVolumes Operation Error Codes API Version 2021-03-31 281 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message Operations That Return this Error Code DescribeWorkingStorage ListLocalDisks ListGateways ListVolumes ListVolumeRecoveryPoints ShutdownGateway StartGateway UpdateBandwidthRateLimit UpdateChapCredentials UpdateMaintenanceStartTime UpdateGatewayInformation UpdateGatewaySoftwareNow UpdateSnapshotSchedule OutdatedGateway The speciﬁed gateway is out of date. ActivateGateway SnapshotInProgress Exception The speciﬁed snapshot is in progress. DeleteVolume SnapshotIdInvalid The speciﬁed snapshot is invalid. CreateCachediSCSIVolume CreateStorediSCSIVolume StagingAreaFull The staging area is full. CreateCachediSCSIVolume CreateStorediSCSIVolume Operation Error Codes API Version 2021-03-31 282 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message Operations That Return this Error Code TargetAlreadyExists TargetInvalid The speciﬁed target already exists. CreateCachediSCSIVolume CreateStorediSCSIVolume The speciﬁed target is invalid. CreateCachediSCSIVolume CreateStorediSCSIVolume DeleteChapCredentials DescribeChapCredentials UpdateChapCredentials TargetNotFound The speciﬁed target was not found. CreateCachediSCSIVolume CreateStorediSCSIVolume DeleteChapCredentials DescribeChapCredentials DeleteVolume UpdateChapCredentials Operation Error Codes API Version 2021-03-31 283 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message UnsupportedOperati onForGatewayType The speciﬁed operation is not valid for the type of the gateway. Operations That Return this Error Code AddCache AddWorkingStorage CreateCachediSCSIVolume CreateSnapshotFromVolumeRec overyPoint CreateStorediSCSIVolume DeleteSnapshotSchedule DescribeCache DescribeCachediSCSIVolumes DescribeStorediSCSIVolumes DescribeUploadBuﬀer DescribeWorkingStorage ListVolumeRecoveryPoints VolumeAlreadyExists The speciﬁed volume already exists. CreateCachediSCSIVolume CreateStorediSCSIVolume VolumeIdInvalid VolumeInUse The speciﬁed volume is invalid. DeleteVolume The speciﬁed volume is already in use. DeleteVolume Operation Error Codes API Version 2021-03-31 284 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation Error Code Message Operations That Return this Error Code VolumeNotFound The speciﬁed volume was not found. CreateSnapshot CreateSnapshotFromVolumeRec overyPoint DeleteVolume DescribeCachediSCSIVolumes DescribeSnapshotSchedule DescribeStorediSCSIVolumes UpdateSnapshotSchedule VolumeNotReady The speciﬁed volume is not ready. CreateSnapshot CreateSnapshotFromVolumeRec overyPoint Error Responses When there is an error, the response header information contains: • Content-Type: application/x-amz-json-1.1 • An appropriate 4xx or 5xx HTTP status code The body of an error response contains information about the error that occurred. The following sample error response shows the output syntax of response elements common to all error responses. { "__type": "String", "message": "String", "error": { "errorCode": "String", Error Responses API Version 2021-03-31 285 AWS Storage Gateway Amazon FSx File Gateway User Guide "errorDetails": "String" } } The following table explains the JSON error response ﬁelds shown in the preceding syntax. __type One of the exceptions from Exceptions. Type: String error Contains API-speciﬁc error details. In general errors (i.e., not speciﬁc to any API), this error information is not shown. Type: Collection errorCode One of the operation error codes . Type: String errorDetails This ﬁeld is not used in the current version of the API. Type: String message One of the operation error code messages. Type: String Error Response Examples The following JSON body is returned if you use the DescribeStorediSCSIVolumes API and specify a gateway ARN request input that does not exist. { "__type": "InvalidGatewayRequestException", Error Responses API Version 2021-03-31 286 AWS Storage Gateway Amazon FSx File Gateway User Guide "message": "The specified volume was not found.", "error": { "errorCode": "VolumeNotFound" } } The following JSON body is returned if Storage Gateway calculates a signature that does not match the signature sent with a request. { "__type": "InvalidSignatureException", "message": "The request signature we calculated does not match the signature you provided." } Storage Gateway API Actions For a list of Storage Gateway operations, see Actions in the AWS Storage Gateway API Reference. Actions API Version 2021-03-31 287 AWS Storage Gateway Amazon FSx File Gateway User Guide Document history for the Amazon FSx File Gateway User Guide • API version: 2013-06-30 • Latest documentation update: June 06, 2024 The following table describes important changes in each release of this user guide after April 2018. For notiﬁcation about updates to this documentation, you can subscribe to an RSS feed. Change Description Date Notice of availability change for FSx File Gateway Amazon FSx File Gateway is no longer available to new October 28, 2024 customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post. Notice of availability change for FSx File Gateway AWS Storage Gateway’s FSx File Gateway will no September 26, 2024 longer be available to new customers starting 10/28/24. To use the service, you must sign up prior to that date. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post. Added
storagegateway-fsxfile-ug-106	storagegateway-fsxfile-ug.pdf	106	File Gateway is no longer available to new October 28, 2024 customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post. Notice of availability change for FSx File Gateway AWS Storage Gateway’s FSx File Gateway will no September 26, 2024 longer be available to new customers starting 10/28/24. To use the service, you must sign up prior to that date. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post. Added option to turn maintenance updates on or Storage Gateway receives regular maintenance updates June 6, 2024 oﬀ that can include operating API Version 2021-03-31 288 AWS Storage Gateway Amazon FSx File Gateway User Guide system and software upgrades, ﬁxes to address stability, performance, and security, and access to new features. You can now conﬁgure a setting to turn these updates on or oﬀ for each individual gateway in your deployment. For more information, see Managing gateway updates using the AWS Storage Gateway console. The CloudWatch HealthNot October 2, 2023 alarm now ifications applies to and is recommende d for all gateway types and host platforms. Recommend ed conﬁguration settings have also been updated for HealthNotifications and AvailabilityNotifi cations . For more information see Understan ding CloudWatch alarms. Updated recommended CloudWatch alarms API Version 2021-03-31 289 AWS Storage Gateway Amazon FSx File Gateway User Guide Added GatewayClockOutOfS ync troubleshooting tips The Troubleshooting: File Gateway issues section now October 19, 2022 includes troubleshooting guidelines to help diagnose problems you may encounter if your gateway system clock is not synchronized with the AWS Storage Gateway server time. For more informati on, see Error: GatewayCl ockOutOfSync. Added Active Directory Join Domain troubleshooting tips The Troubleshooting: File Gateway issues section October 19, 2022 now includes troublesh ooting guidelines to help diagnose problems you may encounter when trying to join your gateway to an Active Directory domain. For more information, see Troublesh ooting: Active Directory domain issues. Updated gateway creation procedures The procedure for creating a new gateway has been October 12, 2021 updated to reﬂect changes in the Storage Gateway console. For more informati on, see Create and activate an Amazon S3 File Gateway. API Version 2021-03-31 290 AWS Storage Gateway Amazon FSx File Gateway User Guide Multiple ﬁle system support July 7, 2021 Amazon FSx File Gateway now supports up to ﬁve attached Amazon FSx ﬁle systems. For more informat ion, see Attach an Amazon FSx for Windows File Server ﬁle system. Amazon FSx soft storage quota support Amazon FSx File Gateway now supports soft storage July 7, 2021 quotas (which warn you when users surpass their data limits) when writing to attached Amazon FSx ﬁle systems where storage quotas are conﬁgured. Hard quotas (which enforce data limits by denying write access) are not supported. Soft quotas work for all users except the Amazon FSx admin user. For more information about setting up storage quotas, see Storage quotas in the Amazon FSx for Windows File Server User Guide. API Version 2021-03-31 291 AWS Storage Gateway New guide FedRAMP compliance File Gateway migration File Gateway cold cache read performance 4x increase In addition to the original File Gateway (now known as Amazon S3 File Gateway), Storage Gateway provides Amazon FSx File Gateway (FSx File Gateway). FSx File Gateway provides low latency and eﬃcient access to in- cloud FSx for Windows File Server ﬁle shares from your on-premises facility. For more information, see What is Amazon FSx File Gateway? Storage Gateway is now FedRAMP compliant. For more information, see Compliance validation for Storage Gateway. File Gateway now provides a documented process for replacing an existing File Gateway with a new File Gateway. For more informati on, see Replacing a File Gateway with a new File Gateway. Storage Gateway has increased cold cache read performance 4x. For more information, see Performance guidance for File Gateways. Amazon FSx File Gateway User Guide April 27, 2021 November 24, 2020 October 30, 2020 August 31, 2020 API Version 2021-03-31 292 AWS Storage Gateway Amazon FSx File Gateway User Guide Order the hardware appliance through the console You can now order the hardware appliance through August 12, 2020 the AWS Storage Gateway console. For more informati on, see Using the AWS Storage Gateway Hardware Appliance. Support for Federal Informati on Processing Standard You can now activate a gateway with FIPS endpoints July 31, 2020 (FIPS) endpoints in new AWS in the US East (Ohio), US E Regions File Gateway local cache storage 4x increase View Amazon CloudWatc h alarms in the Storage Gateway console ast (N. Virginia), US West (N. California), US West (Oregon), and Canada (Central) Regions. For more informati on, see AWS Storage Gateway endpoints and quotas in the
storagegateway-fsxfile-ug-107	storagegateway-fsxfile-ug.pdf	107	the hardware appliance through August 12, 2020 the AWS Storage Gateway console. For more informati on, see Using the AWS Storage Gateway Hardware Appliance. Support for Federal Informati on Processing Standard You can now activate a gateway with FIPS endpoints July 31, 2020 (FIPS) endpoints in new AWS in the US East (Ohio), US E Regions File Gateway local cache storage 4x increase View Amazon CloudWatc h alarms in the Storage Gateway console ast (N. Virginia), US West (N. California), US West (Oregon), and Canada (Central) Regions. For more informati on, see AWS Storage Gateway endpoints and quotas in the AWS General Reference. Storage Gateway now supports a local cache of up to 64 TB for File Gateway, improving performance for on-premises applications by providing low-latency access to larger working datasets. For more information, see Recommended local disk sizes for your gateway in the Storage Gateway User Guide. You can now view CloudWatc h alarms in the Storage Gateway console. For more information, see Understan ding CloudWatch alarms. July 7, 2020 May 29, 2020 API Version 2021-03-31 293 AWS Storage Gateway Amazon FSx File Gateway User Guide Support for Federal Informati on Processing Standard (FIPS) You can now activate a gateway with FIPS endpoints May 22, 2020 endpoints New AWS Regions in the AWS GovCloud (US) Regions. To choose a FIPS endpoint for a File Gateway, see Choosing a service endpoint. Storage Gateway is now available in the Africa (Cape Town) and Europe (Milan) Regions. For more informati on, see AWS Storage Gateway endpoints and quotas in the AWS General Reference. May 7, 2020 Support for S3 Intelligent- Tiering storage class Storage Gateway now supports S3 Intelligent-Tierin April 30, 2020 g storage class. The S3 I ntelligent-Tiering storage class optimizes storage costs by automatically moving data to the most cost-eﬀe ctive storage access tier, without performance impact or operational overhead. For more information, see Storage class for automatic ally optimizing frequently and infrequently accessed objects in the Amazon Simple Storage Service User Guide. API Version 2021-03-31 294 AWS Storage Gateway New AWS Region Amazon FSx File Gateway User Guide March 12, 2020 Storage Gateway is now available in the AWS GovCloud (US-East) Region. For more information, see AWS Storage Gateway Endp oints and Quotas in the AWS General Reference. Support for Linux Kernel-ba sed Virtual Machine (KVM) Storage Gateway now provides the ability to deploy February 4, 2020 hypervisor an on-premises gateway on the KVM virtualization platform. Gateways deployed on KVM have all the same functionality and features as the existing on-premises gateways. For more informat ion, see Supported Hy pervisors and Host Requireme nts in the Storage Gateway User Guide. API Version 2021-03-31 295 AWS Storage Gateway Amazon FSx File Gateway User Guide Support for VMware vSphere High Availability Storage Gateway now provides support for high November 20, 2019 availability on VMware to help protect storage workloads against hardware, hypervisor, or network failures. For more informat ion, see Using VMware vSphere High Availability with Storage Gateway in the Storage Gateway User Guide. This release also includes performance improvements. For more information, see Performance in the Storage Gateway User Guide. You can now conﬁgure File Gateways with Amazon CloudWatch Log Groups to get notiﬁed about errors and the health of your gateway and its resources. For more information, see Getting Noti ﬁed About Gateway Health and Errors With Amazon CloudWatch Log Groups in the Storage Gateway User Guide. September 4, 2019 Support for Amazon CloudWatch Logs API Version 2021-03-31 296 AWS Storage Gateway New AWS Region New AWS Region Amazon FSx File Gateway User Guide August 14, 2019 July 29, 2019 Storage Gateway is now available in the Asia Paciﬁc (Hong Kong) Region. For more information, see AWS Storage Gateway Endp oints and Quotas in the AWS General Reference. Storage Gateway is now available in the Middle East (Bahrain) Region. For more information, see AWS Storage Gateway Endp oints and Quotas in the AWS General Reference. Support for activating a gateway in a virtual private You can now activate a gateway in a VPC. You can June 20, 2019 cloud (VPC) File Gateway support for tag- based authorization create a private connection between your on-premises software appliance and cloud- based storage infrastructure . For more information, see Activating a Gateway in a V irtual Private Cloud. File Gateway now supports tag-based authorization. You can control access to File Gateway resources based on the tags on those resources . You can also control access based on the tags that can be passed in an IAM request condition. For more informati on, see Controlling Access to File Gateway Resources. March 4, 2019 API Version 2021-03-31 297 AWS Storage Gateway Amazon FSx File Gateway User Guide Availability of AWS Storage Gateway Hardware Appliance The AWS Storage Gateway Hardware Appliance is now February 25,
storagegateway-fsxfile-ug-108	storagegateway-fsxfile-ug.pdf	108	storage infrastructure . For more information, see Activating a Gateway in a V irtual Private Cloud. File Gateway now supports tag-based authorization. You can control access to File Gateway resources based on the tags on those resources . You can also control access based on the tags that can be passed in an IAM request condition. For more informati on, see Controlling Access to File Gateway Resources. March 4, 2019 API Version 2021-03-31 297 AWS Storage Gateway Amazon FSx File Gateway User Guide Availability of AWS Storage Gateway Hardware Appliance The AWS Storage Gateway Hardware Appliance is now February 25, 2019 in Europe available in Europe. For more information, see AWS Storage Gateway Hardware Appliance Regions in the AWS General Reference. In addition, you can now increase the useable storage on the AWS Storage Gateway Hardware Appliance from 5 TB to 12 TB and replace the installed copper network card with a 10-gigabi t ﬁber optic network card. For more information, see Setting Up Your Hardware Appliance. Support for AWS Storage Gateway Hardware Appliance The AWS Storage Gateway Hardware Appliance includes September 18, 2018 Storage Gateway software preinstalled on a third-party server. You can manage the appliance from the AWS Management Console. The appliance can host ﬁle, tape, and Volume Gateways. For more information, see Using the Storage Gateway Hard ware Appliance. Earlier updates The following table describes important changes in each release of the AWS Storage Gateway User Guide before May 2018. Earlier updates API Version 2021-03-31 298 AWS Storage Gateway Amazon FSx File Gateway User Guide Change Description New AWS Region Tape Gateway is now available in the Asia Paciﬁc (Singapore) Region. For detailed information, see AWS Regions that support Storage Gateway. Date Changed April 3, 2018 New AWS Region Storage Gateway is now available in the Europe (Paris) Region. For detailed information, see AWS December 18, 2017 Regions that support Storage Gateway. Support for VMware ESXi AWS Storage Gateway now supports VMware ESXi Hypervisor version 6.5. This is in addition to version September 13, 2017 Hypervisor version 4.1, 5.0, 5.1, 5.5, and 6.0. For more information, see 6.5 Supported hypervisors and host requirements. File Gateway support for You can now deploy a File Gateway on a Microsoft Hyper-V hypervisor. For information, see Supported June 22, 2017 Microsoft Hyper-V hypervisors and host requirements. hypervisor New AWS Region Storage Gateway is now available in the Asia Paciﬁc (Mumbai) Region. For detailed information, see AWS May 02, 2017 Regions that support Storage Gateway. Support for File Gateways on AWS Storage Gateway now provides the ability to deploy a File Gateway in Amazon EC2. You can Amazon EC2 launch a File Gateway in Amazon EC2 using the February 08, 2017 Storage Gateway Amazon Machine Image (AMI) now available as a community AMI. For information about how to create a File Gateway and deploy it on an EC2 instance, see Create and activate an Amazon FSx File Gateway. For information about how to launch a File Gateway AMI, see Deploy a default Amazon EC2 host for FSx File Gateway. In addition, File Gateway now supports HTTP proxy conﬁguration. For more information, see Routing Earlier updates API Version 2021-03-31 299 AWS Storage Gateway Amazon FSx File Gateway User Guide Change Description Date Changed your gateway deployed on Amazon EC2 through an HTTP proxy. New AWS Region Storage Gateway is now available in the Europe (London) Region. For detailed information, see AWS December 13, 2016 Regions that support Storage Gateway. New AWS Region Storage Gateway is now available in the Canada (Central) Region. For detailed information, see AWS December 08, 2016 Regions that support Storage Gateway. Support for File Gateway In addition to Volume Gateways and Tape Gateway, Storage Gateway now provides File Gateway. File November 29, 2016 Gateway combines a service and virtual software appliance, allowing you to store and retrieve objects in Amazon S3 using industry-standard ﬁle protocols such as Network File System (NFS). The gateway provides access to objects in Amazon S3 as ﬁles on an NFS mount point. Earlier updates API Version 2021-03-31 300
storagegateway-s3file-ug-001	storagegateway-s3file-ug.pdf	1	Amazon S3 File Gateway User Guide AWS Storage Gateway API Version 2013-06-30 Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AWS Storage Gateway Amazon S3 File Gateway User Guide AWS Storage Gateway: Amazon S3 File Gateway User Guide Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. 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 aﬃliated with, connected to, or sponsored by Amazon. AWS Storage Gateway Amazon S3 File Gateway User Guide Table of Contents What is Amazon S3 File Gateway ................................................................................................... 1 How S3 File Gateway works ....................................................................................................................... 2 Getting Started with AWS Storage Gateway ................................................................................. 5 Sign up for Amazon Web Services ........................................................................................................... 5 Create an IAM user with administrator privileges ................................................................................. 6 Accessing AWS Storage Gateway .............................................................................................................. 7 AWS Regions that support Storage Gateway ......................................................................................... 8 File Gateway setup requirements ................................................................................................... 9 Prerequisites .................................................................................................................................................. 9 Hardware and storage requirements ..................................................................................................... 10 Hardware requirements for on-premises VMs ................................................................................ 10 Requirements for Amazon EC2 instance types ............................................................................... 10 Storage requirements .......................................................................................................................... 11 Network and ﬁrewall requirements ....................................................................................................... 12 Port requirements ................................................................................................................................. 13 Networking and ﬁrewall requirements for the hardware appliance ........................................... 28 Allowing gateway access through ﬁrewall and routers ................................................................ 31 Conﬁguring security group ................................................................................................................. 35 Supported hypervisors and host requirements ................................................................................... 35 Supported NFS and SMB clients for File Gateway .............................................................................. 36 Supported ﬁle system operations .......................................................................................................... 37 Managing local disks ................................................................................................................................. 37 Deciding the amount of local disk storage ..................................................................................... 38 Add cache storage ................................................................................................................................ 39 Using ephemeral storage with EC2 gateways ................................................................................ 40 Using the hardware appliance ...................................................................................................... 42 Setting up your hardware appliance ...................................................................................................... 43 Physically installing your hardware appliance ..................................................................................... 44 Accessing the hardware appliance console ........................................................................................... 46 Conﬁguring hardware appliance network parameters ....................................................................... 48 Activating your hardware appliance ....................................................................................................... 49 Creating a gateway on your hardware appliance ................................................................................ 51 Conﬁguring a gateway IP address on the hardware appliance ......................................................... 52 Removing gateway software from your hardware appliance ........................................................... 54 API Version 2013-06-30 iii AWS Storage Gateway Amazon S3 File Gateway User Guide Deleting your hardware appliance ......................................................................................................... 55 Creating your gateway .................................................................................................................. 57 Overview - Gateway Activation ............................................................................................................... 57 Set up gateway ..................................................................................................................................... 57 Connect to AWS .................................................................................................................................... 57 Review and activate ............................................................................................................................. 58 Overview - Gateway Conﬁguration ........................................................................................................ 58 Overview - Storage Resources ................................................................................................................ 58 Create an S3 File Gateway ....................................................................................................................... 58 Set up an Amazon S3 File Gateway ................................................................................................. 59 Connect your Amazon S3 File Gateway to AWS ............................................................................ 60 Review settings and activate your Amazon S3 File Gateway ...................................................... 61 Conﬁgure your Amazon S3 File Gateway ........................................................................................ 62 Activating a gateway in a VPC ................................................................................................................ 64 Create a VPC endpoint for Storage Gateway ................................................................................. 65 Creating a ﬁle share ...................................................................................................................... 67 Avoid unanticipated costs ........................................................................................................................ 68 Encrypt objects stored by File Gateway ................................................................................................ 69 Create an NFS ﬁle share ........................................................................................................................... 70 Create NFS ﬁle share with default conﬁguration ........................................................................... 71 Create NFS ﬁle share with custom conﬁguration .......................................................................... 75 Create an SMB ﬁle share .......................................................................................................................... 82 Create SMB ﬁle share with default conﬁguration .......................................................................... 82 Create SMB ﬁle share with custom conﬁguration ......................................................................... 89 Mounting and using your ﬁle share ............................................................................................. 99 Mount your NFS ﬁle share on your client ............................................................................................. 99 Mount your SMB ﬁle share on your client .......................................................................................... 101 Using ﬁle shares on buckets with pre-existing objects .................................................................... 105 Test your S3 File Gateway ..................................................................................................................... 105 Managing your Amazon S3 File Gateway .................................................................................. 107 Edit basic gateway information ............................................................................................................ 108 Granting access and permissions .......................................................................................................... 109 Granting access to an S3 bucket ..................................................................................................... 109 Cross-service confused deputy prevention ................................................................................... 113 Using a ﬁle share for cross-account access ................................................................................... 114 Delete a ﬁle share ................................................................................................................................... 115 API Version 2013-06-30 iv AWS Storage Gateway Amazon S3 File Gateway User Guide Editing gateway SMB settings .............................................................................................................. 117 Set gateway security level ................................................................................................................ 117 Conﬁgure Active Directory authentication .................................................................................... 119 Provide guest access .......................................................................................................................... 121 Conﬁgure local groups ...................................................................................................................... 122 Set ﬁle share visibility ....................................................................................................................... 123 Edit SMB ﬁle share settings .................................................................................................................. 124 Limit SMB ﬁle share access ................................................................................................................... 125 Change ﬁle share encryption method ................................................................................................. 126 Edit NFS ﬁle share settings ................................................................................................................... 128 Edit NFS ﬁle share metadata defaults ................................................................................................ 130 Limit NFS ﬁle share access .................................................................................................................... 131 Refreshing Amazon S3 bucket object cache ...................................................................................... 132 Conﬁgure an automated cache refresh schedule using the Storage Gateway console ......... 132 Conﬁgure an automated cache refresh schedule using AWS Lambda with an Amazon CloudWatch rule ................................................................................................................................. 134 Perform a manual cache refresh using the Storage Gateway console .................................... 137 Perform a
storagegateway-s3file-ug-002	storagegateway-s3file-ug.pdf	2	Set ﬁle share visibility ....................................................................................................................... 123 Edit SMB ﬁle share settings .................................................................................................................. 124 Limit SMB ﬁle share access ................................................................................................................... 125 Change ﬁle share encryption method ................................................................................................. 126 Edit NFS ﬁle share settings ................................................................................................................... 128 Edit NFS ﬁle share metadata defaults ................................................................................................ 130 Limit NFS ﬁle share access .................................................................................................................... 131 Refreshing Amazon S3 bucket object cache ...................................................................................... 132 Conﬁgure an automated cache refresh schedule using the Storage Gateway console ......... 132 Conﬁgure an automated cache refresh schedule using AWS Lambda with an Amazon CloudWatch rule ................................................................................................................................. 134 Perform a manual cache refresh using the Storage Gateway console .................................... 137 Perform a manual cache refresh using the Storage Gateway API ............................................ 137 Using S3 Object Lock .............................................................................................................................. 138 File share status ....................................................................................................................................... 139 Gateway status ......................................................................................................................................... 140 Managing bandwidth .............................................................................................................................. 141 Edit bandwidth-rate-limit schedule ................................................................................................ 142 Using the AWS SDK for Java ........................................................................................................... 143 Using the AWS SDK for .NET ........................................................................................................... 146 Using the AWS Tools for Windows PowerShell ............................................................................ 148 Monitoring Storage Gateway ...................................................................................................... 150 Understanding CloudWatch alarms ..................................................................................................... 150 Create recommended CloudWatch alarms ......................................................................................... 152 Create a custom CloudWatch alarm .................................................................................................... 153 Monitoring your S3 File Gateway ......................................................................................................... 155 Getting S3 File Gateway health logs .............................................................................................. 155 Using Amazon CloudWatch metrics ............................................................................................... 157 Getting notiﬁed about ﬁle operations ........................................................................................... 159 Understanding gateway metrics ...................................................................................................... 167 Understanding ﬁle share metrics .................................................................................................... 173 API Version 2013-06-30 v AWS Storage Gateway Amazon S3 File Gateway User Guide Understanding S3 File Gateway audit logs ................................................................................... 176 Create a cache report ............................................................................................................................. 181 Manage cache reports ............................................................................................................................. 184 Understanding cache reports ................................................................................................................ 185 Maintaining your gateway .......................................................................................................... 188 Managing gateway updates ................................................................................................................... 188 Update frequency and expected behavior .................................................................................... 189 Turn maintenance updates on or oﬀ ............................................................................................. 190 Modify the gateway maintenance window schedule .................................................................. 191 Apply an update manually ............................................................................................................... 192 Performing maintenance tasks using the local console .................................................................. 193 Accessing the gateway local console ............................................................................................. 193 Performing tasks on the virtual machine local console ............................................................. 196 Performing tasks on the EC2 local console .................................................................................. 212 Shutting down your gateway VM ......................................................................................................... 219 Replacing your existing S3 File Gateway with a new instance ....................................................... 220 Method 1: Migrate cache disk and Gateway ID to replacement instance ................................ 221 Method 2: Replacement instance with empty cache disk and new Gateway ID ..................... 224 Deleting your gateway and removing resources ............................................................................... 226 Deleting Your Gateway by Using the Storage Gateway Console .............................................. 226 Performance and optimization ................................................................................................... 228 Basic performance guidance for S3 File Gateway ............................................................................. 228 S3 File Gateway performance on Linux clients ............................................................................ 229 File Gateway performance on Windows clients ........................................................................... 231 Performance guidance for gateways with multiple ﬁle shares ...................................................... 232 Maximizing S3 File Gateway throughput ............................................................................................ 234 Deploy your gateway in the same location as your clients ........................................................ 235 Reduce bottlenecks caused by slow disks ..................................................................................... 235 Adjust virtual machine resource allocation for CPU, RAM, and cache disks ........................... 236 Adjust the SMB security level .......................................................................................................... 238 Use multiple threads and clients to parallelize write operations ............................................. 238 Turn oﬀ automated cache refresh .................................................................................................. 240 Increase the number of Amazon S3 uploader threads ............................................................... 241 Increase SMB timeout settings ........................................................................................................ 242 Turn on opportunistic locking for compatible applications ....................................................... 242 Adjust gateway capacity according to the size of the working ﬁle set .................................... 242 API Version 2013-06-30 vi AWS Storage Gateway Amazon S3 File Gateway User Guide Deploy multiple gateways for larger workloads .......................................................................... 243 Security ........................................................................................................................................ 245 Data protection ........................................................................................................................................ 245 Data encryption .................................................................................................................................. 246 Identity and access management ......................................................................................................... 247 Audience ............................................................................................................................................... 247 Authenticating with identities ......................................................................................................... 248 Managing access using policies ....................................................................................................... 251 How AWS Storage Gateway works with IAM ................................................................................ 254 Identity-based policy examples ....................................................................................................... 260 Troubleshooting .................................................................................................................................. 263 Using tags to control access to resources ..................................................................................... 265 Using ACLs for SMB ﬁle share access ............................................................................................. 268 Compliance validation ............................................................................................................................ 271 Resilience ................................................................................................................................................... 272 Infrastructure security ............................................................................................................................. 273 AWS Security Best Practices .................................................................................................................. 273 Logging and monitoring ........................................................................................................................ 274 Storage Gateway information in CloudTrail ................................................................................. 274 Understanding Storage Gateway log ﬁle entries ......................................................................... 275 Troubleshooting ........................................................................................................................... 278 Troubleshooting: gateway oﬄine issues ............................................................................................. 279 Check the associated ﬁrewall or proxy .......................................................................................... 279 Check for an ongoing SSL or deep-packet inspection of your gateway's traﬃc .................... 279 Check the IOWaitPercent metric after a reboot or software update ....................................... 279 Check for a power outage or hardware failure on the hypervisor host ................................... 280 Check for issues with an associated cache disk ........................................................................... 280 Troubleshooting: Active Directory issues ............................................................................................ 280 Conﬁrm that the gateway can reach the domain controller by running an nping test ......... 281 Check the DHCP options set for the VPC of your Amazon EC2 gateway instance ................. 282 Conﬁrm that the gateway can resolve the domain by running a dig query ........................... 282 Check the domain controller settings and roles .......................................................................... 283 Check that the gateway is
storagegateway-s3file-ug-003	storagegateway-s3file-ug.pdf	3	metric after a reboot or software update ....................................... 279 Check for a power outage or hardware failure on the hypervisor host ................................... 280 Check for issues with an associated cache disk ........................................................................... 280 Troubleshooting: Active Directory issues ............................................................................................ 280 Conﬁrm that the gateway can reach the domain controller by running an nping test ......... 281 Check the DHCP options set for the VPC of your Amazon EC2 gateway instance ................. 282 Conﬁrm that the gateway can resolve the domain by running a dig query ........................... 282 Check the domain controller settings and roles .......................................................................... 283 Check that the gateway is joined to the nearest domain controller ........................................ 283 Conﬁrm that Active Directory creates new computer objects in the default organizational unit (OU) ............................................................................................................................................... 284 Check your domain controller event logs ..................................................................................... 284 API Version 2013-06-30 vii AWS Storage Gateway Amazon S3 File Gateway User Guide Troubleshooting: gateway activation issues ....................................................................................... 284 Resolve errors when activating your gateway using a public endpoint ................................... 285 Resolve errors when activating your gateway using an Amazon VPC endpoint .................... 288 Resolve errors when activating your gateway using a public endpoint and there is a Storage Gateway VPC endpoint in the same VPC ....................................................................... 292 Troubleshooting: on-premises gateway issues .................................................................................. 293 Troubleshooting: Open NFS ports .................................................................................................. 296 Turning on Support access to help troubleshoot your gateway ............................................... 297 Troubleshooting: Microsoft Hyper-V setup issues ............................................................................ 298 Troubleshooting: Amazon EC2 gateway issues .................................................................................. 301 Gateway activation hasn't occurred after a few moments ........................................................ 302 Can't ﬁnd the EC2 gateway instance in the instance list ........................................................... 302 Connect to your Amazon EC2 gateway using the serial console .............................................. 303 Turning on Support access to help troubleshoot the gateway ................................................. 303 Troubleshooting: hardware appliance issues ..................................................................................... 305 How to determine service IP address ............................................................................................. 305 How to perform a factory reset ...................................................................................................... 305 How to perform a remote restart ................................................................................................... 305 How to obtain Dell iDRAC support ................................................................................................. 306 How to ﬁnd the hardware appliance serial number ................................................................... 306 How to get hardware appliance support ....................................................................................... 306 Troubleshooting: File Gateway issues .................................................................................................. 307 Error: 1344 (0x00000540) ................................................................................................................ 308 Error: GatewayClockOutOfSync ....................................................................................................... 308 Error: InaccessibleStorageClass ........................................................................................................ 308 Error: InvalidObjectState ................................................................................................................... 309 Error: ObjectMissing ........................................................................................................................... 310 Error: RoleTrustRelationshipInvalid ................................................................................................. 310 Error: S3AccessDenied ....................................................................................................................... 310 Error: DroppedNotiﬁcations ............................................................................................................. 311 Notiﬁcation: HardReboot .................................................................................................................. 312 Notiﬁcation: Reboot ........................................................................................................................... 312 Troubleshooting: Open NFS ports .................................................................................................. 296 Troubleshooting with CloudWatch metrics ................................................................................... 313 Troubleshooting: ﬁle share issues ........................................................................................................ 316 File share is stuck in CREATING status ........................................................................................... 316 API Version 2013-06-30 viii AWS Storage Gateway Amazon S3 File Gateway User Guide Can't create a ﬁle share .................................................................................................................... 317 SMB ﬁle shares don't allow multiple diﬀerent access methods ................................................ 317 Multiple ﬁle shares can't write to the mapped S3 bucket ......................................................... 318 Notiﬁcation for deleted log group when using audit logs ......................................................... 318 Can't upload ﬁles into S3 bucket .................................................................................................... 318 Can't change default encryption to SSE-KMS .............................................................................. 318 Changes made directly in an S3 bucket with object versioning turned on may aﬀect what you see in your ﬁle share ................................................................................................................. 319 When writing to an S3 bucket with versioning turned on, the Amazon S3 File Gateway may create multiple versions of Amazon S3 objects ........................................................................... 320 Changes to an S3 bucket are not reﬂected in Storage Gateway .............................................. 321 ACL permissions aren't working as expected ................................................................................ 322 Gateway performance declined after a recursive operation ...................................................... 322 High Availability Health Notiﬁcations ................................................................................................. 322 Troubleshooting: high availability issues ............................................................................................ 323 Health notiﬁcations ............................................................................................................................ 323 Metrics ................................................................................................................................................... 324 Best practices ............................................................................................................................... 325 Recovering your data .............................................................................................................................. 325 Recovering from an unexpected VM shutdown ........................................................................... 326 Recovering data from a malfunctioning cache disk .................................................................... 326 Recovering data from an inaccessible data center ...................................................................... 326 Managing multipart uploads ................................................................................................................. 327 Unzipping compressed ﬁles ................................................................................................................... 327 Copying data from Windows Server .................................................................................................... 328 Cache disk sizing ...................................................................................................................................... 328 Multiple ﬁle shares and buckets ........................................................................................................... 328 Clean up unnecessary resources ........................................................................................................... 330 Additional resources .................................................................................................................... 331 Host setup ................................................................................................................................................. 332 Deploy a default Amazon EC2 host for File Gateway ................................................................. 332 Deploy a customized Amazon EC2 host for File Gateway ......................................................... 335 Modify Amazon EC2 instance metadata options ......................................................................... 338 Synchronize VM time with Hyper-V or Linux KVM host time .................................................... 339 Synchronize VM time with VMware host time ............................................................................. 340 Conﬁguring network adapters for your gateway ......................................................................... 341 API Version 2013-06-30 ix AWS Storage Gateway Amazon S3 File Gateway User Guide Using Storage Gateway with VMware HA ..................................................................................... 344 Getting activation key ............................................................................................................................ 348 Linux (curl) ........................................................................................................................................... 349 Linux (bash/zsh) .................................................................................................................................. 350 Microsoft Windows PowerShell ....................................................................................................... 351 Using your local console ................................................................................................................... 351 File attribute support .............................................................................................................................. 352 Using AWS Direct Connect ..................................................................................................................... 353 Active Directory permissions ................................................................................................................. 354 Getting the gateway IP address ........................................................................................................... 354 Getting an IP Address from an Amazon EC2 Host ...................................................................... 355 Understanding resources and resource IDs
storagegateway-s3file-ug-004	storagegateway-s3file-ug.pdf	4	VM time with VMware host time ............................................................................. 340 Conﬁguring network adapters for your gateway ......................................................................... 341 API Version 2013-06-30 ix AWS Storage Gateway Amazon S3 File Gateway User Guide Using Storage Gateway with VMware HA ..................................................................................... 344 Getting activation key ............................................................................................................................ 348 Linux (curl) ........................................................................................................................................... 349 Linux (bash/zsh) .................................................................................................................................. 350 Microsoft Windows PowerShell ....................................................................................................... 351 Using your local console ................................................................................................................... 351 File attribute support .............................................................................................................................. 352 Using AWS Direct Connect ..................................................................................................................... 353 Active Directory permissions ................................................................................................................. 354 Getting the gateway IP address ........................................................................................................... 354 Getting an IP Address from an Amazon EC2 Host ...................................................................... 355 Understanding resources and resource IDs ........................................................................................ 356 Working with Resource IDs ............................................................................................................... 356 Tagging your resources ........................................................................................................................... 357 Working with tags .............................................................................................................................. 358 Open-source components ...................................................................................................................... 359 Open-source components for Storage Gateway .......................................................................... 359 Open-source components for Amazon S3 File Gateway ............................................................ 360 Quotas ........................................................................................................................................................ 360 Quotas for ﬁle shares ........................................................................................................................ 360 Recommended local disk sizes for your gateway ........................................................................ 363 Using storage classes .............................................................................................................................. 364 Using storage classes with a File Gateway .................................................................................... 364 Using the GLACIER storage class with File Gateway ................................................................... 369 Using Kubernetes CSI drivers ................................................................................................................ 369 Working with SMB CSI drivers ......................................................................................................... 370 Working with NFS CSI drivers .......................................................................................................... 374 Terraform module .................................................................................................................................... 378 API Reference ............................................................................................................................... 380 Required Request Headers ..................................................................................................................... 380 Signing Requests ...................................................................................................................................... 382 Example Signature Calculation ........................................................................................................ 383 Error Responses ........................................................................................................................................ 385 Exceptions ............................................................................................................................................ 386 Operation Error Codes ....................................................................................................................... 388 Error Responses .................................................................................................................................. 408 API Version 2013-06-30 x AWS Storage Gateway Amazon S3 File Gateway User Guide Actions ........................................................................................................................................................ 410 Document history ........................................................................................................................ 411 Earlier updates .......................................................................................................................................... 425 Release notes ............................................................................................................................... 428 API Version 2013-06-30 xi AWS Storage Gateway Amazon S3 File Gateway User Guide What is Amazon S3 File Gateway Amazon S3 File Gateway – Amazon S3 File Gateway supports a ﬁle interface into Amazon Simple Storage Service (Amazon S3) and combines a service and a virtual software appliance. By using this combination, you can store and retrieve objects in Amazon S3 using industry-standard ﬁle protocols such as Network File System (NFS) and Server Message Block (SMB). You deploy the gateway into your on-premises environment as a virtual machine (VM) running on VMware ESXi, Microsoft Hyper-V, or Linux Kernel-based Virtual Machine (KVM), or as a hardware appliance that you order from your preferred reseller. You can also deploy the Storage Gateway VM in VMware Cloud on AWS, or as an AMI in Amazon EC2. The gateway provides access to objects in S3 as ﬁles or ﬁle share mount points. With a S3 File Gateway, you can do the following: • You can store and retrieve ﬁles directly using the NFS version 3 or 4.1 protocol. • You can store and retrieve ﬁles directly using the SMB ﬁle system version, 2 and 3 protocol. • You can access your data directly in Amazon S3 from any AWS Cloud application or service. • You can manage your S3 data using lifecycle policies, cross-region replication, and versioning. You can think of a S3 File Gateway as a ﬁle system mount on Amazon S3. A S3 File Gateway simpliﬁes ﬁle storage in Amazon S3, integrates to existing applications through industry-standard ﬁle system protocols, and provides a cost-eﬀective alternative to on-premises storage. It also provides low-latency access to data through transparent local caching. A S3 File Gateway manages data transfer to and from AWS, buﬀers applications from network congestion, optimizes and streams data in parallel, and manages bandwidth consumption. S3 File Gateway integrates with other AWS services, for example: • Common access management using AWS Identity and Access Management (IAM) • Encryption using AWS Key Management Service (AWS KMS) • Monitoring using Amazon CloudWatch (CloudWatch) • Audit using AWS CloudTrail (CloudTrail) • Operations using the AWS Management Console and AWS Command Line Interface (AWS CLI) • Billing and cost management In the following documentation, you can ﬁnd a Getting Started section that covers setup information common to all gateways and also gateway-speciﬁc setup sections. The Getting Started API Version 2013-06-30 1 AWS Storage Gateway Amazon S3 File Gateway User Guide section shows you how to deploy, activate, and conﬁgure storage for a gateway. The management section shows you how to manage your gateway and resources: • provides instructions on how to create and use a S3 File Gateway. It shows you how to create a ﬁle share, map your drive to an Amazon S3 bucket, and upload ﬁles and folders to Amazon S3. • describes how to perform management tasks for all gateway types and resources. In this guide, you can primarily ﬁnd how to work with gateway operations by using the AWS Management Console. If you want to perform these operations programmatically, see the AWS Storage Gateway API Reference. How Amazon S3 File Gateway works To use an S3 File Gateway, you start by downloading a VM image for
storagegateway-s3file-ug-005	storagegateway-s3file-ug.pdf	5	to create and use a S3 File Gateway. It shows you how to create a ﬁle share, map your drive to an Amazon S3 bucket, and upload ﬁles and folders to Amazon S3. • describes how to perform management tasks for all gateway types and resources. In this guide, you can primarily ﬁnd how to work with gateway operations by using the AWS Management Console. If you want to perform these operations programmatically, see the AWS Storage Gateway API Reference. How Amazon S3 File Gateway works To use an S3 File Gateway, you start by downloading a VM image for the gateway. You then activate the gateway from the AWS Management Console or through the Storage Gateway API. You can also create an S3 File Gateway using an Amazon EC2 image. After the S3 File Gateway is activated, you create and conﬁgure your ﬁle share and associate that share with your Amazon Simple Storage Service (Amazon S3) bucket. Doing this makes the share accessible by clients using either the Network File System (NFS) or Server Message Block (SMB) protocol. Files written to a ﬁle share become objects in Amazon S3, with the path as the key. There is a one-to-one mapping between ﬁles and objects, and the gateway asynchronously updates the objects in Amazon S3 as you change the ﬁles. Existing objects in the Amazon S3 bucket appear as ﬁles in the ﬁle system, and the key becomes the path. Objects are encrypted with Amazon S3– server-side encryption keys (SSE-S3). All data transfer is done through HTTPS. When sending HTTPS data upload requests to the Amazon S3, File Gateway populates the Content-MD5 header with the MD5 checksum of the data being uploaded. The use of this header causes Amazon S3 to return a failure in case of mismatch between the MD5 checksum computed by Amazon S3 and the value received from the File Gateway. If such a failure is returned, the File Gateway resends the request. The service optimizes data transfer between the gateway and AWS using multipart parallel uploads or byte-range downloads, to better use the available bandwidth. Local cache is maintained to provide low latency access to the recently accessed data and reduce data egress charges. CloudWatch metrics provide insight into resource use on the VM and data transfer to and from AWS. CloudTrail tracks all API calls. How S3 File Gateway works API Version 2013-06-30 2 AWS Storage Gateway Amazon S3 File Gateway User Guide With S3 File Gateway storage, you can do such tasks as ingesting cloud workloads to Amazon S3, performing backups and archiving, tiering, and migrating storage data to the AWS Cloud. The following diagram provides an overview of ﬁle storage deployment for Storage Gateway. S3 File Gateway converts ﬁles to S3 objects when uploading ﬁles to Amazon S3. The interaction between ﬁle operations performed against ﬁles shares on S3 File Gateway and S3 objects requires certain operations to be carefully considered when converting between ﬁles and objects. Common ﬁle operations change ﬁle metadata, which results in the deletion of the current S3 object and the creation of a new S3 object. The following table shows example ﬁle operations and the impact on S3 objects. File operation S3 object impact Storage class implication Rename ﬁle Rename folder Change ﬁle/folder permissio ns Replaces existing S3 object and creates a new S3 object Early deletion fees and retrieval fees may apply for each ﬁle Replaces all existing S3 objects and creates new S3 objects for each folder and ﬁles in the folder structure Replaces existing S3 object and creates a new S3 object for each ﬁle or folder Early deletion fees and retrieval fees may apply Early deletion fees and retrieval fees may apply How S3 File Gateway works API Version 2013-06-30 3 AWS Storage Gateway Amazon S3 File Gateway User Guide File operation S3 object impact Storage class implication Change ﬁle/folder ownership Replaces existing S3 object and creates a new S3 object Early deletion fees and retrieval fees may apply for each ﬁle or folder Append to a ﬁle Replaces existing S3 object and creates a new S3 object Early deletion fees and retrieval fees may apply for each ﬁle When a ﬁle is written to the S3 File Gateway by an NFS or SMB client, the File Gateway uploads the ﬁle's data to Amazon S3 followed by its metadata, (ownerships, timestamps, etc.). Uploading the ﬁle data creates an S3 object, and uploading the metadata for the ﬁle updates the metadata for the S3 object. This process creates another version of the object, resulting in two versions of an object. If S3 Versioning is turned on, both versions will be stored. When a ﬁle is modiﬁed in the S3 File Gateway by an NFS or SMB client after it has been uploaded to Amazon S3,
storagegateway-s3file-ug-006	storagegateway-s3file-ug.pdf	6	to the S3 File Gateway by an NFS or SMB client, the File Gateway uploads the ﬁle's data to Amazon S3 followed by its metadata, (ownerships, timestamps, etc.). Uploading the ﬁle data creates an S3 object, and uploading the metadata for the ﬁle updates the metadata for the S3 object. This process creates another version of the object, resulting in two versions of an object. If S3 Versioning is turned on, both versions will be stored. When a ﬁle is modiﬁed in the S3 File Gateway by an NFS or SMB client after it has been uploaded to Amazon S3, the S3 File Gateway uploads the new or modiﬁed data instead of uploading the whole ﬁle. The ﬁle modiﬁcation results in a new version of the S3 object being created. When the S3 File Gateway uploads larger ﬁles, it might need to upload smaller chunks of the ﬁle before the client is done writing to the S3 File Gateway. Some reasons for this include freeing up cache space or a high rate of writes to a ﬁle share. This can result in multiple versions of an object in the S3 bucket. You should monitor your S3 bucket to determine how many versions of an object exist before setting up lifecycle policies to move objects to diﬀerent storage classes. You should conﬁgure lifecycle expiration for previous versions to minimize the number of versions you have for an object in your S3 bucket. The use of Same-Region replication (SRR) or Cross-Region replication (CRR) between S3 buckets will increase the storage used. How S3 File Gateway works API Version 2013-06-30 4 AWS Storage Gateway Amazon S3 File Gateway User Guide Getting Started with AWS Storage Gateway This section provides instructions for getting started with AWS. You need an AWS account before you can start using AWS Storage Gateway. You can use an existing AWS account, or sign up for a new account. You also need an IAM user in your AWS account that belongs to a group with the necessary administrative permissions to perform Storage Gateway tasks. Users with the appropriate privileges can access the Storage Gateway console and Storage Gateway API to perform gateway deployment, conﬁguration, and maintenance tasks. If you are a ﬁrst-time user, we recommend that you review the Supported AWS regions and File Gateway setup requirements sections before you being working with Storage Gateway. This section contains the following topics, which provide additional information about getting started with AWS Storage Gateway: Topics • Sign up for Amazon Web Services - Learn how to sign up for AWS and create an AWS account. • Create an IAM user with administrator privileges - Learn how to create an IAM user with administrative privileges for your AWS account. • Accessing AWS Storage Gateway - Learn how to access AWS Storage Gateway through the Storage Gateway console or programmatically using the AWS SDKs. • AWS Regions that support Storage Gateway - Learn which AWS Regions you can use to store your data when you activate your gateway in Storage Gateway. Sign up for Amazon Web Services An AWS account is a fundamental requirement for accessing AWS services. Your AWS account is the basic container for all of the AWS resources you create as an AWS user. Your AWS account is also the basic security boundary for your AWS resources. Any resources that you create in your account are available to users who have credentials for the account. Before you can start using AWS Storage Gateway, you need to 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. Sign up for Amazon Web Services API Version 2013-06-30 5 AWS Storage Gateway Amazon S3 File Gateway User Guide 2. Follow the online instructions. Part of the sign-up procedure involves receiving a phone call and entering a veriﬁcation 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. We also recommend that you require your users to use temporary credentials when accessing AWS. To provide temporary credentials, you can use federation and an identity provider, such as AWS IAM Identity Center. If your company already uses an identity provider, you can use it with federation to simplify how you provide access to the resources in your AWS account. Create an IAM user with administrator privileges After you create your AWS account, use the following steps to create an AWS Identity and Access Management (IAM) user
storagegateway-s3file-ug-007	storagegateway-s3file-ug.pdf	7	use only the root user to perform tasks that require root user access. We also recommend that you require your users to use temporary credentials when accessing AWS. To provide temporary credentials, you can use federation and an identity provider, such as AWS IAM Identity Center. If your company already uses an identity provider, you can use it with federation to simplify how you provide access to the resources in your AWS account. Create an IAM user with administrator privileges After you create your AWS account, use the following steps to create an AWS Identity and Access Management (IAM) user for yourself, and then add that user to a group that has administrative permissions. For more information about using the AWS Identity and Access Management service to control access to Storage Gateway resources, see Identity and access management for AWS Storage Gateway. To create an administrator user, choose one of the following options. To By You can also Choose one way to manage your administr ator In IAM Identity Use short-term credentials to access Following the instructions in Getting started in the Conﬁgure programmatic access by Conﬁguring the Center AWS. AWS IAM Identity Center AWS CLI to use AWS IAM User Guide. Identity Center in the AWS Create an IAM user with administrator privileges API Version 2013-06-30 6 AWS Storage Gateway Amazon S3 File Gateway User Guide To By You can also Choose one way to manage your administr ator (Recommen This aligns with the Command Line Interface User ded) security best practices . For information about best practices , see Security best practices in IAM in the IAM User Guide. Guide. In IAM (Not Use long-term credentials to access Following the instructions in Create an IAM user for Conﬁgure programmatic access by Manage access keys AWS. emergency access in the for IAM users in the IAM User IAM User Guide. Guide. recommend ed) Warning IAM users have long-term credentials which present a security risk. To help mitigate this risk, we recommend that you provide these users with only the permissions they require to perform the task and that you remove these users when they are no longer needed. Accessing AWS Storage Gateway You can use the AWS Storage Gateway console to perform various gateway conﬁguration and maintenance tasks, including activating or removing Storage Gateway hardware appliances from your deployment, creating, managing, and deleting the diﬀerent types of gateways, creating, managing, and deleting ﬁle shares, and monitoring the health and status of various elements of the Storage Gateway service. For simplicity and ease of use, this guide focuses on performing tasks Accessing AWS Storage Gateway API Version 2013-06-30 7 AWS Storage Gateway Amazon S3 File Gateway User Guide using the Storage Gateway console web interface. You can access the Storage Gateway console through your web browser at: https://console.aws.amazon.com/storagegateway/home/. If you prefer a programmatic approach, you can use the AWS Storage Gateway Application Programming Interface (API) or Command Line Interface (CLI) to set up and manage the resources in your Storage Gateway deployment. For more information about actions, data types, and required syntax for the Storage Gateway API, see the Storage Gateway API Reference. For more information about the Storage Gateway CLI, see the AWS CLI Command Reference. You can also use the AWS SDKs to develop applications that interact with Storage Gateway. The AWS SDKs for Java, .NET, and PHP wrap the underlying Storage Gateway API to simplify your programming tasks. For information about downloading the SDK libraries, see the AWS Developer Center. For information about pricing, see AWS Storage Gateway pricing. AWS Regions that support Storage Gateway An AWS Region is a physical location in the world where AWS has multiple Availability Zones. Availability Zones consist of one or more discrete AWS data centers, each with redundant power, networking, and connectivity, housed in separate facilities. This means that each AWS Region is physically isolated and independent of the other Regions. Regions provide fault tolerance, stability, and resilience, and can also reduce latency. The resources that you create in one Region do not exist in any other Region unless you explicitly use a replication feature oﬀered by an AWS service. For example, Amazon S3 and Amazon EC2 support cross-Region replication. Some services, such as AWS Identity and Access Management, do not have Regional resources. You can launch AWS resources in locations that meet your business requirements. For example, you might want to launch Amazon EC2 instances to host your AWS Storage Gateway appliances in an AWS Region in Europe to be closer to your European users, or to meet legal requirements. Your AWS account determines which of the Regions supported by a speciﬁc service are available for you to use. • Storage Gateway — For supported AWS Regions and a list of AWS service endpoints that you can use with
storagegateway-s3file-ug-008	storagegateway-s3file-ug.pdf	8	Some services, such as AWS Identity and Access Management, do not have Regional resources. You can launch AWS resources in locations that meet your business requirements. For example, you might want to launch Amazon EC2 instances to host your AWS Storage Gateway appliances in an AWS Region in Europe to be closer to your European users, or to meet legal requirements. Your AWS account determines which of the Regions supported by a speciﬁc service are available for you to use. • Storage Gateway — For supported AWS Regions and a list of AWS service endpoints that you can use with Storage Gateway, see AWS Storage Gateway endpoints and quotas in the AWS General Reference. • Storage Gateway Hardware Appliance — For supported Regions that you can use with the hardware appliance, see AWS Storage Gateway Hardware Appliance Regions in the AWS General Reference. AWS Regions that support Storage Gateway API Version 2013-06-30 8 AWS Storage Gateway Amazon S3 File Gateway User Guide File Gateway setup requirements Unless otherwise noted, the following requirements are common to all File Gateway types in AWS Storage Gateway. Your setup must meet the requirements in this section. Review the requirements that apply to your gateway setup before you deploy your gateway. Topics • Prerequisites • Hardware and storage requirements • Network and ﬁrewall requirements • Supported hypervisors and host requirements • Supported NFS and SMB clients for File Gateway • Supported ﬁle system operations for File Gateway • Managing local disks for your gateway Prerequisites Before you set up your Amazon S3 File Gateway (S3 File Gateway), you must meet the following prerequisites: • Conﬁgure Microsoft Active Directory (AD) and create an Active Directory service account with the requisite permissions. For more information, see Active Directory service account permission requirements. • Ensure that there is suﬃcient network bandwidth between the gateway and AWS. A minimum of 100 Mbps is required to successfully download, activate, and update the gateway. • Conﬁgure the connection you want to use for network traﬃc between AWS and the on-premises environment where you are deploying your gateway. You can connect using the public internet, private networking, a VPN, or AWS Direct Connect. If you want your gateway to communicate AWS through a private connection to an Amazon Virtual Private Cloud, set up the Amazon VPC before you set up your gateway. • Make sure your gateway can resolve the name of your Active Directory Domain Controller. You can use DHCP in your Active Directory domain to handle resolution, or specify a DNS server manually from the Network Conﬁguration settings menu in the gateway local console. Prerequisites API Version 2013-06-30 9 AWS Storage Gateway Amazon S3 File Gateway User Guide Hardware and storage requirements The following sections provide information about the minimum required hardware and storage conﬁgurations for your gateway, and the minimum amount of disk space to allocate for the required storage. For information about best practices for File Gateway performance, see Basic performance guidance for S3 File Gateway. Hardware requirements for on-premises VMs When deploying your gateway on-premises, ensure that the underlying hardware on which you deploy the gateway virtual machine (VM) can dedicate the following minimum resources: • Four virtual processors assigned to the VM • 16 GiB of reserved RAM for File Gateways • 80 GiB of disk space for installation of VM image and system data For more information, see Maximizing S3 File Gateway throughput. For information about how your hardware aﬀects the performance of the gateway VM, see Quotas for ﬁle shares. Requirements for Amazon EC2 instance types When deploying your gateway on Amazon Elastic Compute Cloud (Amazon EC2), the instance size must be at least xlarge for your gateway to function. However, for the compute-optimized instance family the size must be at least 2xlarge. Note The Storage Gateway AMI is only compatible with x86-based instances that use Intel or AMD processors. ARM-based instances that use Graviton processors are not supported. Use one of the following instance types recommended for your gateway type. Recommended for File Gateway types • General-purpose instance family – m4, m5, m6, or m7 instance type. Choose the xlarge instance size or higher to meet the Storage Gateway processor and RAM requirements. Hardware and storage requirements API Version 2013-06-30 10 AWS Storage Gateway Amazon S3 File Gateway User Guide • Compute-optimized instance family – c4, c5, c6, or c7 instance types. Choose the 2xlarge instance size or higher to meet the Storage Gateway processor and RAM requirements. • Memory-optimized instance family – r3, r5, r6, or r7 instance types. Choose the xlarge instance size or higher to meet the Storage Gateway processor and RAM requirements. • Storage-optimized instance family – i3, i4 or i7 instance types. Choose the xlarge instance size or higher to meet the Storage Gateway processor and RAM requirements.
storagegateway-s3file-ug-009	storagegateway-s3file-ug.pdf	9	Hardware and storage requirements API Version 2013-06-30 10 AWS Storage Gateway Amazon S3 File Gateway User Guide • Compute-optimized instance family – c4, c5, c6, or c7 instance types. Choose the 2xlarge instance size or higher to meet the Storage Gateway processor and RAM requirements. • Memory-optimized instance family – r3, r5, r6, or r7 instance types. Choose the xlarge instance size or higher to meet the Storage Gateway processor and RAM requirements. • Storage-optimized instance family – i3, i4 or i7 instance types. Choose the xlarge instance size or higher to meet the Storage Gateway processor and RAM requirements. Note When you launch your gateway in Amazon EC2 and the instance type you choose supports ephemeral storage, the disks are listed automatically. For more information about Amazon EC2 instance storage, see Instance storage in the Amazon EC2 User Guide. Application writes are stored in the cache synchronously, and then asynchronously uploaded to durable storage in Amazon S3. If the ephemeral storage is lost because an instance stops before the upload is complete, the data that still resides in the cache and has not yet written to Amazon Simple Storage Service (Amazon S3) can be lost. Before you stop the instance that hosts the gateway, make sure that the CachePercentDirty CloudWatch metric is 0. For information about ephemeral storage, see Using ephemeral storage with EC2 gateways. For information about monitoring metrics for your Storage Gateway, see Monitoring your S3 File Gateway. If you have more than 5 million objects in your S3 bucket and you are using a gp2 EBS volume, a minimum root EBS volume of 350 GiB is required for acceptable performance of your gateway during start up. Newly-created Amazon EC2 File Gateway instances use gp3 root volumes by default, which do not have this requirement. For information about how to increase the volume size, see Modifying an EBS volume using elastic volumes (console). Storage requirements In addition to 80 GiB of disk space for the VM, you also need additional disks for your gateway. Gateway type Cache (minimum) Cache (maximum) File Gateway 150 GiB 64 TiB Storage requirements API Version 2013-06-30 11 AWS Storage Gateway Amazon S3 File Gateway User Guide Note You can conﬁgure one or more local drives for your cache, up to the maximum capacity. When adding cache to an existing gateway, it's important to create new disks in your host (hypervisor or Amazon EC2 instance). Don't change the size of existing disks if the disks have been previously allocated as a cache. For information about gateway quotas, see Quotas for ﬁle shares. Network and ﬁrewall requirements Your gateway requires access to the internet, local networks, Domain Name Service (DNS) servers, ﬁrewalls, routers, and so on. Network bandwidth requirements vary based on the quantity of data that is uploaded and downloaded by the gateway. A minimum of 100Mbps is required to successfully download, activate, and update the gateway. Your data transfer patterns will determine the bandwidth necessary to support your workload. Following, you can ﬁnd information about required ports and how to allow access through ﬁrewalls and routers. Note In some cases, you might deploy your gateway on Amazon EC2 or use other types of deployment (including on-premises) with network security policies that restrict AWS IP address ranges. In these cases, your gateway might experience service connectivity issues when the AWS IP range values changes. The AWS IP address range values that you need to use are in the Amazon service subset for the AWS Region that you activate your gateway in. For the current IP range values, see AWS IP address ranges in the AWS General Reference. Topics • Port requirements • Networking and ﬁrewall requirements for the Storage Gateway Hardware Appliance • Allowing AWS Storage Gateway access through ﬁrewalls and routers • Conﬁguring security groups for your Amazon EC2 gateway instance Network and ﬁrewall requirements API Version 2013-06-30 12 AWS Storage Gateway Port requirements Amazon S3 File Gateway User Guide S3 File Gateway requires speciﬁc ports to be allowed through your network security for successful deployment and operation. Some ports are required for all gateways, while others are required only for speciﬁc conﬁgurations, such as when connecting to NFS or SMB clients, VPC endpoints, or Microsoft Active Directory. For S3 File Gateway, you only need to use Microsoft Active Directory when you want to allow domain users to access a Server Message Block (SMB) ﬁle share. You can join your File Gateway to any valid Microsoft Windows domain (resolvable by DNS). You can also use the AWS Directory Service to create an AWS Managed Microsoft AD in the Amazon Web Services Cloud. For most AWS Managed Microsoft AD deployments, you need to conﬁgure the Dynamic Host Conﬁguration Protocol (DHCP) service for your VPC. For information about creating a DHCP options set, see
storagegateway-s3file-ug-010	storagegateway-s3file-ug.pdf	10	VPC endpoints, or Microsoft Active Directory. For S3 File Gateway, you only need to use Microsoft Active Directory when you want to allow domain users to access a Server Message Block (SMB) ﬁle share. You can join your File Gateway to any valid Microsoft Windows domain (resolvable by DNS). You can also use the AWS Directory Service to create an AWS Managed Microsoft AD in the Amazon Web Services Cloud. For most AWS Managed Microsoft AD deployments, you need to conﬁgure the Dynamic Host Conﬁguration Protocol (DHCP) service for your VPC. For information about creating a DHCP options set, see Create a DHCP options set in the AWS Directory Service Administration Guide. The following table lists the necessary ports and describes conditional requirements in the Notes column. Port requirements for S3 File Gateway Network Element From To Protocol Port Inbound Outbound Required Notes Web browser Your web Storage Gateway TCP HTTP browser VM 80 ✓ ✓ ✓ Used by local systems to obtain the Storage Gateway activatio n key. Port 80 is used only Port requirements API Version 2013-06-30 13 AWS Storage Gateway Amazon S3 File Gateway User Guide Network Element From To Protocol Port Inbound Outbound Required Notes during activatio n of a Storage Gateway appliance . A Storage Gateway VM doesn't require port 80 to be publicly accessibl e. The required level of access to port 80 depends on your network conﬁgura tion. If you activate your gateway from the Storage Port requirements API Version 2013-06-30 14 AWS Storage Gateway Amazon S3 File Gateway User Guide Network Element From To Protocol Port Inbound Outbound Required Notes Gateway Managemen t Console, the host from which you connect to the console must have access to your gateway's port 80. AWS Managemen t Console (all other operation s) Web browser Storage Gateway AWS TCP HTTPS VM 443 ✓ ✓ ✓ Port requirements API Version 2013-06-30 15 AWS Storage Gateway Amazon S3 File Gateway User Guide Network Element DNS From To Protocol Port Inbound Outbound Required Notes 53 ✓ ✓ ✓ Storage Gateway Domain Name TCP & UDP VM Service DNS (DNS) server Used for communica tion between a Storage Gateway VM and the DNS server for IP name resolutio n. Port requirements API Version 2013-06-30 16 AWS Storage Gateway Amazon S3 File Gateway User Guide Network Element NTP From To Protocol Port Inbound Outbound Required Notes 123 ✓ ✓ ✓ Storage Gateway Network Time TCP & UDP VM Protocol NTP (NTP) server Used by on- premis es systems to synchroni ze VM time to the host time. A Storage Gateway VM is conﬁgure d to use the following NTP servers: • 0.amazon. pool.ntp. org • 1.amazon. pool.ntp. org • 2.amazon. pool.ntp. org Port requirements API Version 2013-06-30 17 AWS Storage Gateway Amazon S3 File Gateway User Guide Network Element From To Protocol Port Inbound Outbound Required Notes • 3.amazon. pool.ntp. org Note Not required for gateways hosted on Amazon EC2. Port requirements API Version 2013-06-30 18 AWS Storage Gateway Amazon S3 File Gateway User Guide Network Element From To Protocol Port Inbound Outbound Required Notes Storage Gateway Storage Gateway Support Endpoint TCP SSH VM 22 ✓ ✓ ✓ Allows Support to access your gateway to help you with troublesh ooting gateway issues. You don't need this port open for the normal operation of your gateway, but it is required for troublesh ooting. For a list of support endpoints Port requirements API Version 2013-06-30 19 AWS Storage Gateway Amazon S3 File Gateway User Guide Network Element From To Protocol Port Inbound Outbound Required Notes Storage Gateway Storage Gateway AWS TCP HTTPS 443 VM Amazon CloudFron t Storage Gateway VM VPC Storage Gateway VM AWS AWS TCP HTTPS 443 TCP HTTPS 443 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓* VPC AWS Storage Gateway VM TCP HTTPS 1026 ✓ ✓* , see Support endpoints . Managemen t control For activatio n Managemen t control Required only when using VPC endpoints Control Plane endpoint Required only when using VPC endpoints Port requirements API Version 2013-06-30 20 AWS Storage Gateway Amazon S3 File Gateway User Guide From To Protocol Port Inbound Outbound Required Notes Network Element VPC AWS Storage Gateway VM TCP HTTPS 1027 ✓ ✓* Anon Control Plane (for activatio n) Required only when using VPC endpoints Proxy endpoint Required only when using VPC endpoints Data Plane Required only when using VPC endpoints VPC AWS Storage Gateway VM TCP HTTPS 1028 ✓ ✓ VPC AWS Storage Gateway VM TCP HTTPS 1031 ✓ ✓* Port requirements API Version 2013-06-30 21 AWS Storage Gateway Amazon S3 File Gateway User Guide From To Protocol Port Inbound Outbound Required Notes Network Element VPC AWS Storage Gateway VM TCP HTTPS 2222 ✓ ✓* VPC AWS Storage Gateway VM TCP HTTPS 443 ✓ ✓ ✓* SSH Support Channel for
storagegateway-s3file-ug-011	storagegateway-s3file-ug.pdf	11	✓ ✓* Anon Control Plane (for activatio n) Required only when using VPC endpoints Proxy endpoint Required only when using VPC endpoints Data Plane Required only when using VPC endpoints VPC AWS Storage Gateway VM TCP HTTPS 1028 ✓ ✓ VPC AWS Storage Gateway VM TCP HTTPS 1031 ✓ ✓* Port requirements API Version 2013-06-30 21 AWS Storage Gateway Amazon S3 File Gateway User Guide From To Protocol Port Inbound Outbound Required Notes Network Element VPC AWS Storage Gateway VM TCP HTTPS 2222 ✓ ✓* VPC AWS Storage Gateway VM TCP HTTPS 443 ✓ ✓ ✓* SSH Support Channel for VPCe Required only for opening support channel when using VPC endpoints Managemen t control Required only when using VPC endpoints Port requirements API Version 2013-06-30 22 AWS Storage Gateway Amazon S3 File Gateway User Guide From To Protocol Port Inbound Outbound Required Notes Network Element File share client SMB Client Storage Gateway VM TCP or UDP SMBv3 445 ✓ ✓ ✓* File sharing data transfer session service. Replaces ports 137– 139 for Microsoft Windows NT and later. Required for SMB only. Name service Required for SMBv1 only. Datagram service Required for SMBv1 only. Microsoft Active Storage Gateway Active Directory UDP NetBIOS Directory VM server 137 ✓ ✓ ✓ Microsoft Active Directory Storage Gateway VM Active Directory server UDP NetBIOS 138 ✓ ✓ ✓* Port requirements API Version 2013-06-30 23 AWS Storage Gateway Amazon S3 File Gateway User Guide Network Element From To Protocol Port Inbound Outbound Required Notes Microsoft Active Storage Gateway Active Directory TCP & UDP Directory VM server LDAP 389 ✓ ✓ ✓* Directory System Agent (DSA) client connectio n Required for SMB only. Microsoft Active Storage Gateway Active Directory TCP & UDP Directory VM server Kerberos 88 ✓ ✓ ✓ Kerberos Required for SMB only. RPC Required for SMB only. Microsoft Active Storage Gateway Active Directory TCP Distribut Directory VM server ed 135 ✓ ✓ ✓* Computing Environme nt/End Point Mapper (DCE/ EMAP) Port requirements API Version 2013-06-30 24 AWS Storage Gateway Amazon S3 File Gateway User Guide From To Protocol Port Inbound Outbound Required Notes Network Element File share client NFS Client Storage Gateway TCP or UDP VM Data NFSv3 111 ✓ ✓ ✓* File share client NFS Client Storage Gateway TCP or UDP VM NFS 2049 ✓ ✓ ✓* File share client NFS Client Storage Gateway VM TCP or UDP NFSv3 20048 ✓ ✓ ✓* File sharing data transfer (for NFS v3 only) Required for NFS only. File sharing data transfer Required for NFS v3 & v4 only. File sharing data transfer Required for NFSv3 only Port requirements API Version 2013-06-30 25 AWS Storage Gateway Amazon S3 File Gateway User Guide From To Protocol Port Inbound Outbound Required Notes Network Element File share client NFS Client Storage Gateway VM TCP or UDP NFSv3 8750 ✓ ✓ ✓ File share client SMB Client Storage Gateway VM TCP or UDP SMBv2 139 ✓ ✓ ✓* File share quota Required for NFSv3 only File sharing data transfer session service Required for SMB only Port requirements API Version 2013-06-30 26 AWS Storage Gateway Amazon S3 File Gateway User Guide Network Element From To Protocol Port Inbound Outbound Required Notes Amazon S3 Storage Gateway Amazon S3 TCP HTTPS 443 ✓ ✓ ✓ For communica VM service endpoints tion from the Storage Gateway VM to the AWS service endpoint. For informati on about service endpoints , see Allowing AWS Storage Gateway access through ﬁrewalls and routers. The following illustration shows network traﬃc ﬂow for a basic S3 File Gateway deployment. Port requirements API Version 2013-06-30 27 AWS Storage Gateway Amazon S3 File Gateway User Guide Networking and ﬁrewall requirements for the Storage Gateway Hardware Appliance Each Storage Gateway Hardware Appliance requires the following network services: • Internet access – an always-on network connection to the internet through any network interface on the server. • DNS services – DNS services for communication between the hardware appliance and DNS server. • Time synchronization – an automatically conﬁgured Amazon NTP time service must be reachable. • IP address – A DHCP or static IPv4 address assigned. You cannot assign an IPv6 address. There are ﬁve physical network ports at the rear of the Dell PowerEdge R640 server. From left to right (facing the back of the server) these ports are as follows: 1. iDRAC 2. em1 Networking and ﬁrewall requirements for the hardware appliance API Version 2013-06-30 28 AWS Storage Gateway Amazon S3 File Gateway User Guide 3. em2 4. em3 5. em4 You can use the iDRAC port for remote server management. A hardware appliance requires the following ports to operate. Protocol Port Direction Source Destination Usage SSH DNS 22 53 Outbound Outbound UDP/NTP 123 Outbound Hardware appliance Hardware appliance Hardware appliance 54.201.22 3.107 DNS servers *.amazon. pool.ntp. org Support channel Name resolutio
storagegateway-s3file-ug-012	storagegateway-s3file-ug.pdf	12	PowerEdge R640 server. From left to right (facing the back of the server) these ports are as follows: 1. iDRAC 2. em1 Networking and ﬁrewall requirements for the hardware appliance API Version 2013-06-30 28 AWS Storage Gateway Amazon S3 File Gateway User Guide 3. em2 4. em3 5. em4 You can use the iDRAC port for remote server management. A hardware appliance requires the following ports to operate. Protocol Port Direction Source Destination Usage SSH DNS 22 53 Outbound Outbound UDP/NTP 123 Outbound Hardware appliance Hardware appliance Hardware appliance 54.201.22 3.107 DNS servers .amazon. pool.ntp. org Support channel Name resolutio n Time synchroni zation HTTPS 443 Outbound Hardware appliance .amazona ws.com Data transfer HTTP 8080 Inbound AWS Hardware appliance Activatio n (only brieﬂy) Networking and ﬁrewall requirements for the hardware appliance API Version 2013-06-30 29 AWS Storage Gateway Amazon S3 File Gateway User Guide To perform as designed, a hardware appliance requires network and ﬁrewall settings as follows: • Conﬁgure all connected network interfaces in the hardware console. • Make sure that each network interface is on a unique subnet. • Provide all connected network interfaces with outbound access to the endpoints listed in the diagram preceding. • Conﬁgure at least one network interface to support the hardware appliance. For more information, see Conﬁguring hardware appliance network parameters. Note For an illustration showing the back of the server with its ports, see Physically installing your hardware appliance. All IP addresses on the same network interface (NIC), whether for a gateway or a host, must be on the same subnet. The following illustration shows the addressing scheme. Networking and ﬁrewall requirements for the hardware appliance API Version 2013-06-30 30 AWS Storage Gateway Amazon S3 File Gateway User Guide For more information about activating and conﬁguring a hardware appliance, see Using the AWS Storage Gateway Hardware Appliance. Allowing AWS Storage Gateway access through ﬁrewalls and routers Your gateway requires access to the following service endpoints to communicate with AWS. If you use a ﬁrewall or router to ﬁlter or limit network traﬃc, you must conﬁgure your ﬁrewall and router to allow these service endpoints for outbound communication to AWS. Allowing gateway access through ﬁrewall and routers API Version 2013-06-30 31 AWS Storage Gateway Amazon S3 File Gateway User Guide Note If you conﬁgure private VPC endpoints for your Storage Gateway to use for connection and data transfer to and from AWS, your gateway does not require access to the public internet. For more information, see Activating a gateway in a virtual private cloud. Important Replace region in the following endpoint examples with the correct AWS Region string for your gateway, such as us-west-2. Replace amzn-s3-demo-bucket with the actual name of the Amazon S3 bucket in your deployment. You can also use an asterisk (*) in place of amzn-s3-demo-bucket to create a wildcard entry in your ﬁrewall rules, which will allowlist the service endpoint for all bucket names. If your gateways are deployed in AWS Regions in the United States or Canada and require Federal Information Processing Standard (FIPS) compliant endpoint connections, replace s3 with s3-fips. The following service endpoint is required by all gateways for head-bucket operations. bucket-name.s3.region.amazonaws.com:443 The following service endpoints are required by all gateways for control path (anon-cp, client- cp, proxy-app) and data path (dp-1) operations. anon-cp.storagegateway.region.amazonaws.com:443 client-cp.storagegateway.region.amazonaws.com:443 proxy-app.storagegateway.region.amazonaws.com:443 dp-1.storagegateway.region.amazonaws.com:443 The following gateway service endpoint is required to make API calls. storagegateway.region.amazonaws.com:443 The following example is a gateway service endpoint in the US West (Oregon) Region (us- west-2). Allowing gateway access through ﬁrewall and routers API Version 2013-06-30 32 AWS Storage Gateway Amazon S3 File Gateway User Guide storagegateway.us-west-2.amazonaws.com:443 Amazon S3 service endpoints Amazon S3 File Gateway requires the following 3 types of endpoints to connect to the Amazon S3 service: Amazon S3 service endpoint Note For this endpoint only, do not replace s3 with s3-fips for FIPS-compliant deployments. s3.amazonaws.com Amazon S3 regional endpoints s3.region.amazonaws.com The following example shows an Amazon S3 regional endpoint in the US East (Ohio) Region (us- east-2). s3.us-east-2.amazonaws.com The following example shows a FIPS-compliant Amazon S3 regional endpoint in the US West (N. California) Region (us-west-1). s3-fips.us-west-1.amazonaws.com The following examples show the Amazon S3 regional endpoints used by AWS GovCloud (US) Regions: s3-fips.us-gov-west-1.amazonaws.com (AWS GovCloud (US-West) Region (FIPS)) s3-fips.us-gov-east-1.amazonaws.com (AWS GovCloud (US-East) Region (FIPS)) s3.us-gov-west-1.amazonaws.com (AWS GovCloud (US-West) Region (Standard)) Allowing gateway access through ﬁrewall and routers API Version 2013-06-30 33 AWS Storage Gateway Amazon S3 File Gateway User Guide s3.us-gov-east-1.amazonaws.com (AWS GovCloud (US-East) Region (Standard)) Note If your gateway can't determine the AWS Region where your Amazon S3 bucket is located, this service endpoint defaults to s3.us-east-1.amazonaws.com. We recommend that you allow access to the US East (N. Virginia) Region (us-east-1) in addition to the AWS Regions where your gateway is activated, and where your Amazon S3 bucket is located. Amazon S3 bucket
storagegateway-s3file-ug-013	storagegateway-s3file-ug.pdf	13	GovCloud (US-West) Region (FIPS)) s3-fips.us-gov-east-1.amazonaws.com (AWS GovCloud (US-East) Region (FIPS)) s3.us-gov-west-1.amazonaws.com (AWS GovCloud (US-West) Region (Standard)) Allowing gateway access through ﬁrewall and routers API Version 2013-06-30 33 AWS Storage Gateway Amazon S3 File Gateway User Guide s3.us-gov-east-1.amazonaws.com (AWS GovCloud (US-East) Region (Standard)) Note If your gateway can't determine the AWS Region where your Amazon S3 bucket is located, this service endpoint defaults to s3.us-east-1.amazonaws.com. We recommend that you allow access to the US East (N. Virginia) Region (us-east-1) in addition to the AWS Regions where your gateway is activated, and where your Amazon S3 bucket is located. Amazon S3 bucket endpoints bucket-name.s3.region.amazonaws.com The following example shows an Amazon S3 bucket endpoint for a bucket named amzn-s3-demo- bucket in the US East (Ohio) Region (us-east-2). amzn-s3-demo-bucket.s3.us-east-2.amazonaws.com The following example shows a FIPS-compliant Amazon S3 bucket endpoint for a bucket named amzn-s3-demo-bucket1 in the AWS GovCloud (US-East) Region (us-gov-east-1). amzn-s3-demo-bucket1.s3-fips.us-gov-east-1.amazonaws.com In addition to the Storage Gateway and Amazon S3 service endpoints, Storage Gateway VMs also require network access to the following NTP servers: 0.amazon.pool.ntp.org 1.amazon.pool.ntp.org 2.amazon.pool.ntp.org 3.amazon.pool.ntp.org • For a complete list of supported AWS Regions and AWS service endpoints that you can use with Storage Gateway, see AWS Storage Gateway endpoints and quotas in the AWS General Reference. • For a list supported AWS Regions that you can use with the hardware appliance, see Storage Gateway hardware appliance Regions in the AWS General Reference. Allowing gateway access through ﬁrewall and routers API Version 2013-06-30 34 AWS Storage Gateway Amazon S3 File Gateway User Guide Conﬁguring security groups for your Amazon EC2 gateway instance In AWS Storage Gateway, a security group controls traﬃc to your Amazon EC2 gateway instance. When you conﬁgure a security group, we recommend the following: • The security group should not allow incoming connections from the outside internet. It should allow only instances within the gateway security group to communicate with the gateway. If you need to allow instances to connect to the gateway from outside its security group, we recommend that you allow connections only on port 80 (for activation). • If you want to activate your gateway from an Amazon EC2 host outside the gateway security group, allow incoming connections on port 80 from the IP address of that host. If you cannot determine the activating host's IP address, you can open port 80, activate your gateway, and then close access on port 80 after completing activation. • Allow port 22 access only if you are using Support for troubleshooting purposes. For more information, see You want Support to help troubleshoot your Amazon EC2 gateway. For information about the ports to open for your gateway, see Port requirements. Supported hypervisors and host requirements You can run Storage Gateway on-premises as either a virtual machine (VM) appliance or a physical hardware appliance, or in AWS as an Amazon EC2 instance. Storage Gateway supports the following hypervisor versions and hosts: • VMware ESXi Hypervisor (version 7.0 or 8.0) – For this setup, you also need a VMware vSphere client to connect to the host. • Microsoft Hyper-V Hypervisor (version 2012 R2, 2016, 2019, or 2022) – A free, standalone version of Hyper-V is available at the Microsoft Download Center. For this setup, you need a Microsoft Hyper-V Manager on a Microsoft Windows client computer to connect to the host. • Linux Kernel-based Virtual Machine (KVM) – A free, open-source virtualization technology. KVM is included in all versions of Linux version 2.6.20 and newer. Storage Gateway is tested and supported for the CentOS/RHEL 7.7, RHEL 8.6 Ubuntu 16.04 LTS, and Ubuntu 18.04 LTS distributions. Any other modern Linux distribution may work, but function or performance is not guaranteed. We recommend this option if you already have a KVM environment up and running and you are already familiar with how KVM works. Conﬁguring security group API Version 2013-06-30 35 AWS Storage Gateway Amazon S3 File Gateway User Guide • Amazon EC2 instance – Storage Gateway provides an Amazon Machine Image (AMI) that contains the gateway VM image. For information about how to deploy a gateway on Amazon EC2, see Deploy a default Amazon EC2 host for S3 File Gateway. • Storage Gateway Hardware Appliance – Storage Gateway provides a physical hardware appliance as an on-premises deployment option for locations with limited virtual machine infrastructure. Note Storage Gateway doesn’t support recovering a gateway from a VM that was created from a snapshot or clone of another gateway VM or from your Amazon EC2 AMI. If your gateway VM malfunctions, activate a new gateway and recover your data to that gateway. For more information, see Recovering from an unexpected virtual machine shutdown. Storage Gateway doesn’t support dynamic memory and virtual memory ballooning. Supported NFS and SMB clients for File Gateway File Gateway supports the following clients: Operating System Version Kernel Version Supported
storagegateway-s3file-ug-014	storagegateway-s3file-ug.pdf	14	hardware appliance as an on-premises deployment option for locations with limited virtual machine infrastructure. Note Storage Gateway doesn’t support recovering a gateway from a VM that was created from a snapshot or clone of another gateway VM or from your Amazon EC2 AMI. If your gateway VM malfunctions, activate a new gateway and recover your data to that gateway. For more information, see Recovering from an unexpected virtual machine shutdown. Storage Gateway doesn’t support dynamic memory and virtual memory ballooning. Supported NFS and SMB clients for File Gateway File Gateway supports the following clients: Operating System Version Kernel Version Supported Protocols Amazon Linux 2023 6.1 LTS Amazon Linux 2 5.10 LTS RHEL 9 RHEL 8.10 SUSE 15 Ubuntu 24.04 LTS Ubuntu 22.04 LTS Microsoft Windows Server 2025 5.14 4.18 6.4 6.8 LTS 5.15 LTS NFSv4.1, NFSv3 NFSv4.1, NFSv3 NFSv4.1, NFSv3 NFSv4.1, NFSv3 NFSv4.1, NFSv3 NFSv4.1, NFSv3 NFSv4.1, NFSv3 SMBv3, NFSv3 Supported NFS and SMB clients for File Gateway API Version 2013-06-30 36 AWS Storage Gateway Amazon S3 File Gateway User Guide Operating System Version Kernel Version Supported Protocols Microsoft Windows Server 2022 Microsoft Windows 11 Microsoft Windows 10 Note SMBv3, NFSv3 SMBv3, NFSv3 SMBv3, NFSv3 Server Message Block (SMB) encryption requires clients that support SMB v3 dialects. Supported ﬁle system operations for File Gateway Your NFS or SMB client can write, read, delete, and truncate ﬁles. When clients send writes to AWS Storage Gateway, it writes to local cache synchronously. Then it writes to Amazon S3 asynchronously through optimized transfers. Reads are ﬁrst served through the local cache. If data is not available, it's fetched through S3 as a read-through cache. Writes and reads are optimized in that only the parts that are changed or requested are transferred through your gateway. Deletes remove objects from Amazon S3. Directories are managed as folder objects in S3, using the same syntax as in the Amazon S3 console. HTTP operations such as GET, PUT, UPDATE, and DELETE can modify ﬁles in a ﬁle share. These operations conform to the atomic create, read, update, and delete (CRUD) functions. Managing local disks for your gateway The gateway virtual machine (VM) uses the local disks that you allocate on-premises for buﬀering and storage. A File Gateway that you create on an Amazon EC2 instance will use Amazon EBS volumes as local disks. The number and size of disks that you want to allocate for your gateway is up to you. The gateway uses the cache storage that you allocate to provide low-latency access to your recently accessed data. The cache storage acts as the on-premises durable store for data that is pending upload to Amazon S3. File Gateways require at least one 150 GiB disk to use as a cache. After the initial conﬁguration and deployment of your gateway, you can add more disks for Supported ﬁle system operations API Version 2013-06-30 37 AWS Storage Gateway Amazon S3 File Gateway User Guide cache storage as your workload demands increase. This section contains the following topics, which describe concepts and procedures related to managing local disks. Topics • Deciding the amount of local disk storage - Learn how to determine the number and size of local cache disks to allocate for your File Gateway. • Conﬁguring additional cache storage - Learn how to increase the cache storage capacity of your File Gateway as your application needs change. • Using ephemeral storage with EC2 gateways - Learn how to prevent data loss when using ephemeral disk storage with File Gateway. Deciding the amount of local disk storage When deploying an S3 File Gateway, consider how much cache disk to allocate. S3 File Gateway uses a least recently used algorithm to automatically evict data from the cache. The cache on an S3 File Gateway is shared between all of the ﬁle shares on that gateway. If you have multiple active shares, it's important to note that heavy utilization on one share could impact the amount of cache resources that another share has access to, possibly impacting performance. When determining how much cache disk you need for a given workload, it's important to note that you can always add cache disk to your gateway (up to the current quotas on S3 File Gateway), but you can't decrease the cache for a given gateway. You can perform a basic analysis on the dataset to determine the right amount of cache disk, but there's not a way to determine exactly how much data is ‘hot,’ and needs to be stored locally, versus ‘cold’ and can be tiered to the cloud. Workloads change over time, and S3 File Gateway provides ﬂexibility and elasticity related to the amount of resources that can be consumed. The amount of cache can always be increased, so starting small and increasing as needed is often the most cost-eﬀective
storagegateway-s3file-ug-015	storagegateway-s3file-ug.pdf	15	S3 File Gateway), but you can't decrease the cache for a given gateway. You can perform a basic analysis on the dataset to determine the right amount of cache disk, but there's not a way to determine exactly how much data is ‘hot,’ and needs to be stored locally, versus ‘cold’ and can be tiered to the cloud. Workloads change over time, and S3 File Gateway provides ﬂexibility and elasticity related to the amount of resources that can be consumed. The amount of cache can always be increased, so starting small and increasing as needed is often the most cost-eﬀective approach. You can use an initial approximation of 150 GiB to provision disks for the cache storage during gateway setup. You can then use Amazon CloudWatch operational metrics to monitor the cache storage usage and provision more storage as needed using the console. For information on using the metrics and setting up alarms, see Performance and optimization. Note Underlying physical storage resources are represented as a data store in VMware. When you deploy the gateway VM, you choose a data store on which to store the VM ﬁles. When you Deciding the amount of local disk storage API Version 2013-06-30 38 AWS Storage Gateway Amazon S3 File Gateway User Guide provision a local disk (for example, to use as cache storage), you have the option to store the virtual disk in the same data store as the VM or a diﬀerent data store. If you have more than one data store, we strongly recommend that you choose one data store for the cache storage. A data store that is backed by only one underlying physical disk can lead to poor performance in some situations when it is used to back both the cache storage. This is also true if the backup is a less-performant RAID conﬁguration such as RAID1. Conﬁguring additional cache storage As your application needs change, you can increase the gateway's cache storage capacity. You can add storage capacity to your gateway without interrupting functionality or causing downtime. When you add more storage, you do so with the gateway VM turned on. Important When adding cache to an existing gateway, you must create new disks on the gateway host hypervisor or Amazon EC2 instance. Do not remove or change the size of existing disks that have already been allocated as cache. To conﬁgure additional cache storage for your gateway 1. Provision one or more new disks on your gateway host hypervisor or Amazon EC2 instance. For information about how to provision a disk on a hypervisor, see your hypervisor's documentation. For information about provisioning Amazon EBS volumes for an Amazon EC2 instance, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide for Linux Instances. In the following steps, you will conﬁgure this disk as cache storage. 2. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ 3. 4. 5. 6. home. In the navigation pane, choose Gateways. Search for your gateway and select it from the list. From the Actions menu, choose Conﬁgure cache storage. In the Conﬁgure cache storage section, identify the disks you provisioned. If you don't see your disks, choose the refresh icon to refresh the list. For each disk, choose Cache from the Allocated to drop-down menu. Add cache storage API Version 2013-06-30 39 AWS Storage Gateway Amazon S3 File Gateway User Guide Note Cache is the only available option for allocating disks on a File Gateway. 7. Choose Save changes to save your conﬁguration settings. Using ephemeral storage with EC2 gateways This section describes steps you need to take to prevent data loss when you select an ephemeral disk as storage for your gateway's cache. Ephemeral disks provide temporary block-level storage for your Amazon EC2 instance. Ephemeral disks are ideal for temporary storage of data that changes frequently, such as data in a gateway's cache storage. When you launch your gateway with an Amazon EC2 Amazon Machine Image and the instance type you select supports ephemeral storage, the ephemeral disks are listed automatically. You can select one of the disks to store your gateway's cache data. For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide. Data that applications write to the gateway is stored synchronously in cache on the ephemeral disks, and then asynchronously uploaded to durable storage in Amazon S3. If the Amazon EC2 instance is stopped after data is written to ephemeral storage, but before an asynchronous upload occurs, any data that has not yet been uploaded to Amazon S3 can be lost. You can prevent such data loss by following the steps before you restart or stop the EC2 instance that hosts your gateway. Important If you stop and start an Amazon EC2 gateway that uses ephemeral storage, the gateway will be permanently oﬄine.
storagegateway-s3file-ug-016	storagegateway-s3file-ug.pdf	16	applications write to the gateway is stored synchronously in cache on the ephemeral disks, and then asynchronously uploaded to durable storage in Amazon S3. If the Amazon EC2 instance is stopped after data is written to ephemeral storage, but before an asynchronous upload occurs, any data that has not yet been uploaded to Amazon S3 can be lost. You can prevent such data loss by following the steps before you restart or stop the EC2 instance that hosts your gateway. Important If you stop and start an Amazon EC2 gateway that uses ephemeral storage, the gateway will be permanently oﬄine. This happens because the physical storage disk is replaced. There is no work-around for this issue. The only resolution is to delete the gateway and activate a new one on a new EC2 instance. These steps in this following procedure are speciﬁc for File Gateways. To prevent data loss in File Gateways that use ephemeral disks 1. Stop all the processes that are writing to Amazon S3. Using ephemeral storage with EC2 gateways API Version 2013-06-30 40 AWS Storage Gateway Amazon S3 File Gateway User Guide 2. Subscribe to receive notiﬁcation from CloudWatch Events. For information, see Getting notiﬁed about ﬁle operations. 3. Call the NotifyWhenUploaded API to get notiﬁed when data that is written, up until the ephemeral storage was lost, has been durably stored in Amazon S3. 4. Wait for the API to complete and you receive a notiﬁcation id. You receive a CloudWatch event with the same notiﬁcation id. 5. Verify that the CachePercentDirty metric for your ﬁle share is 0. This conﬁrms that all your data has been written to Amazon S3. For information about ﬁle share metrics, see Understanding ﬁle share metrics. 6. You can now restart or stop the File Gateway without risk of losing any data. Using ephemeral storage with EC2 gateways API Version 2013-06-30 41 AWS Storage Gateway Amazon S3 File Gateway User Guide Using the AWS Storage Gateway Hardware Appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be oﬀered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. The AWS Storage Gateway Hardware Appliance is a physical hardware appliance with the Storage Gateway software preinstalled on a validated server conﬁguration. You can manage the hardware appliances in your deployment from the Hardware appliance overview page in the AWS Storage Gateway console. The hardware appliance is a high-performance 1U server that you can deploy in your data center, or on-premises inside your corporate ﬁrewall. When you buy and activate your hardware appliance, the activation process associates the hardware appliance with your AWS account. After activation, your hardware appliance appears in the console on the Hardware appliance overview page. You can conﬁgure the hardware appliance as an S3 File Gateway, FSx File Gateway, Tape Gateway, or Volume Gateway type. The procedure that you use to deploy these gateway types on a hardware appliance is same as on a virtual platform. For a list of supported AWS Regions where the AWS Storage Gateway Hardware Appliance is available for activation and use, see AWS Storage Gateway Hardware Appliance Regions in the AWS General Reference. In the sections that follow, you can ﬁnd instructions about how to set up, rack mount, power, conﬁgure, activate, launch, use, and delete an AWS Storage Gateway Hardware Appliance. Topics • Setting up your AWS Storage Gateway Hardware Appliance • Physically installing your hardware appliance • Accessing the hardware appliance console • Conﬁguring hardware appliance network parameters • Activating your AWS Storage Gateway Hardware Appliance API Version 2013-06-30 42 AWS Storage Gateway Amazon S3 File Gateway User Guide • Creating a gateway on your hardware appliance • Conﬁguring a gateway IP address on the hardware appliance • Removing gateway software from your hardware appliance • Deleting your AWS Storage Gateway Hardware Appliance Setting up your AWS Storage Gateway Hardware Appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be oﬀered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. After you receive your Storage Gateway Hardware Appliance, you use the hardware appliance local console to conﬁgure networking to provide an always-on connection to AWS and activate your appliance. Activation associates your appliance with the AWS account that is used during the activation process. After the appliance is activated,
storagegateway-s3file-ug-017	storagegateway-s3file-ug.pdf	17	Hardware Appliance will no longer be oﬀered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. After you receive your Storage Gateway Hardware Appliance, you use the hardware appliance local console to conﬁgure networking to provide an always-on connection to AWS and activate your appliance. Activation associates your appliance with the AWS account that is used during the activation process. After the appliance is activated, you can launch an S3 File Gateway, FSx File Gateway, Tape Gateway, or Volume Gateway from the Storage Gateway console. To install and conﬁgure your hardware appliance 1. Rack-mount the appliance, and plug in power and network connections. For more information, see Physically installing your hardware appliance. 2. Set the Internet Protocol version 4 (IPv4) addresses for the hardware appliance (the host). For more information, see Conﬁguring hardware appliance network parameters. 3. Activate the hardware appliance on the console Hardware appliance overview page in the AWS Region of your choice. For more information, see Activating your AWS Storage Gateway Hardware Appliance. 4. Create a gateway on your hardware appliance. For more information, see Creating your gateway. You set up gateways on your hardware appliance the same way that you set up gateways on VMware ESXi, Microsoft Hyper-V, Linux Kernel-based Virtual Machine (KVM), or Amazon EC2. Setting up your hardware appliance API Version 2013-06-30 43 AWS Storage Gateway Amazon S3 File Gateway User Guide Increasing the usable cache storage You can increase the usable storage on the hardware appliance from 5 TB to 12 TB. Doing this provides a larger cache for low latency access to data in AWS. If you ordered the 5 TB model, you can increase the usable storage to 12 TB by buying ﬁve 1.92 TB SSDs (solid state drives). You can then add them to the hardware appliance before you activate it. If you have already activated the hardware appliance and want to increase the usable storage on the appliance to 12 TB, do the following: 1. Reset the hardware appliance to its factory settings. Contact AWS Support for instructions on how to do this. 2. Add ﬁve 1.92 TB SSDs to the appliance. Network interface card options Depending on the model of appliance you ordered, it may come with a 10G-Base-T RJ45 copper, or a 10G DA/SFP+ network card. • 10G-Base-T NIC conﬁguration: • Use CAT6 cables for 10G or CAT5(e) for 1G • 10G DA/SFP+ NIC conﬁguration: • Use Twinax copper Direct Attach Cables up to 5 meters • Dell/Intel compatible SFP+ optical modules (SR or LR) • SFP/SFP+ copper transceiver for 1G-Base-T or 10G-Base-T Physically installing your hardware appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be oﬀered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. Physically installing your hardware appliance API Version 2013-06-30 44 AWS Storage Gateway Amazon S3 File Gateway User Guide Your appliance has a 1U form factor and ﬁts in a standard International Electrotechnical Commission (IEC) compliant 19-inch rack. Prerequisites To install your hardware appliance, you need the following components: • Power cables: one required, two recommended. • Supported network cabling (depending on which Network Interface Card (NIC) is included in the hardware appliance). Twinax Copper DAC, SFP+ optical module (Intel compatible) or SFP to Base- T copper transceiver. • Keyboard and monitor, or a keyboard, video, and mouse (KVM) switch solution. Note Before you perform the following procedure, make sure that you meet all of the requirements for the Storage Gateway Hardware Appliance as described in Networking and ﬁrewall requirements for the Storage Gateway Hardware Appliance. To physically install your hardware appliance 1. Unbox your hardware appliance and follow the instructions contained in the box to rack- mount the server. The following image shows the back of the hardware appliance with ports for connecting power, ethernet, monitor, USB keyboard, and iDRAC. hardware appliance one rear with network and power connector labels. hardware appliance one rear with network and power connector labels. 2. Plug in a power connection to each of the two power supplies. It's possible to plug in to only one power connection, but we recommend power connections to both power supplies for redundancy. Physically installing your hardware appliance API Version 2013-06-30 45 AWS Storage Gateway Amazon S3 File Gateway User Guide 3. Plug an Ethernet cable into the em1 port to provide an always-on internet connection. The em1
storagegateway-s3file-ug-018	storagegateway-s3file-ug.pdf	18	with ports for connecting power, ethernet, monitor, USB keyboard, and iDRAC. hardware appliance one rear with network and power connector labels. hardware appliance one rear with network and power connector labels. 2. Plug in a power connection to each of the two power supplies. It's possible to plug in to only one power connection, but we recommend power connections to both power supplies for redundancy. Physically installing your hardware appliance API Version 2013-06-30 45 AWS Storage Gateway Amazon S3 File Gateway User Guide 3. Plug an Ethernet cable into the em1 port to provide an always-on internet connection. The em1 port is the ﬁrst of the four physical network ports on the rear, from left to right. Note The hardware appliance doesn't support VLAN trunking. Set up the switch port to which you are connecting the hardware appliance as a non-trunked VLAN port. 4. Plug in the keyboard and monitor. 5. Power on the server by pressing the Power button on the front panel, as shown in the following image. hardware appliance front with power button label. hardware appliance front with power button label. Next step Accessing the hardware appliance console Accessing the hardware appliance console Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be oﬀered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. Accessing the hardware appliance console API Version 2013-06-30 46 AWS Storage Gateway Amazon S3 File Gateway User Guide When you power on your hardware appliance, the hardware appliance console appears on the monitor. The hardware appliance console presents a user interface speciﬁc to AWS that you can use to set an administrator password, conﬁgure initial network parameters, and open a support channel to AWS. To work with the hardware appliance console, enter text from the keyboard and use the Up, Down, Right, and Left Arrow keys to move about the screen in the indicated direction. Use the Tab key to move forward in order through items on-screen. On some setups, you can use the Shift +Tab keystroke to move sequentially backward. Use the Enter key to save selections, or to choose a button on the screen. The ﬁrst time the hardware appliance console appears, the Welcome page is displayed, and you are prompted to set a password for the admin user account before you can access the console. To set an admin password • At the Please set your login password prompt, do the following: a. b. For Set Password, enter a password, and then press Down arrow. For Conﬁrm, re-enter your password, and then choose Save Password. After you set your password, the hardware console Home page appears. The Home page displays network information for the em1, em2, em3, and em4 network interfaces, and has the following menu options: • Conﬁgure Network • Open Service Console • Change Password • Logout • Open Support Console Next step Conﬁguring hardware appliance network parameters Accessing the hardware appliance console API Version 2013-06-30 47 AWS Storage Gateway Amazon S3 File Gateway User Guide Conﬁguring hardware appliance network parameters Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be oﬀered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. After the hardware appliance boots up and you set your admin user password in the hardware console as described in Accessing the hardware appliance console, use the following procedure to conﬁgure network parameters so your hardware appliance can connect to AWS. To set a network address 1. From the Home page, choose Conﬁgure Network and then press Enter. The Conﬁgure Network page appears. The Conﬁgure Network page shows IP and DNS information for each of the 4 network interfaces on the hardware appliance, and includes menu options to conﬁgure DHCP or Static addresses for each. 2. For the em1 interface, do one of the following: • Choose DHCP and press Enter to use the IPv4 address assigned by your Dynamic Host Conﬁguration Protocol (DHCP) server to your physical network port. Note this address for later use in the activation step. • Choose Static and press Enter to conﬁgure a static IPv4 address. Enter a valid IP Address, Subnet Mask, Gateway, and DNS server address for the em1 network interface. When ﬁnished, choose Save and then press Enter to save the conﬁguration. Conﬁguring hardware appliance network parameters API Version
storagegateway-s3file-ug-019	storagegateway-s3file-ug.pdf	19	conﬁgure DHCP or Static addresses for each. 2. For the em1 interface, do one of the following: • Choose DHCP and press Enter to use the IPv4 address assigned by your Dynamic Host Conﬁguration Protocol (DHCP) server to your physical network port. Note this address for later use in the activation step. • Choose Static and press Enter to conﬁgure a static IPv4 address. Enter a valid IP Address, Subnet Mask, Gateway, and DNS server address for the em1 network interface. When ﬁnished, choose Save and then press Enter to save the conﬁguration. Conﬁguring hardware appliance network parameters API Version 2013-06-30 48 AWS Storage Gateway Amazon S3 File Gateway User Guide Note You can use this procedure to conﬁgure other network interfaces in addition to em1. If you conﬁgure other interfaces, they must provide the same always-on connection to the AWS endpoints listed in the requirements. Network bonding and Link Aggregation Control Protocol (LACP) are not supported by the hardware appliance or by Storage Gateway. We do not recommend conﬁguring multiple network interfaces on the same subnet as this can sometimes cause routing issues. To log out of the hardware console 1. Choose Back and press Enter to return to the Home page. 2. Choose Logout and press Enter to return to the Welcome page. Next step Activating your AWS Storage Gateway Hardware Appliance Activating your AWS Storage Gateway Hardware Appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be oﬀered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. After conﬁguring your IP address, you enter this IP address on the Hardware page of the AWS Storage Gateway console to activate your hardware appliance. The activation process registers the appliance to your AWS account. Activating your hardware appliance API Version 2013-06-30 49 AWS Storage Gateway Amazon S3 File Gateway User Guide You can choose to activate your hardware appliance in any of the supported AWS Regions. For a list of supported AWS Regions, see Storage Gateway Hardware Appliance Regions in the AWS General Reference. To activate your AWS Storage Gateway Hardware Appliance 1. Open the AWS Storage Gateway Management Console and sign in with the account credentials you want to use to activate your hardware. Note For activation only, the following must be true: • Your browser must be on the same network as your hardware appliance. • Your ﬁrewall must allow HTTP access on port 8080 to the appliance for inbound traﬃc. 2. Choose Hardware from the navigation menu on the left side of the page. 3. Choose Activate appliance. 4. For IP Address, enter the IP address that you conﬁgured for your hardware appliance, then choose Connect. 5. 6. For more information about conﬁguring the IP address, see Conﬁguring network parameters. For Name, enter a name for your hardware appliance. Names can be up to 255 characters long and can't include a slash character. For Hardware appliance time zone, enter the local time zone from which most of the workload for the gateway will be generated., then choose Next. The time zone controls when hardware updates take place, with 2 a.m. used as the default scheduled time to perform updates. Ideally, if the time zone is set properly, updates will take place outside of the local working day window by default. 7. Review the activation parameters in the Hardware appliance detail section. You can choose Previous to go back and make changes if necessary. Otherwise, choose Activate to ﬁnish the activation. A banner appears on the Hardware appliance overview page, indicating that the hardware appliance has been successfully activated. Activating your hardware appliance API Version 2013-06-30 50 AWS Storage Gateway Amazon S3 File Gateway User Guide At this point, the appliance is associated with your account. The next step is to conﬁgure and launch an S3 File Gateway, FSx File Gateway, Tape Gateway, or Volume Gateway on the new appliance. Next step Creating a gateway on your hardware appliance Creating a gateway on your hardware appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be oﬀered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. You can create an S3 File Gateway, FSx File Gateway, Tape Gateway, or Volume Gateway on any AWS Storage Gateway Hardware Appliance in your deployment. To create a gateway on
storagegateway-s3file-ug-020	storagegateway-s3file-ug.pdf	20	gateway on your hardware appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be oﬀered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. You can create an S3 File Gateway, FSx File Gateway, Tape Gateway, or Volume Gateway on any AWS Storage Gateway Hardware Appliance in your deployment. To create a gateway on your hardware appliance 1. Sign in to the AWS Management Console and open the Storage Gateway console at https:// console.aws.amazon.com/storagegateway/home. 2. Follow the procedures described in Creating Your Gateway to set up, connect, and conﬁgure the type of Storage Gateway that you want to deploy. When you ﬁnish creating your gateway in the Storage Gateway console, the Storage Gateway software automatically starts installing on the hardware appliance. If you use Dynamic Host Conﬁguration Protocol (DHCP), it can take 5 to 10 minutes for a gateway to display as online in the console. To assign a static IP address to your installed gateway, see Conﬁguring an IP address for the gateway. To assign a static IP address to your installed gateway, you next conﬁgure the gateway's network interfaces so your applications can use it. Creating a gateway on your hardware appliance API Version 2013-06-30 51 AWS Storage Gateway Next step Amazon S3 File Gateway User Guide Conﬁguring a gateway IP address on the hardware appliance Conﬁguring a gateway IP address on the hardware appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be oﬀered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. Before you activated your hardware appliance, you assigned an IP address to its physical network interface. Now that you have activated the appliance and launched your Storage Gateway on it, you need to assign another IP address to the Storage Gateway virtual machine that runs on the hardware appliance. To assign a static IP address to a gateway installed on your hardware appliance, conﬁgure the IP address from the gateway local console for that gateway. Your applications (such as your NFS or SMB client) connect to this IP address. You can access the gateway local console from the hardware appliance console using the Open Service Console option. To conﬁgure an IP address on your appliance to work with applications 1. On the hardware console, choose Open Service Console and then press Enter to open the login page for the gateway local console. 2. The AWS Storage Gateway local console login page prompts you to login to change your network conﬁguration and other settings. The default account is admin and the default password is password. Note We recommend changing the default password by entering the corresponding numeral for Gateway Console from the AWS Appliance Activation - Conﬁguration main menu, then running the passwd command. For information about how to run the command, Conﬁguring a gateway IP address on the hardware appliance API Version 2013-06-30 52 AWS Storage Gateway Amazon S3 File Gateway User Guide see Running Storage Gateway commands on the local console. You can also set the password from the Storage Gateway console. For more information, see Setting the local console password from the Storage Gateway console. 3. The AWS Appliance Activation - Conﬁguration page includes the following menu options: • HTTP/SOCKS Proxy Conﬁguration • Network Conﬁguration • Test Network Connectivity • View System Resource Check • System Time Management • License Information • Command Prompt Note Some options appear only for speciﬁc gateway types or host platforms. Enter the corresponding numeral to navigate to the Network Conﬁguration page. 4. Do one of the following to conﬁgure the gateway IP address: • To use the IP address assigned by your Dynamic Host Conﬁguration Protocol (DHCP) server, enter the corresponding numeral for Conﬁgure DHCP, and then enter valid DHCP conﬁguration information on the following page. • To assign a static IP address, enter the corresponding numeral for Conﬁgure Static IP, and then enter valid IP address and DNS information on the following page. Note The IP address you specify here must be on the same subnet as the IP address used during hardware appliance activation. Conﬁguring a gateway IP address on the hardware appliance API Version 2013-06-30 53 AWS Storage Gateway Amazon S3 File Gateway User Guide To exit the gateway local console • Press the Crtl+] (close bracket) keystroke. The hardware console
storagegateway-s3file-ug-021	storagegateway-s3file-ug.pdf	21	DHCP, and then enter valid DHCP conﬁguration information on the following page. • To assign a static IP address, enter the corresponding numeral for Conﬁgure Static IP, and then enter valid IP address and DNS information on the following page. Note The IP address you specify here must be on the same subnet as the IP address used during hardware appliance activation. Conﬁguring a gateway IP address on the hardware appliance API Version 2013-06-30 53 AWS Storage Gateway Amazon S3 File Gateway User Guide To exit the gateway local console • Press the Crtl+] (close bracket) keystroke. The hardware console appears. Note The keystroke preceding is the only way to exit the gateway local console. After your hardware appliance has been activated and conﬁgured, your appliance appears in the console. Now you can continue the setup and conﬁguration procedure for your gateway in the Storage Gateway console. For instructions, see Conﬁgure your Amazon S3 File Gateway. Removing gateway software from your hardware appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be oﬀered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. If you no longer need a speciﬁc Storage Gateway that you have deployed on a hardware appliance, you can remove the gateway software from the hardware appliance. After you remove the gateway software, you can choose to deploy a new gateway in its place, or delete the hardware appliance itself from the Storage Gateway console. To remove gateway software from your hardware appliance, use the following procedure. To remove a gateway from a hardware appliance 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. Choose Hardware from the navigation pane on the left side of the console page, and then choose the Hardware appliance name for the appliance from which you want to remove gateway software. 3. From the Actions drop down menu, choose Remove gateway. Removing gateway software from your hardware appliance API Version 2013-06-30 54 AWS Storage Gateway Amazon S3 File Gateway User Guide The conﬁrmation dialog box appears. 4. Verify that you want to remove the gateway software from the speciﬁed hardware appliance, and then type the word remove in the conﬁrmation box. 5. Choose Remove to permanently remove the gateway software. Note After you remove the gateway software, you can't undo the action. For certain gateway types, you can lose data on deletion, particularly cached data. For more information on deleting a gateway, see Deleting your gateway and removing associated resources. Removing the gateway doesn't delete the hardware appliance from the console. The hardware appliance remains for future gateway deployments. Deleting your AWS Storage Gateway Hardware Appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be oﬀered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. If you no longer need an AWS Storage Gateway Hardware Appliance that you have already activated, you can delete the appliance completely from your AWS account. Note To move your appliance to a diﬀerent AWS account or AWS Region, you must ﬁrst delete it using the following procedure, then open the gateway's support channel and contact Support to perform a soft reset. For more information, see Turning on Support access to help troubleshoot your gateway hosted on-premises. Deleting your hardware appliance API Version 2013-06-30 55 AWS Storage Gateway Amazon S3 File Gateway User Guide To delete your hardware appliance 1. If you have installed a gateway on the hardware appliance, you must ﬁrst remove the gateway before you can delete the appliance. For instructions on how to remove a gateway from your hardware appliance, see Removing gateway software from your hardware appliance. 2. On the Hardware page of the Storage Gateway console, choose the hardware appliance you want to delete. 3. For Actions, choose Delete Appliance. The conﬁrmation dialog box appears. 4. Verify that you want to delete the speciﬁed hardware appliance, then type the word delete in the conﬁrmation box and choose Delete. When you delete the hardware appliance, all resources associated with the gateway that is installed on the appliance are deleted, but the data on the hardware appliance itself is not deleted. Deleting your hardware appliance API Version 2013-06-30 56 AWS Storage Gateway Amazon S3 File Gateway User Guide Creating your gateway The overview sections on this page provide a high-level synopsis
storagegateway-s3file-ug-022	storagegateway-s3file-ug.pdf	22	appliance you want to delete. 3. For Actions, choose Delete Appliance. The conﬁrmation dialog box appears. 4. Verify that you want to delete the speciﬁed hardware appliance, then type the word delete in the conﬁrmation box and choose Delete. When you delete the hardware appliance, all resources associated with the gateway that is installed on the appliance are deleted, but the data on the hardware appliance itself is not deleted. Deleting your hardware appliance API Version 2013-06-30 56 AWS Storage Gateway Amazon S3 File Gateway User Guide Creating your gateway The overview sections on this page provide a high-level synopsis of how the Storage Gateway creation process works. For step-by-step procedures to create a speciﬁc type of gateway using the Storage Gateway console, see the following topics: • Create and activate an Amazon S3 File Gateway • Create and activate an Amazon FSx File Gateway • Create and activate a Tape Gateway • Create and activate a Volume Gateway Important Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post. Overview - Gateway Activation Gateway activation involves setting up your gateway, connecting it to AWS, then reviewing your settings and activating it. Set up gateway To set up your Storage Gateway, you ﬁrst choose the type of gateway you want to create and the host platform on which you will run the gateway virtual appliance. You then download the gateway virtual appliance template for the platform of your choice and deploy it in your on-premises environment. You can also deploy your Storage Gateway as a physical hardware appliance that you order from your preferred reseller, or as an Amazon EC2 instance in your AWS cloud environment. When you deploy the gateway appliance, you allocate local physical disk space on the virtualization host. Connect to AWS The next step is to connect your gateway to AWS. To do this, you ﬁrst choose the type of service endpoint you want to use for communications between the gateway virtual appliance and AWS Overview - Gateway Activation API Version 2013-06-30 57 AWS Storage Gateway Amazon S3 File Gateway User Guide services in the cloud. This endpoint can be accessible from the public internet, or only from within your Amazon VPC, where you have full control over the network security conﬁguration. You then specify the gateway's IP address or its activation key, which you can obtain by connecting to the local console on the gateway appliance. Review and activate At this point, you'll have an opportunity to review the gateway and connection options you chose, and make changes if necessary. When everything is set up the way you want you can activate the gateway. Before you can start using your activated gateway, you will need to conﬁgure some additional settings and create your storage resources. Overview - Gateway Conﬁguration After you activate your Storage Gateway, you need to perform some additional conﬁguration. In this step, you allocate the physical storage you provisioned on the gateway host platform to be used as either the cache or the upload buﬀer by the gateway appliance. You then conﬁgure settings to help monitor the health of your gateway using Amazon CloudWatch Logs and CloudWatch alarms, and add tags to help identify the gateway, if desired. Before you can start using your activated and conﬁgured gateway, you will need to create your storage resources. Overview - Storage Resources After you activate and conﬁgure your Storage Gateway, you need to create cloud storage resources for it to use. Depending on the type of gateway you created, you will use the Storage Gateway console to create Volumes, Tapes, or Amazon S3 or Amazon FSx ﬁles shares to associate with it. Each gateway type uses its respective resources to emulate the related type of network storage infrastructure, and transfers the data you write to it into the AWS cloud. Create and activate an Amazon S3 File Gateway In this section, you can ﬁnd instructions on how to create, deploy, and activate a File Gateway in AWS Storage Gateway. Topics • Set up an Amazon S3 File Gateway Review and activate API Version 2013-06-30 58 AWS Storage Gateway Amazon S3 File Gateway User Guide • Connect your Amazon S3 File Gateway to AWS • Review settings and activate your Amazon S3 File Gateway • Conﬁgure your Amazon S3 File Gateway Set up an Amazon S3 File Gateway To set up a new S3 File Gateway 1. Open the AWS Management Console at https://console.aws.amazon.com/storagegateway/ home/, and choose the AWS Region where you want to create your gateway. 2. Choose Create gateway to open the Set up gateway page. 3. In the Gateway settings section, do the following: a. b. For
storagegateway-s3file-ug-023	storagegateway-s3file-ug.pdf	23	and activate API Version 2013-06-30 58 AWS Storage Gateway Amazon S3 File Gateway User Guide • Connect your Amazon S3 File Gateway to AWS • Review settings and activate your Amazon S3 File Gateway • Conﬁgure your Amazon S3 File Gateway Set up an Amazon S3 File Gateway To set up a new S3 File Gateway 1. Open the AWS Management Console at https://console.aws.amazon.com/storagegateway/ home/, and choose the AWS Region where you want to create your gateway. 2. Choose Create gateway to open the Set up gateway page. 3. In the Gateway settings section, do the following: a. b. For Gateway name, enter a name for your gateway. After your gateway is created, you can search for this name to ﬁnd your gateway on the list pages in the AWS Storage Gateway console. For Gateway time zone, choose the local time zone for the part of the world where you want to deploy your gateway. 4. 5. In the Gateway options section, for Gateway type, choose Amazon S3 File Gateway. In the Platform options section, do the following: a. For Host platform, choose the platform on which you want to deploy your gateway. Then follow the platform-speciﬁc instructions displayed on the Storage Gateway console page to set up your host platform. You can choose from the following options: • VMware ESXi – Download, deploy, and conﬁgure the gateway virtual machine using VMware ESXi. • Microsoft Hyper-V – Download, deploy, and conﬁgure the gateway virtual machine using Microsoft Hyper-V. • Linux KVM – Download, deploy, and conﬁgure the gateway virtual machine using Linux Kernel-based Virtual Machine (KVM). • Amazon EC2 – Conﬁgure and launch an Amazon EC2 instance to host your gateway. • Hardware appliance – Order a dedicated physical hardware appliance from AWS to host your gateway. Set up an Amazon S3 File Gateway API Version 2013-06-30 59 AWS Storage Gateway Amazon S3 File Gateway User Guide b. For Conﬁrm set up gateway, select the check box to conﬁrm that you performed the deployment steps for the host platform that you chose. This step is not applicable for the Hardware appliance host platform. 6. Now that your gateway is set up, you must choose how you want it to connect and communicate with AWS. Choose Next to proceed. Connect your Amazon S3 File Gateway to AWS To connect a new S3 File Gateway to AWS 1. 2. If you have not done so already, complete the procedure described in Set up an Amazon S3 File Gateway. When ﬁnished, choose Next to open the Connect to AWS page in the AWS Storage Gateway console. In the Gateway connection options section, for Connection options, choose how to identify your gateway to AWS. You can choose from the following options: • IP address – Provide the IP address of your gateway in the corresponding ﬁeld. This IP address must be public or accessible from within your current network, and you must be able to connect to it from your web browser. You can obtain the gateway IP address by logging into the gateway's local console from your hypervisor client, or by copying it from your Amazon EC2 instance details page. For more information, see Getting the gateway IP address". • Activation key – Provide the activation key for your gateway in the corresponding ﬁeld. You can generate an activation key using the gateway's local console. If your gateway's IP address is unavailable, choose this option. 3. In the Endpoint options section, for Service endpoint, choose the type of endpoint that your gateway will use to communicate with AWS. You can choose from the following options: • Publicly accessible – Your gateway communicates with AWS over the public internet. If you select this option, use the FIPS enabled endpoint check box to specify whether the connection must comply with Federal Information Processing Standards (FIPS). Connect your Amazon S3 File Gateway to AWS API Version 2013-06-30 60 AWS Storage Gateway Amazon S3 File Gateway User Guide Note If you require FIPS 140-2 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS-compliant endpoint. For more information, see Federal Information Processing Standard (FIPS) 140-2. The FIPS service endpoint is available only in some AWS Regions. For more information, see AWS Storage Gateway endpoints and quotas in the AWS General Reference. • VPC hosted – Your gateway communicates with AWS through a private connection with your virtual private cloud (VPC), allowing you to control your network settings. If you select this option, you must specify an existing VPC endpoint by choosing its VPC endpoint ID from the dropdown list. You can also provide its VPC endpoint Domain Name System (DNS) name or IP address. Note To specify a VPC endpoint that belongs to an AWS account other than the one
storagegateway-s3file-ug-024	storagegateway-s3file-ug.pdf	24	available only in some AWS Regions. For more information, see AWS Storage Gateway endpoints and quotas in the AWS General Reference. • VPC hosted – Your gateway communicates with AWS through a private connection with your virtual private cloud (VPC), allowing you to control your network settings. If you select this option, you must specify an existing VPC endpoint by choosing its VPC endpoint ID from the dropdown list. You can also provide its VPC endpoint Domain Name System (DNS) name or IP address. Note To specify a VPC endpoint that belongs to an AWS account other than the one you are currently using to create your gateway, you must provide its DNS name or IP address. 4. Now that you have chosen how you want your gateway to connect to AWS, you must activate the gateway. Choose Next to proceed. Review settings and activate your Amazon S3 File Gateway To review settings and activate a new S3 File Gateway 1. If you have not done so already, complete the procedures described in the following topics: • Set up an Amazon S3 File Gateway • Connect your Amazon S3 File Gateway to AWS When ﬁnished, choose Next to open the Review and activate page in the AWS Storage Gateway console. 2. Review the initial gateway details for each section on the page. Review settings and activate your Amazon S3 File Gateway API Version 2013-06-30 61 AWS Storage Gateway Amazon S3 File Gateway User Guide 3. If a section contains errors, choose Edit to return to the corresponding settings page and make changes. Important You cannot modify the gateway options or connection settings after your gateway is activated. 4. Now that you have activated your gateway, you must perform the ﬁrst-time conﬁguration to allocate local storage disks and conﬁgure logging. Choose Next to proceed. Conﬁgure your Amazon S3 File Gateway To perform the ﬁrst-time conﬁguration on a new S3 File Gateway 1. If you have not done so already, complete the procedures described in the following topics: • Set up an Amazon S3 File Gateway • Connect your Amazon S3 File Gateway to AWS • Review settings and activate your Amazon S3 File Gateway When ﬁnished, choose Next to open the Conﬁgure gateway page in the AWS Storage Gateway console. In the Conﬁgure storage section, use the dropdown lists to allocate at least one local disk with at least 150 gibibytes (GiB) capacity to Cache. The local disks listed in this section correspond to the physical storage that you provisioned on your host platform. In the CloudWatch log group section, choose how to set up Amazon CloudWatch Logs to monitor the health of your gateway. You can choose from the following options: 2. 3. • Create a new log group – Set up a new log group to monitor your gateway. • Use an existing log group – Choose an existing log group from the corresponding dropdown list. • Deactivate logging – Do not use Amazon CloudWatch Logs to monitor your gateway. Conﬁgure your Amazon S3 File Gateway API Version 2013-06-30 62 AWS Storage Gateway Amazon S3 File Gateway User Guide Note To receive Storage Gateway health logs, the following permissions must be present in your log group resource policy. Replace the highlighted section with the speciﬁc log group resourceArn information for your deployment. "Sid": "AWSLogDeliveryWrite20150319", "Effect": "Allow", "Principal": { "Service": [ "delivery.logs.amazonaws.com" ] }, "Action": [ "logs:CreateLogStream", "logs:PutLogEvents" ], "Resource": "arn:aws:logs:eu-west-1:1234567890:log-group:/foo/bar:log- stream:*" The "Resource" element is required only if you want the permissions to apply explicitly to an individual log group. 4. In the CloudWatch alarms section, choose how to set up Amazon CloudWatch alarms to notify you when your gateway's metrics deviate from deﬁned limits. You can choose from the following options: • Create Storage Gateway's recommended alarms – Create all recommended CloudWatch alarms automatically when the gateway is created. For more information about recommended alarms, see Understanding CloudWatch alarms. Note This feature requires CloudWatch policy permissions, which are not automatically granted as part of the preconﬁgured Storage Gateway full access policy. Make sure your security policy grants the following permissions before you attempt to create recommended CloudWatch alarms: • cloudwatch:PutMetricAlarm - create alarms Conﬁgure your Amazon S3 File Gateway API Version 2013-06-30 63 AWS Storage Gateway Amazon S3 File Gateway User Guide • cloudwatch:DisableAlarmActions - turn alarm actions oﬀ • cloudwatch:EnableAlarmActions - turn alarm actions on • cloudwatch:DeleteAlarms - delete alarms • Create a custom alarm – Conﬁgure a new CloudWatch alarm to notify you about your gateway's metrics. Choose Create alarm to deﬁne metrics and specify alarm actions in the Amazon CloudWatch console. For instructions, see Using Amazon CloudWatch alarms in the Amazon CloudWatch User Guide. • No alarm – Don't receive CloudWatch notiﬁcations about your gateway's metrics. 5. 6. (Optional) In the Tags section, choose Add
storagegateway-s3file-ug-025	storagegateway-s3file-ug.pdf	25	Gateway API Version 2013-06-30 63 AWS Storage Gateway Amazon S3 File Gateway User Guide • cloudwatch:DisableAlarmActions - turn alarm actions oﬀ • cloudwatch:EnableAlarmActions - turn alarm actions on • cloudwatch:DeleteAlarms - delete alarms • Create a custom alarm – Conﬁgure a new CloudWatch alarm to notify you about your gateway's metrics. Choose Create alarm to deﬁne metrics and specify alarm actions in the Amazon CloudWatch console. For instructions, see Using Amazon CloudWatch alarms in the Amazon CloudWatch User Guide. • No alarm – Don't receive CloudWatch notiﬁcations about your gateway's metrics. 5. 6. (Optional) In the Tags section, choose Add new tag, then enter a case-sensitive key-value pair to help you search and ﬁlter for your gateway on the list pages in the AWS Storage Gateway console. Repeat this step to add as many tags as you need. (Optional) In the Verify VMware High Availability conﬁguration section, if your gateway is deployed on a VMware host that is part of a VMware High Availability (HA) cluster, choose Verify VMware HA to test whether the HA conﬁguration is working properly. Note This section appears only for gateways that are running on the VMware host platform. This step is not required to complete the gateway conﬁguration process. You can test your gateway's HA conﬁguration at any time. Veriﬁcation takes a few minutes, and reboots the Storage Gateway virtual machine (VM). 7. Choose Conﬁgure to ﬁnish creating your gateway. To check the status of your new gateway, search for it on the Gateway overview page of the AWS Storage Gateway console. Now that you have created your gateway, you must create a ﬁle share for it to use. For instructions, see Create a ﬁle share. Activating a gateway in a virtual private cloud You can create a private connection between your on-premises gateway appliance and cloud-based storage infrastructure. You can use this connection to activate your gateway and conﬁgure it to transfer data to AWS storage services without communicating over the public internet. Using the Activating a gateway in a VPC API Version 2013-06-30 64 AWS Storage Gateway Amazon S3 File Gateway User Guide Amazon VPC service, you can launch AWS resources, including private network interface endpoints, in a custom virtual private cloud (VPC). A VPC gives you control over network settings such as IP address range, subnets, route tables, and network gateways. For more information about VPCs, see What is Amazon VPC? in the Amazon VPC User Guide. To activate your gateway in a VPC, use the Amazon VPC Console to create a VPC endpoint for Storage Gateway and get the VPC endpoint ID, then specify this VPC endpoint ID when you create and activate the gateway. For more information, see Connect your Amazon S3 File Gateway to AWS. To conﬁgure your S3 File Gateway to transfer data through the VPC, you must create a separate VPC endpoint for Amazon S3, then specify this VPC endpoint when you create ﬁle shares for the gateway. Note You must activate your gateway in the same region where you create the VPC endpoint for Storage Gateway, and the Amazon S3 storage that you conﬁgure for the ﬁle share must be in the same region where you create the VPC endpoint for Amazon S3. Create a VPC endpoint for Storage Gateway Follow these instructions to create a VPC endpoint. If you already have a VPC endpoint for Storage Gateway, you can use it. To create a VPC endpoint for Storage Gateway 1. Sign in to the AWS Management Console and open the Amazon VPC console at https:// console.aws.amazon.com/vpc/. 2. In the navigation pane, choose Endpoints, and then choose Create Endpoint. 3. On the Create Endpoint page, choose AWS Services for Service category. 4. For Service Name, choose com.amazonaws.region.storagegateway. For example com.amazonaws.us-east-2.storagegateway. 5. For VPC, choose your VPC and note its Availability Zones and subnets. 6. Verify that Enable Private DNS Name is not selected. Create a VPC endpoint for Storage Gateway API Version 2013-06-30 65 AWS Storage Gateway Amazon S3 File Gateway User Guide 7. For Security group, choose the security group that you want to use for your VPC. You can accept the default security group. Verify that all of the following TCP ports are allowed in your security group: • TCP 443 • TCP 1026 • TCP 1027 • TCP 1028 • TCP 1031 • TCP 2222 8. Choose Create endpoint. The initial state of the endpoint is pending. When the endpoint is created, note the ID of the VPC endpoint that you just created. 9. When the endpoint is created, choose Endpoints, then choose the new VPC endpoint. 10. In Details tab of the selected storage gateway endpoint, under DNS Names, use the ﬁrst DNS name that doesn't specify an Availability Zone. Your DNS name should look similar to the following example: vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-
storagegateway-s3file-ug-026	storagegateway-s3file-ug.pdf	26	allowed in your security group: • TCP 443 • TCP 1026 • TCP 1027 • TCP 1028 • TCP 1031 • TCP 2222 8. Choose Create endpoint. The initial state of the endpoint is pending. When the endpoint is created, note the ID of the VPC endpoint that you just created. 9. When the endpoint is created, choose Endpoints, then choose the new VPC endpoint. 10. In Details tab of the selected storage gateway endpoint, under DNS Names, use the ﬁrst DNS name that doesn't specify an Availability Zone. Your DNS name should look similar to the following example: vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us- east-1.vpce.amazonaws.com Now that you have a VPC endpoint, you can create and activate your gateway. For more information, see Create and activate an Amazon S3 File Gateway. For information about getting an activation key, see Getting an activation key for your gateway. Important To conﬁgure your S3 File Gateway to transfer data through the VPC, you must create a separate VPC endpoint for Amazon S3, then specify this VPC endpoint when you create ﬁle shares for the gateway. To do this, follow the same steps as shown above, but choose com.amazonaws.region.s3 for Service Name, then select the route table that you want the S3 endpoint associated with instead of subnet/security group. For instructions, see Creating a gateway endpoint. Create a VPC endpoint for Storage Gateway API Version 2013-06-30 66 AWS Storage Gateway Amazon S3 File Gateway User Guide Creating a ﬁle share In this section, you can ﬁnd instructions on how to create a ﬁle share that can be accessed using the Network File System (NFS) or the Server Message Block (SMB) protocol. When you create an NFS share, anyone who has access to the NFS server can access the NFS ﬁle share by default. You can limit access to clients by IP address. When you create an SMB ﬁle share, you can use one of three modes of authentication: • A ﬁle share with Microsoft Active Directory (AD) access. Any authenticated Microsoft AD user gets access to this ﬁle share type. • An SMB ﬁle share with limited access. Only certain domain users and groups that you specify are allowed access (through an allow list). Users and groups can also be denied access (through a deny list). • An SMB ﬁle share with guest access. Any user who can provide the guest password has access to this ﬁle share. Note File shares that are exported through the gateway for NFS ﬁle shares support POSIX permissions. For SMB ﬁle shares, you can use access control lists (ACLs) to manage permissions on ﬁles and folders in your ﬁle share. For more information, see Using Windows ACLs to limit SMB ﬁle share access. A File Gateway can host one or more ﬁle shares of diﬀerent types. You can have multiple NFS and SMB ﬁle shares on a File Gateway. Important To create a ﬁle share, a File Gateway requires you to activate AWS Security Token Service (AWS STS). If AWS STS isn't activated in the AWS Region where you create your File Gateway, activate it. For information about how to activate AWS STS, see Activating and deactivating AWS Security Token Service in an AWS Region in the AWS Identity and Access Management User Guide. API Version 2013-06-30 67 AWS Storage Gateway Topics • Avoiding unanticipated costs when uploading gateway data • Encrypt objects stored by File Gateway in Amazon S3 • Create an NFS ﬁle share • Create an SMB ﬁle share Amazon S3 File Gateway User Guide Avoiding unanticipated costs when uploading gateway data When a ﬁle is written to the File Gateway by an NFS client, the File Gateway uploads the ﬁle's data to Amazon S3 followed by its metadata. Uploading the ﬁle data creates an S3 object, and uploading the metadata for the ﬁle updates the metadata for the S3 object. This process creates an additional version of the object. If S3 versioning is turned on, both versions are stored. If you change the metadata of a ﬁle that's stored in your File Gateway, a new S3 object is created and replaces the existing S3 object. This behavior is diﬀerent from editing a ﬁle in a ﬁle system, where editing a ﬁle does not result in a new ﬁle being created. Test all ﬁle operations that you plan to use with AWS Storage Gateway so that you understand how each ﬁle operation interacts with Amazon S3 storage. Carefully consider the use of S3 versioning and Cross-Region replication (CRR) in Amazon S3 when you're uploading data from your File Gateway. Uploading ﬁles from your File Gateway to Amazon S3 when S3 versioning is turned on results in at least two versions of an S3 object. Certain workﬂows involving large ﬁles and ﬁle-writing patterns such as ﬁle uploads that are performed
storagegateway-s3file-ug-027	storagegateway-s3file-ug.pdf	27	editing a ﬁle does not result in a new ﬁle being created. Test all ﬁle operations that you plan to use with AWS Storage Gateway so that you understand how each ﬁle operation interacts with Amazon S3 storage. Carefully consider the use of S3 versioning and Cross-Region replication (CRR) in Amazon S3 when you're uploading data from your File Gateway. Uploading ﬁles from your File Gateway to Amazon S3 when S3 versioning is turned on results in at least two versions of an S3 object. Certain workﬂows involving large ﬁles and ﬁle-writing patterns such as ﬁle uploads that are performed in several steps can increase the number of stored S3 object versions. If the File Gateway cache needs to free up space due to high ﬁle-write rates, multiple S3 object versions might be created. These scenarios increase S3 storage if S3 Versioning is turned on and increase the transfer costs associated with CRR. Test all ﬁle operations that you plan to use with Storage Gateway so that you understand how each ﬁle operation interacts with Amazon S3 storage. Using the Rsync utility with your File Gateway results in the creation of temporary ﬁles in the cache and the creation of temporary S3 objects in Amazon S3. This situation results in early deletion charges in the S3 Standard-Infrequent Access (S3 Standard-IA) storage class. Avoid unanticipated costs API Version 2013-06-30 68 AWS Storage Gateway Amazon S3 File Gateway User Guide Encrypt objects stored by File Gateway in Amazon S3 S3 File Gateway supports the following methods of server-side encryption for the data that it stores in Amazon S3: • SSE-S3 — By default, all new objects uploaded to Amazon S3 buckets use server-side encryption with Amazon S3 managed keys. For more information, see Using server-side encryption with Amazon S3 managed keys in the Amazon Simple Storage Service User Guide. • SSE-KMS — You can conﬁgure your ﬁle share to use server-side encryption with AWS Key Management Service (AWS KMS) managed keys. AWS KMS is a service that combines secure, highly available hardware and software to provide a key management system scaled for the cloud. For more information, see What is AWS Key Management Service? in the AWS Key Management Service Developer Guide. • DSSE-KMS — Dual-layer server-side encryption with AWS KMS keys applies two layers of encryption to objects when they are uploaded to Amazon S3. This helps fulﬁll compliance standards for multilayer encryption. For more information, see Using dual-layer server-side encryption with AWS KMS keys in the Amazon Simple Storage Service User Guide. Note There are additional charges for using DSSE-KMS and AWS KMS keys. For more information, see AWS KMS pricing. You can specify an encryption method when you create a new ﬁle share by using the Storage Gateway console or the Storage Gateway API. For console procedures, see Create an NFS ﬁle share with a custom conﬁguration or Create an SMB ﬁle share with a custom conﬁguration. For information about the corresponding API commands, see CreateNFSFileShare or CreateSMBFileShare in the AWS Storage Gateway API Reference. You can also update encryption settings for an existing ﬁle share using the Storage Gateway console, or the Storage Gateway API. For the console procedure, see Change the server-side encryption method for an existing ﬁle share. For information about the corresponding API commands, see UpdateNFSFileShare or UpdateSMBFileShare in the AWS Storage Gateway API Reference. Encrypt objects stored by File Gateway API Version 2013-06-30 69 AWS Storage Gateway Amazon S3 File Gateway User Guide Note After you update the encryption method, the gateway uses the new method for all new objects it creates in Amazon S3 and for any stored objects that it updates or modiﬁes in the future. Existing Amazon S3 objects will only receive the new encryption method if they are updated or modiﬁed by the gateway. Important Make sure that your ﬁle share uses the same encryption type as the Amazon S3 bucket where it stores your data. If you conﬁgure your File Gateway to use SSE-KMS or DSSE-KMS for encryption, you must manually add kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, kms:GenerateDataKey, and kms:DescribeKey permissions to the IAM role associated with the ﬁle share. For more information, see Using Identity-Based Policies (IAM Policies) for Storage Gateway. Create an NFS ﬁle share The Network File System (NFS) protocol is a stateful ﬁle sharing protocol for Unix-based systems. When an NFS-enabled client and NFS server communicate, the client requests a ﬁle or directory from the server using remote procedure calls (RPC). The server veriﬁes that the ﬁle or directory is available and that the client has the required access permissions. The server then mounts the ﬁle or directory remotely on the client and shares access via a virtual connection. For client operations, NFS makes using the remote server ﬁle similar to accessing a local ﬁle. The following
storagegateway-s3file-ug-028	storagegateway-s3file-ug.pdf	28	Gateway. Create an NFS ﬁle share The Network File System (NFS) protocol is a stateful ﬁle sharing protocol for Unix-based systems. When an NFS-enabled client and NFS server communicate, the client requests a ﬁle or directory from the server using remote procedure calls (RPC). The server veriﬁes that the ﬁle or directory is available and that the client has the required access permissions. The server then mounts the ﬁle or directory remotely on the client and shares access via a virtual connection. For client operations, NFS makes using the remote server ﬁle similar to accessing a local ﬁle. The following topics explain various methods for creating an NFS ﬁle share for your File Gateway: Contents • Create an NFS ﬁle share using the default conﬁguration • Default conﬁguration settings for NFS ﬁle shares • Create an NFS ﬁle share with a custom conﬁguration Create an NFS ﬁle share API Version 2013-06-30 70 AWS Storage Gateway Amazon S3 File Gateway User Guide Create an NFS ﬁle share using the default conﬁguration This section explains how to create a new Network File System (NFS) ﬁle share using preconﬁgured default settings. Use this method for basic deployments, personal use, testing, or as a way to quickly deploy multiple ﬁle shares that you plan to edit and customize later. For a list of the default settings for ﬁle shares that you create using this procedure, see Default conﬁguration settings for NFS ﬁle shares. If you need more granular control or want to use advanced settings for your ﬁle share, see Create an NFS ﬁle share using a custom conﬁguration. Note If you need to connect your ﬁle share to Amazon S3 through a Virtual Private Cloud (VPC), you must follow the custom conﬁguration procedure. You can’t edit VPC settings for a ﬁle share after you create it. Important Using S3 Versioning, Cross-Region Replication, or the Rsync utility when uploading data from a File Gateway can have signiﬁcant cost implications. For more information, see Avoiding unanticipated costs when uploading data from File Gateway. To create an NFS ﬁle share using the default conﬁguration: 1. Open the AWS Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home/ and choose File shares from the left navigation pane. 2. Choose Create ﬁle share. 3. 4. 5. For Gateway, choose your Amazon S3 File Gateway from the list. For File share protocol, choose NFS. For S3 bucket, do one of the following: • Choose an existing Amazon S3 bucket in your account from the dropdown list. • Choose A bucket in another account from the dropdown list, then enter the name of the bucket in Cross-account bucket name. Create NFS ﬁle share with default conﬁguration API Version 2013-06-30 71 AWS Storage Gateway Amazon S3 File Gateway User Guide • Choose Create new S3 bucket, then choose the AWS Region where the Amazon S3 endpoint for your new bucket is located, and enter a unique S3 bucket name. Choose Create S3 bucket when ﬁnished. For information about creating a new bucket, see How do I create an S3 bucket? in the Amazon S3 User Guide. Note S3 File Gateway does not support support Amazon S3 buckets with periods (.) in the bucket name. Make sure your bucket name complies with the rules for bucket naming in Amazon S3. For more information, see Rules for bucket naming in the Amazon Simple Storage Service User Guide. 6. Review the settings under Default conﬁguration, then choose Create ﬁle share to create your new NFS ﬁle share using the default conﬁguration. After your NFS ﬁle share is created, you can view its conﬁguration settings in the AWS Storage Gateway console on the ﬁle share's Details tab. For information about mounting your ﬁle share, see Mount your NFS ﬁle share on your client. Default conﬁguration settings for NFS ﬁle shares The following settings apply to all new NFS ﬁle shares that you create using the default conﬁguration. After you create a ﬁle share, you can select it from the File shares page in the AWS Storage Gateway console to view details about its conﬁguration. Important The default NFS ﬁle share conﬁguration provides full ﬁle control and access permissions to the owner of the S3 bucket that's mapped to the ﬁle share, even if the bucket is owned by a diﬀerent AWS account. For more information about using your ﬁle share to access objects in a bucket that's owned by another account, see Using a ﬁle share for cross-account access. Create NFS ﬁle share with default conﬁguration API Version 2013-06-30 72 AWS Storage Gateway Amazon S3 File Gateway User Guide Setting Default value Notes Amazon S3 location AWS PrivateLink for S3 The ﬁle share connects directly to the Amazon S3 bucket and has the same name as the bucket. Your gateway uses this bucket to store and retrieve ﬁles.
storagegateway-s3file-ug-029	storagegateway-s3file-ug.pdf	29	the ﬁle share, even if the bucket is owned by a diﬀerent AWS account. For more information about using your ﬁle share to access objects in a bucket that's owned by another account, see Using a ﬁle share for cross-account access. Create NFS ﬁle share with default conﬁguration API Version 2013-06-30 72 AWS Storage Gateway Amazon S3 File Gateway User Guide Setting Default value Notes Amazon S3 location AWS PrivateLink for S3 The ﬁle share connects directly to the Amazon S3 bucket and has the same name as the bucket. Your gateway uses this bucket to store and retrieve ﬁles. The ﬁle share doesn't connect to Amazon S3 through an interface endpoint in your virtual private cloud (VPC). File upload notiﬁcation Oﬀ Storage class for new objects Amazon S3 Standard Encryption Server-side encryption with S3 managed keys (SSE-S3) Object metadata Guess MIME type The name doesn't include a preﬁx. This lets you store your frequently accessed object data redundantly in multiple Availability Zones that are geographically separated. For more information about the Amazon S3 Standard storage class, see Storage classes for frequently accessed objects in the Amazon Simple Storage Service User Guide. All Amazon S3 objects that your S3 File Gateway uploads, updates, or modiﬁes are encrypted by default with server-side encryption using Amazon S3 managed keys. This allows Storage Gateway to guess the Multipurpose Create NFS ﬁle share with default conﬁguration API Version 2013-06-30 73 AWS Storage Gateway Amazon S3 File Gateway User Guide Setting Default value Notes Internet Mail Extension (MIME) type for uploaded objects based on ﬁle extensions. This option requires that Access Control Lists (ACLs) are turned on for the Amazon S3 bucket that's associated with your ﬁle share. If ACLs are turned oﬀ, the ﬁle share can't access the Amazon S3 bucket, and remains in the Unavailab le state indeﬁnitely. For more information, see Requester Pays buckets. Logging to an Amazon CloudWatch group is turned oﬀ by default. The default option allows the File Gateway to create a new IAM role and access policy on your behalf. All NFS clients are allowed access. For information about supported NFS clients, see Supported NFS and SMB clients for File Gateway. Enable requester pays Audit logs Oﬀ Oﬀ Access to your S3 bucket Create a new IAM role Create NFS ﬁle share with default conﬁguration API Version 2013-06-30 74 AWS Storage Gateway Amazon S3 File Gateway User Guide Setting Default value Notes Mount options • Squash level – Root squash • Export as – Read-write The default value of Squash level means that access for the remote superuser (root) is mapped to User Identiﬁer (UID) (65534) and Group Identiﬁer (GID) (65534). File metadata defaults • Directory permissions – 0777 • File permissions – 0666 • User Identiﬁer (UID) – 65534 • Group Identiﬁer (GID) – 65534 Create an NFS ﬁle share with a custom conﬁguration Use the following procedure to create a Network File System (NFS) ﬁle share with a custom conﬁguration. To create an NFS ﬁle share using default conﬁguration settings, see Create an NFS ﬁle share using the default conﬁguration. Important Using S3 Versioning, Cross-Region Replication, or the Rsync utility when uploading data from a File Gateway can have signiﬁcant cost implications. For more information, see Avoiding unanticipated costs when uploading data from File Gateway. To create an NFS ﬁle share with customized settings 1. Open the AWS Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home/ and choose File shares from the left navigation pane. 2. Choose Create ﬁle share. Create NFS ﬁle share with custom conﬁguration API Version 2013-06-30 75 AWS Storage Gateway Amazon S3 File Gateway User Guide 3. Choose Customize conﬁguration. You can ignore the other ﬁelds on this page for now. You will be prompted to conﬁgure gateway, protocol, and storage settings in subsequent steps. 4. For Gateway, choose the Amazon S3 File Gateway for your new ﬁle share for from the dropdown list. 5. For CloudWatch log group, choose one of the following from the dropdown list: • To turn oﬀ logging for this ﬁle share, choose Disable logging. • To automatically create a new log group for this ﬁle share, choose Created by Storage Gateway. • To send health and resource notiﬁcations for this ﬁle share to an existing log group, choose the desired group from the list. For more information about audit logs, see Understanding S3 File Gateway audit logs. 6. (Optional) Under Tags - Optional, choose Add new tag, then enter a Key and Value for your ﬁle share. A tag is a case-sensitive key-value pair that helps you categorize your Storage Gateway resources. Adding tags can make ﬁltering and searching for your ﬁle share easier. You can repeat this step to add up to 50 tags. Choose Next when ﬁnished. 7. For S3 bucket, do one of the following
storagegateway-s3file-ug-030	storagegateway-s3file-ug.pdf	30	for this ﬁle share to an existing log group, choose the desired group from the list. For more information about audit logs, see Understanding S3 File Gateway audit logs. 6. (Optional) Under Tags - Optional, choose Add new tag, then enter a Key and Value for your ﬁle share. A tag is a case-sensitive key-value pair that helps you categorize your Storage Gateway resources. Adding tags can make ﬁltering and searching for your ﬁle share easier. You can repeat this step to add up to 50 tags. Choose Next when ﬁnished. 7. For S3 bucket, do one of the following to specify where your ﬁle share will store and retrieve ﬁles: • To connect the ﬁle share directly to an existing S3 bucket in your Amazon Web Services account, choose the bucket name from the dropdown list. • To connect the ﬁle share to an existing S3 bucket that is owned by an Amazon Web Services account other than the one that you use to create the ﬁle share, choose A bucket in another account from the dropdown list, then enter the Cross-account bucket name. • To connect the ﬁle share to a new S3 bucket, choose Create a new S3 bucket, then choose the Region where the Amazon S3 endpoint for your new bucket is located, and enter a unique S3 bucket name. Choose Create S3 bucket when ﬁnished. For more information about creating new buckets, see How do I create an S3 bucket? in the Amazon S3 User Guide. • To connect the ﬁle share to an S3 bucket using an access point name, choose Amazon S3 access point name from the dropdown list, then enter the Access point name. If Create NFS ﬁle share with custom conﬁguration API Version 2013-06-30 76 AWS Storage Gateway Amazon S3 File Gateway User Guide you need to create a new access point, you can choose Create an S3 access point. For further instructions, see Creating an access point in the Amazon S3 User Guide. For more information about access points, see Managing data access with Amazon S3 access points and Delegating access control to access points in the Amazon S3 User Guide. • To connect the ﬁle share to an S3 bucket using an access point alias, choose Amazon S3 access point alias from the dropdown list, then enter the Access point alias. If you need to create a new access point, you can choose Create an S3 access point. For further instructions, see Creating an access point in the Amazon S3 User Guide. For more information about access point aliases, see Using a bucket-style alias for your access point in the Amazon S3 User Guide. Note Each ﬁle share can only connect to one S3 bucket, but multiple ﬁle shares can connect to the same bucket. If you connect more than one ﬁle share to the same bucket, you must conﬁgure each ﬁle share to use a unique, non-overlapping S3 bucket preﬁx to prevent read/write conﬂicts. S3 File Gateway does not support support Amazon S3 buckets with periods (.) in the bucket name. Make sure your bucket name complies with the rules for bucket naming in Amazon S3. For more information, see Rules for bucket naming in the Amazon Simple Storage Service User Guide. 8. (Optional) For S3 bucket preﬁx, enter a preﬁx for your ﬁle share to apply to the objects it creates in Amazon S3. Preﬁxes are a way to organize your data in S3, similar to directories in traditional ﬁle structures. For more information, see Organizing objects using preﬁxes in the Amazon S3 User Guide. Note • If you connect more than one ﬁle share to the same bucket, you must conﬁgure each ﬁle share to use a unique, non-overlapping preﬁx to prevent read/write conﬂicts. • The preﬁx must end with a forward slash (/). • After the ﬁle share is created, the preﬁx can't be modiﬁed or deleted. Create NFS ﬁle share with custom conﬁguration API Version 2013-06-30 77 AWS Storage Gateway Amazon S3 File Gateway User Guide 9. For Region, choose the AWS Region where the S3 endpoint for your bucket is located from the dropdown list. This ﬁeld appears only when you specify an access point or a bucket in another account for S3 bucket. 10. For Storage class for new objects, choose a storage class from the dropdown list. For more information about storage classes, see Using storage classes with a File Gateway. 11. For IAM Role, do one of the following to conﬁgure an IAM role for your ﬁle share: • To automatically create a new IAM role with the necessary permissions for your ﬁle share to work properly, choose Created by Storage Gateway from the dropdown list. • To use an existing IAM role, choose the role name from the dropdown
storagegateway-s3file-ug-031	storagegateway-s3file-ug.pdf	31	access point or a bucket in another account for S3 bucket. 10. For Storage class for new objects, choose a storage class from the dropdown list. For more information about storage classes, see Using storage classes with a File Gateway. 11. For IAM Role, do one of the following to conﬁgure an IAM role for your ﬁle share: • To automatically create a new IAM role with the necessary permissions for your ﬁle share to work properly, choose Created by Storage Gateway from the dropdown list. • To use an existing IAM role, choose the role name from the dropdown list. • To create a new IAM role, choose Create a role. For further instructions, see Creating a role to delegate permissions to an AWS service in the AWS Identity and Access Management User Guide. For more information about how IAM roles control access between your ﬁle share and S3 bucket, see Granting access to an Amazon S3 bucket. 12. For Private link, do the following only if you need to conﬁgure your ﬁle share to communicate with AWS using a private endpoint in a Virtual Private Cloud (VPC). Otherwise, skip this step. For more information, see What is AWS PrivateLink? in the AWS PrivateLink Guide. a. b. Select Use VPC endpoint. For Identify VPC endpoint by, do one of the following: • Select VPC endpoint ID, then choose the endpoint that you want to use from the VPC endpoint dropdown list. • Select DNS name, then enter the DNS name for the endpoint that you want to use. 13. For Encryption, choose the type of server-side encryption that the ﬁle share will use for the data that it stores in Amazon S3: • To use server-side encryption managed with Amazon S3 (SSE-S3), choose S3-Managed Keys (SSE-S3). For more information, see Using server-side encryption with Amazon S3 managed keys in the Amazon Simple Storage Service User Guide. • To use server-side encryption managed with AWS Key Management Service (SSE-KMS), choose KMS-Managed Keys (SSE-KMS). For Primary KMS key, choose an existing AWS KMS Create NFS ﬁle share with custom conﬁguration API Version 2013-06-30 78 AWS Storage Gateway Amazon S3 File Gateway User Guide key, or choose Create a new KMS key to create a new KMS key in the AWS Key Management Service (AWS KMS) console. For more information about AWS KMS, see What is AWS Key Management Service? in the AWS Key Management Service Developer Guide. • To use dual-layer server-side encryption managed with AWS Key Management Service (DSSE-KMS), choose Dual-layer server-side encryption with AWS Key Management Service keys (DSSE-KMS). For Primary KMS key, choose an existing AWS KMS key, or choose Create a new KMS key to create a new KMS key in the AWS Key Management Service (AWS KMS) console. For more information about DSSE-KMS, see Using dual-layer server-side encryption with AWS KMS keys in the Amazon Simple Storage Service User Guide. Note There are additional charges for using DSSE-KMS and AWS KMS keys. For more information, see AWS KMS pricing. To specify an AWS KMS key with an alias that is not listed or to use an AWS KMS key from a diﬀerent AWS account, you must use the AWS Command Line Interface. Asymmetric KMS keys are not supported. For more information, see CreateNFSFileShare in the AWS Storage Gateway API Reference. Important Make sure that your ﬁle share uses the same encryption type as the Amazon S3 bucket where it stores your data. 14. For Guess MIME types, select Guess media MIME type to allow Storage Gateway to guess the media type for uploaded objects based on their ﬁle extensions. 15. For File share name, enter a name for your ﬁle share. Note A valid NFS ﬁle share name can only contain the following characters: a-z, A-Z, 0-9, -, ., and _. Create NFS ﬁle share with custom conﬁguration API Version 2013-06-30 79 AWS Storage Gateway Amazon S3 File Gateway User Guide 16. For Upload events, select Log an event when a ﬁle is successfully uploaded by the gateway if you want your gateway to record CloudWatch log events when it successfully uploads ﬁles to Amazon S3. Notiﬁcation delay controls the minimum delay between the most recent client write operation and generation of the ObjectUploaded log notiﬁcation. Because clients can make many small writes to ﬁles in a short time, we recommend setting this parameter for as long as possible to avoid generating multiple notiﬁcations for the same ﬁle in rapid succession. For more information, see Getting ﬁle upload notiﬁcation. Note This setting has no eﬀect on the timing of the object uploading to S3, only on the timing of the notiﬁcation. This setting is not meant to specify an exact time at which the notiﬁcation will be sent. In some cases, the gateway might require more
storagegateway-s3file-ug-032	storagegateway-s3file-ug.pdf	32	client write operation and generation of the ObjectUploaded log notiﬁcation. Because clients can make many small writes to ﬁles in a short time, we recommend setting this parameter for as long as possible to avoid generating multiple notiﬁcations for the same ﬁle in rapid succession. For more information, see Getting ﬁle upload notiﬁcation. Note This setting has no eﬀect on the timing of the object uploading to S3, only on the timing of the notiﬁcation. This setting is not meant to specify an exact time at which the notiﬁcation will be sent. In some cases, the gateway might require more than the speciﬁed delay time to generate and send notiﬁcations. Choose Next when ﬁnished. 17. 18. For File share protocol, choose NFS. 19. For Client access, do one of the following to specify which NFS clients can access your ﬁle share: • To accept all incoming client connections, select All NFS clients. • To accept incoming client connections only from speciﬁc IP addresses, select Speciﬁc NFS clients, then choose Add a client. For Allowed clients, specify a valid IP address or CIDR block from which to accept connections. If you need to specify additional IP addresses, choose Add another client. Note We recommend conﬁguring limiting access to your ﬁle share using the Speciﬁc NFS clients option. If you don't, any client on your network can mount to the ﬁle share. 20. For Access type, select one of the following: Create NFS ﬁle share with custom conﬁguration API Version 2013-06-30 80 AWS Storage Gateway Amazon S3 File Gateway User Guide • To allow clients to read and write ﬁles on the ﬁle share, select Read/Write. • To allow clients to read ﬁles but not write to the ﬁle share, select Read-only. Note For ﬁle shares that are mounted on a Microsoft Windows client, if you choose Read- only, you might see a message about an unexpected error keeping you from creating the folder. You can ignore this message. 21. For Access level, choose one of the following: • Root squash (default): Access for the remote superuser (root) is mapped to UID (65534) and GID (65534). • All squash: All user access is mapped to User ID (UID) (65534) and Group ID (GID) (65534). • No root squash: The remote superuser (root) receives access as root. 22. (Optional) For Automated cache refresh from S3, choose Set cache refresh interval, then set the time in Minutes or Days to refresh the ﬁle share's cache using Time To Live (TTL). TTL is the length of time since the last refresh. After the TTL interval has elapsed, accessing a directory causes the File Gateway to refresh that directory's contents from the Amazon S3 bucket. Note Setting this value shorter than 30 minutes can negatively impact gateway performance in situations where large numbers of Amazon S3 objects are frequently created or deleted. 23. For File metadata defaults, select Change default metadata for S3 objects that were not created or modiﬁed by your gateway if you want your gateway to apply ﬁle metadata (including Unix permissions) to preexisting objects that it discovers in your S3 bucket. Specify the Directory permissions, File permissions, User ID, and Group ID that you want to apply in the corresponding ﬁelds. 24. For File ownership and permissions, select Give the S3 bucket owner full ownership of ﬁles created by the gateway, including read, write, edit, and delete permissions if you want the AWS account that owns the S3 bucket to have full control of all objects written to the bucket by your ﬁle share. Create NFS ﬁle share with custom conﬁguration API Version 2013-06-30 81 AWS Storage Gateway Amazon S3 File Gateway User Guide Choose Next when ﬁnished. 25. Review the ﬁle share conﬁguration. Choose Edit to modify the settings for any section that you want to change. When ﬁnished, choose Create. After your NFS ﬁle share is created, you can view its conﬁguration settings in the AWS Storage Gateway console on the ﬁle share's Details tab. For instructions to mount your ﬁle share, see Mount your NFS ﬁle share on your client. Create an SMB ﬁle share The Server Message Block (SMB) protocol is deeply integrated into the Microsoft Windows product suite, and remains the default ﬁle sharing protocol for Windows operating systems. The process of client-server communication is similar to NFS at a high level, but there are diﬀerences in some details and operational mechanisms. For example, in SMB, ﬁle systems are not mounted on the local SMB client. Instead, a network share hosted on the SMB server is accessed via a network path. The topics in this section explain various methods for creating an SMB ﬁle share for your File Gateway. Contents • Create an SMB ﬁle share using the default conﬁguration • Default conﬁguration settings for SMB ﬁle
storagegateway-s3file-ug-033	storagegateway-s3file-ug.pdf	33	suite, and remains the default ﬁle sharing protocol for Windows operating systems. The process of client-server communication is similar to NFS at a high level, but there are diﬀerences in some details and operational mechanisms. For example, in SMB, ﬁle systems are not mounted on the local SMB client. Instead, a network share hosted on the SMB server is accessed via a network path. The topics in this section explain various methods for creating an SMB ﬁle share for your File Gateway. Contents • Create an SMB ﬁle share using the default conﬁguration • Default conﬁguration settings for SMB ﬁle shares • Create an SMB ﬁle share with a custom conﬁguration Create an SMB ﬁle share using the default conﬁguration This section explains how to create a new Server Message Block (SMB) ﬁle share using preconﬁgured default settings. Use this method for basic deployments, personal use, testing, or as a way to quickly deploy multiple ﬁle shares that you plan to edit and customize later. For a list of the default settings for ﬁle shares that you create using this procedure, see Default conﬁguration settings for SMB ﬁle shares. If you need more granular control or want to use advanced settings for your ﬁle share, see Create an SMB ﬁle share with a custom conﬁguration. Create an SMB ﬁle share API Version 2013-06-30 82 AWS Storage Gateway Amazon S3 File Gateway User Guide Note If you need to connect your ﬁle share to Amazon S3 through a Virtual Private Cloud (VPC), you must follow the custom conﬁguration procedure. You can’t edit VPC settings for a ﬁle share after you create it. Important Using S3 Versioning, Cross-Region Replication, or the Rsync utility when uploading data from a File Gateway can have signiﬁcant cost implications. For more information, see Avoiding unanticipated costs when uploading data from File Gateway. Prerequisites Before you create your ﬁle share, do the following: • Conﬁgure SMB security settings for your File Gateway. For instructions, see Setting a security level for your gateway. • Conﬁgure either Microsoft Active Directory or guest access for authentication. For instructions, see Using Active Directory to authenticate users or Providing guest access to your ﬁle share. • Make sure that the required ports are open in your security group. For more information, see Port Requirements. To create an SMB ﬁle share using the default conﬁguration: 1. Open the AWS Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home/ and choose File shares from the left navigation pane. 2. Choose Create ﬁle share. 3. 4. 5. For Gateway, choose the Amazon S3 File Gateway from the dropdown list. For File share protocol, choose SMB. For S3 bucket, do one of the following: • Choose an existing Amazon S3 bucket in your account from the dropdown list. Create SMB ﬁle share with default conﬁguration API Version 2013-06-30 83 AWS Storage Gateway Amazon S3 File Gateway User Guide • Choose A bucket in another account from the dropdown list, then enter the name of the bucket in Cross-account bucket name. • Choose Create new S3 bucket, then choose the AWS Region where the Amazon S3 endpoint for your new bucket is located, and enter a unique S3 bucket name. Choose Create S3 bucket when ﬁnished. For information about creating a new bucket, see How do I create an S3 bucket? in the Amazon S3 User Guide. Note S3 File Gateway does not support support Amazon S3 buckets with periods (.) in the bucket name. Make sure your bucket name complies with the rules for bucket naming in Amazon S3. For more information, see Rules for bucket naming in the Amazon Simple Storage Service User Guide. 6. User authentication, choose the authentication method you want to use from the dropdown list: • To use your corporate Microsoft Active Directory or AWS Managed Microsoft AD to authenticate user access to your SMB ﬁle share, choose Active Directory. Your gateway must be joined to a domain to use this method. For more information, see Using Active Directory to authenticate users. Note To use AWS Managed Microsoft AD with an Amazon EC2 gateway, you must create the Amazon EC2 instance in the same VPC as the AWS Managed Microsoft AD, add the _workspaceMembers security group to the Amazon EC2 instance, and join the AD domain using the Admin credentials from the AWS Managed Microsoft AD. For more information about AWS Managed Microsoft AD, see the AWS Directory Service Administration Guide. For more information about Amazon EC2, see the Amazon Elastic Compute Cloud Documentation. Create SMB ﬁle share with default conﬁguration API Version 2013-06-30 84 AWS Storage Gateway Amazon S3 File Gateway User Guide If Join status indicates that your gateway is already joined to an Active Directory domain, proceed to the next step. Otherwise, do the following: 1. Choose Conﬁgure. 2. For Domain,
storagegateway-s3file-ug-034	storagegateway-s3file-ug.pdf	34	security group to the Amazon EC2 instance, and join the AD domain using the Admin credentials from the AWS Managed Microsoft AD. For more information about AWS Managed Microsoft AD, see the AWS Directory Service Administration Guide. For more information about Amazon EC2, see the Amazon Elastic Compute Cloud Documentation. Create SMB ﬁle share with default conﬁguration API Version 2013-06-30 84 AWS Storage Gateway Amazon S3 File Gateway User Guide If Join status indicates that your gateway is already joined to an Active Directory domain, proceed to the next step. Otherwise, do the following: 1. Choose Conﬁgure. 2. For Domain, enter the name of the Active Directory domain you want your gateway to join. 3. Enter the Username and Password that the gateway will use to join the domain. 4. (Optional) For Organization unit (OU), enter the designated OU that your Active Directory uses for new computer objects. 5. (Optional) For Domain controller(s) (DC), enter the name of the DC through which your gateway will connect to Active Directory. You can leave this ﬁeld blank to allow DNS to automatically select a DC. 6. Choose Join Active Directory. Note Joining a domain creates an Active Directory account in the default container (which isn't an organizational unit) using the Gateway ID as the account name (for example, SGW-1234ADE). It is not possible to customize the name of this account. If your Active Directory environment requires that you pre-stage accounts to facilitate the domain join process, you need to create this account ahead of time. If your Active Directory environment has a designated OU for new computer objects, you must specify that OU when joining the domain. • To grant password-protected access to anyone who provides the guest password that you conﬁgure, choose Guest access. Your File Gateway doesn't need to be part of a Microsoft Active Directory domain to use this method. Choose Conﬁgure to specify your Guest password, then choose Save. 7. Review the settings under Default conﬁguration, then choose Create ﬁle share to create your new SMB ﬁle share using the default conﬁguration. After your SMB ﬁle share is created, you can view its conﬁguration settings in the AWS Storage Gateway console on the ﬁle share's Details tab. For information about mounting your ﬁle share, see Mount your SMB ﬁle share on your client. Create SMB ﬁle share with default conﬁguration API Version 2013-06-30 85 AWS Storage Gateway Amazon S3 File Gateway User Guide Default conﬁguration settings for SMB ﬁle shares The following settings apply to all new SMB ﬁle shares that you create using the default conﬁguration. After you create a ﬁle share, you can select it from the File shares page in the AWS Storage Gateway console to view details about its conﬁguration. Important The default SMB ﬁle share conﬁguration provides full ﬁle control and access permissions to the owner of the S3 bucket that's mapped to the ﬁle share, even if the bucket is owned by a diﬀerent Amazon Web Services account. For more information about using your ﬁle share to access objects in a bucket that's owned by another account, see Using a ﬁle share for cross-account access. Setting Default value Notes Amazon S3 location AWS PrivateLink for S3 The ﬁle share connects directly to the Amazon S3 bucket and has the same name as the bucket. Your gateway uses this bucket to store and retrieve ﬁles. The ﬁle share doesn't connect to Amazon S3 through an interface endpoint in your virtual private cloud (VPC). File upload notiﬁcation Oﬀ Storage class for new objects Amazon S3 Standard The name doesn't include a preﬁx. This lets you store your frequently accessed object data redundantly in multiple Availability Zones that are geographically separated. For more information about the Amazon S3 Standard storage Create SMB ﬁle share with default conﬁguration API Version 2013-06-30 86 AWS Storage Gateway Amazon S3 File Gateway User Guide Setting Default value Notes class, see Storage classes for frequently accessed objects in the Amazon Simple Storage Service User Guide. Encryption Server-side encryption with S3 managed keys (SSE-S3) All Amazon S3 objects that your S3 File Gateway uploads, Object metadata Guess MIME type updates, or modiﬁes are encrypted by default with server-side encryption using Amazon S3 managed keys. This allows Storage Gateway to guess the Multipurpose Internet Mail Extension (MIME) type for uploaded objects based on ﬁle extensions. This option requires that Access Control Lists (ACLs) are turned on for the Amazon S3 bucket that's associated with your ﬁle share. If ACLs are turned oﬀ, the ﬁle share can't access the Amazon S3 bucket, and remains in the Unavailab le state indeﬁnitely. Create SMB ﬁle share with default conﬁguration API Version 2013-06-30 87 AWS Storage Gateway Amazon S3 File Gateway User Guide Setting Default value Notes Access based enumeration Not activated Enable requester pays Opportunistic
storagegateway-s3file-ug-035	storagegateway-s3file-ug.pdf	35	S3 managed keys. This allows Storage Gateway to guess the Multipurpose Internet Mail Extension (MIME) type for uploaded objects based on ﬁle extensions. This option requires that Access Control Lists (ACLs) are turned on for the Amazon S3 bucket that's associated with your ﬁle share. If ACLs are turned oﬀ, the ﬁle share can't access the Amazon S3 bucket, and remains in the Unavailab le state indeﬁnitely. Create SMB ﬁle share with default conﬁguration API Version 2013-06-30 87 AWS Storage Gateway Amazon S3 File Gateway User Guide Setting Default value Notes Access based enumeration Not activated Enable requester pays Opportunistic locking Oﬀ On Audit logs Oﬀ Force case sensitivity Oﬀ The ﬁles and folders on the ﬁle share are visible to all users during directory enumerati on. Access-based enumerati on is a system that ﬁlters the enumeration of ﬁles and folders on an SMB ﬁle share based on the share's access control lists (ACLs). For more information, see Requester Pays buckets. This allows the ﬁle share to use opportunistic locking to optimize the ﬁle buﬀering strategy. In most cases, activatin g opportunistic locking improves performance, particularly with regard to Windows context menus. Logging to an Amazon CloudWatch group is turned oﬀ by default. This allows the client to control the case sensitivity. Create SMB ﬁle share with default conﬁguration API Version 2013-06-30 88 AWS Storage Gateway Amazon S3 File Gateway User Guide Setting Default value Notes Access to your S3 bucket Create a new IAM role The default option allows the File Gateway to create a new IAM role and access policy on your behalf. Create an SMB ﬁle share with a custom conﬁguration Use the following procedure to create a Server Message Block (SMB) ﬁle share with a custom conﬁguration. To create an SMB ﬁle share using default conﬁguration settings, see Create an SMB ﬁle share using the default conﬁguration. Important Using S3 Versioning, Cross-Region Replication, or the Rsync utility when uploading data from a File Gateway can have signiﬁcant cost implications. For more information, see Avoiding unanticipated costs when uploading data from File Gateway. Prerequisites Before you create your ﬁle share, do the following: • Conﬁgure SMB security settings for your File Gateway. For instructions, see Setting a security level for your gateway. • Conﬁgure either Microsoft Active Directory or guest access for authentication. For instructions, see Using Active Directory to authenticate users or Providing guest access to your ﬁle share. • Make sure that the required ports are open in your security group. For more information, see Port Requirements. To create an SMB ﬁle share with customized settings 1. Open the AWS Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home/ and choose File shares from the left navigation pane. 2. Choose Create ﬁle share. Create SMB ﬁle share with custom conﬁguration API Version 2013-06-30 89 AWS Storage Gateway Amazon S3 File Gateway User Guide 3. Choose Customize conﬁguration. You can ignore the other ﬁelds on this page for now. You will be prompted to conﬁgure gateway, protocol, and storage settings in subsequent steps. 4. 5. For Gateway, choose the Amazon S3 File Gateway from the dropdown list. For CloudWatch log group, choose one of the following from the dropdown list: • To turn oﬀ logging for this ﬁle share, choose Disable logging. • To automatically create a new log group for this ﬁle share, choose Created by Storage Gateway. • To send health and resource notiﬁcations for this ﬁle share to an existing log group, choose the desired group from the list. For more information about audit logs, see Understanding S3 File Gateway audit logs. 6. (Optional) Under Tags - Optional, choose Add new tag, then enter a Key and Value for your ﬁle share. A tag is a case-sensitive key-value pair that helps you to categorize your Storage Gateway resources. Adding tags can make ﬁltering and searching for your ﬁle share easier. You can repeat this step to add up to 50 tags. Choose Next when ﬁnished. 7. For S3 bucket, do one of the following to specify where to store and retrieve ﬁles: • To connect the ﬁle share directly to an existing S3 bucket in your Amazon Web Services account, choose the bucket name from the dropdown list. • To connect the ﬁle share to an existing S3 bucket that's owned by an Amazon Web Services account other than the one that you're using to create the ﬁle share, choose A bucket in another account from the dropdown list, then enter the Cross-account bucket name. • To connect the ﬁle share to a new S3 bucket, choose Create a new S3 bucket, then choose the Region where the Amazon S3 endpoint for your new bucket is located, and enter a unique S3 bucket name. Choose Create S3 bucket when ﬁnished. For more information about creating new
storagegateway-s3file-ug-036	storagegateway-s3file-ug.pdf	36	dropdown list. • To connect the ﬁle share to an existing S3 bucket that's owned by an Amazon Web Services account other than the one that you're using to create the ﬁle share, choose A bucket in another account from the dropdown list, then enter the Cross-account bucket name. • To connect the ﬁle share to a new S3 bucket, choose Create a new S3 bucket, then choose the Region where the Amazon S3 endpoint for your new bucket is located, and enter a unique S3 bucket name. Choose Create S3 bucket when ﬁnished. For more information about creating new buckets, see How do I create an S3 bucket? in the Amazon S3 User Guide. • To connect the ﬁle share to an S3 bucket using an access point name, choose Amazon S3 access point name from the dropdown list, then enter the Access point name. If you need to create a new access point, you can choose Create an S3 access point. For further instructions, see Creating an access point in the Amazon S3 User Guide. For more Create SMB ﬁle share with custom conﬁguration API Version 2013-06-30 90 AWS Storage Gateway Amazon S3 File Gateway User Guide information about access points, see Managing data access with Amazon S3 access points and Delegating access control to access points in the Amazon S3 User Guide. • To connect the ﬁle share to an S3 bucket using an access point alias, choose Amazon S3 access point alias from the dropdown list, then enter the Access point alias. If you need to create a new access point, you can choose Create an S3 access point. For further instructions, see Creating an access point in the Amazon S3 User Guide. For more information about access point aliases, see Using a bucket-style alias for your access point in the Amazon S3 User Guide. Note Each ﬁle share can only connect to one S3 bucket, but multiple ﬁle shares can connect to the same bucket. If you connect more than one ﬁle share to the same bucket, you must conﬁgure each ﬁle share to use a unique, non-overlapping S3 bucket preﬁx to prevent read/write conﬂicts. S3 File Gateway does not support support Amazon S3 buckets with periods (.) in the bucket name. Make sure your bucket name complies with the rules for bucket naming in Amazon S3. For more information, see Rules for bucket naming in the Amazon Simple Storage Service User Guide. 8. (Optional) For S3 bucket preﬁx, enter a preﬁx for your ﬁle share to apply to the objects it creates in Amazon S3. Preﬁxes are a way to organize your data in S3, similar to directories in traditional ﬁle structures. For more information, see Organizing objects using preﬁxes in the Amazon S3 User Guide. Note • If you connect more than one ﬁle share to the same bucket, you must conﬁgure each ﬁle share to use a unique, non-overlapping preﬁx to prevent read/write conﬂicts. • The preﬁx must end with a forward slash (/). • After the ﬁle share is created, the preﬁx can't be modiﬁed or deleted. 9. For Region, choose the AWS Region where the S3 endpoint for your bucket is located from the dropdown list. This ﬁeld appears only when you specify an access point or a bucket in another account for S3 bucket. Create SMB ﬁle share with custom conﬁguration API Version 2013-06-30 91 AWS Storage Gateway Amazon S3 File Gateway User Guide 10. For Storage class for new objects, choose a storage class from the dropdown list. For more information about storage classes, see Using storage classes with a File Gateway. 11. For IAM Role, do one of the following to conﬁgure an IAM role for your ﬁle share: • To automatically create a new IAM role with the necessary permissions for your ﬁle share to work properly, choose Created by Storage Gateway from the dropdown list. • To use an existing IAM role, choose the role name from the dropdown list. • To create a new IAM role, choose Create a role. For further instructions, see Creating a role to delegate permissions to an AWS service in the AWS Identity and Access Management User Guide. For more information about how IAM roles control access between your ﬁle share and S3 bucket, see Granting access to an Amazon S3bucket. 12. For Private link, do the following only if you need to conﬁgure your ﬁle share to communicate with AWS using a private endpoint in a Virtual Private Cloud (VPC). Otherwise, skip this step. For more information, see What is AWS PrivateLink? in the AWS PrivateLink Guide. a. b. Select Use VPC endpoint. For Identify VPC endpoint by, do one of the following: • Select VPC endpoint ID, then choose the endpoint that you want to use from
storagegateway-s3file-ug-037	storagegateway-s3file-ug.pdf	37	more information about how IAM roles control access between your ﬁle share and S3 bucket, see Granting access to an Amazon S3bucket. 12. For Private link, do the following only if you need to conﬁgure your ﬁle share to communicate with AWS using a private endpoint in a Virtual Private Cloud (VPC). Otherwise, skip this step. For more information, see What is AWS PrivateLink? in the AWS PrivateLink Guide. a. b. Select Use VPC endpoint. For Identify VPC endpoint by, do one of the following: • Select VPC endpoint ID, then choose the endpoint that you want to use from the VPC endpoint dropdown list. • Select DNS name, then enter the DNS name for the endpoint that you want to use. 13. For Encryption, choose the type of encryption keys to use to encrypt objects that your File Gateway stores in Amazon S3: • To use server-side encryption managed with Amazon S3 (SSE-S3), choose S3-Managed Keys (SSE-S3). For more information, see Using server-side encryption with Amazon S3 managed keys in the Amazon Simple Storage Service User Guide. • To use server-side encryption managed with AWS Key Management Service (SSE-KMS), choose KMS-Managed Keys (SSE-KMS). For Primary KMS key, choose an existing AWS KMS key, or choose Create a new KMS key to create a new KMS key in the AWS Key Management Service (AWS KMS) console. Create SMB ﬁle share with custom conﬁguration API Version 2013-06-30 92 AWS Storage Gateway Amazon S3 File Gateway User Guide For more information about AWS KMS, see What is AWS Key Management Service? in the AWS Key Management Service Developer Guide. • To use dual-layer server-side encryption managed with AWS Key Management Service (DSSE-KMS), choose Dual-layer server-side encryption with AWS Key Management Service keys (DSSE-KMS). For Primary KMS key, choose an existing AWS KMS key, or choose Create a new KMS key to create a new KMS key in the AWS Key Management Service (AWS KMS) console. For more information about DSSE-KMS, see Using dual-layer server-side encryption with AWS KMS keys in the Amazon Simple Storage Service User Guide. Note There are additional charges for using DSSE-KMS and AWS KMS keys. For more information, see AWS KMS pricing. To specify an AWS KMS key with an alias that is not listed or to use an AWS KMS key from a diﬀerent AWS account, you must use the AWS Command Line Interface. Asymmetric KMS keys are not supported. For more information, see CreateSMBFileShare in the AWS Storage Gateway API Reference. Important Make sure that your ﬁle share uses the same encryption type as the Amazon S3 bucket where it stores your data. 14. For Guess MIME types, select Guess media MIME type to allow Storage Gateway to guess the Multipurpose Internet Mail Extension (MIME) type for uploaded objects based on their ﬁle extensions. 15. For File share name, enter a name for your ﬁle share. Note A valid SMB ﬁle share name cannot contain the following characters: [,],#,;,<,>,:,",\,/,\|,?,*,+, or ASCII control characters 1-31. Create SMB ﬁle share with custom conﬁguration API Version 2013-06-30 93 AWS Storage Gateway Amazon S3 File Gateway User Guide 16. For Upload events, select Log an event when a ﬁle is successfully uploaded by the gateway if you want your gateway to record CloudWatch log events when it successfully uploads ﬁles to Amazon S3. Notiﬁcation delay controls the delay between the most recent client write operation and generation of the ObjectUploaded log notiﬁcation. Because clients can make many small writes to ﬁles in a short time, we recommend setting this parameter for as long as possible to avoid generating multiple notiﬁcations for the same ﬁle in rapid succession. For more information, see Getting ﬁle upload notiﬁcation. Note This setting has no eﬀect on the timing of the object uploading to S3, only on the timing of the notiﬁcation. This setting is not meant to specify an exact time at which the notiﬁcation will be sent. In some cases, the gateway might require more than the speciﬁed delay time to generate and send notiﬁcations. Choose Next when ﬁnished. 17. For File share protocol, choose SMB. 18. For User authentication, choose the authentication method that you want to use from the dropdown list: • To use your corporate Microsoft Active Directory or AWS Managed Microsoft AD to authenticate user access to your SMB ﬁle share, choose Active Directory. Your gateway must be joined to a domain to use this method. For more information, see Using Active Directory to authenticate users. Note To use AWS Managed Microsoft AD with an Amazon EC2 gateway, you must create the Amazon EC2 instance in the same VPC as the AWS Managed Microsoft AD, add the _workspaceMembers security group to the Amazon EC2 instance, and join the AD domain using the Admin credentials from the AWS Managed Microsoft
storagegateway-s3file-ug-038	storagegateway-s3file-ug.pdf	38	• To use your corporate Microsoft Active Directory or AWS Managed Microsoft AD to authenticate user access to your SMB ﬁle share, choose Active Directory. Your gateway must be joined to a domain to use this method. For more information, see Using Active Directory to authenticate users. Note To use AWS Managed Microsoft AD with an Amazon EC2 gateway, you must create the Amazon EC2 instance in the same VPC as the AWS Managed Microsoft AD, add the _workspaceMembers security group to the Amazon EC2 instance, and join the AD domain using the Admin credentials from the AWS Managed Microsoft AD. For more information about AWS Managed Microsoft AD, see the AWS Directory Service Administration Guide. Create SMB ﬁle share with custom conﬁguration API Version 2013-06-30 94 AWS Storage Gateway Amazon S3 File Gateway User Guide For more information about Amazon EC2, see the Amazon Elastic Compute Cloud Documentation. If Join status indicates that your gateway is already joined to an Active Directory domain, proceed to the next step. Otherwise, do the following: 1. Choose Conﬁgure. 2. For Domain, enter the name of the Active Directory domain that you want your gateway to join. 3. Enter the Username and Password that the gateway will use to join the domain. 4. (Optional) For Organization unit (OU), enter the designated OU that your Active Directory uses for new computer objects. 5. (Optional) For Domain controller(s) (DC), enter the name of the DC through which your gateway will connect to Active Directory. You can leave this ﬁeld blank to allow DNS to automatically select a DC. 6. Choose Join Active Directory. Note Joining a domain creates an Active Directory account in the default container (which isn't an organizational unit), using the gateway's Gateway ID as the account name (for example, SGW-1234ADE). It is not possible to customize the name of this account. If your Active Directory environment requires that you pre-stage accounts to facilitate the domain join process, you need to create this account ahead of time. If your Active Directory environment has a designated OU for new computer objects, you must specify that OU when joining the domain. • To grant password-protected access to anyone who provides the guest password that you conﬁgure, choose Guest access. Your File Gateway doesn't need to be part of a Microsoft Active Directory domain to use this method. Choose Conﬁgure to specify your Guest password, then choose Save. 19. For User access, do one of the following to specify which SMB clients can access your ﬁle share: Create SMB ﬁle share with custom conﬁguration API Version 2013-06-30 95 AWS Storage Gateway Amazon S3 File Gateway User Guide • To grant access to all users that successfully authenticate through Active Directory, select All AD-authenticated users. • To allow or deny access to speciﬁc users or groups, choose Speciﬁc AD-authenticated users or groups, then do the following: • For Allowed users and groups, choose Add allowed user or Add allowed group and enter an Active Directory user or group that you want to allow ﬁle share access. Repeat this process to allow as many users and groups as necessary • For Denied users and groups, choose Add denied user or Add denied group and enter an Active Directory user or group that you want to deny ﬁle share access. Repeat this process to deny as many users and groups as necessary. Note The User and group ﬁle share access section appears only if User authentication is set to Active Directory. When specifying users or groups, do not include the domain. The domain name is implied by the membership of the gateway in the speciﬁc Active Directory to which it is joined. 20. (Optional) For Admin users, enter a comma-separated list of Active Directory users and groups. Admin users receive privileges to update access control lists (ACLs) on all ﬁles and folders in the ﬁle share. Groups must be preﬁxed with the @ character, for example, @group1. 21. For Access type, select one of the following: • To allow clients to read and write ﬁles on the ﬁle share, select Read/Write. • To allow clients to read ﬁles but not write to the ﬁle share, select Read-only. Note For ﬁle shares that are mounted on a Microsoft Windows client, if you choose Read- only, you might see a message about an unexpected error keeping you from creating the folder. You can ignore this message. 22. For File and directory access control, select one of the following: Create SMB ﬁle share with custom conﬁguration API Version 2013-06-30 96 AWS Storage Gateway Amazon S3 File Gateway User Guide • To set ﬁne-grained permissions on ﬁles and folders in your SMB ﬁle share, select Windows Access Control List. For more information, see Using Microsoft Windows ACLs to Control Access to an SMB
storagegateway-s3file-ug-039	storagegateway-s3file-ug.pdf	39	ﬁle shares that are mounted on a Microsoft Windows client, if you choose Read- only, you might see a message about an unexpected error keeping you from creating the folder. You can ignore this message. 22. For File and directory access control, select one of the following: Create SMB ﬁle share with custom conﬁguration API Version 2013-06-30 96 AWS Storage Gateway Amazon S3 File Gateway User Guide • To set ﬁne-grained permissions on ﬁles and folders in your SMB ﬁle share, select Windows Access Control List. For more information, see Using Microsoft Windows ACLs to Control Access to an SMB File Share. • To use POSIX permissions to control access to ﬁles and directories that are stored through your SMB ﬁle share, choose POSIX permissions. 23. For Access based enumeration, do one of the following: • To make the ﬁles and folders on the share visible only to users who have read access, select Hide ﬁles and directories where user doesn't have permission. • To make the ﬁles and folders on the share visible to all users during directory enumeration, don't select the check box. Note Access-based enumeration is a system that ﬁlters the enumeration of ﬁles and folders on an SMB ﬁle share based on the share's access control lists (ACLs). 24. For File access options, select one of the following: • To optimize the ﬁle share’s ﬁle buﬀering strategy using opportunistic locking, select Opportunistic lock. In most cases, activating opportunistic locking improves performance, particularly with regard to Windows context menus. • To allow the gateway - rather than the SMB client - to control ﬁle name case sensitivity, select Force case sensitivity. • To deactivate both settings, select Neither. Note To avoid ﬁle access conﬂicts, these settings are mutually exclusive and cannot be activated at the same time. 25. (Optional) For Automated cache refresh from S3, choose Set cache refresh interval, then set the time in Minutes or Days to refresh the ﬁle share's cache using Time To Live (TTL). TTL is the length of time since the last refresh. After the TTL interval has elapsed, accessing a Create SMB ﬁle share with custom conﬁguration API Version 2013-06-30 97 AWS Storage Gateway Amazon S3 File Gateway User Guide directory causes the File Gateway to refresh that directory's contents from the Amazon S3 bucket. Note Setting this value shorter than 30 minutes can negatively impact gateway performance in situations where large numbers of Amazon S3 objects are frequently created or deleted. 26. For File ownership and permissions, select Give the S3 bucket owner full ownership of ﬁles created by the gateway, including read, write, edit, and delete permissions if you want the AWS account that owns the S3 bucket to have full control of all objects written to the bucket by your ﬁle share. Choose Next when ﬁnished. 27. Review the ﬁle share conﬁguration. Choose Edit to modify the settings for any section that you want to change. When ﬁnished, choose Create. After your SMB ﬁle share is created, you can view its conﬁguration settings in the AWS Storage Gateway console on the ﬁle share's Details tab. For instructions to mount your ﬁle share, see Mount your SMB ﬁle share on your client. Create SMB ﬁle share with custom conﬁguration API Version 2013-06-30 98 AWS Storage Gateway Amazon S3 File Gateway User Guide Mounting and using your ﬁle share The topics in this section provide instructions about how to mount your ﬁle share on your client, use your ﬁle share, test your File Gateway, and clean up resources that are no longer needed, such as the gateways, Amazon EC2 instances, or and on-premises VMs that you might create for testing purposes. For more information about supported Network File System (NFS) and Service Message Block (SMB) clients, see Supported NFS and SMB clients for File Gateway. Note The AWS Management Console also provides example commands that you can use to mount your ﬁle share. Topics • Mount your NFS ﬁle share on your client - Learn how to mount your NFS ﬁle share on a drive on your client and map it to your Amazon S3 bucket. • Mount your SMB ﬁle share on your client - Learn how to mount your SMB ﬁle share and map to a drive accessible to your client. • Using ﬁle shares on buckets with pre-existing objects - Learn how to export a ﬁle share on an Amazon S3 bucket with objects created outside of the File Gateway using either NFS or SMB. • Test your S3 File Gateway - Learn how to test your gateway by copying ﬁles and folders to your mapped drive and verifying that they appear in your Amazon S3 bucket automatically. Mount your NFS ﬁle share on your client Use the following procedure to mount your NFS ﬁle share

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.