Package software.amazon.awscdk.services.mediapackage

Interface CfnOriginEndpoint.SpekeKeyProviderProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnOriginEndpoint.SpekeKeyProviderProperty.Jsii$Proxy
Enclosing class:
CfnOriginEndpoint
@Stability(Stable) public static interface CfnOriginEndpoint.SpekeKeyProviderProperty extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.mediapackage.*;
 SpekeKeyProviderProperty spekeKeyProviderProperty = SpekeKeyProviderProperty.builder()
         .resourceId("resourceId")
         .roleArn("roleArn")
         .systemIds(List.of("systemIds"))
         .url("url")
         // the properties below are optional
         .certificateArn("certificateArn")
         .encryptionContractConfiguration(EncryptionContractConfigurationProperty.builder().build())
         .build();

  • Method Details

    • getResourceId

      @Stability(Stable) @NotNull String getResourceId()
      Unique identifier for this endpoint, as it is configured in the key provider service.

    • getRoleArn

      @Stability(Stable) @NotNull String getRoleArn()
      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}

    • getSystemIds

      @Stability(Stable) @NotNull List<String> getSystemIds()
      List of unique identifiers for the DRM systems to use, as defined in the CPIX specification.

    • getUrl

      @Stability(Stable) @NotNull String getUrl()
      URL for the key provider’s key retrieval API endpoint.

      Must start with https://.

    • getCertificateArn

      @Stability(Stable) @Nullable default String getCertificateArn()
      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.

    • getEncryptionContractConfiguration

      @Stability(Stable) @Nullable default Object getEncryptionContractConfiguration()
      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.

    • builder

      @Stability(Stable) static CfnOriginEndpoint.SpekeKeyProviderProperty.Builder builder()
      Returns:
      a CfnOriginEndpoint.SpekeKeyProviderProperty.Builder of CfnOriginEndpoint.SpekeKeyProviderProperty