Add fsx ontap_volume resource (#21889)

* new volume resource

* changelog and formatting

* main merge

* clear lint

* fixed tests

Author: awsaxeman

.changelog/21889.txt

@@ -0,0 +1,3 @@
+```release-note:new-resource
+aws_fsx_ontap_volume
+```

internal/provider/provider.go

@@ -1191,6 +1191,7 @@ func Provider() *schema.Provider {
 			"aws_fsx_lustre_file_system":            fsx.ResourceLustreFileSystem(),
 			"aws_fsx_ontap_file_system":             fsx.ResourceOntapFileSystem(),
 			"aws_fsx_ontap_storage_virtual_machine": fsx.ResourceOntapStorageVirtualMachine(),
+			"aws_fsx_ontap_volume":                  fsx.ResourceOntapVolume(),
 			"aws_fsx_windows_file_system":           fsx.ResourceWindowsFileSystem(),
 
 			"aws_gamelift_alias":              gamelift.ResourceAlias(),

internal/service/fsx/find.go

@@ -131,3 +131,42 @@ func FindStorageVirtualMachineByID(conn *fsx.FSx, id string) (*fsx.StorageVirtua
 
 	return storageVirtualMachines[0], nil
 }
+
+func FindVolumeByID(conn *fsx.FSx, id string) (*fsx.Volume, error) {
+	input := &fsx.DescribeVolumesInput{
+		VolumeIds: []*string{aws.String(id)},
+	}
+
+	var volumes []*fsx.Volume
+
+	err := conn.DescribeVolumesPages(input, func(page *fsx.DescribeVolumesOutput, lastPage bool) bool {
+		if page == nil {
+			return !lastPage
+		}
+
+		volumes = append(volumes, page.Volumes...)
+
+		return !lastPage
+	})
+
+	if tfawserr.ErrCodeEquals(err, fsx.ErrCodeVolumeNotFound) {
+		return nil, &resource.NotFoundError{
+			LastError:   err,
+			LastRequest: input,
+		}
+	}
+
+	if err != nil {
+		return nil, err
+	}
+
+	if len(volumes) == 0 || volumes[0] == nil {
+		return nil, tfresource.NewEmptyResultError(input)
+	}
+
+	if count := len(volumes); count > 1 {
+		return nil, tfresource.NewTooManyResultsError(count, input)
+	}
+
+	return volumes[0], nil
+}

internal/service/fsx/ontap_volume.go

@@ -0,0 +1,340 @@
+package fsx
+
+import (
+	"fmt"
+	"log"
+	"time"
+
+	"github.com/aws/aws-sdk-go/aws"
+	"github.com/aws/aws-sdk-go/service/fsx"
+	"github.com/hashicorp/aws-sdk-go-base/tfawserr"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
+	"github.com/hashicorp/terraform-provider-aws/internal/conns"
+	tftags "github.com/hashicorp/terraform-provider-aws/internal/tags"
+	"github.com/hashicorp/terraform-provider-aws/internal/tfresource"
+	"github.com/hashicorp/terraform-provider-aws/internal/verify"
+)
+
+func ResourceOntapVolume() *schema.Resource {
+	return &schema.Resource{
+		Create: resourceOntapVolumeCreate,
+		Read:   resourceOntapVolumeRead,
+		Update: resourceOntapVolumeUpdate,
+		Delete: resourceOntapVolumeDelete,
+		Importer: &schema.ResourceImporter{
+			State: schema.ImportStatePassthrough,
+		},
+
+		Timeouts: &schema.ResourceTimeout{
+			Create: schema.DefaultTimeout(30 * time.Minute),
+			Update: schema.DefaultTimeout(30 * time.Minute),
+			Delete: schema.DefaultTimeout(30 * time.Minute),
+		},
+
+		Schema: map[string]*schema.Schema{
+			"arn": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+			"file_system_id": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+			"flexcache_endpoint_type": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+			"junction_path": {
+				Type:         schema.TypeString,
+				Required:     true,
+				ValidateFunc: validation.StringLenBetween(1, 255),
+			},
+			"name": {
+				Type:         schema.TypeString,
+				Required:     true,
+				ForceNew:     true,
+				ValidateFunc: validation.StringLenBetween(1, 203),
+			},
+			"ontap_volume_type": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+			"security_style": {
+				Type:         schema.TypeString,
+				Optional:     true,
+				Default:      "UNIX",
+				ValidateFunc: validation.StringInSlice(fsx.StorageVirtualMachineRootVolumeSecurityStyle_Values(), false),
+			},
+			"size_in_megabytes": {
+				Type:         schema.TypeInt,
+				Required:     true,
+				ValidateFunc: validation.IntBetween(0, 2147483647),
+			},
+			"storage_efficiency_enabled": {
+				Type:     schema.TypeBool,
+				Required: true,
+			},
+			"storage_virtual_machine_id": {
+				Type:         schema.TypeString,
+				Required:     true,
+				ValidateFunc: validation.StringLenBetween(21, 21),
+			},
+			"tiering_policy": {
+				Type:             schema.TypeList,
+				Optional:         true,
+				DiffSuppressFunc: verify.SuppressMissingOptionalConfigurationBlock,
+				MaxItems:         1,
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"cooling_period": {
+							Type:         schema.TypeInt,
+							Optional:     true,
+							ValidateFunc: validation.IntBetween(2, 183),
+						},
+						"name": {
+							Type:         schema.TypeString,
+							Optional:     true,
+							Computed:     true,
+							ValidateFunc: validation.StringInSlice(fsx.TieringPolicyName_Values(), false),
+						},
+					},
+				},
+			},
+			"tags":     tftags.TagsSchema(),
+			"tags_all": tftags.TagsSchemaComputed(),
+			"uuid": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+			"volume_type": {
+				Type:         schema.TypeString,
+				Default:      fsx.VolumeTypeOntap,
+				Optional:     true,
+				ValidateFunc: validation.StringInSlice(fsx.VolumeType_Values(), false),
+			},
+		},
+		CustomizeDiff: verify.SetTagsDiff,
+	}
+}
+
+func resourceOntapVolumeCreate(d *schema.ResourceData, meta interface{}) error {
+	conn := meta.(*conns.AWSClient).FSxConn
+	defaultTagsConfig := meta.(*conns.AWSClient).DefaultTagsConfig
+	tags := defaultTagsConfig.MergeTags(tftags.New(d.Get("tags").(map[string]interface{})))
+
+	input := &fsx.CreateVolumeInput{
+		Name:       aws.String(d.Get("name").(string)),
+		VolumeType: aws.String(d.Get("volume_type").(string)),
+		OntapConfiguration: &fsx.CreateOntapVolumeConfiguration{
+			JunctionPath:             aws.String(d.Get("junction_path").(string)),
+			SizeInMegabytes:          aws.Int64(int64(d.Get("size_in_megabytes").(int))),
+			StorageEfficiencyEnabled: aws.Bool(d.Get("storage_efficiency_enabled").(bool)),
+			StorageVirtualMachineId:  aws.String(d.Get("storage_virtual_machine_id").(string)),
+		},
+	}
+
+	if v, ok := d.GetOk("security_style"); ok {
+		input.OntapConfiguration.SecurityStyle = aws.String(v.(string))
+	}
+
+	if v, ok := d.GetOk("tiering_policy"); ok {
+		input.OntapConfiguration.TieringPolicy = expandFsxOntapVolumeTieringPolicy(v.([]interface{}))
+	}
+
+	if len(tags) > 0 {
+		input.Tags = Tags(tags.IgnoreAWS())
+	}
+
+	log.Printf("[DEBUG] Creating FSx ONTAP Volume: %s", input)
+	result, err := conn.CreateVolume(input)
+
+	if err != nil {
+		return fmt.Errorf("error creating FSx Volume: %w", err)
+	}
+
+	d.SetId(aws.StringValue(result.Volume.VolumeId))
+
+	if _, err := waitVolumeCreated(conn, d.Id(), d.Timeout(schema.TimeoutCreate)); err != nil {
+		return fmt.Errorf("error waiting for FSx Volume(%s) create: %w", d.Id(), err)
+	}
+
+	return resourceOntapVolumeRead(d, meta)
+
+}
+
+func resourceOntapVolumeRead(d *schema.ResourceData, meta interface{}) error {
+	conn := meta.(*conns.AWSClient).FSxConn
+	defaultTagsConfig := meta.(*conns.AWSClient).DefaultTagsConfig
+	ignoreTagsConfig := meta.(*conns.AWSClient).IgnoreTagsConfig
+
+	volume, err := FindVolumeByID(conn, d.Id())
+
+	if !d.IsNewResource() && tfresource.NotFound(err) {
+		log.Printf("[WARN] FSx ONTAP Volume (%s) not found, removing from state", d.Id())
+		d.SetId("")
+		return nil
+	}
+
+	if err != nil {
+		return fmt.Errorf("error reading FSx ONTAP Volume (%s): %w", d.Id(), err)
+	}
+
+	ontapConfig := volume.OntapConfiguration
+	if ontapConfig == nil {
+		return fmt.Errorf("error describing FSx ONTAP Volume (%s): empty ONTAP configuration", d.Id())
+	}
+
+	d.Set("arn", volume.ResourceARN)
+	d.Set("name", volume.Name)
+	d.Set("file_system_id", volume.FileSystemId)
+	d.Set("junction_path", ontapConfig.JunctionPath)
+	d.Set("ontap_volume_type", ontapConfig.OntapVolumeType)
+	d.Set("security_style", ontapConfig.SecurityStyle)
+	d.Set("size_in_megabytes", ontapConfig.SizeInMegabytes)
+	d.Set("storage_efficiency_enabled", ontapConfig.StorageEfficiencyEnabled)
+	d.Set("storage_virtual_machine_id", ontapConfig.StorageVirtualMachineId)
+	d.Set("uuid", ontapConfig.UUID)
+	d.Set("volume_type", volume.VolumeType)
+
+	if err := d.Set("tiering_policy", flattenFsxOntapVolumeTieringPolicy(ontapConfig.TieringPolicy)); err != nil {
+		return fmt.Errorf("error setting tiering_policy: %w", err)
+	}
+
+	//Volume tags do not get returned with describe call so need to make a separate list tags call
+	tags, tagserr := ListTags(conn, *volume.ResourceARN)
+
+	if tagserr != nil {
+		return fmt.Errorf("error reading Tags for FSx ONTAP Volume (%s): %w", d.Id(), err)
+	} else {
+		tags = tags.IgnoreAWS().IgnoreConfig(ignoreTagsConfig)
+	}
+
+	//lintignore:AWSR002
+	if err := d.Set("tags", tags.RemoveDefaultConfig(defaultTagsConfig).Map()); err != nil {
+		return fmt.Errorf("error setting tags: %w", err)
+	}
+
+	if err := d.Set("tags_all", tags.Map()); err != nil {
+		return fmt.Errorf("error setting tags_all: %w", err)
+	}
+
+	return nil
+}
+
+func resourceOntapVolumeUpdate(d *schema.ResourceData, meta interface{}) error {
+	conn := meta.(*conns.AWSClient).FSxConn
+
+	if d.HasChange("tags_all") {
+		o, n := d.GetChange("tags_all")
+
+		if err := UpdateTags(conn, d.Get("arn").(string), o, n); err != nil {
+			return fmt.Errorf("error updating FSx ONTAP Volume (%s) tags: %w", d.Get("arn").(string), err)
+		}
+	}
+
+	if d.HasChangesExcept("tags_all", "tags") {
+		input := &fsx.UpdateVolumeInput{
+			ClientRequestToken: aws.String(resource.UniqueId()),
+			VolumeId:           aws.String(d.Id()),
+			OntapConfiguration: &fsx.UpdateOntapVolumeConfiguration{},
+		}
+
+		if d.HasChange("junction_path") {
+			input.OntapConfiguration.JunctionPath = aws.String(d.Get("junction_path").(string))
+		}
+
+		if d.HasChange("security_style") {
+			input.OntapConfiguration.SecurityStyle = aws.String(d.Get("security_style").(string))
+		}
+
+		if d.HasChange("size_in_megabytes") {
+			input.OntapConfiguration.SizeInMegabytes = aws.Int64(int64(d.Get("size_in_megabytes").(int)))
+		}
+
+		if d.HasChange("storage_efficiency_enabled") {
+			input.OntapConfiguration.StorageEfficiencyEnabled = aws.Bool(d.Get("storage_efficiency_enabled").(bool))
+		}
+
+		if d.HasChange("tiering_policy") {
+			input.OntapConfiguration.TieringPolicy = expandFsxOntapVolumeTieringPolicy(d.Get("tiering_policy").([]interface{}))
+		}
+
+		_, err := conn.UpdateVolume(input)
+
+		if err != nil {
+			return fmt.Errorf("error updating FSx ONTAP Volume (%s): %w", d.Id(), err)
+		}
+
+		if _, err := waitVolumeUpdated(conn, d.Id(), d.Timeout(schema.TimeoutUpdate)); err != nil {
+			return fmt.Errorf("error waiting for FSx ONTAP Volume (%s) update: %w", d.Id(), err)
+		}
+	}
+
+	return resourceOntapVolumeRead(d, meta)
+}
+
+func resourceOntapVolumeDelete(d *schema.ResourceData, meta interface{}) error {
+	conn := meta.(*conns.AWSClient).FSxConn
+
+	log.Printf("[DEBUG] Deleting FSx ONTAP Volume: %s", d.Id())
+	_, err := conn.DeleteVolume(&fsx.DeleteVolumeInput{
+		VolumeId: aws.String(d.Id()),
+	})
+
+	if tfawserr.ErrCodeEquals(err, fsx.ErrCodeVolumeNotFound) {
+		return nil
+	}
+
+	if err != nil {
+		return fmt.Errorf("error deleting FSx ONTAP Volume (%s): %w", d.Id(), err)
+	}
+
+	if _, err := waitVolumeDeleted(conn, d.Id(), d.Timeout(schema.TimeoutDelete)); err != nil {
+		return fmt.Errorf("error waiting for FSx ONTAP Volume (%s) delete: %w", d.Id(), err)
+	}
+
+	return nil
+}
+
+func expandFsxOntapVolumeTieringPolicy(cfg []interface{}) *fsx.TieringPolicy {
+	if len(cfg) < 1 {
+		return nil
+	}
+
+	conf := cfg[0].(map[string]interface{})
+
+	out := fsx.TieringPolicy{}
+
+	//Cooling period only accepts a minimum of 2 but int will return 0 not nil if unset
+	//Therefore we only set it if it is 2 or more
+	if v, ok := conf["cooling_period"].(int); ok && v >= 2 {
+		out.CoolingPeriod = aws.Int64(int64(v))
+	}
+
+	if v, ok := conf["name"].(string); ok {
+		out.Name = aws.String(v)
+	}
+
+	return &out
+}
+
+func flattenFsxOntapVolumeTieringPolicy(rs *fsx.TieringPolicy) []interface{} {
+	if rs == nil {
+		return []interface{}{}
+	}
+
+	minCoolingPeriod := 2
+
+	m := make(map[string]interface{})
+	if rs.CoolingPeriod != nil && *rs.CoolingPeriod >= int64(minCoolingPeriod) {
+		m["cooling_period"] = aws.Int64Value(rs.CoolingPeriod)
+	}
+
+	if rs.Name != nil {
+		m["name"] = aws.StringValue(rs.Name)
+	}
+
+	return []interface{}{m}
+}