1.204.0

interface CfnLocationFSxWindowsProps

LanguageType name
.NETAmazon.CDK.AWS.DataSync.CfnLocationFSxWindowsProps
Javasoftware.amazon.awscdk.services.datasync.CfnLocationFSxWindowsProps
Pythonaws_cdk.aws_datasync.CfnLocationFSxWindowsProps
TypeScript @aws-cdk/aws-datasync » 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 * as datasync from '@aws-cdk/aws-datasync';
const cfnLocationFSxWindowsProps: datasync.CfnLocationFSxWindowsProps = {
  securityGroupArns: ['securityGroupArns'],
  user: 'user',

  // the properties below are optional
  domain: 'domain',
  fsxFilesystemArn: 'fsxFilesystemArn',
  password: 'password',
  subdirectory: 'subdirectory',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
securityGroupArnsstring[]The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Windows File Server file system.
userstringThe user who has the permissions to access files and folders in the FSx for Windows File Server file system.
domain?stringSpecifies the name of the Windows domain that the FSx for Windows File Server belongs to.
fsxFilesystemArn?stringSpecifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
password?stringSpecifies the password of the user who has the permissions to access files and folders in the file system.
subdirectory?stringSpecifies a mount path for your file system using forward slashes.
tags?CfnTag[]Specifies labels that help you categorize, filter, and search for your AWS resources.

securityGroupArns

Type: string[]

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.

user

Type: string

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 .

domain?

Type: string (optional)

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

fsxFilesystemArn?

Type: string (optional)

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

password?

Type: string (optional)

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

subdirectory?

Type: string (optional)

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

tags?

Type: CfnTag[] (optional)

Specifies labels that help you categorize, filter, and search for your AWS resources.

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

← PreviousNext →