aws-ecs: EFSVolumeConfiguration is an extraneous key

❓ General Issue

The Question

When creating a FargateTaskDefinition and adding an EFS Volume, the CloudFormation template warns that the “EfsVolumeConfiguration” is an extraneous key - is this a known issue?

Given the following Typescript FargateTaskDefinition

    const myAppFargateTaskDefinition = new FargateTaskDefinition(this, 'MyAppFargateTaskDefinition', {
         memoryLimitMiB: 512,
        cpu: 256,
        executionRole: myAppFargateTaskExecutionRole,
        taskRole: myAppFargateTaskRole,
    });

    myAppFargateTaskDefinition.addVolume({
        name: 'MyAppEfsVolume',
        efsVolumeConfiguration: {
            fileSystemId: fileSystem.fileSystemId,
            transitEncryption: 'ENABLED',
            authorizationConfig: {
                accessPointId: fileSystemAccessPoint.accessPointId
            }
        }
    });

The output Cloudformation template generates the following:

    "MyAppFargateTaskDefinitionEB5C71CC": {
          "Type": "AWS::ECS::TaskDefinition",
          "Properties": {
              ...,
              Volumes": [ {
                "Name": "MyAppEfsVolume",
                "EfsVolumeConfiguration": {
                  "AuthorizationConfig": {
                    "AccessPointId": {
                      "Ref": "FileSystemAccessPointF8178182"
                    }
                  },
                  "TransitEncryption": "ENABLED",
                  "FileSystemId": {
                    "Ref": "FileSystem8A8E25C0"
                  }
               }
           }]
       }
    }

However when creating the stack there is the following validation message:

Resource template validation failed for resource MyAppFargateTaskDefinitionEB5C71CC as the template has invalid properties. Please refer to the resource documentation to fix the template. Properties validation failed for resource MyAppFargateTaskDefinitionEB5C71CC with message: #/Volumes/0: extraneous key [EfsVolumeConfiguration] is not permitted

Environment

• CDK CLI Version: 1.97.0
• Module Version: 1.97.1
• Node.js Version: v13.14.0
• OS: macOs Mojave
• Language (Version): Typescript (4.2.4)

Other information

[alexb-uk]

If it helps I’m running 1.102.0 and am still seeing the warning in CDK console out:

 1/3 | 12:47:34 | CREATE_IN_PROGRESS   | AWS::ECS::TaskDefinition | TaskDef (TaskDef54694570) Resource template validation failed for resource TaskDef54694570 as the template has invalid properties. Please refer to the resource documentation to fix the template.
Properties validation failed for resource TaskDef54694570 with message:
#/Volumes/0: extraneous key [EfsVolumeConfiguration] is not permitted

Synth template:

"Volumes": [
    {
      "Name": "efs-test",
      "EfsVolumeConfiguration": {
        "FileSystemId": {
          "Ref": "EfsFileSystemXXX"
        }
      }
    },

Stack does go on to deploy with the volume mounted correctly.

Thanks

[joe-glasgow]

You can cdk synth and manually change and upload the output given. If you cdk synth here and manually change EfsVolumeConfiguration to EFSVolumeConfiguration and try to manually upload that to cloudformation will it work?

Thanks, that did indeed fix this instance however, there is a subsequent casing issue for FileSystemId

with message: #/Volumes/0/EFSVolumeConfiguration: required key [FilesystemId] not found #/Volumes/0/EFSVolumeConfiguration: extraneous key [FileSystemId] is not permitted

Will manually change this too, will try and find the offending code later and PR a fix!