Enable setting a description for EBS Volume Snapshots

hashicorp · Apr 16, 2024 · 4756795 · 4756795
1 parent cfc2f1e
commit 4756795
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 0 deletions.
diff --git a/.web-docs/components/builder/ebsvolume/README.md b/.web-docs/components/builder/ebsvolume/README.md
@@ -428,6 +428,8 @@ https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concept
 
 - `snapshot_volume` (bool) - Create a Snapshot of this Volume.
 
+- `snapshot_description` (string) - The description for the snapshot.
+
 <!-- End of code generated from the comments of the BlockDevice struct in builder/ebsvolume/block_device.go; -->
 
 

diff --git a/builder/ebsvolume/block_device.go b/builder/ebsvolume/block_device.go
@@ -27,6 +27,9 @@ type BlockDevice struct {
 	// Create a Snapshot of this Volume.
 	SnapshotVolume bool `mapstructure:"snapshot_volume" required:"false"`
 
+	// The description for the snapshot.
+	SnapshotDescription string `mapstructure:"snapshot_description" required:"false"`
+
 	awscommon.SnapshotConfig `mapstructure:",squash"`
 }
 

diff --git a/builder/ebsvolume/builder.hcl2spec.go b/builder/ebsvolume/builder.hcl2spec.go
diff --git a/builder/ebsvolume/step_snapshot_ebs_volumes.go b/builder/ebsvolume/step_snapshot_ebs_volumes.go
@@ -59,6 +59,7 @@ func (s *stepSnapshotEBSVolumes) Run(ctx context.Context, state multistep.StateB
 				input := &ec2.CreateSnapshotInput{
 					VolumeId:          aws.String(*instanceBlockDevice.Ebs.VolumeId),
 					TagSpecifications: []*ec2.TagSpecification{tagSpec},
+					Description:       aws.String(configVolumeMapping.SnapshotDescription),
 				}
 
 				//Dont try to set an empty tag spec

diff --git a/docs-partials/builder/ebsvolume/BlockDevice-not-required.mdx b/docs-partials/builder/ebsvolume/BlockDevice-not-required.mdx
@@ -11,4 +11,6 @@
 
 - `snapshot_volume` (bool) - Create a Snapshot of this Volume.
 
+- `snapshot_description` (string) - The description for the snapshot.
+
 <!-- End of code generated from the comments of the BlockDevice struct in builder/ebsvolume/block_device.go; -->