Add FSx File Gateway Support to Storage Gateway & Add FSx Association resource

.changelog/20082.txt

@@ -0,0 +1,6 @@
+```release-note:new-resource
+resource/aws_storagegateway_fsx_associate_file_system: Add new resource for associating FSx Storage Gateway with FSx File Systems
+```
+```release-note:enhancement
+resource/aws_storagegateway_gateway: Add new option for gateway_type, FILE_FSX_SMB, to be used with aws_storagegateway_fsx_associate_file_system
+```

aws/internal/service/storagegateway/errors.go

@@ -9,6 +9,7 @@ import (
 
 const (
 	OperationErrCodeFileShareNotFound = "FileShareNotFound"
+	FileSystemAssociationNotFound     = "FileSystemAssociationNotFound"
 )
 
 // OperationErrorCode returns the operation error code from the specified error:
@@ -26,3 +27,16 @@ func OperationErrorCode(err error) string {
 
 	return ""
 }
+
+// Error code constants missing from AWS Go SDK:
+// https://docs.aws.amazon.com/sdk-for-go/api/service/storagegateway/#pkg-constants
+
+func InvalidGatewayRequestErrCodeEquals(err error, errCode string) bool {
+	var igrex *storagegateway.InvalidGatewayRequestException
+	if errors.As(err, &igrex) {
+		if err := igrex.Error_; err != nil {
+			return aws.StringValue(err.ErrorCode) == errCode
+		}
+	}
+	return false
+}

aws/internal/service/storagegateway/finder/finder.go

@@ -1,8 +1,13 @@
 package finder
 
 import (
+	"errors"
+	"fmt"
+	"log"
+
 	"github.com/aws/aws-sdk-go/aws"
 	"github.com/aws/aws-sdk-go/service/storagegateway"
+	"github.com/hashicorp/aws-sdk-go-base/tfawserr"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
 	tfstoragegateway "github.com/terraform-providers/terraform-provider-aws/aws/internal/service/storagegateway"
 )
@@ -109,6 +114,39 @@ func SMBFileShareByARN(conn *storagegateway.StorageGateway, arn string) (*storag
 
 	// TODO Check for multiple results.
 	// TODO https://github.com/hashicorp/terraform-provider-aws/pull/17613.
-
 	return output.SMBFileShareInfoList[0], nil
 }
+
+func FileSystemAssociationByARN(conn *storagegateway.StorageGateway, fileSystemAssociationARN string) (*storagegateway.FileSystemAssociationInfo, error) {
+
+	input := &storagegateway.DescribeFileSystemAssociationsInput{
+		FileSystemAssociationARNList: []*string{aws.String(fileSystemAssociationARN)},
+	}
+	log.Printf("[DEBUG] Reading Storage Gateway FSx File Associations: %s", input)
+
+	output, err := conn.DescribeFileSystemAssociations(input)
+	if err != nil {
+		if tfawserr.ErrCodeEquals(err, storagegateway.ErrCodeInvalidGatewayRequestException) {
+			var igrex *storagegateway.InvalidGatewayRequestException
+			if ok := errors.As(err, &igrex); ok {
+				if err := igrex.Error_; err != nil {
+					if aws.StringValue(err.ErrorCode) == "FileSystemAssociationNotFound" {
+						log.Printf("[WARN] FSX File System %q not found", fileSystemAssociationARN)
+						return nil, nil
+					}
+				}
+			}
+		}
+
+		return nil, fmt.Errorf("error reading Storage Gateway FSx File System: %w", err)
+	}
+
+	if output == nil || len(output.FileSystemAssociationInfoList) == 0 || output.FileSystemAssociationInfoList[0] == nil {
+		log.Printf("[WARN] FSX File System %q not found", fileSystemAssociationARN)
+		return nil, nil
+	}
+
+	filesystem := output.FileSystemAssociationInfoList[0]
+
+	return filesystem, nil
+}

aws/internal/service/storagegateway/waiter/status.go

@@ -13,13 +13,21 @@ import (
 )
 
 const (
-	StorageGatewayGatewayStatusConnected = "GatewayConnected"
-	StoredIscsiVolumeStatusNotFound      = "NotFound"
-	StoredIscsiVolumeStatusUnknown       = "Unknown"
-	NfsFileShareStatusNotFound           = "NotFound"
-	NfsFileShareStatusUnknown            = "Unknown"
-	SmbFileShareStatusNotFound           = "NotFound"
-	SmbFileShareStatusUnknown            = "Unknown"
+	StorageGatewayGatewayStatusConnected        = "GatewayConnected"
+	StoredIscsiVolumeStatusNotFound             = "NotFound"
+	StoredIscsiVolumeStatusUnknown              = "Unknown"
+	NfsFileShareStatusNotFound                  = "NotFound"
+	NfsFileShareStatusUnknown                   = "Unknown"
+	SmbFileShareStatusNotFound                  = "NotFound"
+	SmbFileShareStatusUnknown                   = "Unknown"
+	FsxFileSystemStatusNotFound                 = "NotFound"
+	FsxFileSystemStatusUnknown                  = "Unknown"
+	FsxFileSystemAssociationStatusAvailable     = "AVAILABLE"
+	FsxFileSystemAssociationStatusCreating      = "CREATING"
+	FsxFileSystemAssociationStatusDeleting      = "DELETING"
+	FsxFileSystemAssociationStatusForceDeleting = "FORCE_DELETING"
+	FsxFileSystemAssociationStatusUpdating      = "UPDATING"
+	FsxFileSystemAssociationStatusError         = "ERROR"
 )
 
 func StorageGatewayGatewayStatus(conn *storagegateway.StorageGateway, gatewayARN string) resource.StateRefreshFunc {
@@ -128,3 +136,38 @@ func SMBFileShareStatus(conn *storagegateway.StorageGateway, arn string) resourc
 		return output, aws.StringValue(output.FileShareStatus), nil
 	}
 }
