software.amazon.awscdk.services.datasync

Class CfnLocationFSxOpenZFS

java.lang.Object

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:14.858Z")
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")
         .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();
 

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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnLocationFSxOpenZFS(Construct scope, java.lang.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
java.lang.String	getAttrLocationArn() The ARN of the specified FSx for OpenZFS file system location.
java.lang.String	getAttrLocationUri() The URI of the specified FSx for OpenZFS file system location.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getFsxFilesystemArn() The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.
java.lang.Object	getProtocol() The type of protocol that AWS DataSync uses to access your file system.
java.util.List<java.lang.String>	getSecurityGroupArns() The ARNs of the security groups that are used to configure the FSx for OpenZFS file system.
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setFsxFilesystemArn(java.lang.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(java.util.List<java.lang.String> value) The ARNs of the security groups that are used to configure the FSx for OpenZFS file system.
void	setSubdirectory(java.lang.String value) A subdirectory in the location's path that must begin with `/fsx` .

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnLocationFSxOpenZFS(Construct scope,
                             java.lang.String id,
                             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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrLocationArn

public java.lang.String getAttrLocationArn()

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

getAttrLocationUri

public java.lang.String getAttrLocationUri()

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

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

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.

getProtocol

public java.lang.Object getProtocol()

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

setProtocol

public void setProtocol(IResolvable value)

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

setProtocol

public void setProtocol(CfnLocationFSxOpenZFS.ProtocolProperty value)

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

getSecurityGroupArns

public java.util.List<java.lang.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

public void setSecurityGroupArns(java.util.List<java.lang.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.

getFsxFilesystemArn

public java.lang.String getFsxFilesystemArn()

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

setFsxFilesystemArn

public void setFsxFilesystemArn(java.lang.String value)

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

getSubdirectory

public java.lang.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

public void setSubdirectory(java.lang.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).