Package software.amazon.awscdk.services.mediapackage

Class CfnPackagingConfiguration

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.mediapackage.CfnPackagingConfiguration

All Implemented Interfaces:

IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:09.936Z")
@Stability(Stable)
public class CfnPackagingConfiguration
extends CfnResource
implements IInspectable, ITaggable

Creates a packaging configuration in a packaging group.

The packaging configuration represents a single delivery point for an asset. It determines the format and setting for the egressing content. Specify only one package format per configuration, such as HlsPackage .

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.*;
 CfnPackagingConfiguration cfnPackagingConfiguration = CfnPackagingConfiguration.Builder.create(this, "MyCfnPackagingConfiguration")
         .id("id")
         .packagingGroupId("packagingGroupId")
         // the properties below are optional
         .cmafPackage(CmafPackageProperty.builder()
                 .hlsManifests(List.of(HlsManifestProperty.builder()
                         .adMarkers("adMarkers")
                         .includeIframeOnlyStream(false)
                         .manifestName("manifestName")
                         .programDateTimeIntervalSeconds(123)
                         .repeatExtXKey(false)
                         .streamSelection(StreamSelectionProperty.builder()
                                 .maxVideoBitsPerSecond(123)
                                 .minVideoBitsPerSecond(123)
                                 .streamOrder("streamOrder")
                                 .build())
                         .build()))
                 // the properties below are optional
                 .encryption(CmafEncryptionProperty.builder()
                         .spekeKeyProvider(SpekeKeyProviderProperty.builder()
                                 .roleArn("roleArn")
                                 .systemIds(List.of("systemIds"))
                                 .url("url")
                                 // the properties below are optional
                                 .encryptionContractConfiguration(EncryptionContractConfigurationProperty.builder()
                                         .presetSpeke20Audio("presetSpeke20Audio")
                                         .presetSpeke20Video("presetSpeke20Video")
                                         .build())
                                 .build())
                         .build())
                 .includeEncoderConfigurationInSegments(false)
                 .segmentDurationSeconds(123)
                 .build())
         .dashPackage(DashPackageProperty.builder()
                 .dashManifests(List.of(DashManifestProperty.builder()
                         .manifestLayout("manifestLayout")
                         .manifestName("manifestName")
                         .minBufferTimeSeconds(123)
                         .profile("profile")
                         .scteMarkersSource("scteMarkersSource")
                         .streamSelection(StreamSelectionProperty.builder()
                                 .maxVideoBitsPerSecond(123)
                                 .minVideoBitsPerSecond(123)
                                 .streamOrder("streamOrder")
                                 .build())
                         .build()))
                 // the properties below are optional
                 .encryption(DashEncryptionProperty.builder()
                         .spekeKeyProvider(SpekeKeyProviderProperty.builder()
                                 .roleArn("roleArn")
                                 .systemIds(List.of("systemIds"))
                                 .url("url")
                                 // the properties below are optional
                                 .encryptionContractConfiguration(EncryptionContractConfigurationProperty.builder()
                                         .presetSpeke20Audio("presetSpeke20Audio")
                                         .presetSpeke20Video("presetSpeke20Video")
                                         .build())
                                 .build())
                         .build())
                 .includeEncoderConfigurationInSegments(false)
                 .includeIframeOnlyStream(false)
                 .periodTriggers(List.of("periodTriggers"))
                 .segmentDurationSeconds(123)
                 .segmentTemplateFormat("segmentTemplateFormat")
                 .build())
         .hlsPackage(HlsPackageProperty.builder()
                 .hlsManifests(List.of(HlsManifestProperty.builder()
                         .adMarkers("adMarkers")
                         .includeIframeOnlyStream(false)
                         .manifestName("manifestName")
                         .programDateTimeIntervalSeconds(123)
                         .repeatExtXKey(false)
                         .streamSelection(StreamSelectionProperty.builder()
                                 .maxVideoBitsPerSecond(123)
                                 .minVideoBitsPerSecond(123)
                                 .streamOrder("streamOrder")
                                 .build())
                         .build()))
                 // the properties below are optional
                 .encryption(HlsEncryptionProperty.builder()
                         .spekeKeyProvider(SpekeKeyProviderProperty.builder()
                                 .roleArn("roleArn")
                                 .systemIds(List.of("systemIds"))
                                 .url("url")
                                 // the properties below are optional
                                 .encryptionContractConfiguration(EncryptionContractConfigurationProperty.builder()
                                         .presetSpeke20Audio("presetSpeke20Audio")
                                         .presetSpeke20Video("presetSpeke20Video")
                                         .build())
                                 .build())
                         // the properties below are optional
                         .constantInitializationVector("constantInitializationVector")
                         .encryptionMethod("encryptionMethod")
                         .build())
                 .includeDvbSubtitles(false)
                 .segmentDurationSeconds(123)
                 .useAudioRenditionGroup(false)
                 .build())
         .mssPackage(MssPackageProperty.builder()
                 .mssManifests(List.of(MssManifestProperty.builder()
                         .manifestName("manifestName")
                         .streamSelection(StreamSelectionProperty.builder()
                                 .maxVideoBitsPerSecond(123)
                                 .minVideoBitsPerSecond(123)
                                 .streamOrder("streamOrder")
                                 .build())
                         .build()))
                 // the properties below are optional
                 .encryption(MssEncryptionProperty.builder()
                         .spekeKeyProvider(SpekeKeyProviderProperty.builder()
                                 .roleArn("roleArn")
                                 .systemIds(List.of("systemIds"))
                                 .url("url")
                                 // the properties below are optional
                                 .encryptionContractConfiguration(EncryptionContractConfigurationProperty.builder()
                                         .presetSpeke20Audio("presetSpeke20Audio")
                                         .presetSpeke20Video("presetSpeke20Video")
                                         .build())
                                 .build())
                         .build())
                 .segmentDurationSeconds(123)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnPackagingConfiguration.Builder	A fluent builder for CfnPackagingConfiguration.
static interface	CfnPackagingConfiguration.CmafEncryptionProperty	Holds encryption information so that access to the content can be controlled by a DRM solution.
static interface	CfnPackagingConfiguration.CmafPackageProperty	Parameters for a packaging configuration that uses Common Media Application Format (CMAF) packaging.
static interface	CfnPackagingConfiguration.DashEncryptionProperty	Holds encryption information so that access to the content can be controlled by a DRM solution.
static interface	CfnPackagingConfiguration.DashManifestProperty	Parameters for a DASH manifest.
static interface	CfnPackagingConfiguration.DashPackageProperty	Parameters for a packaging configuration that uses Dynamic Adaptive Streaming over HTTP (DASH) packaging.
static interface	CfnPackagingConfiguration.EncryptionContractConfigurationProperty	Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0.
static interface	CfnPackagingConfiguration.HlsEncryptionProperty	Holds encryption information so that access to the content can be controlled by a DRM solution.
static interface	CfnPackagingConfiguration.HlsManifestProperty	Parameters for an HLS manifest.
static interface	CfnPackagingConfiguration.HlsPackageProperty	Parameters for a packaging configuration that uses HTTP Live Streaming (HLS) packaging.
static interface	CfnPackagingConfiguration.MssEncryptionProperty	Holds encryption information so that access to the content can be controlled by a DRM solution.
static interface	CfnPackagingConfiguration.MssManifestProperty	Parameters for a Microsoft Smooth manifest.
static interface	CfnPackagingConfiguration.MssPackageProperty	Parameters for a packaging configuration that uses Microsoft Smooth Streaming (MSS) packaging.
static interface	CfnPackagingConfiguration.SpekeKeyProviderProperty	A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that provides encryption keys.
static interface	CfnPackagingConfiguration.StreamSelectionProperty	Limitations for outputs from the endpoint, based on the video bitrate.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnPackagingConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPackagingConfiguration(software.amazon.jsii.JsiiObjectRef objRef)
	CfnPackagingConfiguration(software.constructs.Construct scope, String id, CfnPackagingConfigurationProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The Amazon Resource Name (ARN) for the packaging configuration.
protected Map<String,Object>	getCfnProperties()
Object	getCmafPackage()	Parameters for CMAF packaging.
Object	getDashPackage()	Parameters for DASH-ISO packaging.
Object	getHlsPackage()	Parameters for Apple HLS packaging.
String	getId()	Unique identifier that you assign to the packaging configuration.
Object	getMssPackage()	Parameters for Microsoft Smooth Streaming packaging.
String	getPackagingGroupId()	The ID of the packaging group associated with this packaging configuration.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	The tags to assign to the packaging configuration.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCmafPackage(IResolvable value)	Parameters for CMAF packaging.
void	setCmafPackage(CfnPackagingConfiguration.CmafPackageProperty value)	Parameters for CMAF packaging.
void	setDashPackage(IResolvable value)	Parameters for DASH-ISO packaging.
void	setDashPackage(CfnPackagingConfiguration.DashPackageProperty value)	Parameters for DASH-ISO packaging.
void	setHlsPackage(IResolvable value)	Parameters for Apple HLS packaging.
void	setHlsPackage(CfnPackagingConfiguration.HlsPackageProperty value)	Parameters for Apple HLS packaging.
void	setId(String value)	Unique identifier that you assign to the packaging configuration.
void	setMssPackage(IResolvable value)	Parameters for Microsoft Smooth Streaming packaging.
void	setMssPackage(CfnPackagingConfiguration.MssPackageProperty value)	Parameters for Microsoft Smooth Streaming packaging.
void	setPackagingGroupId(String value)	The ID of the packaging group associated with this packaging configuration.
void	setTagsRaw(List<CfnTag> value)	The tags to assign to the packaging configuration.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnPackagingConfiguration

protected CfnPackagingConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

CfnPackagingConfiguration

protected CfnPackagingConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnPackagingConfiguration

@Stability(Stable)
public CfnPackagingConfiguration(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnPackagingConfigurationProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) for the packaging configuration.

You can get this from the response to any request to the packaging configuration.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getId

@Stability(Stable)
@NotNull
public String getId()

Unique identifier that you assign to the packaging configuration.

setId

@Stability(Stable)
public void setId(@NotNull
 String value)

Unique identifier that you assign to the packaging configuration.

getPackagingGroupId

@Stability(Stable)
@NotNull
public String getPackagingGroupId()

The ID of the packaging group associated with this packaging configuration.

setPackagingGroupId

@Stability(Stable)
public void setPackagingGroupId(@NotNull
 String value)

The ID of the packaging group associated with this packaging configuration.

getCmafPackage

@Stability(Stable)
@Nullable
public Object getCmafPackage()

Parameters for CMAF packaging.

setCmafPackage

@Stability(Stable)
public void setCmafPackage(@Nullable
 IResolvable value)

Parameters for CMAF packaging.

setCmafPackage

@Stability(Stable)
public void setCmafPackage(@Nullable
 CfnPackagingConfiguration.CmafPackageProperty value)

Parameters for CMAF packaging.

getDashPackage

@Stability(Stable)
@Nullable
public Object getDashPackage()

Parameters for DASH-ISO packaging.

setDashPackage

@Stability(Stable)
public void setDashPackage(@Nullable
 IResolvable value)

Parameters for DASH-ISO packaging.

setDashPackage

@Stability(Stable)
public void setDashPackage(@Nullable
 CfnPackagingConfiguration.DashPackageProperty value)

Parameters for DASH-ISO packaging.

getHlsPackage

@Stability(Stable)
@Nullable
public Object getHlsPackage()

Parameters for Apple HLS packaging.

setHlsPackage

@Stability(Stable)
public void setHlsPackage(@Nullable
 IResolvable value)

Parameters for Apple HLS packaging.

setHlsPackage

@Stability(Stable)
public void setHlsPackage(@Nullable
 CfnPackagingConfiguration.HlsPackageProperty value)

Parameters for Apple HLS packaging.

getMssPackage

@Stability(Stable)
@Nullable
public Object getMssPackage()

Parameters for Microsoft Smooth Streaming packaging.

setMssPackage

@Stability(Stable)
public void setMssPackage(@Nullable
 IResolvable value)

Parameters for Microsoft Smooth Streaming packaging.

setMssPackage

@Stability(Stable)
public void setMssPackage(@Nullable
 CfnPackagingConfiguration.MssPackageProperty value)

Parameters for Microsoft Smooth Streaming packaging.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

The tags to assign to the packaging configuration.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

The tags to assign to the packaging configuration.