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.89.0 (build 2f74b3e)",
           date="2023-11-02T10:21:16.173Z")
@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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html#cfn-datasync-locationfsxwindows-securitygrouparns

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html#cfn-datasync-locationfsxwindows-user

getDomain

@Stability(Stable)
@Nullable
default String getDomain()

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

If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

For more information, see required permissions for FSx for Windows File Server locations.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html#cfn-datasync-locationfsxwindows-domain

getFsxFilesystemArn

@Stability(Stable)
@Nullable
default String getFsxFilesystemArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html#cfn-datasync-locationfsxwindows-fsxfilesystemarn

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.

For more information, see required permissions for FSx for Windows File Server locations.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html#cfn-datasync-locationfsxwindows-password

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html#cfn-datasync-locationfsxwindows-subdirectory

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html#cfn-datasync-locationfsxwindows-tags

builder

@Stability(Stable)
static CfnLocationFSxWindowsProps.Builder builder()

Returns:

a CfnLocationFSxWindowsProps.Builder of CfnLocationFSxWindowsProps