Package software.amazon.awscdk.services.mediapackage

Interface CfnPackagingConfiguration.SpekeKeyProviderProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPackagingConfiguration.SpekeKeyProviderProperty.Jsii$Proxy

Enclosing class:

CfnPackagingConfiguration

@Stability(Stable)
public static interface CfnPackagingConfiguration.SpekeKeyProviderProperty
extends software.amazon.jsii.JsiiSerializable

A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that provides encryption keys.

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()
         .roleArn("roleArn")
         .systemIds(List.of("systemIds"))
         .url("url")
         // the properties below are optional
         .encryptionContractConfiguration(EncryptionContractConfigurationProperty.builder()
                 .presetSpeke20Audio("presetSpeke20Audio")
                 .presetSpeke20Video("presetSpeke20Video")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-spekekeyprovider.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPackagingConfiguration.SpekeKeyProviderProperty.Builder	A builder for CfnPackagingConfiguration.SpekeKeyProviderProperty
static final class	CfnPackagingConfiguration.SpekeKeyProviderProperty.Jsii$Proxy	An implementation for CfnPackagingConfiguration.SpekeKeyProviderProperty

Method Summary

Modifier and Type	Method	Description
static CfnPackagingConfiguration.SpekeKeyProviderProperty.Builder	builder()
default Object	getEncryptionContractConfiguration()	Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0.
String	getRoleArn()	The ARN for the IAM role that's granted by the key provider to provide access to the key provider API.
List<String>	getSystemIds()	List of unique identifiers for the DRM systems to use, as defined in the CPIX specification.
String	getUrl()	URL for the key provider's key retrieval API endpoint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

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.

Valid format: arn:aws:iam::{accountID}:role/{name}

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-spekekeyprovider.html#cfn-mediapackage-packagingconfiguration-spekekeyprovider-rolearn

getSystemIds

@Stability(Stable)
@NotNull
List<String> getSystemIds()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-spekekeyprovider.html#cfn-mediapackage-packagingconfiguration-spekekeyprovider-systemids

getUrl

@Stability(Stable)
@NotNull
String getUrl()

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

Must start with https://.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-spekekeyprovider.html#cfn-mediapackage-packagingconfiguration-spekekeyprovider-url

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-spekekeyprovider.html#cfn-mediapackage-packagingconfiguration-spekekeyprovider-encryptioncontractconfiguration

builder

@Stability(Stable)
static CfnPackagingConfiguration.SpekeKeyProviderProperty.Builder builder()

Returns:

a CfnPackagingConfiguration.SpekeKeyProviderProperty.Builder of CfnPackagingConfiguration.SpekeKeyProviderProperty