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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.872Z")
 @Stability(value=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()
         .fsxFilesystemArn("fsxFilesystemArn")
         .password("password")
         .securityGroupArns(List.of("securityGroupArns"))
         .user("user")
         // the properties below are optional
         .domain("domain")
         .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 String	getDomain() The name of the Windows domain that the FSx for Windows File Server belongs to.
String	getFsxFilesystemArn() The Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
String	getPassword() The password of the user who has the permissions to access files and folders in the FSx for Windows File Server 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() A subdirectory in the location's path.
default List<CfnTag>	getTags() The key-value pair that represents a tag that you want to add to the resource.
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 Detail

getFsxFilesystemArn

@Stability(value=Stable)
 @NotNull
String getFsxFilesystemArn()

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

getPassword

@Stability(value=Stable)
 @NotNull
String getPassword()

The password of the user who has the permissions to access files and folders in the FSx for Windows File Server file system.

getSecurityGroupArns

@Stability(value=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(value=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(value=Stable)
 @Nullable
default String getDomain()

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

getSubdirectory

@Stability(value=Stable)
 @Nullable
default String getSubdirectory()

A subdirectory in the location's path.

This subdirectory in the Amazon FSx for Windows File Server file system is used to read data from the Amazon FSx for Windows File Server source location or write data to the FSx for Windows File Server destination.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> 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.

builder

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

Returns:

a CfnLocationFSxWindowsProps.Builder of CfnLocationFSxWindowsProps