+
+func FsxFileSystemStatus(conn *storagegateway.StorageGateway, fileSystemArn string) resource.StateRefreshFunc {
+	return func() (interface{}, string, error) {
+
+		output, err := finder.FileSystemAssociationByARN(conn, fileSystemArn)
+
+		// there was an unhandled error in the Finder
+		if err != nil {
+			return nil, "", err
+		}
+
+		// no error, and no File System Association found
+		if output == nil {
+			return nil, FsxFileSystemStatusNotFound, nil
+		}
+
+		return output, aws.StringValue(output.FileSystemAssociationStatus), nil
+	}
+}
+
+func FsxFileSystemStatusAvailableStatusPending() []string {
+	return []string{FsxFileSystemAssociationStatusCreating, FsxFileSystemAssociationStatusUpdating}
+}
+
+func FsxFileSystemStatusAvailableStatusTarget() []string {
+	return []string{FsxFileSystemAssociationStatusAvailable}
+}
+
+func FsxFileSystemStatusDeletedStatusPending() []string {
+	return []string{FsxFileSystemAssociationStatusAvailable, FsxFileSystemAssociationStatusDeleting, FsxFileSystemAssociationStatusForceDeleting}
+}
+
+func FsxFileSystemStatusDeletedStatusTarget() []string {
+	return []string{}
+}

aws/internal/service/storagegateway/waiter/waiter.go

@@ -17,6 +17,8 @@ const (
 	NfsFileShareDeletedDelay                                = 5 * time.Second
 	SmbFileShareAvailableDelay                              = 5 * time.Second
 	SmbFileShareDeletedDelay                                = 5 * time.Second
+	FsxFileSystemAvailableDelay                             = 5 * time.Second
+	FsxFileSystemDeletedDelay                               = 5 * time.Second
 )
 
 func StorageGatewayGatewayConnected(conn *storagegateway.StorageGateway, gatewayARN string, timeout time.Duration) (*storagegateway.DescribeGatewayInformationOutput, error) {
@@ -166,3 +168,41 @@ func SMBFileShareUpdated(conn *storagegateway.StorageGateway, arn string, timeou
 
 	return nil, err
 }
+
+// FsxFileSystemAvailable waits for a FSx File System to return Available
+func FsxFileSystemAvailable(conn *storagegateway.StorageGateway, fileSystemArn string, timeout time.Duration) (*storagegateway.FileSystemAssociationInfo, error) {
+	stateConf := &resource.StateChangeConf{
+		Pending: FsxFileSystemStatusAvailableStatusPending(),
+		Target:  FsxFileSystemStatusAvailableStatusTarget(),
+		Refresh: FsxFileSystemStatus(conn, fileSystemArn),
+		Timeout: timeout,
+		Delay:   FsxFileSystemAvailableDelay,
+	}
+
+	outputRaw, err := stateConf.WaitForState()
+
+	if output, ok := outputRaw.(*storagegateway.FileSystemAssociationInfo); ok {
+		return output, err
+	}
+
+	return nil, err
+}
+
+func FsxFileSystemDeleted(conn *storagegateway.StorageGateway, fileSystemArn string, timeout time.Duration) (*storagegateway.FileSystemAssociationInfo, error) {
+	stateConf := &resource.StateChangeConf{
+		Pending:        FsxFileSystemStatusDeletedStatusPending(),
+		Target:         FsxFileSystemStatusDeletedStatusTarget(),
+		Refresh:        FsxFileSystemStatus(conn, fileSystemArn),
+		Timeout:        timeout,
+		Delay:          FsxFileSystemDeletedDelay,
+		NotFoundChecks: 1,
+	}
+
+	outputRaw, err := stateConf.WaitForState()
+
+	if output, ok := outputRaw.(*storagegateway.FileSystemAssociationInfo); ok {
+		return output, err
+	}
+
+	return nil, err
+}

aws/provider.go

@@ -1098,6 +1098,7 @@ func Provider() *schema.Provider {
 			"aws_ssoadmin_permission_set_inline_policy":               resourceAwsSsoAdminPermissionSetInlinePolicy(),
 			"aws_storagegateway_cache":                                resourceAwsStorageGatewayCache(),
 			"aws_storagegateway_cached_iscsi_volume":                  resourceAwsStorageGatewayCachedIscsiVolume(),
+			"aws_storagegateway_fsx_associate_file_system":            resourceAwsStorageGatewayFsxAssociateFileSystem(),
 			"aws_storagegateway_gateway":                              resourceAwsStorageGatewayGateway(),
 			"aws_storagegateway_nfs_file_share":                       resourceAwsStorageGatewayNfsFileShare(),
 			"aws_storagegateway_smb_file_share":                       resourceAwsStorageGatewaySmbFileShare(),

aws/resource_aws_storagegateway_cache_test.go

@@ -197,7 +197,7 @@ resource "aws_storagegateway_cache" "test" {
   # We expect this data source value to change due to how Storage Gateway works.
 
   lifecycle {
-    ignore_changes = ["disk_id"]
+    ignore_changes = [disk_id]
   }
 
   disk_id     = data.aws_storagegateway_local_disk.test.id