interface SpekeKeyProviderProperty

Language	Type name
.NET	`Amazon.CDK.AWS.MediaPackage.CfnOriginEndpoint.SpekeKeyProviderProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsmediapackage#CfnOriginEndpoint_SpekeKeyProviderProperty`
Java	`software.amazon.awscdk.services.mediapackage.CfnOriginEndpoint.SpekeKeyProviderProperty`
Python	`aws_cdk.aws_mediapackage.CfnOriginEndpoint.SpekeKeyProviderProperty`
TypeScript	`aws-cdk-lib` » `aws_mediapackage` » `CfnOriginEndpoint` » `SpekeKeyProviderProperty`

Key provider settings for DRM.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediapackage as mediapackage } from 'aws-cdk-lib';
const spekeKeyProviderProperty: mediapackage.CfnOriginEndpoint.SpekeKeyProviderProperty = {
  resourceId: 'resourceId',
  roleArn: 'roleArn',
  systemIds: ['systemIds'],
  url: 'url',

  // the properties below are optional
  certificateArn: 'certificateArn',
  encryptionContractConfiguration: {
    presetSpeke20Audio: 'presetSpeke20Audio',
    presetSpeke20Video: 'presetSpeke20Video',
  },
};

Properties

Name	Type	Description
resourceId	`string`	Unique identifier for this endpoint, as it is configured in the key provider service.
roleArn	`string`	The ARN for the IAM role that's granted by the key provider to provide access to the key provider API.
systemIds	`string[]`	List of unique identifiers for the DRM systems to use, as defined in the CPIX specification.
url	`string`	URL for the key provider’s key retrieval API endpoint.
certificateArn?	`string`	The Amazon Resource Name (ARN) for the certificate that you imported to AWS Certificate Manager to add content key encryption to this endpoint.
encryptionContractConfiguration?	`IResolvable` `\|` `EncryptionContractConfigurationProperty`	Use `encryptionContractConfiguration` to configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.

resourceId

Type: string

Unique identifier for this endpoint, as it is configured in the key provider service.

roleArn

Type: string

The ARN for the IAM role that's granted by the key provider to provide access to the key provider API.

This role must have a trust policy that allows AWS Elemental MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Valid format: arn:aws:iam::{accountID}:role/{name}

systemIds

Type: string[]

List of unique identifiers for the DRM systems to use, as defined in the CPIX specification.

url

Type: string

URL for the key provider’s key retrieval API endpoint.

Must start with https://.

certificateArn?

Type: string (optional)

The Amazon Resource Name (ARN) for the certificate that you imported to AWS Certificate Manager to add content key encryption to this endpoint.

For this feature to work, your DRM key provider must support content key encryption.

encryptionContractConfiguration?

Type: IResolvable | EncryptionContractConfigurationProperty (optional)

Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.