CfnLocationNFSPropsMixin

class aws_cdk.mixins_preview.aws_datasync.mixins.CfnLocationNFSPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::DataSync::LocationNFS resource specifies a Network File System (NFS) file server that AWS DataSync can use as a transfer source or destination.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html
CloudformationResource:: AWS::DataSync::LocationNFS
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_datasync import mixins as datasync_mixins

cfn_location_nFSProps_mixin = datasync_mixins.CfnLocationNFSPropsMixin(datasync_mixins.CfnLocationNFSMixinProps(
    mount_options=datasync_mixins.CfnLocationNFSPropsMixin.MountOptionsProperty(
        version="version"
    ),
    on_prem_config=datasync_mixins.CfnLocationNFSPropsMixin.OnPremConfigProperty(
        agent_arns=["agentArns"]
    ),
    server_hostname="serverHostname",
    subdirectory="subdirectory",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::DataSync::LocationNFS.

Parameters:

props (Union[CfnLocationNFSMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['mountOptions', 'onPremConfig', 'serverHostname', 'subdirectory', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

MountOptionsProperty

class CfnLocationNFSPropsMixin.MountOptionsProperty(*, version=None)

Bases: object

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

Parameters:: version (Optional[str]) – Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails. You can specify the following options: - AUTOMATIC (default): DataSync chooses NFS version 4.1. - NFS3 : Stateless protocol version that allows for asynchronous writes on the server. - NFSv4_0 : Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems. - NFSv4_1 : Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0. .. epigraph:: DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationnfs-mountoptions.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.mixins_preview.aws_datasync import mixins as datasync_mixins

mount_options_property = datasync_mixins.CfnLocationNFSPropsMixin.MountOptionsProperty(
    version="version"
)

Attributes

version

Specifies the NFS version that you want DataSync to use when mounting your NFS share.

If the server refuses to use the version specified, the task fails.

You can specify the following options:

AUTOMATIC (default): DataSync chooses NFS version 4.1.
NFS3 : Stateless protocol version that allows for asynchronous writes on the server.
NFSv4_0 : Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.
NFSv4_1 : Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.

DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.

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

OnPremConfigProperty

class CfnLocationNFSPropsMixin.OnPremConfigProperty(*, agent_arns=None)

Bases: object

The AWS DataSync agents that can connect to your Network File System (NFS) file server.

Parameters:: agent_arns (Optional[Sequence[str]]) – The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your NFS file server. You can specify more than one agent. For more information, see Using multiple DataSync agents .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationnfs-onpremconfig.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.mixins_preview.aws_datasync import mixins as datasync_mixins

on_prem_config_property = datasync_mixins.CfnLocationNFSPropsMixin.OnPremConfigProperty(
    agent_arns=["agentArns"]
)

Attributes

agent_arns

The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your NFS file server.

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

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