CfnLocationFSxONTAPPropsMixin

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

Bases: Mixin

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html
CloudformationResource:: AWS::DataSync::LocationFSxONTAP
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_fSx_oNTAPProps_mixin = datasync_mixins.CfnLocationFSxONTAPPropsMixin(datasync_mixins.CfnLocationFSxONTAPMixinProps(
    protocol=datasync_mixins.CfnLocationFSxONTAPPropsMixin.ProtocolProperty(
        nfs=datasync_mixins.CfnLocationFSxONTAPPropsMixin.NFSProperty(
            mount_options=datasync_mixins.CfnLocationFSxONTAPPropsMixin.NfsMountOptionsProperty(
                version="version"
            )
        ),
        smb=datasync_mixins.CfnLocationFSxONTAPPropsMixin.SMBProperty(
            domain="domain",
            mount_options=datasync_mixins.CfnLocationFSxONTAPPropsMixin.SmbMountOptionsProperty(
                version="version"
            ),
            password="password",
            user="user"
        )
    ),
    security_group_arns=["securityGroupArns"],
    storage_virtual_machine_arn="storageVirtualMachineArn",
    subdirectory="subdirectory",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnLocationFSxONTAPMixinProps, 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 = ['protocol', 'securityGroupArns', 'storageVirtualMachineArn', '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

NFSProperty

class CfnLocationFSxONTAPPropsMixin.NFSProperty(*, mount_options=None)

Bases: object

Specifies the Network File System (NFS) protocol configuration that AWS DataSync uses to access a storage virtual machine (SVM) on your Amazon FSx for NetApp ONTAP file system.

For more information, see Accessing FSx for ONTAP file systems .

Parameters:: mount_options (Union[IResolvable, NfsMountOptionsProperty, Dict[str, Any], None]) – Specifies how DataSync can access a location using the NFS protocol.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-nfs.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

n_fSProperty = datasync_mixins.CfnLocationFSxONTAPPropsMixin.NFSProperty(
    mount_options=datasync_mixins.CfnLocationFSxONTAPPropsMixin.NfsMountOptionsProperty(
        version="version"
    )
)

Attributes

mount_options

Specifies how DataSync can access a location using the NFS protocol.

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

NfsMountOptionsProperty

class CfnLocationFSxONTAPPropsMixin.NfsMountOptionsProperty(*, version=None)

Bases: object

Specifies how DataSync can access a location using the NFS protocol.

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-locationfsxontap-nfsmountoptions.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

nfs_mount_options_property = datasync_mixins.CfnLocationFSxONTAPPropsMixin.NfsMountOptionsProperty(
    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-locationfsxontap-nfsmountoptions.html#cfn-datasync-locationfsxontap-nfsmountoptions-version

ProtocolProperty

class CfnLocationFSxONTAPPropsMixin.ProtocolProperty(*, nfs=None, smb=None)

Bases: object

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

Parameters:

nfs (Union[IResolvable, NFSProperty, Dict[str, Any], None]) – Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for ONTAP file system’s storage virtual machine (SVM).
smb (Union[IResolvable, SMBProperty, Dict[str, Any], None]) – Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system’s SVM.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-protocol.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

protocol_property = datasync_mixins.CfnLocationFSxONTAPPropsMixin.ProtocolProperty(
    nfs=datasync_mixins.CfnLocationFSxONTAPPropsMixin.NFSProperty(
        mount_options=datasync_mixins.CfnLocationFSxONTAPPropsMixin.NfsMountOptionsProperty(
            version="version"
        )
    ),
    smb=datasync_mixins.CfnLocationFSxONTAPPropsMixin.SMBProperty(
        domain="domain",
        mount_options=datasync_mixins.CfnLocationFSxONTAPPropsMixin.SmbMountOptionsProperty(
            version="version"
        ),
        password="password",
        user="user"
    )
)

Attributes

nfs

Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for ONTAP file system’s storage virtual machine (SVM).

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

smb

Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system’s SVM.

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

SMBProperty

class CfnLocationFSxONTAPPropsMixin.SMBProperty(*, domain=None, mount_options=None, password=None, user=None)

Bases: object

Specifies the Server Message Block (SMB) protocol configuration that AWS DataSync uses to access a storage virtual machine (SVM) on your Amazon FSx for NetApp ONTAP file system.

For more information, see Accessing FSx for ONTAP file systems .

Parameters:

domain (Optional[str]) – Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to. If you have multiple domains in your environment, configuring this setting makes sure that DataSync connects to the right SVM. If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.
mount_options (Union[IResolvable, SmbMountOptionsProperty, Dict[str, Any], None]) – Specifies how DataSync can access a location using the SMB protocol.
password (Optional[str]) – Specifies the password of a user who has permission to access your SVM.
user (Optional[str]) – Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM. If you provide a user in your Active Directory, note the following: - If you’re using AWS Directory Service for Microsoft Active Directory , the user must be a member of the AWS Delegated FSx Administrators group. - If you’re using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system. Make sure that the user has the permissions it needs to copy the data you want: - SE_TCB_NAME : Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs). - SE_SECURITY_NAME : May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.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

s_mBProperty = datasync_mixins.CfnLocationFSxONTAPPropsMixin.SMBProperty(
    domain="domain",
    mount_options=datasync_mixins.CfnLocationFSxONTAPPropsMixin.SmbMountOptionsProperty(
        version="version"
    ),
    password="password",
    user="user"
)

Attributes

domain

Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.

If you have multiple domains in your environment, configuring this setting makes sure that DataSync connects to the right SVM.

If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html#cfn-datasync-locationfsxontap-smb-domain

mount_options

Specifies how DataSync can access a location using the SMB protocol.

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

password

Specifies the password of a user who has permission to access your SVM.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html#cfn-datasync-locationfsxontap-smb-password

user

Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.

If you provide a user in your Active Directory, note the following:

If you’re using AWS Directory Service for Microsoft Active Directory , the user must be a member of the AWS Delegated FSx Administrators group.
If you’re using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.

Make sure that the user has the permissions it needs to copy the data you want:

SE_TCB_NAME : Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).
SE_SECURITY_NAME : May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html#cfn-datasync-locationfsxontap-smb-user

SmbMountOptionsProperty

class CfnLocationFSxONTAPPropsMixin.SmbMountOptionsProperty(*, version=None)

Bases: object

Specifies the version of the Server Message Block (SMB) protocol that AWS DataSync uses to access an SMB file server.

Parameters:: version (Optional[str]) – By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically. These are the following options for configuring the SMB version: - AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1. This is the recommended option. If you instead choose a specific version that your file server doesn’t support, you may get an Operation Not Supported error. - SMB3 : Restricts the protocol negotiation to only SMB version 3.0.2. - SMB2 : Restricts the protocol negotiation to only SMB version 2.1. - SMB2_0 : Restricts the protocol negotiation to only SMB version 2.0. - SMB1 : Restricts the protocol negotiation to only SMB version 1.0. .. epigraph:: The SMB1 option isn’t available when creating an Amazon FSx for NetApp ONTAP location .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smbmountoptions.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

smb_mount_options_property = datasync_mixins.CfnLocationFSxONTAPPropsMixin.SmbMountOptionsProperty(
    version="version"
)

Attributes

version

By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server.

You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.

These are the following options for configuring the SMB version:

AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1.

This is the recommended option. If you instead choose a specific version that your file server doesn’t support, you may get an Operation Not Supported error.

SMB3 : Restricts the protocol negotiation to only SMB version 3.0.2.
SMB2 : Restricts the protocol negotiation to only SMB version 2.1.
SMB2_0 : Restricts the protocol negotiation to only SMB version 2.0.
SMB1 : Restricts the protocol negotiation to only SMB version 1.0.

The SMB1 option isn’t available when creating an Amazon FSx for NetApp ONTAP location .

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