software.amazon.awscdk.services.datasync

Interface CfnLocationFSxWindowsProps

All Known Implementing Classes:

CfnLocationFSxWindowsProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:21.351Z")
public interface CfnLocationFSxWindowsProps

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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnLocationFSxWindowsProps.Builder	builder()
default java.lang.String	getDomain() Specifies the name of the Windows domain that the FSx for Windows File Server belongs to.
default java.lang.String	getFsxFilesystemArn() Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
default java.lang.String	getPassword() Specifies the password of the user who has the permissions to access files and folders in the file system.
java.util.List<java.lang.String>	getSecurityGroupArns() The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Windows File Server file system.
default java.lang.String	getSubdirectory() Specifies a mount path for your file system using forward slashes.
default java.util.List<CfnTag>	getTags() Specifies labels that help you categorize, filter, and search for your AWS resources.
java.lang.String	getUser() The user who has the permissions to access files and folders in the FSx for Windows File Server file system.

Method Detail

getSecurityGroupArns

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

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

default java.lang.String getDomain()

Specifies the name of the Windows domain that the FSx for Windows File Server belongs to.

getFsxFilesystemArn

default java.lang.String getFsxFilesystemArn()

Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.

getPassword

default java.lang.String getPassword()

Specifies the password of the user who has the permissions to access files and folders in the file system.

getSubdirectory

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

default java.util.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

static CfnLocationFSxWindowsProps.Builder builder()

Returns:

a CfnLocationFSxWindowsProps.Builder of CfnLocationFSxWindowsProps