Package software.amazon.awscdk.services.datasync

Class CfnLocationFSxONTAP

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.datasync.CfnLocationFSxONTAP
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, ILocationFSxONTAPRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:37.826Z") @Stability(Stable) public class CfnLocationFSxONTAP extends CfnResource implements IInspectable, ILocationFSxONTAPRef, ITaggable
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();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnLocationFSxONTAPProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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

    • getLocationFSxOntapRef

      @Stability(Stable) @NotNull public LocationFSxONTAPReference getLocationFSxOntapRef()
      A reference to a LocationFSxONTAP resource.
      Specified by:
      getLocationFSxOntapRef in interface ILocationFSxONTAPRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

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

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

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

      Returns union: either IResolvable or CfnLocationFSxONTAP.ProtocolProperty

    • 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 want to transfer data to or from.

    • setSubdirectory

      @Stability(Stable) public void setSubdirectory(@Nullable String value)
      Specifies a path to the file share in the SVM where you want to transfer data to or from.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Specifies labels that help you categorize, filter, and search for your AWS resources.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Specifies labels that help you categorize, filter, and search for your AWS resources.