View a markdown version of this page

AWS::Transfer::User HomeDirectoryMapEntry - AWS CloudFormation
SyntaxProperties

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Transfer::User HomeDirectoryMapEntry

Represents an object that contains entries and targets for HomeDirectoryMappings.

The following is an Entry and Target pair example for chroot.

[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Entry" : String,
  "Target" : String,
  "Type" : String
}

YAML

  Entry: String
  Target: String
  Type: String

Properties

Entry

Represents an entry for HomeDirectoryMappings.

Required: Yes

Type: String

Pattern: ^/.*$

Minimum: 0

Maximum: 1024

Update requires: No interruption

Target

Represents the map target that is used in a HomeDirectoryMapEntry.

Required: Yes

Type: String

Pattern: ^/.*$

Minimum: 0

Maximum: 1024

Update requires: No interruption

Type

Specifies the type of mapping. 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.

Note

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.

Required: No

Type: String

Allowed values: FILE | DIRECTORY

Update requires: No interruption