Module: `transfer-sftp`

This is terraform-aws-transfer-sftp project provides all the scaffolding for a typical well-built Cloud Posse module. It's a template repository you can use when creating new repositories.

Usage

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

module "example" {
  source = "https://github.com/cloudposse/terraform-aws-transfer-sftp.git?ref=master"
  example = "Hello world!"
}

Examples

Here is an example of using this module:

examples/complete - complete example of using this module

Variables

Required Variables

s3_bucket_name (string) required: This is the bucket that the SFTP users will use when managing files

Optional Variables

address_allocation_ids (list(string)) optional

A list of address allocation IDs that are required to attach an Elastic IP address to your SFTP server's endpoint. This property can only be used when endpoint_type is set to VPC.

Default value: [ ]

domain (string) optional

Where your files are stored. S3 or EFS

Default value: "S3"

domain_name (string) optional

Domain to use when connecting to the SFTP endpoint

Default value: ""

eip_enabled (bool) optional

Whether to provision and attach an Elastic IP to be used as the SFTP endpoint. An EIP will be provisioned per subnet.

Default value: false

force_destroy (bool) optional

Forces the AWS Transfer Server to be destroyed

Default value: false

restricted_home (bool) optional

Restricts SFTP users so they only have access to their home directories.

Default value: true

security_policy_name (string) optional

Specifies the name of the security policy that is attached to the server. Possible values are TransferSecurityPolicy-2018-11, TransferSecurityPolicy-2020-06, and TransferSecurityPolicy-FIPS-2020-06. Default value is: TransferSecurityPolicy-2018-11.

Default value: "TransferSecurityPolicy-2018-11"

sftp_users optional

Map of SFTP users and their configurations. Required: user_name, public_key. Optional: s3_bucket_name, bucket_permissions, home_directory_type, home_directory, home_directory_mappings

Type:

map(object({
user_name           = string
public_key          = string
s3_bucket_name      = optional(string)
bucket_permissions  = optional(list(string))
home_directory_type = optional(string)
home_directory      = optional(string)
home_directory_mappings = optional(list(object({
  entry  = string
  target = string
})))
}))

Default value: { }

subnet_ids (list(string)) optional

A list of subnet IDs that are required to host your SFTP server endpoint in your VPC. This property can only be used when endpoint_type is set to VPC.

Default value: [ ]

vpc_id (string) optional

VPC ID that the AWS Transfer Server will be deployed to

Default value: null

vpc_security_group_ids (list(string)) optional

A list of security groups IDs that are available to attach to your server's endpoint. If no security groups are specified, the VPC's default security groups are automatically assigned to your endpoint. This property can only be used when endpoint_type is set to VPC.

Default value: [ ]

zone_id (string) optional

Route53 Zone ID to add the CNAME

Default value: ""

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.

Required: No

Default value: { }

attributes (list(string)) optional

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.

Required: No

Default value: [ ]

context (any) optional

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.

Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.

Required: No

Default value: null

label_key_case (string) optional

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.

Required: No

Default value: null

label_order (list(string)) optional

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.

Required: No

Default value: null

label_value_case (string) optional

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.

Required: No

Default value: null

labels_as_tags (set(string)) optional

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.

Required: No

Default value:

[
  "default"
]

name (string) optional

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

arn: ARN of the created Transfer Server
elastic_ips: Provisioned Elastic IPs
endpoint_details: Endpoints details
host_key_fingerprint: The message-digest algorithm (MD5) hash of the Transfer Server's host key
id: ID of the created example
s3_access_role_arns: Role ARNs for the S3 access
transfer_endpoint: The endpoint of the Transfer Server

Dependencies

Requirements

terraform, version: >= 1.1.0
aws, version: >= 3.0, != 4.0.0, != 4.1.0, != 4.2.0, != 4.3.0, != 4.4.0, != 4.5.0, != 4.6.0, != 4.7.0, != 4.8.0

Providers

aws, version: >= 3.0, != 4.0.0, != 4.1.0, != 4.2.0, != 4.3.0, != 4.4.0, != 4.5.0, != 4.6.0, != 4.7.0, != 4.8.0

Modules

Name	Version	Source	Description
`iam_label`	0.25.0	`cloudposse/label/null`	n/a
`logging_label`	0.25.0	`cloudposse/label/null`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

aws_eip.sftp (resource)
aws_iam_policy.logging (resource)
aws_iam_policy.s3_access_for_sftp_users (resource)
aws_iam_role.logging (resource)
aws_iam_role.s3_access_for_sftp_users (resource)
aws_iam_role_policy_attachment.logging (resource)
aws_iam_role_policy_attachment.s3_access_for_sftp_users (resource)
aws_route53_record.main (resource)
aws_transfer_server.default (resource)
aws_transfer_ssh_key.default (resource)
aws_transfer_user.default (resource)

Data Sources

The following data sources are used by this module:

aws_iam_policy_document.assume_role_policy (data source)
aws_iam_policy_document.logging (data source)
aws_iam_policy_document.s3_access_for_sftp_users (data source)
aws_partition.default (data source)
aws_s3_bucket.landing (data source)

Module: transfer-sftp

Usage​

Examples​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Module: `transfer-sftp`

Usage

Examples

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources