CfnLocationFSxONTAPProps

class aws_cdk.aws_datasync.CfnLocationFSxONTAPProps(*, security_group_arns, storage_virtual_machine_arn, protocol=None, subdirectory=None, tags=None)

Bases: object

Properties for defining a CfnLocationFSxONTAP.

Parameters:

security_group_arns (Sequence[str]) – 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.
storage_virtual_machine_arn (str) – Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.
protocol (Union[IResolvable, ProtocolProperty, Dict[str, Any], None]) – Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.
subdirectory (Optional[str]) – Specifies a path to the file share in the SVM where you’ll copy your data. 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 . .. epigraph:: 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 .
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least a name tag for your location.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datasync as datasync

cfn_location_fSx_oNTAPProps = datasync.CfnLocationFSxONTAPProps(
    security_group_arns=["securityGroupArns"],
    storage_virtual_machine_arn="storageVirtualMachineArn",

    # the properties below are optional
    protocol=datasync.CfnLocationFSxONTAP.ProtocolProperty(
        nfs=datasync.CfnLocationFSxONTAP.NFSProperty(
            mount_options=datasync.CfnLocationFSxONTAP.NfsMountOptionsProperty(
                version="version"
            )
        ),
        smb=datasync.CfnLocationFSxONTAP.SMBProperty(
            mount_options=datasync.CfnLocationFSxONTAP.SmbMountOptionsProperty(
                version="version"
            ),
            password="password",
            user="user",

            # the properties below are optional
            domain="domain"
        )
    ),
    subdirectory="subdirectory",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

protocol

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html#cfn-datasync-locationfsxontap-protocol

security_group_arns

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html#cfn-datasync-locationfsxontap-securitygrouparns

storage_virtual_machine_arn

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html#cfn-datasync-locationfsxontap-storagevirtualmachinearn

subdirectory

Specifies a path to the file share in the SVM where you’ll copy your data.

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 . .. epigraph:

Don't specify a junction path in the SVM's root volume. For more information, see `Managing FSx for ONTAP storage virtual machines <https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html>`_ in the *Amazon FSx for NetApp ONTAP User Guide* .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html#cfn-datasync-locationfsxontap-subdirectory

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html#cfn-datasync-locationfsxontap-tags