interface EncryptionProperty

Language	Type name
.NET	`Amazon.CDK.AWS.MediaPackageV2.CfnOriginEndpoint.EncryptionProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsmediapackagev2#CfnOriginEndpoint_EncryptionProperty`
Java	`software.amazon.awscdk.services.mediapackagev2.CfnOriginEndpoint.EncryptionProperty`
Python	`aws_cdk.aws_mediapackagev2.CfnOriginEndpoint.EncryptionProperty`
TypeScript	`aws-cdk-lib` » `aws_mediapackagev2` » `CfnOriginEndpoint` » `EncryptionProperty`

The parameters for encrypting content.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediapackagev2 as mediapackagev2 } from 'aws-cdk-lib';
const encryptionProperty: mediapackagev2.CfnOriginEndpoint.EncryptionProperty = {
  encryptionMethod: {
    cmafEncryptionMethod: 'cmafEncryptionMethod',
    ismEncryptionMethod: 'ismEncryptionMethod',
    tsEncryptionMethod: 'tsEncryptionMethod',
  },
  spekeKeyProvider: {
    drmSystems: ['drmSystems'],
    encryptionContractConfiguration: {
      presetSpeke20Audio: 'presetSpeke20Audio',
      presetSpeke20Video: 'presetSpeke20Video',
    },
    resourceId: 'resourceId',
    roleArn: 'roleArn',
    url: 'url',
  },

  // the properties below are optional
  cmafExcludeSegmentDrmMetadata: false,
  constantInitializationVector: 'constantInitializationVector',
  keyRotationIntervalSeconds: 123,
};

Properties

Name	Type	Description
encryptionMethod	`IResolvable` `\|` `EncryptionMethodProperty`	The encryption method to use.
spekeKeyProvider	`IResolvable` `\|` `SpekeKeyProviderProperty`	The SPEKE key provider to use for encryption.
cmafExcludeSegmentDrmMetadata?	`boolean \|` `IResolvable`	Excludes SEIG and SGPD boxes from segment metadata in CMAF containers.
constantInitializationVector?	`string`	A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content.
keyRotationIntervalSeconds?	`number`	The interval, in seconds, to rotate encryption keys for the origin endpoint.

encryptionMethod

Type: IResolvable | EncryptionMethodProperty

The encryption method to use.

spekeKeyProvider

Type: IResolvable | SpekeKeyProviderProperty

The SPEKE key provider to use for encryption.

cmafExcludeSegmentDrmMetadata?

Type: boolean | IResolvable (optional)

Excludes SEIG and SGPD boxes from segment metadata in CMAF containers.

When set to true , MediaPackage omits these DRM metadata boxes from CMAF segments, which can improve compatibility with certain devices and players that don't support these boxes.

Important considerations:

This setting only affects CMAF container formats
Key rotation can still be handled through media playlist signaling
PSSH and TENC boxes remain unaffected
Default behavior is preserved when this setting is disabled

Valid values: true | false

Default: false

constantInitializationVector?

Type: string (optional)

A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content.

If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).

keyRotationIntervalSeconds?

Type: number (optional)

The interval, in seconds, to rotate encryption keys for the origin endpoint.