Package software.amazon.awscdk.services.datasync

Class CfnLocationNFS

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.CfnLocationNFS
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, ILocationNFSRef, 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.840Z") @Stability(Stable) public class CfnLocationNFS extends CfnResource implements IInspectable, ILocationNFSRef, ITaggable
The AWS::DataSync::LocationNFS resource specifies a Network File System (NFS) file server that AWS DataSync can use as a transfer source or destination.

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.*;
 CfnLocationNFS cfnLocationNFS = CfnLocationNFS.Builder.create(this, "MyCfnLocationNFS")
         .onPremConfig(OnPremConfigProperty.builder()
                 .agentArns(List.of("agentArns"))
                 .build())
         // the properties below are optional
         .mountOptions(MountOptionsProperty.builder()
                 .version("version")
                 .build())
         .serverHostname("serverHostname")
         .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

    • CfnLocationNFS

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

    • CfnLocationNFS

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

    • CfnLocationNFS

      @Stability(Stable) public CfnLocationNFS(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLocationNFSProps 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.

    • getAttrLocationArn

      @Stability(Stable) @NotNull public String getAttrLocationArn()
      The Amazon Resource Name (ARN) of the NFS location that you created.

    • getAttrLocationUri

      @Stability(Stable) @NotNull public String getAttrLocationUri()
      The URI of the NFS location that you created.

    • getCfnProperties

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

    • getLocationNfsRef

      @Stability(Stable) @NotNull public LocationNFSReference getLocationNfsRef()
      A reference to a LocationNFS resource.
      Specified by:
      getLocationNfsRef in interface ILocationNFSRef

    • getTags

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

    • getOnPremConfig

      @Stability(Stable) @NotNull public Object getOnPremConfig()
      Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect to your NFS file server.

      Returns union: either IResolvable or CfnLocationNFS.OnPremConfigProperty

    • setOnPremConfig

      @Stability(Stable) public void setOnPremConfig(@NotNull IResolvable value)
      Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect to your NFS file server.

    • setOnPremConfig

      @Stability(Stable) public void setOnPremConfig(@NotNull CfnLocationNFS.OnPremConfigProperty value)
      Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect to your NFS file server.

    • getMountOptions

      @Stability(Stable) @Nullable public Object getMountOptions()
      Specifies the options that DataSync can use to mount your NFS file server.

      Returns union: either IResolvable or CfnLocationNFS.MountOptionsProperty

    • setMountOptions

      @Stability(Stable) public void setMountOptions(@Nullable IResolvable value)
      Specifies the options that DataSync can use to mount your NFS file server.

    • setMountOptions

      @Stability(Stable) public void setMountOptions(@Nullable CfnLocationNFS.MountOptionsProperty value)
      Specifies the options that DataSync can use to mount your NFS file server.

    • getServerHostname

      @Stability(Stable) @Nullable public String getServerHostname()
      Specifies the DNS name or IP address (IPv4 or IPv6) of the NFS file server that your DataSync agent connects to.

    • setServerHostname

      @Stability(Stable) public void setServerHostname(@Nullable String value)
      Specifies the DNS name or IP address (IPv4 or IPv6) of the NFS file server that your DataSync agent connects to.

    • getSubdirectory

      @Stability(Stable) @Nullable public String getSubdirectory()
      Specifies the export path in your NFS file server that you want DataSync to mount.

    • setSubdirectory

      @Stability(Stable) public void setSubdirectory(@Nullable String value)
      Specifies the export path in your NFS file server that you want DataSync to mount.

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