» Resource: aws_storagegateway_gateway

Manages an AWS Storage Gateway file, tape, or volume gateway in the provider region.

NOTE: The Storage Gateway API requires the gateway to be connected to properly return information after activation. If you are receiving The specified gateway is not connected errors during resource creation (gateway activation), ensure your gateway instance meets the Storage Gateway requirements.

» Example Usage

» File Gateway

resource "aws_storagegateway_gateway" "example" {
  gateway_ip_address = "1.2.3.4"
  gateway_name       = "example"
  gateway_timezone   = "GMT"
  gateway_type       = "FILE_S3"
}

» Tape Gateway

resource "aws_storagegateway_gateway" "example" {
  gateway_ip_address = "1.2.3.4"
  gateway_name       = "example"
  gateway_timezone   = "GMT"
  gateway_type       = "VTL"
  media_changer_type = "AWS-Gateway-VTL"
  tape_drive_type    = "IBM-ULT3580-TD5"
}

» Volume Gateway (Cached)

resource "aws_storagegateway_gateway" "example" {
  gateway_ip_address = "1.2.3.4"
  gateway_name       = "example"
  gateway_timezone   = "GMT"
  gateway_type       = "CACHED"
}

» Volume Gateway (Stored)

resource "aws_storagegateway_gateway" "example" {
  gateway_ip_address = "1.2.3.4"
  gateway_name       = "example"
  gateway_timezone   = "GMT"
  gateway_type       = "STORED"
}

» Argument Reference

NOTE: One of activation_key or gateway_ip_address must be provided for resource creation (gateway activation). Neither is required for resource import. If using gateway_ip_address, Terraform must be able to make an HTTP (port 80) GET request to the specified IP address from where it is running.

The following arguments are supported:

gateway_name - (Required) Name of the gateway.
gateway_timezone - (Required) 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. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
activation_key - (Optional) Gateway activation key during resource creation. Conflicts with gateway_ip_address. Additional information is available in the Storage Gateway User Guide.
gateway_ip_address - (Optional) Gateway IP address to retrieve activation key during resource creation. Conflicts with activation_key. Gateway must be accessible on port 80 from where Terraform is running. Additional information is available in the Storage Gateway User Guide.
gateway_type - (Optional) Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_S3, STORED, VTL.
media_changer_type - (Optional) Type of medium changer to use for tape gateway. Terraform cannot detect drift of this argument. Valid values: STK-L700, AWS-Gateway-VTL.
smb_active_directory_settings - (Optional) Nested argument with Active Directory domain join information for Server Message Block (SMB) file shares. Only valid for FILE_S3 gateway type. Must be set before creating ActiveDirectory authentication SMB file shares. More details below.
smb_guest_password - (Optional) Guest password for Server Message Block (SMB) file shares. Only valid for FILE_S3 gateway type. Must be set before creating GuestAccess authentication SMB file shares. Terraform can only detect drift of the existence of a guest password, not its actual value from the gateway. Terraform can however update the password with changing the argument.
tape_drive_type - (Optional) Type of tape drive to use for tape gateway. Terraform cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.

» smb_active_directory_settings

Information to join the gateway to an Active Directory domain for Server Message Block (SMB) file shares.

NOTE It is not possible to unconfigure this setting without recreating the gateway. Also, Terraform can only detect drift of the domain_name argument from the gateway.

domain_name - (Required) The name of the domain that you want the gateway to join.
password - (Required) The password of the user who has permission to add the gateway to the Active Directory domain.
username - (Required) The user name of user who has permission to add the gateway to the Active Directory domain.

» Attribute Reference

In addition to all arguments above, the following attributes are exported:

id - Amazon Resource Name (ARN) of the gateway.
arn - Amazon Resource Name (ARN) of the gateway.
gateway_id - Identifier of the gateway.

» Timeouts

aws_storagegateway_gateway provides the following Timeouts configuration options:

create - (Default 10m) How long to wait for gateway activation and connection to Storage Gateway.

» Import

aws_storagegateway_gateway can be imported by using the gateway Amazon Resource Name (ARN), e.g.

$ terraform import aws_storagegateway_gateway.example arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678