Package software.amazon.awscdk.services.datasync

Interface CfnLocationFSxWindowsProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnLocationFSxWindowsProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.181Z") @Stability(Stable) public interface CfnLocationFSxWindowsProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnLocationFSxWindows.

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.*;
 CfnLocationFSxWindowsProps cfnLocationFSxWindowsProps = CfnLocationFSxWindowsProps.builder()
         .securityGroupArns(List.of("securityGroupArns"))
         .user("user")
         // the properties below are optional
         .domain("domain")
         .fsxFilesystemArn("fsxFilesystemArn")
         .password("password")
         .subdirectory("subdirectory")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Method Details

    • getSecurityGroupArns

      @Stability(Stable) @NotNull List<String> getSecurityGroupArns()
      The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Windows File Server 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.

    • getUser

      @Stability(Stable) @NotNull String getUser()
      The user who has the permissions to access files and folders in the FSx for Windows File Server file system.

      For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user .

    • getDomain

      @Stability(Stable) @Nullable default String getDomain()
      Specifies the name of the Windows domain that the FSx for Windows File Server belongs to.

    • getFsxFilesystemArn

      @Stability(Stable) @Nullable default String getFsxFilesystemArn()
      Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.

    • getPassword

      @Stability(Stable) @Nullable default String getPassword()
      Specifies the password of the user who has the permissions to access files and folders in the file system.

    • getSubdirectory

      @Stability(Stable) @Nullable default String getSubdirectory()
      Specifies a mount path for your file system using forward slashes.

      This is where DataSync reads or writes data (depending on if this is a source or destination location).

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      Specifies labels that help you categorize, filter, and search for your AWS resources.

      We recommend creating at least a name tag for your location.

    • builder

      @Stability(Stable) static CfnLocationFSxWindowsProps.Builder builder()
      Returns:
      a CfnLocationFSxWindowsProps.Builder of CfnLocationFSxWindowsProps