Package software.amazon.awscdk.services.datasync

Interface CfnLocationFSxONTAPProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLocationFSxONTAPProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:14.309Z")
@Stability(Stable)
public interface CfnLocationFSxONTAPProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnLocationFSxONTAP.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.datasync.*;
 CfnLocationFSxONTAPProps cfnLocationFSxONTAPProps = CfnLocationFSxONTAPProps.builder()
         .securityGroupArns(List.of("securityGroupArns"))
         .storageVirtualMachineArn("storageVirtualMachineArn")
         // the properties below are optional
         .protocol(ProtocolProperty.builder()
                 .nfs(NFSProperty.builder()
                         .mountOptions(NfsMountOptionsProperty.builder()
                                 .version("version")
                                 .build())
                         .build())
                 .smb(SMBProperty.builder()
                         .mountOptions(SmbMountOptionsProperty.builder()
                                 .version("version")
                                 .build())
                         .password("password")
                         .user("user")
                         // the properties below are optional
                         .domain("domain")
                         .build())
                 .build())
         .subdirectory("subdirectory")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLocationFSxONTAPProps.Builder	A builder for CfnLocationFSxONTAPProps
static final class	CfnLocationFSxONTAPProps.Jsii$Proxy	An implementation for CfnLocationFSxONTAPProps

Method Summary

Modifier and Type	Method	Description
static CfnLocationFSxONTAPProps.Builder	builder()
default Object	getProtocol()	Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.
List<String>	getSecurityGroupArns()	Specifies the Amazon Resource Names (ARNs) of the security groups that DataSync can use to access your FSx for ONTAP file system.
String	getStorageVirtualMachineArn()	Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.
default String	getSubdirectory()	Specifies a path to the file share in the SVM where you'll copy your data.
default List<CfnTag>	getTags()	Specifies labels that help you categorize, filter, and search for your AWS resources.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSecurityGroupArns

@Stability(Stable)
@NotNull
List<String> getSecurityGroupArns()

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 Also:

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

getStorageVirtualMachineArn

@Stability(Stable)
@NotNull
String getStorageVirtualMachineArn()

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

See Also:

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

getProtocol

@Stability(Stable)
@Nullable
default Object getProtocol()

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

See Also:

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

getSubdirectory

@Stability(Stable)
@Nullable
default String getSubdirectory()

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 .

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 .

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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 Also:

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

builder

@Stability(Stable)
static CfnLocationFSxONTAPProps.Builder builder()

Returns:

a CfnLocationFSxONTAPProps.Builder of CfnLocationFSxONTAPProps