AWS::Transfer::User

Transfer User

Definition of AWS::Transfer::User Resource Type

Properties

10 configurable properties. 3 required. Click a row to see details.

Filter:

Property	Type	Flags
`Role`	`string`	Required
`ServerId`	`string`	RequiredCreate-only
`UserName`	`string`	RequiredCreate-only
`HomeDirectory`	`string`
`HomeDirectoryMappings`	`Array<HomeDirectoryMapEntry>`
`HomeDirectoryType`	`string`
`Policy`	`string`
`PosixProfile`	`PosixProfile`
`SshPublicKeys`	`Array<string>`
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Arn`	`string`	-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Transfer::User

Resources:
  MyResource:
    Type: AWS::Transfer::User
    Properties:
      Role: "value"
      ServerId: "my-serverid"
      UserName: "my-username"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

iam:PassRoletransfer:CreateUsertransfer:DescribeUsertransfer:ImportSshPublicKeytransfer:TagResource

read

transfer:DescribeUser

update

iam:PassRoletransfer:DeleteSshPublicKeytransfer:DescribeUsertransfer:ImportSshPublicKeytransfer:TagResourcetransfer:UnTagResourcetransfer:UpdateUser

delete

transfer:DeleteUser

list

transfer:ListUsers

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceTransfer

Properties11

Required3

TaggingSupported

Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ServerIdUserName

Related Resources

External Links

AWS Documentation