Package software.amazon.awscdk.services.datasync

Class CfnLocationFSxOpenZFS

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.177Z") @Stability(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")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnLocationFSxOpenZFS

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

    • CfnLocationFSxOpenZFS

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

    • CfnLocationFSxOpenZFS

      @Stability(Stable) public CfnLocationFSxOpenZFS(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrLocationArn()
      The ARN of the specified FSx for OpenZFS file system location.

    • getAttrLocationUri

      @Stability(Stable) @NotNull public String getAttrLocationUri()
      The URI of the specified FSx for OpenZFS file system location.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

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

    • getProtocol

      @Stability(Stable) @NotNull public Object getProtocol()
      The type of protocol that AWS DataSync uses to access your file system.

    • setProtocol

      @Stability(Stable) public void setProtocol(@NotNull IResolvable value)
      The type of protocol that AWS DataSync uses to access your file system.

    • setProtocol

      @Stability(Stable) public void setProtocol(@NotNull CfnLocationFSxOpenZFS.ProtocolProperty value)
      The type of protocol that AWS DataSync uses to access your file system.

    • getSecurityGroupArns

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

    • getFsxFilesystemArn

      @Stability(Stable) @Nullable public String getFsxFilesystemArn()
      The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.

    • setFsxFilesystemArn

      @Stability(Stable) public void setFsxFilesystemArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.

    • getSubdirectory

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