feat(ec2): support throughput on LaunchTemplate EBS volumes

This support was simply not included in ec2 when it was added to autoscaling in #22441. I have copied that PR's implementation implementation to ec2 and similarly adapted its tests. Fixes #24341.
aws · Aug 1, 2024 · 7773043 · 7773043
1 parent 439feaf
commit 7773043
Show file tree

Hide file tree

Showing 9 changed files with 199 additions and 60 deletions.
diff --git a/...test/aws-ec2/test/integ.launch-template.js.snapshot/aws-cdk-ec2-lt-metadata-1.assets.json b/...test/aws-ec2/test/integ.launch-template.js.snapshot/aws-cdk-ec2-lt-metadata-1.assets.json
diff --git a/...st/aws-ec2/test/integ.launch-template.js.snapshot/aws-cdk-ec2-lt-metadata-1.template.json b/...st/aws-ec2/test/integ.launch-template.js.snapshot/aws-cdk-ec2-lt-metadata-1.template.json
@@ -159,6 +159,16 @@
    "Type": "AWS::EC2::LaunchTemplate",
    "Properties": {
     "LaunchTemplateData": {
+     "BlockDeviceMappings": [
+      {
+       "DeviceName": "/dev/xvda",
+       "Ebs": {
+        "Throughput": 250,
+        "VolumeSize": 15,
+        "VolumeType": "gp3"
+       }
+      }
+     ],
      "MetadataOptions": {
       "HttpEndpoint": "enabled",
       "HttpProtocolIpv6": "enabled",
@@ -211,8 +221,7 @@
        }
       ]
      }
-    ],
-    "VersionDescription": "test template v1"
+    ]
    }
   },
   "sg2860DD91F": {

diff --git a/...testing/framework-integ/test/aws-ec2/test/integ.launch-template.js.snapshot/manifest.json b/...testing/framework-integ/test/aws-ec2/test/integ.launch-template.js.snapshot/manifest.json
diff --git a/...cdk-testing/framework-integ/test/aws-ec2/test/integ.launch-template.js.snapshot/tree.json b/...cdk-testing/framework-integ/test/aws-ec2/test/integ.launch-template.js.snapshot/tree.json
diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-ec2/test/integ.launch-template.ts b/packages/@aws-cdk-testing/framework-integ/test/aws-ec2/test/integ.launch-template.ts
@@ -23,6 +23,13 @@ const lt = new ec2.LaunchTemplate(stack, 'LT', {
   httpTokens: ec2.LaunchTemplateHttpTokens.REQUIRED,
   instanceMetadataTags: true,
   securityGroup: sg1,
+  blockDevices: [{
+    deviceName: '/dev/xvda',
+    volume: ec2.BlockDeviceVolume.ebs(15, {
+      volumeType: ec2.EbsDeviceVolumeType.GP3,
+      throughput: 250,
+    }),
+  }],
 });
 
 const sg2 = new ec2.SecurityGroup(stack, 'sg2', {

diff --git a/packages/aws-cdk-lib/aws-ec2/README.md b/packages/aws-cdk-lib/aws-ec2/README.md
@@ -1603,6 +1603,33 @@ new ec2.Instance(this, 'Instance', {
 
 ```
 
+To specify the throughput value for `gp3` volumes, use the `throughput` property:
+
+```ts
+declare const vpc: ec2.Vpc;
+declare const instanceType: ec2.InstanceType;
+declare const machineImage: ec2.IMachineImage;
+
+const kmsKey = new Key(this, 'KmsKey')
+
+new ec2.Instance(this, 'Instance', {
+  vpc,
+  instanceType,
+  machineImage,
+
+  // ...
+
+  blockDevices: [
+    {
+      deviceName: '/dev/sda1',
+      volume: ec2.BlockDeviceVolume.ebs(100, {
+        volumeType: ec2.EbsDeviceVolumeType.GP3,
+        throughput: 250,
+      }),
+    },
+  ],
+});
+
 #### EBS Optimized Instances
 
 An Amazon EBS–optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O. This optimization provides the best performance for your EBS volumes by minimizing contention between Amazon EBS I/O and other traffic from your instance.