Package software.amazon.awscdk.services.mediapackagev2

Interface CfnOriginEndpoint.EncryptionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnOriginEndpoint.EncryptionProperty.Jsii$Proxy

Enclosing class:

CfnOriginEndpoint

@Stability(Stable)
public static interface CfnOriginEndpoint.EncryptionProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.mediapackagev2.*;
 EncryptionProperty encryptionProperty = EncryptionProperty.builder()
         .encryptionMethod(EncryptionMethodProperty.builder()
                 .cmafEncryptionMethod("cmafEncryptionMethod")
                 .tsEncryptionMethod("tsEncryptionMethod")
                 .build())
         .spekeKeyProvider(SpekeKeyProviderProperty.builder()
                 .drmSystems(List.of("drmSystems"))
                 .encryptionContractConfiguration(EncryptionContractConfigurationProperty.builder()
                         .presetSpeke20Audio("presetSpeke20Audio")
                         .presetSpeke20Video("presetSpeke20Video")
                         .build())
                 .resourceId("resourceId")
                 .roleArn("roleArn")
                 .url("url")
                 .build())
         // the properties below are optional
         .cmafExcludeSegmentDrmMetadata(false)
         .constantInitializationVector("constantInitializationVector")
         .keyRotationIntervalSeconds(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryption.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnOriginEndpoint.EncryptionProperty.Builder	builder()
default Object	getCmafExcludeSegmentDrmMetadata()	Excludes SEIG and SGPD boxes from segment metadata in CMAF containers.
default String	getConstantInitializationVector()	A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content.
Object	getEncryptionMethod()	The encryption method to use.
default Number	getKeyRotationIntervalSeconds()	The interval, in seconds, to rotate encryption keys for the origin endpoint.
Object	getSpekeKeyProvider()	The SPEKE key provider to use for encryption.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEncryptionMethod

@Stability(Stable)
@NotNull
Object getEncryptionMethod()

The encryption method to use.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryption.html#cfn-mediapackagev2-originendpoint-encryption-encryptionmethod

getSpekeKeyProvider

@Stability(Stable)
@NotNull
Object getSpekeKeyProvider()

The SPEKE key provider to use for encryption.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryption.html#cfn-mediapackagev2-originendpoint-encryption-spekekeyprovider

getCmafExcludeSegmentDrmMetadata

@Stability(Stable)
@Nullable
default Object getCmafExcludeSegmentDrmMetadata()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryption.html#cfn-mediapackagev2-originendpoint-encryption-cmafexcludesegmentdrmmetadata

getConstantInitializationVector

@Stability(Stable)
@Nullable
default String getConstantInitializationVector()

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).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryption.html#cfn-mediapackagev2-originendpoint-encryption-constantinitializationvector

getKeyRotationIntervalSeconds

@Stability(Stable)
@Nullable
default Number getKeyRotationIntervalSeconds()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryption.html#cfn-mediapackagev2-originendpoint-encryption-keyrotationintervalseconds

builder

@Stability(Stable)
static CfnOriginEndpoint.EncryptionProperty.Builder builder()

Returns:

a CfnOriginEndpoint.EncryptionProperty.Builder of CfnOriginEndpoint.EncryptionProperty