Package software.amazon.awscdk.services.datasync

Class CfnLocationNFS

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.CfnLocationNFS
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.199Z") @Stability(Stable) public class CfnLocationNFS extends CfnResource implements IInspectable
A CloudFormation AWS::DataSync::LocationNFS.

The AWS::DataSync::LocationNFS resource specifies a file system on a Network File System (NFS) server that can be read from or written to.

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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnLocationNFSProps props)
      Create a new AWS::DataSync::LocationNFS.

      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.

    • getAttrLocationArn

      @Stability(Stable) @NotNull public String getAttrLocationArn()
      The Amazon Resource Name (ARN) of the specified source NFS file system location.

    • getAttrLocationUri

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

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The key-value pair that represents the tag that you want to add to the location.

      The value can be an empty string. We recommend using tags to name your resources.

    • getOnPremConfig

      @Stability(Stable) @NotNull public Object getOnPremConfig()
      Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.

      If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

    • setOnPremConfig

      @Stability(Stable) public void setOnPremConfig(@NotNull IResolvable value)
      Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.

      If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

    • setOnPremConfig

      @Stability(Stable) public void setOnPremConfig(@NotNull CfnLocationNFS.OnPremConfigProperty value)
      Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.

      If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

    • getMountOptions

      @Stability(Stable) @Nullable public Object getMountOptions()
      The NFS mount options that DataSync can use to mount your NFS share.

    • setMountOptions

      @Stability(Stable) public void setMountOptions(@Nullable IResolvable value)
      The NFS mount options that DataSync can use to mount your NFS share.

    • setMountOptions

      @Stability(Stable) public void setMountOptions(@Nullable CfnLocationNFS.MountOptionsProperty value)
      The NFS mount options that DataSync can use to mount your NFS share.

    • getServerHostname

      @Stability(Stable) @Nullable public String getServerHostname()
      The name of the NFS server.

      This value is the IP address or Domain Name Service (DNS) name of the NFS server. An agent that is installed on-premises uses this hostname to mount the NFS server in a network.

      If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

      This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

    • setServerHostname

      @Stability(Stable) public void setServerHostname(@Nullable String value)
      The name of the NFS server.

      This value is the IP address or Domain Name Service (DNS) name of the NFS server. An agent that is installed on-premises uses this hostname to mount the NFS server in a network.

      If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

      This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

    • getSubdirectory

      @Stability(Stable) @Nullable public String getSubdirectory()
      The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination.

      The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network.

      To see all the paths exported by your NFS server, run " showmount -e nfs-server-name " from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication.

      To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with no_root_squash, or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.

      If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

      For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.

    • setSubdirectory

      @Stability(Stable) public void setSubdirectory(@Nullable String value)
      The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination.

      The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network.

      To see all the paths exported by your NFS server, run " showmount -e nfs-server-name " from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication.

      To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with no_root_squash, or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.

      If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

      For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.