software.amazon.awscdk.services.mediapackage

Class CfnPackagingConfiguration

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.mediapackage.CfnPackagingConfiguration

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-18T02:14:06.022Z")
public class CfnPackagingConfiguration
extends CfnResource
implements IInspectable

A CloudFormation `AWS::MediaPackage::PackagingConfiguration`.

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")
                                 .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")
                                 .build())
                         .build())
                 .includeEncoderConfigurationInSegments(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")
                                 .build())
                         // the properties below are optional
                         .constantInitializationVector("constantInitializationVector")
                         .encryptionMethod("encryptionMethod")
                         .build())
                 .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")
                                 .build())
                         .build())
                 .segmentDurationSeconds(123)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static 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.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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPackagingConfiguration(Construct scope, java.lang.String id, CfnPackagingConfigurationProps props) Create a new `AWS::MediaPackage::PackagingConfiguration`.
protected	CfnPackagingConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPackagingConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

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

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnPackagingConfiguration

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

CfnPackagingConfiguration

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

CfnPackagingConfiguration

public CfnPackagingConfiguration(Construct scope,
                                 java.lang.String id,
                                 CfnPackagingConfigurationProps props)

Create a new `AWS::MediaPackage::PackagingConfiguration`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.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

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags to assign to the packaging configuration.

getId

public java.lang.String getId()

Unique identifier that you assign to the packaging configuration.

setId

public void setId(java.lang.String value)

Unique identifier that you assign to the packaging configuration.

getPackagingGroupId

public java.lang.String getPackagingGroupId()

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

setPackagingGroupId

public void setPackagingGroupId(java.lang.String value)

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

getCmafPackage

public java.lang.Object getCmafPackage()

Parameters for CMAF packaging.

setCmafPackage

public void setCmafPackage(IResolvable value)

Parameters for CMAF packaging.

setCmafPackage

public void setCmafPackage(CfnPackagingConfiguration.CmafPackageProperty value)

Parameters for CMAF packaging.

getDashPackage

public java.lang.Object getDashPackage()

Parameters for DASH-ISO packaging.

setDashPackage

public void setDashPackage(IResolvable value)

Parameters for DASH-ISO packaging.

setDashPackage

public void setDashPackage(CfnPackagingConfiguration.DashPackageProperty value)

Parameters for DASH-ISO packaging.

getHlsPackage

public java.lang.Object getHlsPackage()

Parameters for Apple HLS packaging.

setHlsPackage

public void setHlsPackage(IResolvable value)

Parameters for Apple HLS packaging.

setHlsPackage

public void setHlsPackage(CfnPackagingConfiguration.HlsPackageProperty value)

Parameters for Apple HLS packaging.

getMssPackage

public java.lang.Object getMssPackage()

Parameters for Microsoft Smooth Streaming packaging.

setMssPackage

public void setMssPackage(IResolvable value)

Parameters for Microsoft Smooth Streaming packaging.

setMssPackage

public void setMssPackage(CfnPackagingConfiguration.MssPackageProperty value)

Parameters for Microsoft Smooth Streaming packaging.