AWS::DataSync::LocationNFS - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamples
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::DataSync::LocationNFS

The AWS::DataSync::LocationNFS resource specifies a file system on a Network File System (NFS) server that can be read from or written to.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::DataSync::LocationNFS",
  "Properties" : {
      "MountOptions" : MountOptions,
      "OnPremConfig" : OnPremConfig,
      "ServerHostname" : String,
      "Subdirectory" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::DataSync::LocationNFS
Properties: 
  MountOptions: 
    MountOptions
  OnPremConfig: 
    OnPremConfig
  ServerHostname: String
  Subdirectory: String
  Tags: 
    - Tag

Properties

MountOptions

The NFS mount options that DataSync can use to mount your NFS share.

Required: No

Type: MountOptions

Update requires: No interruption

OnPremConfig

Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.

If you are copying data to or from your Amazon Snowcone device, see NFS Server on Amazon Snowcone for more information.

Required: Yes

Type: OnPremConfig

Update requires: No interruption

ServerHostname

The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An agent that is installed on-premises uses this hostname to mount the NFS server in a network.

If you are copying data to or from your Amazon Snowcone device, see NFS Server on Amazon Snowcone for more information.

Note

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

Required: No

Type: String

Maximum: 255

Pattern: ^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$

Update requires: Replacement

Subdirectory

The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network.

To see all the paths exported by your NFS server, run "showmount -e nfs-server-name" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication.

To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with no_root_squash, or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.

If you are copying data to or from your Amazon Snowcone device, see NFS Server on Amazon Snowcone for more information.

For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.

Required: No

Type: String

Maximum: 4096

Pattern: ^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]+$

Update requires: No interruption

Tags

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Required: No

Type: List of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the location resource ARN. For example:

arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

LocationArn

The Amazon Resource Name (ARN) of the specified source NFS file system location.

LocationUri

The URI of the specified source NFS location.

Examples

Create a NFS location for DataSync

The following example specifies an NFS location for DataSync, using a source and destination location. In this example, the server hostname is MyServer@example.com, using NFS version 4.0, in the subdirectory /MySubdirectory.

JSON

{
"AWSTemplateFormatVersion": "2010-09-09",
"Description": "Specifies an NFS location for DataSync",
"Resources": 
  "LocationNFS": {
    "Type": "AWS::DataSync::LocationNFS",
    "Properties": {
      "MountOptions": {
        "Version": "NFS4_0"
      },
      "OnPremConfig": {
        "AgentArns": [
          "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs"
        ]
      },
      "ServerHostname": "MyServer@example.com",
      "Subdirectory": "/MySubdirectory"
    }
  }
}

YAML


AWSTemplateFormatVersion: 2010-09-09
Description: Specifies an NFS location for DataSync
Resources:
LocationNFS:
  Type: AWS::DataSync::LocationNFS
  Properties: 
    MountOptions: 
      Version: NFS4_0
    OnPremConfig: 
      AgentArns: 
        - arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs
    ServerHostname: MyServer@example.com
    Subdirectory: /MySubdirectory