terraform-aws-transfer-sftp-user

Terraform Module Registry

Terraform module to manage AWS transfer service user

Directory mappings are not fully supported currently

Usage

Basic usage of this module is as follows:

module "example" {
    source = "notablehealth/<module-name>/aws"
    # Recommend pinning every module to a specific version
    # version = "x.x.x"

    # Required variables
        aws_transfer_server_id =
        s3_bucket_name =
        sftp_user =
}

Requirements

Name	Version
terraform	~> 1.5.7
aws	~> 5.64

Providers

Name	Version
aws	5.31.0

Modules

Name	Source	Version
iam_label	cloudposse/label/null	0.25.0
label	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_iam_policy.s3_access_for_sftp_users	resource
aws_iam_role.s3_access_for_sftp_users	resource
aws_s3_object.additional_directories	resource
aws_s3_object.home_directory	resource
aws_transfer_ssh_key.self	resource
aws_transfer_user.self	resource
aws_iam_policy_document.assume_role_policy	data source
aws_iam_policy_document.s3_access_for_sftp_users	data source

Inputs

Name	Description	Type	Default	Required
aws_transfer_server_id	AWS Transfer Server ID	string	n/a	yes
create_home_folder	Create S3 object for user home folder	bool	false	no
s3_bucket_name	Name of the default S3 bucket	string	n/a	yes
sftp_user	Map of sftp user objects	object({ user_name = string, public_key = optional(set(string), []), add_directories = optional(set(string), []), home_directory = optional(string), home_directory_mappings = optional(list(object({ entry = string, target = string })), []), policy = optional(string), restricted_home = optional(bool, true), role = optional(string), s3_bucket_name = optional(string), tags = optional(map(string)), })	n/a	yes

Outputs

Name	Description
directory_mappings	Home directory mappings for the user