diff --git a/README.md b/README.md index 3b9e0e0..bdc3881 100644 --- a/README.md +++ b/README.md @@ -91,20 +91,30 @@ Here is an example of how you can use this module in your inventory structure: | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| -| attributes | Additional attributes (e.g. `1`). | `list(any)` | `[]` | no | +| 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 | -| endpoint\_type | The type of endpoint that you want your SFTP server connect to. If you connect to a VPC (or VPC\_ENDPOINT), your SFTP server isn't accessible over the public internet. If you want to connect your SFTP server via public internet, set PUBLIC. Defaults to PUBLIC | `string` | `"PUBLIC"` | 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 | -| public\_key | Name (e.g. `ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD3F6tyPEFEzV0LX3X8BsXdMsQ`). | `string` | `""` | no | | repository | Terraform current module repo | `string` | `"https://github.com/clouddrove/terraform-aws-sftp"` | no | -| s3\_bucket\_id | The landing directory (folder) for a user when they log in to the server using their SFTP client. | `string` | n/a | yes | -| sub\_folder | Landind folder. | `string` | `""` | no | -| user\_name | User name for SFTP server. | `string` | n/a | yes | -| vpc\_id | VPC ID | `string` | `""` | no | +| restricted\_home | Restricts SFTP users so they only have access to their home directories. | `bool` | `true` | 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