Package software.amazon.awscdk.services.datasync

Class CfnLocationFSxONTAP

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.datasync.CfnLocationFSxONTAP
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.171Z") @Stability(Stable) public class CfnLocationFSxONTAP extends CfnResource implements IInspectable
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.

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.*;
 CfnLocationFSxONTAP cfnLocationFSxONTAP = CfnLocationFSxONTAP.Builder.create(this, "MyCfnLocationFSxONTAP")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnLocationFSxONTAP

      protected CfnLocationFSxONTAP(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnLocationFSxONTAP

      protected CfnLocationFSxONTAP(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnLocationFSxONTAP

      @Stability(Stable) public CfnLocationFSxONTAP(@NotNull Construct scope, @NotNull String id, @NotNull CfnLocationFSxONTAPProps props)
      Create a new AWS::DataSync::LocationFSxONTAP.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrFsxFilesystemArn

      @Stability(Stable) @NotNull public String getAttrFsxFilesystemArn()
      The ARN of the FSx for ONTAP file system in the specified location.

    • getAttrLocationArn

      @Stability(Stable) @NotNull public String getAttrLocationArn()
      The ARN of the specified location.

    • getAttrLocationUri

      @Stability(Stable) @NotNull public String getAttrLocationUri()
      The URI of the specified location.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager 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.

    • getSecurityGroupArns

      @Stability(Stable) @NotNull public 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.

    • setSecurityGroupArns

      @Stability(Stable) public void setSecurityGroupArns(@NotNull List<String> value)
      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.

    • getStorageVirtualMachineArn

      @Stability(Stable) @NotNull public String getStorageVirtualMachineArn()
      Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.

    • setStorageVirtualMachineArn

      @Stability(Stable) public void setStorageVirtualMachineArn(@NotNull String value)
      Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.

    • getProtocol

      @Stability(Stable) @Nullable public Object getProtocol()
      Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.

    • setProtocol

      @Stability(Stable) public void setProtocol(@Nullable IResolvable value)
      Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.

    • setProtocol

      @Stability(Stable) public void setProtocol(@Nullable CfnLocationFSxONTAP.ProtocolProperty value)
      Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.

    • getSubdirectory

      @Stability(Stable) @Nullable public 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 .

    • setSubdirectory

      @Stability(Stable) public void setSubdirectory(@Nullable String value)
      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 .