Package software.amazon.awscdk.services.datasync

Interface CfnLocationNFSProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLocationNFSProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:59.616Z")
@Stability(Stable)
public interface CfnLocationNFSProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnLocationNFS.

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.*;
 CfnLocationNFSProps cfnLocationNFSProps = CfnLocationNFSProps.builder()
         .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:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnLocationNFSProps.Builder	builder()
default Object	getMountOptions()	Specifies the options that DataSync can use to mount your NFS file server.
Object	getOnPremConfig()	Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect to your NFS file server.
default String	getServerHostname()	Specifies the Domain Name System (DNS) name or IP version 4 address of the NFS file server that your DataSync agent connects to.
default String	getSubdirectory()	Specifies the export path in your NFS file server that you want DataSync to mount.
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

getOnPremConfig

@Stability(Stable)
@NotNull
Object getOnPremConfig()

Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect to your NFS file server.

You can specify more than one agent. For more information, see Using multiple DataSync agents .

See Also:

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

getMountOptions

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

Specifies the options that DataSync can use to mount your NFS file server.

See Also:

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

getServerHostname

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

Specifies the Domain Name System (DNS) name or IP version 4 address of the NFS file server that your DataSync agent connects to.

See Also:

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

getSubdirectory

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

Specifies the export path in your NFS file server that you want DataSync to mount.

This path (or a subdirectory of the path) is where DataSync transfers data to or from. For information on configuring an export for DataSync, see Accessing NFS file servers .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html#cfn-datasync-locationnfs-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-locationnfs.html#cfn-datasync-locationnfs-tags

builder

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

Returns:

a CfnLocationNFSProps.Builder of CfnLocationNFSProps