refactor(ecs): rename hwType to hardwareType (aws#2916)

This change spells out the previously abbreviated `hwType` into `hardwareType` and it closes aws#2896. BREAKING CHANGE: * **ecs**: the property that specifies the type of EC2 AMI optimized for ECS was renamed to `hardwareType` from `hwType`.
jogold · Jun 19, 2019 · 1aa0589 · 1aa0589
1 parent 5b44a4d
commit 1aa0589
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/packages/@aws-cdk/aws-ecs/lib/cluster.ts b/packages/@aws-cdk/aws-ecs/lib/cluster.ts
@@ -221,7 +221,7 @@ export interface EcsOptimizedAmiProps {
   /**
    * What generation of Amazon Linux to use
    *
-   * @default AmazonLinuxGeneration.AmazonLinux if hwType equal to AmiHardwareType.Standard else AmazonLinuxGeneration.AmazonLinux2
+   * @default AmazonLinuxGeneration.AmazonLinux if hardwareType equal to AmiHardwareType.Standard else AmazonLinuxGeneration.AmazonLinux2
    */
   readonly generation?: ec2.AmazonLinuxGeneration;
 
@@ -230,7 +230,7 @@ export interface EcsOptimizedAmiProps {
    *
    * @default AmiHardwareType.Standard
    */
-  readonly hwType?: AmiHardwareType;
+  readonly hardwareType?: AmiHardwareType;
 }
 
 /**
@@ -243,7 +243,7 @@ export class EcsOptimizedAmi implements ec2.IMachineImageSource {
   private readonly amiParameterName: string;
 
   constructor(props?: EcsOptimizedAmiProps) {
-    this.hwType = (props && props.hwType) || AmiHardwareType.Standard;
+    this.hwType = (props && props.hardwareType) || AmiHardwareType.Standard;
     if (props && props.generation) {      // generation defined in the props object
       if (props.generation === ec2.AmazonLinuxGeneration.AmazonLinux && this.hwType !== AmiHardwareType.Standard) {
         throw new Error(`Amazon Linux does not support special hardware type. Use Amazon Linux 2 instead`);

diff --git a/packages/@aws-cdk/aws-ecs/test/test.ecs-cluster.ts b/packages/@aws-cdk/aws-ecs/test/test.ecs-cluster.ts
@@ -229,7 +229,7 @@ export = {
     cluster.addCapacity('GpuAutoScalingGroup', {
       instanceType: new ec2.InstanceType('t2.micro'),
       machineImage: new ecs.EcsOptimizedAmi({
-        hwType: ecs.AmiHardwareType.Gpu
+        hardwareType: ecs.AmiHardwareType.Gpu
       }),
     });
 
@@ -254,7 +254,7 @@ export = {
         instanceType: new ec2.InstanceType('t2.micro'),
         machineImage: new ecs.EcsOptimizedAmi({
           generation: ec2.AmazonLinuxGeneration.AmazonLinux,
-          hwType: ecs.AmiHardwareType.Gpu,
+          hardwareType: ecs.AmiHardwareType.Gpu,
         }),
       });
     });