AWS::Transfer::User HomeDirectoryMapEntry - AWS CloudFormation

AWS::Transfer::User HomeDirectoryMapEntry

Represents an object that contains entries and targets for HomeDirectoryMappings.

Syntax

To declare this entity in your AWS 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

Update requires: No interruption

Target

Represents the map target that is used in a HomeDirectoryMapEntry.

Required: Yes

Type: String

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

Update requires: No interruption

See also

HomeDirectoryMapEntry in the AWS Transfer Family User Guide.