CfnLocationFSxONTAP

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

Bases: CfnResource

A CloudFormation 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.

CloudformationResource:: AWS::DataSync::LocationFSxONTAP
Link:: 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.
import aws_cdk.aws_datasync as datasync

cfn_location_fSx_oNTAP = datasync.CfnLocationFSxONTAP(self, "MyCfnLocationFSxONTAP",
    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"
    )]
)

Create a new AWS::DataSync::LocationFSxONTAP.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:: attribute_name (str) – The name of the attribute.
Return type:: Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) –

tree inspector to collect and process attributes.

Return type:

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::DataSync::LocationFSxONTAP'

attr_fsx_filesystem_arn

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

CloudformationAttribute:: FsxFilesystemArn

attr_location_arn

The ARN of the specified location.

CloudformationAttribute:: LocationArn

attr_location_uri

The URI of the specified location.

CloudformationAttribute:: LocationUri

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The construct tree node associated with this construct.

protocol

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

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

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

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.

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

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.

Link:: 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* .

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

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

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

NFSProperty

class CfnLocationFSxONTAP.NFSProperty(*, mount_options)

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]]) – Specifies how DataSync can access a location using the NFS protocol.
Link:: 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.
import aws_cdk.aws_datasync as datasync

n_fSProperty = datasync.CfnLocationFSxONTAP.NFSProperty(
    mount_options=datasync.CfnLocationFSxONTAP.NfsMountOptionsProperty(
        version="version"
    )
)

Attributes

mount_options

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

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

NfsMountOptionsProperty

class CfnLocationFSxONTAP.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.
Link:: 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.
import aws_cdk.aws_datasync as datasync

nfs_mount_options_property = datasync.CfnLocationFSxONTAP.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.

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

ProtocolProperty

class CfnLocationFSxONTAP.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.

Link:

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.
import aws_cdk.aws_datasync as datasync

protocol_property = 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"
    )
)

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).

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

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

SMBProperty

class CfnLocationFSxONTAP.SMBProperty(*, mount_options, password, user, domain=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:

mount_options (Union[IResolvable, SmbMountOptionsProperty, Dict[str, Any]]) – Specifies how DataSync can access a location using the SMB protocol.
password (str) – Specifies the password of a user who has permission to access your SVM.
user (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 .
domain (Optional[str]) – Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.

Link:

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.
import aws_cdk.aws_datasync as datasync

s_mBProperty = datasync.CfnLocationFSxONTAP.SMBProperty(
    mount_options=datasync.CfnLocationFSxONTAP.SmbMountOptionsProperty(
        version="version"
    ),
    password="password",
    user="user",

    # the properties below are optional
    domain="domain"
)

Attributes

domain

Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.

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

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

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

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

SmbMountOptionsProperty

class CfnLocationFSxONTAP.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 .
Link:: 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.
import aws_cdk.aws_datasync as datasync

smb_mount_options_property = datasync.CfnLocationFSxONTAP.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 .

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