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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.870Z")
 @Stability(value=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()
         .fsxFilesystemArn("fsxFilesystemArn")
         .protocol(ProtocolProperty.builder()
                 .nfs(NFSProperty.builder()
                         .mountOptions(MountOptionsProperty.builder()
                                 .version("version")
                                 .build())
                         .build())
                 .build())
         .securityGroupArns(List.of("securityGroupArns"))
         // the properties below are optional
         .subdirectory("subdirectory")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnLocationFSxOpenZFSProps.Builder	builder()
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 Detail

getFsxFilesystemArn

@Stability(value=Stable)
 @NotNull
String getFsxFilesystemArn()

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

getProtocol

@Stability(value=Stable)
 @NotNull
Object getProtocol()

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

getSecurityGroupArns

@Stability(value=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.

getSubdirectory

@Stability(value=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).

getTags

@Stability(value=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.

builder

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

Returns:

a CfnLocationFSxOpenZFSProps.Builder of CfnLocationFSxOpenZFSProps