aws-cdk-lib.aws_transfer.CfnUser.HomeDirectoryMapEntryProperty

HomeDirectoryMapEntryProperty Struct

Represents an object that contains entries and targets for HomeDirectoryMappings .

Source

Generated code

Type last changed

v2.114.0 · 5 Dec 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_transfer as transfer } from 'aws-cdk-lib';
const homeDirectoryMapEntryProperty: transfer.CfnUser.HomeDirectoryMapEntryProperty = {
  entry: 'entry',
  target: 'target',

  // the properties below are optional
  type: 'type',
};

Properties

entrystringentrystrentryStringEntrystringEntry*stringrequired#

Represents an entry for `HomeDirectoryMappings` .

targetstringtargetstrtargetStringTargetstringTarget*stringrequired#

Represents the map target that is used in a `HomeDirectoryMapEntry` .

type?optionalstringtype?optionalstrtype?optionalStringType?optionalstringType?optional*string#

Specifies the type of mapping.

notes

Set the type to FILE if you want the mapping to point to a file, or DIRECTORY for the directory to point to a directory.

By default, home directory mappings have a Type of DIRECTORY when you create a Transfer Family server. You would need to explicitly set Type to FILE if you want a mapping to have a file target.