software.amazon.awscdk.services.datasync

Class CfnLocationFSxOpenZFS

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

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.868Z")
 @Stability(value=Stable)
public class CfnLocationFSxOpenZFS
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DataSync::LocationFSxOpenZFS`.

The AWS::DataSync::LocationFSxOpenZFS resource specifies an endpoint for an Amazon FSx for OpenZFS file system.

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.*;
 CfnLocationFSxOpenZFS cfnLocationFSxOpenZFS = CfnLocationFSxOpenZFS.Builder.create(this, "MyCfnLocationFSxOpenZFS")
         .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	Class and Description
static class	CfnLocationFSxOpenZFS.Builder A fluent builder for CfnLocationFSxOpenZFS.
static interface	CfnLocationFSxOpenZFS.MountOptionsProperty Represents the mount options that are available for DataSync to access a Network File System (NFS) location.
static interface	CfnLocationFSxOpenZFS.NFSProperty Represents the Network File System (NFS) protocol that AWS DataSync uses to access your Amazon FSx for OpenZFS file system.
static interface	CfnLocationFSxOpenZFS.ProtocolProperty Represents the protocol that AWS DataSync uses to access your Amazon FSx for OpenZFS file system.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnLocationFSxOpenZFS(software.constructs.Construct scope, String id, CfnLocationFSxOpenZFSProps props) Create a new `AWS::DataSync::LocationFSxOpenZFS`.
protected	CfnLocationFSxOpenZFS(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnLocationFSxOpenZFS(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrLocationArn() The ARN of the specified FSx for OpenZFS file system location.
String	getAttrLocationUri() The URI of the specified FSx for OpenZFS file system location.
protected Map<String,Object>	getCfnProperties()
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.
String	getSubdirectory() A subdirectory in the location's path that must begin with `/fsx` .
TagManager	getTags() The key-value pair that represents a tag that you want to add to the resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setFsxFilesystemArn(String value) The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.
void	setProtocol(CfnLocationFSxOpenZFS.ProtocolProperty value) The type of protocol that AWS DataSync uses to access your file system.
void	setProtocol(IResolvable value) The type of protocol that AWS DataSync uses to access your file system.
void	setSecurityGroupArns(List<String> value) The ARNs of the security groups that are used to configure the FSx for OpenZFS file system.
void	setSubdirectory(String value) A subdirectory in the location's path that must begin with `/fsx` .

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnLocationFSxOpenZFS

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

CfnLocationFSxOpenZFS

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

CfnLocationFSxOpenZFS

@Stability(value=Stable)
public CfnLocationFSxOpenZFS(@NotNull
                                                      software.constructs.Construct scope,
                                                      @NotNull
                                                      String id,
                                                      @NotNull
                                                      CfnLocationFSxOpenZFSProps props)

Create a new `AWS::DataSync::LocationFSxOpenZFS`.

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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrLocationArn()

The ARN of the specified FSx for OpenZFS file system location.

getAttrLocationUri

@Stability(value=Stable)
 @NotNull
public String getAttrLocationUri()

The URI of the specified FSx for OpenZFS file system location.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager 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.

getFsxFilesystemArn

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

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

setFsxFilesystemArn

@Stability(value=Stable)
public void setFsxFilesystemArn(@NotNull
                                                         String value)

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

getProtocol

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

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

setProtocol

@Stability(value=Stable)
public void setProtocol(@NotNull
                                                 CfnLocationFSxOpenZFS.ProtocolProperty value)

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

setProtocol

@Stability(value=Stable)
public void setProtocol(@NotNull
                                                 IResolvable value)

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

getSecurityGroupArns

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

setSecurityGroupArns

@Stability(value=Stable)
public void setSecurityGroupArns(@NotNull
                                                          List<String> value)

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
public 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).

setSubdirectory

@Stability(value=Stable)
public void setSubdirectory(@Nullable
                                                     String value)

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