Package software.amazon.awscdk.services.datasync

Interface CfnLocationFSxOpenZFSProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLocationFSxOpenZFSProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:05.126Z")
@Stability(Stable)
public interface CfnLocationFSxOpenZFSProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnLocationFSxOpenZFS.

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.*;
 CfnLocationFSxOpenZFSProps cfnLocationFSxOpenZFSProps = CfnLocationFSxOpenZFSProps.builder()
         .protocol(ProtocolProperty.builder()
                 .nfs(NFSProperty.builder()
                         .mountOptions(MountOptionsProperty.builder()
                                 .version("version")
                                 .build())
                         .build())
                 .build())
         .securityGroupArns(List.of("securityGroupArns"))
         // the properties below are optional
         .fsxFilesystemArn("fsxFilesystemArn")
         .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-locationfsxopenzfs.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnLocationFSxOpenZFSProps.Builder	builder()
default String	getFsxFilesystemArn()	The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.
Object	getProtocol()	The type of protocol that AWS DataSync uses to access your file system.
List<String>	getSecurityGroupArns()	The ARNs of the security groups that are used to configure the FSx for OpenZFS file system.
default String	getSubdirectory()	A subdirectory in the location's path that must begin with /fsx .
default List<CfnTag>	getTags()	The key-value pair that represents a tag that you want to add to the resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getProtocol

@Stability(Stable)
@NotNull
Object getProtocol()

The type of protocol that AWS DataSync uses to access your file system.

See Also:

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

getSecurityGroupArns

@Stability(Stable)
@NotNull
List<String> getSecurityGroupArns()

The ARNs of the security groups that are used to configure the FSx for OpenZFS file system.

Pattern : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/.*$

Length constraints : Maximum length of 128.

See Also:

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

getFsxFilesystemArn

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

The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.

See Also:

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

getSubdirectory

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

A subdirectory in the location's path that must begin with /fsx .

DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location).

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The key-value pair that represents a tag that you want to add to the resource.

The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.

See Also:

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

builder

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

Returns:

a CfnLocationFSxOpenZFSProps.Builder of CfnLocationFSxOpenZFSProps