Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

AWS Storage Gateway Terraform sub-module

Deploys a Storage Gateway on AWS, configures Storage Gateway cache and maps it to a local storage disk. Requires the Storage Gateway appliance to be deployed first using the module vmware-sgw or the ec2-sgw. For an end to end examples refer to the examples directory

AWS Storage Gateway types

  • Amazon S3 File Gateway (FILE_S3)
  • Amazon FSx File Gateway (FILE_FSX_SMB)
  • Tape Gateway (VTL)
  • Volume Gateway (CACHED, STORED)

The module requires a Gateway Type to be declared with a default set to FILE_S3. For more details regarding the Storage Gateway types and their respective arguments can be found here

Requirements

Name Version
terraform >= 1.0.7
aws >= 4.0.0
awscc >= 0.24.0

Providers

Name Version
aws >= 4.0.0

Modules

No modules.

Resources

Name Type
aws_security_group.vpce_sg resource
aws_security_group_rule.vpce_1031 resource
aws_security_group_rule.vpce_2222 resource
aws_security_group_rule.vpce_443 resource
aws_security_group_rule.vpce_dynamic resource
aws_storagegateway_cache.sgw resource
aws_storagegateway_gateway.mysgw resource
aws_vpc_endpoint.sgw_vpce resource
aws_region.current data source
aws_storagegateway_local_disk.sgw data source

Inputs

Name Description Type Default Required
gateway_ip_address IP Address of the SGW appliance in vSphere string n/a yes
gateway_name Storage Gateway Name string n/a yes
create_vpc_endpoint Create an interface VPC endpoint for the Storage Gateway bool false no
create_vpc_endpoint_security_group Create a Security Group for the VPC Endpoint for Storage Gateway appliance. bool false no
disk_node Disk node on the SGW appliance where the cache disk resides on the OS string "/dev/sdb" no
disk_path Disk path on the SGW appliance where the cache disk resides on the OS string "/dev/sdb" no
domain_controllers List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389. list(any) [] no
domain_name The name of the domain that you want the gateway to join string "" no
domain_password The password for the service account on your self-managed AD domain that SGW will use to join to your AD domain string "" no
domain_username The user name for the service account on your self-managed AD domain that SGW use to join to your AD domain string "" no
gateway_private_ip_address Inbound IP address of Gateway VM appliance for Security Group associated with VPC Endpoint. Must be set if create_vpc_endpoint=true string null no
gateway_type Type of the gateway. Valid options are FILE_S3, FILE_FSX_SMB, VTL, CACHED, STORED string "FILE_S3" no
gateway_vpc_endpoint Existing VPC endpoint address to be used when activating your gateway. This variable value will be ignored if setting create_vpc_endpoint=true. string null no
join_smb_domain Setting for controlling whether to join the Storage gateway to an Active Directory (AD) domain for Server Message Block (SMB) file shares. Variables domain_controllers, domain_name, password and username should also be specified to join AD domain. bool true no
organizational_unit The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain. string "" no
timeout_in_seconds Specifies the time in seconds, in which the JoinDomain operation must complete. The default is 20 seconds. number -1 no
timezone Time zone for the gateway. The time zone is of the format GMT, GMT-hr:mm, or GMT+hr:mm.For example, GMT-4:00 indicates the time is 4 hours behind GMT. Avoid prefixing with 0 string "GMT" no
vpc_endpoint_private_dns_enabled Enable private DNS for VPC Endpoint bool false no
vpc_endpoint_security_group_id Optionally provide an existing Security Group ID to associate with the VPC Endpoint. Must be set if create_vpc_endpoint_security_group=false string null no
vpc_endpoint_subnet_ids Provide existing subnet IDs to associate with the VPC Endpoint. Must provide a valid values if create_vpc_endpoint=true. list(string) null no
vpc_id VPC id for creating a VPC endpoint. Must provide a valid value if create_vpc_endpoint=true. string null no

Outputs

Name Description
storage_gateway Storage Gateway Module
storage_gateway_name Storage Gateway Name