CfnPackagingConfiguration

class aws_cdk.aws_mediapackage.CfnPackagingConfiguration(scope, id_, *, id, packaging_group_id, cmaf_package=None, dash_package=None, hls_package=None, mss_package=None, tags=None)

Bases: CfnResource

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 .

See:

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

CloudformationResource:

AWS::MediaPackage::PackagingConfiguration

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediapackage as mediapackage

cfn_packaging_configuration = mediapackage.CfnPackagingConfiguration(self, "MyCfnPackagingConfiguration",
    id="id",
    packaging_group_id="packagingGroupId",

    # the properties below are optional
    cmaf_package=mediapackage.CfnPackagingConfiguration.CmafPackageProperty(
        hls_manifests=[mediapackage.CfnPackagingConfiguration.HlsManifestProperty(
            ad_markers="adMarkers",
            include_iframe_only_stream=False,
            manifest_name="manifestName",
            program_date_time_interval_seconds=123,
            repeat_ext_xKey=False,
            stream_selection=mediapackage.CfnPackagingConfiguration.StreamSelectionProperty(
                max_video_bits_per_second=123,
                min_video_bits_per_second=123,
                stream_order="streamOrder"
            )
        )],

        # the properties below are optional
        encryption=mediapackage.CfnPackagingConfiguration.CmafEncryptionProperty(
            speke_key_provider=mediapackage.CfnPackagingConfiguration.SpekeKeyProviderProperty(
                role_arn="roleArn",
                system_ids=["systemIds"],
                url="url",

                # the properties below are optional
                encryption_contract_configuration=mediapackage.CfnPackagingConfiguration.EncryptionContractConfigurationProperty(
                    preset_speke20_audio="presetSpeke20Audio",
                    preset_speke20_video="presetSpeke20Video"
                )
            )
        ),
        include_encoder_configuration_in_segments=False,
        segment_duration_seconds=123
    ),
    dash_package=mediapackage.CfnPackagingConfiguration.DashPackageProperty(
        dash_manifests=[mediapackage.CfnPackagingConfiguration.DashManifestProperty(
            manifest_layout="manifestLayout",
            manifest_name="manifestName",
            min_buffer_time_seconds=123,
            profile="profile",
            scte_markers_source="scteMarkersSource",
            stream_selection=mediapackage.CfnPackagingConfiguration.StreamSelectionProperty(
                max_video_bits_per_second=123,
                min_video_bits_per_second=123,
                stream_order="streamOrder"
            )
        )],

        # the properties below are optional
        encryption=mediapackage.CfnPackagingConfiguration.DashEncryptionProperty(
            speke_key_provider=mediapackage.CfnPackagingConfiguration.SpekeKeyProviderProperty(
                role_arn="roleArn",
                system_ids=["systemIds"],
                url="url",

                # the properties below are optional
                encryption_contract_configuration=mediapackage.CfnPackagingConfiguration.EncryptionContractConfigurationProperty(
                    preset_speke20_audio="presetSpeke20Audio",
                    preset_speke20_video="presetSpeke20Video"
                )
            )
        ),
        include_encoder_configuration_in_segments=False,
        include_iframe_only_stream=False,
        period_triggers=["periodTriggers"],
        segment_duration_seconds=123,
        segment_template_format="segmentTemplateFormat"
    ),
    hls_package=mediapackage.CfnPackagingConfiguration.HlsPackageProperty(
        hls_manifests=[mediapackage.CfnPackagingConfiguration.HlsManifestProperty(
            ad_markers="adMarkers",
            include_iframe_only_stream=False,
            manifest_name="manifestName",
            program_date_time_interval_seconds=123,
            repeat_ext_xKey=False,
            stream_selection=mediapackage.CfnPackagingConfiguration.StreamSelectionProperty(
                max_video_bits_per_second=123,
                min_video_bits_per_second=123,
                stream_order="streamOrder"
            )
        )],

        # the properties below are optional
        encryption=mediapackage.CfnPackagingConfiguration.HlsEncryptionProperty(
            speke_key_provider=mediapackage.CfnPackagingConfiguration.SpekeKeyProviderProperty(
                role_arn="roleArn",
                system_ids=["systemIds"],
                url="url",

                # the properties below are optional
                encryption_contract_configuration=mediapackage.CfnPackagingConfiguration.EncryptionContractConfigurationProperty(
                    preset_speke20_audio="presetSpeke20Audio",
                    preset_speke20_video="presetSpeke20Video"
                )
            ),

            # the properties below are optional
            constant_initialization_vector="constantInitializationVector",
            encryption_method="encryptionMethod"
        ),
        include_dvb_subtitles=False,
        segment_duration_seconds=123,
        use_audio_rendition_group=False
    ),
    mss_package=mediapackage.CfnPackagingConfiguration.MssPackageProperty(
        mss_manifests=[mediapackage.CfnPackagingConfiguration.MssManifestProperty(
            manifest_name="manifestName",
            stream_selection=mediapackage.CfnPackagingConfiguration.StreamSelectionProperty(
                max_video_bits_per_second=123,
                min_video_bits_per_second=123,
                stream_order="streamOrder"
            )
        )],

        # the properties below are optional
        encryption=mediapackage.CfnPackagingConfiguration.MssEncryptionProperty(
            speke_key_provider=mediapackage.CfnPackagingConfiguration.SpekeKeyProviderProperty(
                role_arn="roleArn",
                system_ids=["systemIds"],
                url="url",

                # the properties below are optional
                encryption_contract_configuration=mediapackage.CfnPackagingConfiguration.EncryptionContractConfigurationProperty(
                    preset_speke20_audio="presetSpeke20Audio",
                    preset_speke20_video="presetSpeke20Video"
                )
            )
        ),
        segment_duration_seconds=123
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • id – Unique identifier that you assign to the packaging configuration.

  • packaging_group_id (str) – The ID of the packaging group associated with this packaging configuration.

  • cmaf_package (Union[IResolvable, CmafPackageProperty, Dict[str, Any], None]) – Parameters for CMAF packaging.

  • dash_package (Union[IResolvable, DashPackageProperty, Dict[str, Any], None]) – Parameters for DASH-ISO packaging.

  • hls_package (Union[IResolvable, HlsPackageProperty, Dict[str, Any], None]) – Parameters for Apple HLS packaging.

  • mss_package (Union[IResolvable, MssPackageProperty, Dict[str, Any], None]) – Parameters for Microsoft Smooth Streaming packaging.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags to assign to the packaging configuration.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::MediaPackage::PackagingConfiguration'
attr_arn

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

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

CloudformationAttribute:

Arn

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

cmaf_package

Parameters for CMAF packaging.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

dash_package

Parameters for DASH-ISO packaging.

hls_package

Parameters for Apple HLS packaging.

id

Unique identifier that you assign to the packaging configuration.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

mss_package

Parameters for Microsoft Smooth Streaming packaging.

node

The tree node.

packaging_group_id

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

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Tag Manager which manages the tags for this resource.

tags_raw

The tags to assign to the packaging configuration.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

CmafEncryptionProperty

class CfnPackagingConfiguration.CmafEncryptionProperty(*, speke_key_provider)

Bases: object

Holds encryption information so that access to the content can be controlled by a DRM solution.

Parameters:

speke_key_provider (Union[IResolvable, SpekeKeyProviderProperty, Dict[str, Any]]) – Parameters for the SPEKE key provider.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediapackage as mediapackage

cmaf_encryption_property = mediapackage.CfnPackagingConfiguration.CmafEncryptionProperty(
    speke_key_provider=mediapackage.CfnPackagingConfiguration.SpekeKeyProviderProperty(
        role_arn="roleArn",
        system_ids=["systemIds"],
        url="url",

        # the properties below are optional
        encryption_contract_configuration=mediapackage.CfnPackagingConfiguration.EncryptionContractConfigurationProperty(
            preset_speke20_audio="presetSpeke20Audio",
            preset_speke20_video="presetSpeke20Video"
        )
    )
)

Attributes

speke_key_provider

Parameters for the SPEKE key provider.

See:

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

CmafPackageProperty

class CfnPackagingConfiguration.CmafPackageProperty(*, hls_manifests, encryption=None, include_encoder_configuration_in_segments=None, segment_duration_seconds=None)

Bases: object

Parameters for a packaging configuration that uses Common Media Application Format (CMAF) packaging.

Parameters:

  • hls_manifests (Union[IResolvable, Sequence[Union[IResolvable, HlsManifestProperty, Dict[str, Any]]]]) – A list of HLS manifest configurations that are available from this endpoint.

  • encryption (Union[IResolvable, CmafEncryptionProperty, Dict[str, Any], None]) – Parameters for encrypting content.

  • include_encoder_configuration_in_segments (Union[bool, IResolvable, None]) – When includeEncoderConfigurationInSegments is set to true, AWS Elemental MediaPackage places your encoder’s Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.

  • segment_duration_seconds (Union[int, float, None]) – Duration (in seconds) of each segment. Actual segments are rounded to the nearest multiple of the source fragment duration.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediapackage as mediapackage

cmaf_package_property = mediapackage.CfnPackagingConfiguration.CmafPackageProperty(
    hls_manifests=[mediapackage.CfnPackagingConfiguration.HlsManifestProperty(
        ad_markers="adMarkers",
        include_iframe_only_stream=False,
        manifest_name="manifestName",
        program_date_time_interval_seconds=123,
        repeat_ext_xKey=False,
        stream_selection=mediapackage.CfnPackagingConfiguration.StreamSelectionProperty(
            max_video_bits_per_second=123,
            min_video_bits_per_second=123,
            stream_order="streamOrder"
        )
    )],

    # the properties below are optional
    encryption=mediapackage.CfnPackagingConfiguration.CmafEncryptionProperty(
        speke_key_provider=mediapackage.CfnPackagingConfiguration.SpekeKeyProviderProperty(
            role_arn="roleArn",
            system_ids=["systemIds"],
            url="url",

            # the properties below are optional
            encryption_contract_configuration=mediapackage.CfnPackagingConfiguration.EncryptionContractConfigurationProperty(
                preset_speke20_audio="presetSpeke20Audio",
                preset_speke20_video="presetSpeke20Video"
            )
        )
    ),
    include_encoder_configuration_in_segments=False,
    segment_duration_seconds=123
)

Attributes

encryption

Parameters for encrypting content.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-cmafpackage.html#cfn-mediapackage-packagingconfiguration-cmafpackage-encryption

hls_manifests

A list of HLS manifest configurations that are available from this endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-cmafpackage.html#cfn-mediapackage-packagingconfiguration-cmafpackage-hlsmanifests

include_encoder_configuration_in_segments

When includeEncoderConfigurationInSegments is set to true, AWS Elemental MediaPackage places your encoder’s Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment.

This lets you use different SPS/PPS/VPS settings for your assets during content playback.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-cmafpackage.html#cfn-mediapackage-packagingconfiguration-cmafpackage-includeencoderconfigurationinsegments

segment_duration_seconds

Duration (in seconds) of each segment.

Actual segments are rounded to the nearest multiple of the source fragment duration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-cmafpackage.html#cfn-mediapackage-packagingconfiguration-cmafpackage-segmentdurationseconds

DashEncryptionProperty

class CfnPackagingConfiguration.DashEncryptionProperty(*, speke_key_provider)

Bases: object

Holds encryption information so that access to the content can be controlled by a DRM solution.

Parameters:

speke_key_provider (Union[IResolvable, SpekeKeyProviderProperty, Dict[str, Any]]) – Parameters for the SPEKE key provider.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediapackage as mediapackage

dash_encryption_property = mediapackage.CfnPackagingConfiguration.DashEncryptionProperty(
    speke_key_provider=mediapackage.CfnPackagingConfiguration.SpekeKeyProviderProperty(
        role_arn="roleArn",
        system_ids=["systemIds"],
        url="url",

        # the properties below are optional
        encryption_contract_configuration=mediapackage.CfnPackagingConfiguration.EncryptionContractConfigurationProperty(
            preset_speke20_audio="presetSpeke20Audio",
            preset_speke20_video="presetSpeke20Video"
        )
    )
)

Attributes

speke_key_provider

Parameters for the SPEKE key provider.

See:

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

DashManifestProperty

class CfnPackagingConfiguration.DashManifestProperty(*, manifest_layout=None, manifest_name=None, min_buffer_time_seconds=None, profile=None, scte_markers_source=None, stream_selection=None)

Bases: object

Parameters for a DASH manifest.

Parameters:

  • manifest_layout (Optional[str]) – Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL , elements like SegmentTemplate and ContentProtection are included in each Representation . When set to COMPACT , duplicate elements are combined and presented at the AdaptationSet level.

  • manifest_name (Optional[str]) – A short string that’s appended to the end of the endpoint URL to create a unique path to this packaging configuration.

  • min_buffer_time_seconds (Union[int, float, None]) – Minimum amount of content (measured in seconds) that a player must keep available in the buffer.

  • profile (Optional[str]) – The DASH profile type. When set to HBBTV_1_5 , the content is compliant with HbbTV 1.5.

  • scte_markers_source (Optional[str]) – The source of scte markers used. Value description: - SEGMENTS - The scte markers are sourced from the segments of the ingested content. - MANIFEST - the scte markers are sourced from the manifest of the ingested content. The MANIFEST value is compatible with source HLS playlists using the SCTE-35 Enhanced syntax ( EXT-OATCLS-SCTE35 tags). SCTE-35 Elemental and SCTE-35 Daterange syntaxes are not supported with this option.

  • stream_selection (Union[IResolvable, StreamSelectionProperty, Dict[str, Any], None]) – Limitations for outputs from the endpoint, based on the video bitrate.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediapackage as mediapackage

dash_manifest_property = mediapackage.CfnPackagingConfiguration.DashManifestProperty(
    manifest_layout="manifestLayout",
    manifest_name="manifestName",
    min_buffer_time_seconds=123,
    profile="profile",
    scte_markers_source="scteMarkersSource",
    stream_selection=mediapackage.CfnPackagingConfiguration.StreamSelectionProperty(
        max_video_bits_per_second=123,
        min_video_bits_per_second=123,
        stream_order="streamOrder"
    )
)

Attributes

manifest_layout

Determines the position of some tags in the Media Presentation Description (MPD).

When set to FULL , elements like SegmentTemplate and ContentProtection are included in each Representation . When set to COMPACT , duplicate elements are combined and presented at the AdaptationSet level.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashmanifest.html#cfn-mediapackage-packagingconfiguration-dashmanifest-manifestlayout

manifest_name

A short string that’s appended to the end of the endpoint URL to create a unique path to this packaging configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashmanifest.html#cfn-mediapackage-packagingconfiguration-dashmanifest-manifestname

min_buffer_time_seconds

Minimum amount of content (measured in seconds) that a player must keep available in the buffer.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashmanifest.html#cfn-mediapackage-packagingconfiguration-dashmanifest-minbuffertimeseconds

profile

The DASH profile type.

When set to HBBTV_1_5 , the content is compliant with HbbTV 1.5.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashmanifest.html#cfn-mediapackage-packagingconfiguration-dashmanifest-profile

scte_markers_source

The source of scte markers used.

Value description:

  • SEGMENTS - The scte markers are sourced from the segments of the ingested content.

  • MANIFEST - the scte markers are sourced from the manifest of the ingested content. The MANIFEST value is compatible with source HLS playlists using the SCTE-35 Enhanced syntax ( EXT-OATCLS-SCTE35 tags). SCTE-35 Elemental and SCTE-35 Daterange syntaxes are not supported with this option.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashmanifest.html#cfn-mediapackage-packagingconfiguration-dashmanifest-sctemarkerssource

stream_selection

Limitations for outputs from the endpoint, based on the video bitrate.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashmanifest.html#cfn-mediapackage-packagingconfiguration-dashmanifest-streamselection

DashPackageProperty

class CfnPackagingConfiguration.DashPackageProperty(*, dash_manifests, encryption=None, include_encoder_configuration_in_segments=None, include_iframe_only_stream=None, period_triggers=None, segment_duration_seconds=None, segment_template_format=None)

Bases: object

Parameters for a packaging configuration that uses Dynamic Adaptive Streaming over HTTP (DASH) packaging.

Parameters:

  • dash_manifests (Union[IResolvable, Sequence[Union[IResolvable, DashManifestProperty, Dict[str, Any]]]]) – A list of DASH manifest configurations that are available from this endpoint.

  • encryption (Union[IResolvable, DashEncryptionProperty, Dict[str, Any], None]) – Parameters for encrypting content.

  • include_encoder_configuration_in_segments (Union[bool, IResolvable, None]) – When includeEncoderConfigurationInSegments is set to true, AWS Elemental MediaPackage places your encoder’s Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.

  • include_iframe_only_stream (Union[bool, IResolvable, None]) – This applies only to stream sets with a single video track. When true, the stream set includes an additional I-frame trick-play only stream, along with the other tracks. If false, this extra stream is not included.

  • period_triggers (Optional[Sequence[str]]) – Controls whether AWS Elemental MediaPackage produces single-period or multi-period DASH manifests. For more information about periods, see Multi-period DASH in AWS Elemental MediaPackage . Valid values: - ADS - AWS Elemental MediaPackage will produce multi-period DASH manifests. Periods are created based on the SCTE-35 ad markers present in the input manifest. - No value - AWS Elemental MediaPackage will produce single-period DASH manifests. This is the default setting.

  • segment_duration_seconds (Union[int, float, None]) – Duration (in seconds) of each fragment. Actual fragments are rounded to the nearest multiple of the source segment duration.

  • segment_template_format (Optional[str]) – Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE , a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE , a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION , only a duration is included in each SegmentTemplate, with $Number$ media URLs.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediapackage as mediapackage

dash_package_property = mediapackage.CfnPackagingConfiguration.DashPackageProperty(
    dash_manifests=[mediapackage.CfnPackagingConfiguration.DashManifestProperty(
        manifest_layout="manifestLayout",
        manifest_name="manifestName",
        min_buffer_time_seconds=123,
        profile="profile",
        scte_markers_source="scteMarkersSource",
        stream_selection=mediapackage.CfnPackagingConfiguration.StreamSelectionProperty(
            max_video_bits_per_second=123,
            min_video_bits_per_second=123,
            stream_order="streamOrder"
        )
    )],

    # the properties below are optional
    encryption=mediapackage.CfnPackagingConfiguration.DashEncryptionProperty(
        speke_key_provider=mediapackage.CfnPackagingConfiguration.SpekeKeyProviderProperty(
            role_arn="roleArn",
            system_ids=["systemIds"],
            url="url",

            # the properties below are optional
            encryption_contract_configuration=mediapackage.CfnPackagingConfiguration.EncryptionContractConfigurationProperty(
                preset_speke20_audio="presetSpeke20Audio",
                preset_speke20_video="presetSpeke20Video"
            )
        )
    ),
    include_encoder_configuration_in_segments=False,
    include_iframe_only_stream=False,
    period_triggers=["periodTriggers"],
    segment_duration_seconds=123,
    segment_template_format="segmentTemplateFormat"
)

Attributes

dash_manifests

A list of DASH manifest configurations that are available from this endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashpackage.html#cfn-mediapackage-packagingconfiguration-dashpackage-dashmanifests

encryption

Parameters for encrypting content.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashpackage.html#cfn-mediapackage-packagingconfiguration-dashpackage-encryption

include_encoder_configuration_in_segments

When includeEncoderConfigurationInSegments is set to true, AWS Elemental MediaPackage places your encoder’s Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment.

This lets you use different SPS/PPS/VPS settings for your assets during content playback.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashpackage.html#cfn-mediapackage-packagingconfiguration-dashpackage-includeencoderconfigurationinsegments

include_iframe_only_stream

This applies only to stream sets with a single video track.

When true, the stream set includes an additional I-frame trick-play only stream, along with the other tracks. If false, this extra stream is not included.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashpackage.html#cfn-mediapackage-packagingconfiguration-dashpackage-includeiframeonlystream

period_triggers

Controls whether AWS Elemental MediaPackage produces single-period or multi-period DASH manifests.

For more information about periods, see Multi-period DASH in AWS Elemental MediaPackage .

Valid values:

  • ADS - AWS Elemental MediaPackage will produce multi-period DASH manifests. Periods are created based on the SCTE-35 ad markers present in the input manifest.

  • No value - AWS Elemental MediaPackage will produce single-period DASH manifests. This is the default setting.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashpackage.html#cfn-mediapackage-packagingconfiguration-dashpackage-periodtriggers

segment_duration_seconds

Duration (in seconds) of each fragment.

Actual fragments are rounded to the nearest multiple of the source segment duration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashpackage.html#cfn-mediapackage-packagingconfiguration-dashpackage-segmentdurationseconds

segment_template_format

Determines the type of SegmentTemplate included in the Media Presentation Description (MPD).

When set to NUMBER_WITH_TIMELINE , a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE , a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION , only a duration is included in each SegmentTemplate, with $Number$ media URLs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashpackage.html#cfn-mediapackage-packagingconfiguration-dashpackage-segmenttemplateformat

EncryptionContractConfigurationProperty

class CfnPackagingConfiguration.EncryptionContractConfigurationProperty(*, preset_speke20_audio, preset_speke20_video)

Bases: object

Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines the content keys 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. For more information about these presets, see SPEKE Version 2.0 Presets .

Note the following considerations when using encryptionContractConfiguration :

  • You can use encryptionContractConfiguration for DASH endpoints that use SPEKE Version 2.0. SPEKE Version 2.0 relies on the CPIX Version 2.3 specification.

  • You cannot combine an UNENCRYPTED preset with UNENCRYPTED or SHARED presets across presetSpeke20Audio and presetSpeke20Video .

  • When you use a SHARED preset, you must use it for both presetSpeke20Audio and presetSpeke20Video .

Parameters:

  • preset_speke20_audio (str) – A collection of audio encryption presets. Value description: - PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream. - PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks. - PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels. - SHARED - Use the same content key for all of the audio and video tracks in your stream. - UNENCRYPTED - Don’t encrypt any of the audio tracks in your stream.

  • preset_speke20_video (str) – A collection of video encryption presets. Value description: - PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream. - PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks. - PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks. - PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. - PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. - PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks. - PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks. - PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. - SHARED - Use the same content key for all of the video and audio tracks in your stream. - UNENCRYPTED - Don’t encrypt any of the video tracks in your stream.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediapackage as mediapackage

encryption_contract_configuration_property = mediapackage.CfnPackagingConfiguration.EncryptionContractConfigurationProperty(
    preset_speke20_audio="presetSpeke20Audio",
    preset_speke20_video="presetSpeke20Video"
)

Attributes

preset_speke20_audio

A collection of audio encryption presets.

Value description:

  • PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.

  • PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.

  • PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.

  • SHARED - Use the same content key for all of the audio and video tracks in your stream.

  • UNENCRYPTED - Don’t encrypt any of the audio tracks in your stream.

See:

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

preset_speke20_video

A collection of video encryption presets.

Value description:

  • PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.

  • PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.

  • PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.

  • PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

  • PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

  • PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

  • PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

  • PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

  • SHARED - Use the same content key for all of the video and audio tracks in your stream.

  • UNENCRYPTED - Don’t encrypt any of the video tracks in your stream.

See:

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

HlsEncryptionProperty

class CfnPackagingConfiguration.HlsEncryptionProperty(*, speke_key_provider, constant_initialization_vector=None, encryption_method=None)

Bases: object

Holds encryption information so that access to the content can be controlled by a DRM solution.

Parameters:

  • speke_key_provider (Union[IResolvable, SpekeKeyProviderProperty, Dict[str, Any]]) – Parameters for the SPEKE key provider.

  • constant_initialization_vector (Optional[str]) – A 128-bit, 16-byte hex value represented by a 32-character string, used with the key for encrypting blocks. If you don’t specify a constant initialization vector (IV), AWS Elemental MediaPackage periodically rotates the IV.

  • encryption_method (Optional[str]) – HLS encryption type.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediapackage as mediapackage

hls_encryption_property = mediapackage.CfnPackagingConfiguration.HlsEncryptionProperty(
    speke_key_provider=mediapackage.CfnPackagingConfiguration.SpekeKeyProviderProperty(
        role_arn="roleArn",
        system_ids=["systemIds"],
        url="url",

        # the properties below are optional
        encryption_contract_configuration=mediapackage.CfnPackagingConfiguration.EncryptionContractConfigurationProperty(
            preset_speke20_audio="presetSpeke20Audio",
            preset_speke20_video="presetSpeke20Video"
        )
    ),

    # the properties below are optional
    constant_initialization_vector="constantInitializationVector",
    encryption_method="encryptionMethod"
)

Attributes

constant_initialization_vector

A 128-bit, 16-byte hex value represented by a 32-character string, used with the key for encrypting blocks.

If you don’t specify a constant initialization vector (IV), AWS Elemental MediaPackage periodically rotates the IV.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsencryption.html#cfn-mediapackage-packagingconfiguration-hlsencryption-constantinitializationvector

encryption_method

HLS encryption type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsencryption.html#cfn-mediapackage-packagingconfiguration-hlsencryption-encryptionmethod

speke_key_provider

Parameters for the SPEKE key provider.

See:

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

HlsManifestProperty

class CfnPackagingConfiguration.HlsManifestProperty(*, ad_markers=None, include_iframe_only_stream=None, manifest_name=None, program_date_time_interval_seconds=None, repeat_ext_x_key=None, stream_selection=None)

Bases: object

Parameters for an HLS manifest.

Parameters:

  • ad_markers (Optional[str]) – This setting controls ad markers in the packaged content. Valid values: - NONE - Omits all SCTE-35 ad markers from the output. - PASSTHROUGH - Creates a copy in the output of the SCTE-35 ad markers (comments) taken directly from the input manifest. - SCTE35_ENHANCED - Generates ad markers and blackout tags in the output based on the SCTE-35 messages from the input manifest.

  • include_iframe_only_stream (Union[bool, IResolvable, None]) – Applies to stream sets with a single video track only. When enabled, the output includes an additional I-frame only stream, along with the other tracks.

  • manifest_name (Optional[str]) – A short string that’s appended to the end of the endpoint URL to create a unique path to this packaging configuration.

  • program_date_time_interval_seconds (Union[int, float, None]) – Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. Additionally, ID3Timed metadata messages are generated every 5 seconds starting when the content was ingested. Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output. Omit this attribute or enter 0 to indicate that the EXT-X-PROGRAM-DATE-TIME tags are not included in the manifest.

  • repeat_ext_x_key (Union[bool, IResolvable, None]) – Repeat the EXT-X-KEY directive for every media segment. This might result in an increase in client requests to the DRM server.

  • stream_selection (Union[IResolvable, StreamSelectionProperty, Dict[str, Any], None]) – Video bitrate limitations for outputs from this packaging configuration.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediapackage as mediapackage

hls_manifest_property = mediapackage.CfnPackagingConfiguration.HlsManifestProperty(
    ad_markers="adMarkers",
    include_iframe_only_stream=False,
    manifest_name="manifestName",
    program_date_time_interval_seconds=123,
    repeat_ext_xKey=False,
    stream_selection=mediapackage.CfnPackagingConfiguration.StreamSelectionProperty(
        max_video_bits_per_second=123,
        min_video_bits_per_second=123,
        stream_order="streamOrder"
    )
)

Attributes

ad_markers

This setting controls ad markers in the packaged content.

Valid values:

  • NONE - Omits all SCTE-35 ad markers from the output.

  • PASSTHROUGH - Creates a copy in the output of the SCTE-35 ad markers (comments) taken directly from the input manifest.

  • SCTE35_ENHANCED - Generates ad markers and blackout tags in the output based on the SCTE-35 messages from the input manifest.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsmanifest.html#cfn-mediapackage-packagingconfiguration-hlsmanifest-admarkers

include_iframe_only_stream

Applies to stream sets with a single video track only.

When enabled, the output includes an additional I-frame only stream, along with the other tracks.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsmanifest.html#cfn-mediapackage-packagingconfiguration-hlsmanifest-includeiframeonlystream

manifest_name

A short string that’s appended to the end of the endpoint URL to create a unique path to this packaging configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsmanifest.html#cfn-mediapackage-packagingconfiguration-hlsmanifest-manifestname

program_date_time_interval_seconds

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify.

Additionally, ID3Timed metadata messages are generated every 5 seconds starting when the content was ingested.

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

Omit this attribute or enter 0 to indicate that the EXT-X-PROGRAM-DATE-TIME tags are not included in the manifest.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsmanifest.html#cfn-mediapackage-packagingconfiguration-hlsmanifest-programdatetimeintervalseconds

repeat_ext_x_key

Repeat the EXT-X-KEY directive for every media segment.

This might result in an increase in client requests to the DRM server.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsmanifest.html#cfn-mediapackage-packagingconfiguration-hlsmanifest-repeatextxkey

stream_selection

Video bitrate limitations for outputs from this packaging configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsmanifest.html#cfn-mediapackage-packagingconfiguration-hlsmanifest-streamselection

HlsPackageProperty

class CfnPackagingConfiguration.HlsPackageProperty(*, hls_manifests, encryption=None, include_dvb_subtitles=None, segment_duration_seconds=None, use_audio_rendition_group=None)

Bases: object

Parameters for a packaging configuration that uses HTTP Live Streaming (HLS) packaging.

Parameters:

  • hls_manifests (Union[IResolvable, Sequence[Union[IResolvable, HlsManifestProperty, Dict[str, Any]]]]) – A list of HLS manifest configurations that are available from this endpoint.

  • encryption (Union[IResolvable, HlsEncryptionProperty, Dict[str, Any], None]) – Parameters for encrypting content.

  • include_dvb_subtitles (Union[bool, IResolvable, None]) – When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.

  • segment_duration_seconds (Union[int, float, None]) – Duration (in seconds) of each fragment. Actual fragments are rounded to the nearest multiple of the source fragment duration.

  • use_audio_rendition_group (Union[bool, IResolvable, None]) – When true, AWS Elemental MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediapackage as mediapackage

hls_package_property = mediapackage.CfnPackagingConfiguration.HlsPackageProperty(
    hls_manifests=[mediapackage.CfnPackagingConfiguration.HlsManifestProperty(
        ad_markers="adMarkers",
        include_iframe_only_stream=False,
        manifest_name="manifestName",
        program_date_time_interval_seconds=123,
        repeat_ext_xKey=False,
        stream_selection=mediapackage.CfnPackagingConfiguration.StreamSelectionProperty(
            max_video_bits_per_second=123,
            min_video_bits_per_second=123,
            stream_order="streamOrder"
        )
    )],

    # the properties below are optional
    encryption=mediapackage.CfnPackagingConfiguration.HlsEncryptionProperty(
        speke_key_provider=mediapackage.CfnPackagingConfiguration.SpekeKeyProviderProperty(
            role_arn="roleArn",
            system_ids=["systemIds"],
            url="url",

            # the properties below are optional
            encryption_contract_configuration=mediapackage.CfnPackagingConfiguration.EncryptionContractConfigurationProperty(
                preset_speke20_audio="presetSpeke20Audio",
                preset_speke20_video="presetSpeke20Video"
            )
        ),

        # the properties below are optional
        constant_initialization_vector="constantInitializationVector",
        encryption_method="encryptionMethod"
    ),
    include_dvb_subtitles=False,
    segment_duration_seconds=123,
    use_audio_rendition_group=False
)

Attributes

encryption

Parameters for encrypting content.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlspackage.html#cfn-mediapackage-packagingconfiguration-hlspackage-encryption

hls_manifests

A list of HLS manifest configurations that are available from this endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlspackage.html#cfn-mediapackage-packagingconfiguration-hlspackage-hlsmanifests

include_dvb_subtitles

When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlspackage.html#cfn-mediapackage-packagingconfiguration-hlspackage-includedvbsubtitles

segment_duration_seconds

Duration (in seconds) of each fragment.

Actual fragments are rounded to the nearest multiple of the source fragment duration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlspackage.html#cfn-mediapackage-packagingconfiguration-hlspackage-segmentdurationseconds

use_audio_rendition_group

When true, AWS Elemental MediaPackage bundles all audio tracks in a rendition group.

All other tracks in the stream can be used with any audio rendition from the group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlspackage.html#cfn-mediapackage-packagingconfiguration-hlspackage-useaudiorenditiongroup

MssEncryptionProperty

class CfnPackagingConfiguration.MssEncryptionProperty(*, speke_key_provider)

Bases: object

Holds encryption information so that access to the content can be controlled by a DRM solution.

Parameters:

speke_key_provider (Union[IResolvable, SpekeKeyProviderProperty, Dict[str, Any]]) – Parameters for the SPEKE key provider.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediapackage as mediapackage

mss_encryption_property = mediapackage.CfnPackagingConfiguration.MssEncryptionProperty(
    speke_key_provider=mediapackage.CfnPackagingConfiguration.SpekeKeyProviderProperty(
        role_arn="roleArn",
        system_ids=["systemIds"],
        url="url",

        # the properties below are optional
        encryption_contract_configuration=mediapackage.CfnPackagingConfiguration.EncryptionContractConfigurationProperty(
            preset_speke20_audio="presetSpeke20Audio",
            preset_speke20_video="presetSpeke20Video"
        )
    )
)

Attributes

speke_key_provider

Parameters for the SPEKE key provider.

See:

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

MssManifestProperty

class CfnPackagingConfiguration.MssManifestProperty(*, manifest_name=None, stream_selection=None)

Bases: object

Parameters for a Microsoft Smooth manifest.

Parameters:

  • manifest_name (Optional[str]) – A short string that’s appended to the end of the endpoint URL to create a unique path to this packaging configuration.

  • stream_selection (Union[IResolvable, StreamSelectionProperty, Dict[str, Any], None]) – Video bitrate limitations for outputs from this packaging configuration.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediapackage as mediapackage

mss_manifest_property = mediapackage.CfnPackagingConfiguration.MssManifestProperty(
    manifest_name="manifestName",
    stream_selection=mediapackage.CfnPackagingConfiguration.StreamSelectionProperty(
        max_video_bits_per_second=123,
        min_video_bits_per_second=123,
        stream_order="streamOrder"
    )
)

Attributes

manifest_name

A short string that’s appended to the end of the endpoint URL to create a unique path to this packaging configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-mssmanifest.html#cfn-mediapackage-packagingconfiguration-mssmanifest-manifestname

stream_selection

Video bitrate limitations for outputs from this packaging configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-mssmanifest.html#cfn-mediapackage-packagingconfiguration-mssmanifest-streamselection

MssPackageProperty

class CfnPackagingConfiguration.MssPackageProperty(*, mss_manifests, encryption=None, segment_duration_seconds=None)

Bases: object

Parameters for a packaging configuration that uses Microsoft Smooth Streaming (MSS) packaging.

Parameters:

  • mss_manifests (Union[IResolvable, Sequence[Union[IResolvable, MssManifestProperty, Dict[str, Any]]]]) – A list of Microsoft Smooth manifest configurations that are available from this endpoint.

  • encryption (Union[IResolvable, MssEncryptionProperty, Dict[str, Any], None]) – Parameters for encrypting content.

  • segment_duration_seconds (Union[int, float, None]) – Duration (in seconds) of each fragment. Actual fragments are rounded to the nearest multiple of the source fragment duration.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediapackage as mediapackage

mss_package_property = mediapackage.CfnPackagingConfiguration.MssPackageProperty(
    mss_manifests=[mediapackage.CfnPackagingConfiguration.MssManifestProperty(
        manifest_name="manifestName",
        stream_selection=mediapackage.CfnPackagingConfiguration.StreamSelectionProperty(
            max_video_bits_per_second=123,
            min_video_bits_per_second=123,
            stream_order="streamOrder"
        )
    )],

    # the properties below are optional
    encryption=mediapackage.CfnPackagingConfiguration.MssEncryptionProperty(
        speke_key_provider=mediapackage.CfnPackagingConfiguration.SpekeKeyProviderProperty(
            role_arn="roleArn",
            system_ids=["systemIds"],
            url="url",

            # the properties below are optional
            encryption_contract_configuration=mediapackage.CfnPackagingConfiguration.EncryptionContractConfigurationProperty(
                preset_speke20_audio="presetSpeke20Audio",
                preset_speke20_video="presetSpeke20Video"
            )
        )
    ),
    segment_duration_seconds=123
)

Attributes

encryption

Parameters for encrypting content.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-msspackage.html#cfn-mediapackage-packagingconfiguration-msspackage-encryption

mss_manifests

A list of Microsoft Smooth manifest configurations that are available from this endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-msspackage.html#cfn-mediapackage-packagingconfiguration-msspackage-mssmanifests

segment_duration_seconds

Duration (in seconds) of each fragment.

Actual fragments are rounded to the nearest multiple of the source fragment duration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-msspackage.html#cfn-mediapackage-packagingconfiguration-msspackage-segmentdurationseconds

SpekeKeyProviderProperty

class CfnPackagingConfiguration.SpekeKeyProviderProperty(*, role_arn, system_ids, url, encryption_contract_configuration=None)

Bases: object

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

Parameters:

  • role_arn (str) – 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}

  • system_ids (Sequence[str]) – List of unique identifiers for the DRM systems to use, as defined in the CPIX specification.

  • url (str) – URL for the key provider’s key retrieval API endpoint. Must start with https://.

  • encryption_contract_configuration (Union[IResolvable, EncryptionContractConfigurationProperty, Dict[str, Any], None]) – 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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediapackage as mediapackage

speke_key_provider_property = mediapackage.CfnPackagingConfiguration.SpekeKeyProviderProperty(
    role_arn="roleArn",
    system_ids=["systemIds"],
    url="url",

    # the properties below are optional
    encryption_contract_configuration=mediapackage.CfnPackagingConfiguration.EncryptionContractConfigurationProperty(
        preset_speke20_audio="presetSpeke20Audio",
        preset_speke20_video="presetSpeke20Video"
    )
)

Attributes

encryption_contract_configuration

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:

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

role_arn

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:

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

system_ids

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

See:

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

url

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

Must start with https://.

See:

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

StreamSelectionProperty

class CfnPackagingConfiguration.StreamSelectionProperty(*, max_video_bits_per_second=None, min_video_bits_per_second=None, stream_order=None)

Bases: object

Limitations for outputs from the endpoint, based on the video bitrate.

Parameters:

  • max_video_bits_per_second (Union[int, float, None]) – The upper limit of the bitrates that this endpoint serves. If the video track exceeds this threshold, then AWS Elemental MediaPackage excludes it from output. If you don’t specify a value, it defaults to 2147483647 bits per second.

  • min_video_bits_per_second (Union[int, float, None]) – The lower limit of the bitrates that this endpoint serves. If the video track is below this threshold, then AWS Elemental MediaPackage excludes it from output. If you don’t specify a value, it defaults to 0 bits per second.

  • stream_order (Optional[str]) – Order in which the different video bitrates are presented to the player. Valid values: ORIGINAL , VIDEO_BITRATE_ASCENDING , VIDEO_BITRATE_DESCENDING .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediapackage as mediapackage

stream_selection_property = mediapackage.CfnPackagingConfiguration.StreamSelectionProperty(
    max_video_bits_per_second=123,
    min_video_bits_per_second=123,
    stream_order="streamOrder"
)

Attributes

max_video_bits_per_second

The upper limit of the bitrates that this endpoint serves.

If the video track exceeds this threshold, then AWS Elemental MediaPackage excludes it from output. If you don’t specify a value, it defaults to 2147483647 bits per second.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-streamselection.html#cfn-mediapackage-packagingconfiguration-streamselection-maxvideobitspersecond

min_video_bits_per_second

The lower limit of the bitrates that this endpoint serves.

If the video track is below this threshold, then AWS Elemental MediaPackage excludes it from output. If you don’t specify a value, it defaults to 0 bits per second.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-streamselection.html#cfn-mediapackage-packagingconfiguration-streamselection-minvideobitspersecond

stream_order

Order in which the different video bitrates are presented to the player.

Valid values: ORIGINAL , VIDEO_BITRATE_ASCENDING , VIDEO_BITRATE_DESCENDING .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-streamselection.html#cfn-mediapackage-packagingconfiguration-streamselection-streamorder