Skip to content

Latest commit

 

History

History
38 lines (34 loc) · 4.01 KB

io.md

File metadata and controls

38 lines (34 loc) · 4.01 KB
Raw

Inputs

Name Description Type Default Required
address_allocation_ids 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. list(string) [] no
attributes Additional attributes (e.g. 1). list(any) 
[
  "transfer"
]
 no
domain Where your files are stored. S3 or EFS string "S3" no
domain_name Domain to use when connecting to the SFTP endpoint string "" no
eip_enabled Whether to provision and attach an Elastic IP to be used as the SFTP endpoint. An EIP will be provisioned per subnet. bool false no
enable_sftp Set to false to prevent the module from creating any resources. bool true no
enable_workflow n/a bool false no
enabled Set to false to prevent the module from creating any resources. bool true no
environment Environment (e.g. prod, dev, staging). string "" no
force_destroy Forces the AWS Transfer Server to be destroyed bool false no
identity_provider_type The mode of authentication enabled for this service. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the service. API_GATEWAY. string "SERVICE_MANAGED" no
label_order Label order, e.g. name,application. list(any) [] no
managedby ManagedBy, eg 'CloudDrove'. string "hello@clouddrove.com" no
name Name (e.g. app or cluster). string "" no
repository Terraform current module repo string "https://github.com/clouddrove/terraform-aws-sftp" no
restricted_home Restricts SFTP users so they only have access to their home directories. bool true no
retention_in_days Specifies the number of days you want to retain log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, 3653, and 0. If you select 0, the events in the log group are always retained and never expire. number 3 no
s3_bucket_name This is the bucket that the SFTP users will use when managing files string n/a yes
security_policy_name 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. string "TransferSecurityPolicy-2018-11" no
sftp_users List of SFTP usernames and public keys. The keys user_name, public_key are required. The keys s3_bucket_name are optional. any {} no
subnet_ids 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. list(string) [] no
vpc_id VPC ID string null no
vpc_security_group_ids 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. list(string) [] no
workflow_details Workflow details for triggering the execution on file upload. 
object({
    on_upload = object({
      execution_role = string
      workflow_id    = string
    })
  })
 n/a yes
zone_id Route53 Zone ID to add the CNAME string "" no

Outputs

Name Description
id The Server ID of the Transfer Server (e.g. s-12345678).
tags A mapping of tags to assign to the resource.
transfer_server_endpoint The endpoint of the Transfer Server (e.g. s-12345678.server.transfer.REGION.amazonaws.com).