CfnLocationNFSProps

class aws_cdk.aws_datasync.CfnLocationNFSProps(*, on_prem_config, mount_options=None, server_hostname=None, subdirectory=None, tags=None)

Bases: object

Properties for defining a CfnLocationNFS.

Parameters:
  • on_prem_config (Union[IResolvable, OnPremConfigProperty, Dict[str, Any]]) – Specifies the Amazon Resource Name (ARN) of the DataSync agent that want to connect to your NFS file server. You can specify more than one agent. For more information, see Using multiple agents for transfers .

  • mount_options (Union[IResolvable, MountOptionsProperty, Dict[str, Any], None]) – Specifies the options that DataSync can use to mount your NFS file server.

  • server_hostname (Optional[str]) – Specifies the Domain Name System (DNS) name or IP version 4 address of the NFS file server that your DataSync agent connects to.

  • subdirectory (Optional[str]) – Specifies the export path in your NFS file server that you want DataSync to mount. This path (or a subdirectory of the path) is where DataSync transfers data to or from. For information on configuring an export for DataSync, see Accessing NFS file servers .

  • 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-locationnfs.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_nFSProps = datasync.CfnLocationNFSProps(
    on_prem_config=datasync.CfnLocationNFS.OnPremConfigProperty(
        agent_arns=["agentArns"]
    ),

    # the properties below are optional
    mount_options=datasync.CfnLocationNFS.MountOptionsProperty(
        version="version"
    ),
    server_hostname="serverHostname",
    subdirectory="subdirectory",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

mount_options

Specifies the options that DataSync can use to mount your NFS file server.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html#cfn-datasync-locationnfs-mountoptions

on_prem_config

Specifies the Amazon Resource Name (ARN) of the DataSync agent that want to connect to your NFS file server.

You can specify more than one agent. For more information, see Using multiple agents for transfers .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html#cfn-datasync-locationnfs-onpremconfig

server_hostname

Specifies the Domain Name System (DNS) name or IP version 4 address of the NFS file server that your DataSync agent connects to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html#cfn-datasync-locationnfs-serverhostname

subdirectory

Specifies the export path in your NFS file server that you want DataSync to mount.

This path (or a subdirectory of the path) is where DataSync transfers data to or from. For information on configuring an export for DataSync, see Accessing NFS file servers .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html#cfn-datasync-locationnfs-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-locationnfs.html#cfn-datasync-locationnfs-tags