# AWS S3 SMB File share Terraform sub-module
Creates an SMB file share backed by S3. For an end to end example on VMware, refer to the [s3filegateway-vmware](../../examples/s3filegateway-vmware/) example.
## Requirements
| Name | Version |
|------|---------|
| [terraform](#requirement\_terraform) | >= 1.0.7 |
| [aws](#requirement\_aws) | >= 4.0.0 |
| [awscc](#requirement\_awscc) | >= 0.24.0 |
## Providers
| Name | Version |
|------|---------|
| [aws](#provider\_aws) | >= 4.0.0 |
## Modules
No modules.
## Resources
| Name | Type |
|------|------|
| [aws_storagegateway_smb_file_share.smbshare](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/storagegateway_smb_file_share) | resource |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [bucket\_arn](#input\_bucket\_arn) | Storage Gateway ARN | `string` | n/a | yes |
| [gateway\_arn](#input\_gateway\_arn) | Storage Gateway ARN | `string` | n/a | yes |
| [log\_group\_arn](#input\_log\_group\_arn) | Cloudwatch Log Group ARN for audit logs | `string` | n/a | yes |
| [role\_arn](#input\_role\_arn) | The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage. | `string` | n/a | yes |
| [share\_name](#input\_share\_name) | Name of the smb file share | `string` | n/a | yes |
| [admin\_user\_list](#input\_admin\_user\_list) | A list of users in the Active Directory that have admin access to the file share. | `list(any)` | [
"Domain Admins"
]
| no |
| [cache\_timout](#input\_cache\_timout) | Cache stale timeout for automated cache refresh in seconds. Default is set to 1 hour (3600 seconds) can be changed to as low as 5 minutes (300 seconds) | `number` | `"3600"` | no |
| [kms\_encrypted](#input\_kms\_encrypted) | (Optional) Boolean value if true to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Defaults to false | `bool` | `false` | no |
| [kms\_key\_arn](#input\_kms\_key\_arn) | (Optional) Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when kms\_encrypted is true. | `string` | `null` | no |
| [storage\_class](#input\_storage\_class) | Storage class for SMB file share. Valid options are S3\_STANDARD \| S3\_INTELLIGENT\_TIERING \| S3\_STANDARD\_IA \| S3\_ONEZONE\_IA | `string` | `"S3_STANDARD"` | no |
| [tags](#input\_tags) | (Optional) Key-value map of resource tags. | `map(any)` | `{}` | no |
## Outputs
| Name | Description |
|------|-------------|
| [smb\_share\_arn](#output\_smb\_share\_arn) | The ARN of the created SMB File Share. |
| [smb\_share\_path](#output\_smb\_share\_path) | The path of the created SMB File Share. |