AWS::DataSync::LocationFSxONTAP - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

AWS::DataSync::LocationFSxONTAP

The AWS::DataSync::LocationFSxONTAP resource creates an endpoint for an Amazon FSx for NetApp ONTAP file system. AWS DataSync can access this endpoint as a source or destination location.

Syntax

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

JSON

{
  "Type" : "AWS::DataSync::LocationFSxONTAP",
  "Properties" : {
      "Protocol" : Protocol,
      "SecurityGroupArns" : [ String, ... ],
      "StorageVirtualMachineArn" : String,
      "Subdirectory" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::DataSync::LocationFSxONTAP
Properties:
  Protocol: 
    Protocol
  SecurityGroupArns: 
    - String
  StorageVirtualMachineArn: String
  Subdirectory: String
  Tags: 
    - Tag

Properties

Protocol

Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.

Required: No

Type: Protocol

Update requires: Replacement

SecurityGroupArns

Specifies the Amazon Resource Names (ARNs) of the security groups that DataSync can use to access your FSx for ONTAP file system. You must configure the security groups to allow outbound traffic on the following ports (depending on the protocol that you're using):

  • Network File System (NFS): TCP ports 111, 635, and 2049

  • Server Message Block (SMB): TCP port 445

Your file system's security groups must also allow inbound traffic on the same port.

Required: Yes

Type: Array of String

Minimum: 1

Maximum: 128 | 5

Update requires: Replacement

StorageVirtualMachineArn

Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.

Required: Yes

Type: String

Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:storage-virtual-machine/fs-[0-9a-f]+/svm-[0-9a-f]{17,}$

Maximum: 162

Update requires: Replacement

Subdirectory

Specifies a path to the file share in the SVM where you want to transfer data to or from.

You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be /vol1, /vol1/tree1, or /share1.

Note

Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.

Required: No

Type: String

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

Maximum: 4096

Update requires: Replacement

Tags

Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least a name tag for your location.

Required: No

Type: Array of Tag

Minimum: 0

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.

FsxFilesystemArn

The ARN of the FSx for ONTAP file system in the specified location.

LocationArn

The ARN of the specified location.

LocationUri

The URI of the specified location.

Examples

Creating an FSx for ONTAP location with NFS access

The following example creates a location for an FSx for ONTAP file system that DataSync can access using NFS.

JSON

{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Description": "Specifies a location for an Amazon FSx for ONTAP file system that DataSync can access using NFS.",
    "Resources": {
        "LocationFSxONTAP": {
            "Type": "AWS::DataSync::LocationFSxONTAP",
            "Properties": {
                "Protocol": {
                    "NFS": {
                        "MountOptions": {
                            "Version": "NFS3"
                        }
                    }
                },
                "SecurityGroupArns": [
                    "arn:aws:ec2:us-east-2:11122233344:security-group/sg-1234567890abcdef2"
                ],
                "StorageVirtualMachineArn": "arn:aws:fsx:us-east-1:11122233344:storage-virtual-machine/fs-abcdef01234567890/svm-021345abcdef6789",
                "Subdirectory": "/vol1"
            }
        }
    }
}

YAML

AWSTemplateFormatVersion: 2010-09-09
Description: Specifies a location for an Amazon FSx for ONTAP file system that DataSync can access using NFS.
Resources:
  LocationFSxONTAP:
    Type: AWS::DataSync::LocationFSxONTAP
      Properties:
        Protocol:
          NFS:
            MountOptions:
              Version: NFS3
        SecurityGroupArns: 
          - arn:aws:ec2:us-east-2:11122233344:security-group/sg-1234567890abcdef2
        StorageVirtualMachineArn: arn:aws:fsx:us-east-1:11122233344:storage-virtual-machine/fs-abcdef01234567890/svm-021345abcdef6789
        Subdirectory: /vol1

Creating an FSx for ONTAP location with SMB access

The following example creates a location for an FSx for ONTAP file system that DataSync can access using SMB.

JSON

{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Description": "Specifies a location for an Amazon FSx for ONTAP file system that DataSync can access using SMB.",
    "Resources": {
        "LocationFSxONTAP": {
            "Type": "AWS::DataSync::LocationFSxONTAP",
            "Properties": {
                "Protocol": {
                    "SMB": {
                        "Domain": "example.company",
                        "MountOptions": {
                            "Version": "AUTOMATIC"
                        },
                        "Password": "examplepassword",
                        "User": "exampleusername"
                    }
                },
                "SecurityGroupArns": [
                    "arn:aws:ec2:us-east-2:11122233344:security-group/sg-1234567890abcdef2"
                ],
                "StorageVirtualMachineArn": "arn:aws:fsx:us-east-1:11122233344:storage-virtual-machine/fs-abcdef01234567890/svm-021345abcdef6789",
                "Subdirectory": "/vol1"
            }
        }
    }
}

YAML

AWSTemplateFormatVersion: 2010-09-09
Description: Specifies a location for an Amazon FSx for ONTAP file system that DataSync can access using SMB.
Resources:
  LocationFSxONTAP:
    Type: AWS::DataSync::LocationFSxONTAP
      Properties: 
        Protocol:
          SMB:
            Domain: example.company
            MountOptions:
              Version: AUTOMATIC
            Password: examplepassword
            User: exampleusername
        SecurityGroupArns: 
          - arn:aws:ec2:us-east-2:11122233344:security-group/sg-1234567890abcdef2
        StorageVirtualMachineArn: arn:aws:fsx:us-east-1:11122233344:storage-virtual-machine/fs-abcdef01234567890/svm-021345abcdef6789
        Subdirectory: /vol1