MediaPackage: speke 2 configuration error

[lightglitch]

Describe the bug

The speke 2 configuration "EncryptionContractConfiguration" is not correctly converted to the cloud formation template, giving an error when deploying.

Expected Behavior

The cf template should include the speke 2 configurations and the deploy show set speke 2 configuration.

Current Behavior

When generating a cmaf or dash mediapackage with the following information:

              spekeKeyProvider: {
                  roleArn: "arn",
                  systemIds: "xxxxxxxxxxx",
                  url: "https://xxx.xx",
                  resourceId: `resource-cmaf`,
                  encryptionContractConfiguration: {
                      presetSpeke20Audio: "PRESET-AUDIO-1",
                      presetSpeke20Video: "PRESET-VIDEO-1",
                  },
              },

the generated cloudformation template doesn't include the preset information:

      "SpekeKeyProvider": {
       "EncryptionContractConfiguration": {},
       "ResourceId": "resource-xxxx",
       "RoleArn": {
        "Fn::ImportValue": "role"
       },
       "SystemIds": [
        "xxxxx"
       ],

And when we deploy we get the following error:

Resource handler returned message: "Model validation failed (#: #: only 1 subschema matches out of 2)
#/CmafPackage/Encryption/SpekeKeyProvider/EncryptionContractConfiguration: 2 schema violations found (#/CmafPackage/Encryption/SpekeKeyProvider/EncryptionContractConfiguration)" (RequestToken: a53b01e3-b50a-3ce3-4cd8-6550561eda09, HandlerErrorCode: InvalidRequest)

Reproduction Steps

Just create a media package endpoint with speke 2 configurations and check the generated cf template.

Possible Solution

No response

Additional Information/Context

No response

CDK CLI Version

2.86.0 (build 1130fab)

Framework Version

2.86

Node.js Version

v18.16.0

OS

windows 11

Language

Typescript

Language Version

5.1.6

Other information

No response

[pahud]

Looks like you are using the aws_mediapackage L1 constructs.

Can you share a minimal working sample that I can copy/paste to reproduce this issue in my account?

[lightglitch]

Here you have it:

new MediaPackageTest(app, "test-channel-1", {
    project: "project",
    channelName: "ch-1",
    env: { account: process.env.CDK_DEFAULT_ACCOUNT, region: process.env.CDK_DEFAULT_REGION || "eu-west-1" },
})

import * as cdk from "aws-cdk-lib"
import { Construct, DependencyGroup } from "constructs"
import * as mediapackage from "aws-cdk-lib/aws-mediapackage"

export class MediaPackageTest extends cdk.Stack {

    constructor(scope?: Construct, id?: string, props?: {
        env: { region: any; account: any };
        project: string;
        channelName: string;
    }) {
        super(scope, id, props)

        const mpChannel = new mediapackage.CfnChannel(this, (id = `${props!.project}-mp-${props!.channelName}`), {
            id: `${props!.project}-mp-${props!.channelName}`,
            description: `Media Package channel for ${props!.channelName}`,
        })

        const cmafPackage: mediapackage.CfnOriginEndpoint.CmafPackageProperty = {
            segmentDurationSeconds: 6,

            encryption: {
                spekeKeyProvider: {
                    roleArn: "testRole",
                    systemIds: ["94ce86fb-07ff-4f43-adb8-93d2fa968ca2"],
                    url: "https://localhost",
                    resourceId: `${props!.project}-${props!.channelName}-cmaf-20230703`,
                    encryptionContractConfiguration: {
                        presetSpeke20Audio: "PRESET-AUDIO-1",
                        presetSpeke20Video: "PRESET-VIDEO-1",
                    },
                },
                keyRotationIntervalSeconds: 0,
            },
            streamSelection: {
                minVideoBitsPerSecond: 0,
                maxVideoBitsPerSecond: 2147483647,
                streamOrder: "ORIGINAL",
            },
            hlsManifests: [
                {
                    id: "hls_id",
                    url: "https://localhost",
                    playlistWindowSeconds: 7200,
                    programDateTimeIntervalSeconds: 6,
                },
            ],
        }

        const cmaf_endpoint = new mediapackage.CfnOriginEndpoint(
            this,
            (id = `cmaf-endpoint-${props!.channelName}-20230703`),
            {
                channelId: mpChannel.id,
                id: `cmaf-endpoint-${props!.channelName}-20230703`,
                cmafPackage,
                manifestName: "cmaf",
                startoverWindowSeconds: 1209600,
                description: `CMAF Endpoint for ${props!.channelName}`,
            },
        )

        cmaf_endpoint.addDependency(mpChannel)
    }
}

[peterwoodworth]

This is occurring because it's misdefined in the Cloudformation Spec file - search here for the property definition and you'll see: https://d1uauaxba7bl26.cloudfront.net/latest/gzip/CloudFormationResourceSpecification.json

You can work around this by manually overriding the property with an escape hatch

[lightglitch]

@peterwoodworth can you clarify how can I override the property with an example? I can't find any documentation to guide me.

[peterwoodworth]

Sure @lightglitch, view this page to see how to override the template. Here, it will look something like this:

cmaf_endpoint.addPropertyOverride('CmafPackage.Encryption.SpekeKeyProvider.EncryptionContractConfiguration.PresetSpeke20Audio', 'PRESET-AUDIO-1');

After doing this synth and check your template and this property should now be filled out with PRESET-AUDIO-1

[peterwoodworth]

Reported this internally P94116434