transfer-sftp
cloudposse/transfer-sftp/aws
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. > [!TIP] > #### 👽 Use Atmos with Terraform > Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform. > Works with Github Actions, Atlantis, or Spacelift. > > > Watch demo of using Atmos with Terraform > > Example of running atmos to manage infrastructure from our Quick Start tutorial. > 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. ``hcl module "example" { source = "https://github.com/cloudposse/terraform-aws-transfer-sftp.git?ref=master" example
| Name | Type | Description | Default |
|---|---|---|---|
| s3_bucket_name | string | This is the bucket that the SFTP users will use when managing files | |
| subnet_ids | list(string) | A list of subnet IDs that are required to host your SFTP server endpoint in your | [] |
| attributes | list(string) | ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`, | [] |
| regex_replace_chars | string | Terraform regular expression (regex) string. Characters matching the regex will | null |
| sftp_users | map(object({ user_name | Map of SFTP users and their configurations. Required: user_name, public_key. Opt | {} |
| address_allocation_ids | list(string) | A list of address allocation IDs that are required to attach an Elastic IP addre | [] |
| vpc_security_group_ids | list(string) | A list of security groups IDs that are available to attach to your server's endp | [] |
| name | string | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. Thi | null |
| labels_as_tags | set(string) | Set of labels (ID elements) to include as tags in the `tags` output. Default is | [
"default"
] |
| additional_tag_map | map(string) | Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not add | {} |
| label_order | list(string) | The order in which the labels (ID elements) appear in the `id`. Defaults to ["na | null |
| descriptor_formats | any | Describe additional descriptors to be output in the `descriptors` output map. Ma | {} |
| force_destroy | bool | Forces the AWS Transfer Server to be destroyed | false |
| eip_enabled | bool | Whether to provision and attach an Elastic IP to be used as the SFTP endpoint. A | false |
| stage | string | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'bu | null |
| delimiter | string | Delimiter to be used between ID elements. Defaults to `-` (hyphen). Set to `""` | null |
| security_policy_name | string | Specifies the name of the security policy that is attached to the server. Possib | "TransferSecurityPolicy-2018-11" |
| enabled | bool | Set to false to prevent the module from creating any resources | null |
| tenant | string | ID element _(Rarely used, not included by default)_. A customer identifier, indi | null |
| vpc_id | string | VPC ID that the AWS Transfer Server will be deployed to | null |
| namespace | string | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp' | null |
id — ID of the created exampletransfer_endpoint — The endpoint of the Transfer Serverelastic_ips — Provisioned Elastic IPss3_access_role_arns — Role ARNs for the S3 accessendpoint_details — Endpoints detailsarn — ARN of the created Transfer Serverhost_key_fingerprint — The message-digest algorithm (MD5) hash of the Transfer Server's host key