CfnOriginEndpointProps

class aws_cdk.aws_mediapackage.CfnOriginEndpointProps(*, channel_id, id, authorization=None, cmaf_package=None, dash_package=None, description=None, hls_package=None, manifest_name=None, mss_package=None, origination=None, startover_window_seconds=None, tags=None, time_delay_seconds=None, whitelist=None)

Bases: object

Properties for defining a CfnOriginEndpoint.

Parameters:

channel_id (str) – The ID of the channel associated with this endpoint.
id (str) – The manifest ID is required and must be unique within the OriginEndpoint. The ID can’t be changed after the endpoint is created.
authorization (Union[IResolvable, AuthorizationProperty, Dict[str, Any], None]) – Parameters for CDN authorization.
cmaf_package (Union[IResolvable, CmafPackageProperty, Dict[str, Any], None]) – Parameters for Common Media Application Format (CMAF) packaging.
dash_package (Union[IResolvable, DashPackageProperty, Dict[str, Any], None]) – Parameters for DASH packaging.
description (Optional[str]) – Any descriptive information that you want to add to the endpoint for future identification purposes.
hls_package (Union[IResolvable, HlsPackageProperty, Dict[str, Any], None]) – Parameters for Apple HLS packaging.
manifest_name (Optional[str]) – A short string that’s appended to the end of the endpoint URL to create a unique path to this endpoint.
mss_package (Union[IResolvable, MssPackageProperty, Dict[str, Any], None]) – Parameters for Microsoft Smooth Streaming packaging.
origination (Optional[str]) – Controls video origination from this endpoint. Valid values: - ALLOW - enables this endpoint to serve content to requesting devices. - DENY - prevents this endpoint from serving content. Denying origination is helpful for harvesting live-to-VOD assets. For more information about harvesting and origination, see Live-to-VOD Requirements .
startover_window_seconds (Union[int, float, None]) – Maximum duration (seconds) of content to retain for startover playback. Omit this attribute or enter 0 to indicate that startover playback is disabled for this endpoint.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags to assign to the endpoint.
time_delay_seconds (Union[int, float, None]) – Minimum duration (seconds) of delay to enforce on the playback of live content. Omit this attribute or enter 0 to indicate that there is no time delay in effect for this endpoint.
whitelist (Optional[Sequence[str]]) – The IP addresses that can access this endpoint.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

cfn_origin_endpoint_props = mediapackage.CfnOriginEndpointProps(
    channel_id="channelId",
    id="id",

    # the properties below are optional
    authorization=mediapackage.CfnOriginEndpoint.AuthorizationProperty(
        cdn_identifier_secret="cdnIdentifierSecret",
        secrets_role_arn="secretsRoleArn"
    ),
    cmaf_package=mediapackage.CfnOriginEndpoint.CmafPackageProperty(
        encryption=mediapackage.CfnOriginEndpoint.CmafEncryptionProperty(
            speke_key_provider=mediapackage.CfnOriginEndpoint.SpekeKeyProviderProperty(
                resource_id="resourceId",
                role_arn="roleArn",
                system_ids=["systemIds"],
                url="url",

                # the properties below are optional
                certificate_arn="certificateArn",
                encryption_contract_configuration=mediapackage.CfnOriginEndpoint.EncryptionContractConfigurationProperty()
            ),

            # the properties below are optional
            constant_initialization_vector="constantInitializationVector",
            encryption_method="encryptionMethod",
            key_rotation_interval_seconds=123
        ),
        hls_manifests=[mediapackage.CfnOriginEndpoint.HlsManifestProperty(
            id="id",

            # the properties below are optional
            ad_markers="adMarkers",
            ads_on_delivery_restrictions="adsOnDeliveryRestrictions",
            ad_triggers=["adTriggers"],
            include_iframe_only_stream=False,
            manifest_name="manifestName",
            playlist_type="playlistType",
            playlist_window_seconds=123,
            program_date_time_interval_seconds=123,
            url="url"
        )],
        segment_duration_seconds=123,
        segment_prefix="segmentPrefix",
        stream_selection=mediapackage.CfnOriginEndpoint.StreamSelectionProperty(
            max_video_bits_per_second=123,
            min_video_bits_per_second=123,
            stream_order="streamOrder"
        )
    ),
    dash_package=mediapackage.CfnOriginEndpoint.DashPackageProperty(
        ads_on_delivery_restrictions="adsOnDeliveryRestrictions",
        ad_triggers=["adTriggers"],
        encryption=mediapackage.CfnOriginEndpoint.DashEncryptionProperty(
            speke_key_provider=mediapackage.CfnOriginEndpoint.SpekeKeyProviderProperty(
                resource_id="resourceId",
                role_arn="roleArn",
                system_ids=["systemIds"],
                url="url",

                # the properties below are optional
                certificate_arn="certificateArn",
                encryption_contract_configuration=mediapackage.CfnOriginEndpoint.EncryptionContractConfigurationProperty()
            ),

            # the properties below are optional
            key_rotation_interval_seconds=123
        ),
        include_iframe_only_stream=False,
        manifest_layout="manifestLayout",
        manifest_window_seconds=123,
        min_buffer_time_seconds=123,
        min_update_period_seconds=123,
        period_triggers=["periodTriggers"],
        profile="profile",
        segment_duration_seconds=123,
        segment_template_format="segmentTemplateFormat",
        stream_selection=mediapackage.CfnOriginEndpoint.StreamSelectionProperty(
            max_video_bits_per_second=123,
            min_video_bits_per_second=123,
            stream_order="streamOrder"
        ),
        suggested_presentation_delay_seconds=123,
        utc_timing="utcTiming",
        utc_timing_uri="utcTimingUri"
    ),
    description="description",
    hls_package=mediapackage.CfnOriginEndpoint.HlsPackageProperty(
        ad_markers="adMarkers",
        ads_on_delivery_restrictions="adsOnDeliveryRestrictions",
        ad_triggers=["adTriggers"],
        encryption=mediapackage.CfnOriginEndpoint.HlsEncryptionProperty(
            speke_key_provider=mediapackage.CfnOriginEndpoint.SpekeKeyProviderProperty(
                resource_id="resourceId",
                role_arn="roleArn",
                system_ids=["systemIds"],
                url="url",

                # the properties below are optional
                certificate_arn="certificateArn",
                encryption_contract_configuration=mediapackage.CfnOriginEndpoint.EncryptionContractConfigurationProperty()
            ),

            # the properties below are optional
            constant_initialization_vector="constantInitializationVector",
            encryption_method="encryptionMethod",
            key_rotation_interval_seconds=123,
            repeat_ext_xKey=False
        ),
        include_dvb_subtitles=False,
        include_iframe_only_stream=False,
        playlist_type="playlistType",
        playlist_window_seconds=123,
        program_date_time_interval_seconds=123,
        segment_duration_seconds=123,
        stream_selection=mediapackage.CfnOriginEndpoint.StreamSelectionProperty(
            max_video_bits_per_second=123,
            min_video_bits_per_second=123,
            stream_order="streamOrder"
        ),
        use_audio_rendition_group=False
    ),
    manifest_name="manifestName",
    mss_package=mediapackage.CfnOriginEndpoint.MssPackageProperty(
        encryption=mediapackage.CfnOriginEndpoint.MssEncryptionProperty(
            speke_key_provider=mediapackage.CfnOriginEndpoint.SpekeKeyProviderProperty(
                resource_id="resourceId",
                role_arn="roleArn",
                system_ids=["systemIds"],
                url="url",

                # the properties below are optional
                certificate_arn="certificateArn",
                encryption_contract_configuration=mediapackage.CfnOriginEndpoint.EncryptionContractConfigurationProperty()
            )
        ),
        manifest_window_seconds=123,
        segment_duration_seconds=123,
        stream_selection=mediapackage.CfnOriginEndpoint.StreamSelectionProperty(
            max_video_bits_per_second=123,
            min_video_bits_per_second=123,
            stream_order="streamOrder"
        )
    ),
    origination="origination",
    startover_window_seconds=123,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    time_delay_seconds=123,
    whitelist=["whitelist"]
)

Attributes

authorization

Parameters for CDN authorization.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-authorization

channel_id

The ID of the channel associated with this endpoint.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-channelid

cmaf_package

Parameters for Common Media Application Format (CMAF) packaging.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-cmafpackage

dash_package

Parameters for DASH packaging.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-dashpackage

description

Any descriptive information that you want to add to the endpoint for future identification purposes.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-description

hls_package

Parameters for Apple HLS packaging.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-hlspackage

id

The manifest ID is required and must be unique within the OriginEndpoint.

The ID can’t be changed after the endpoint is created.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-id

manifest_name

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

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-manifestname

mss_package

Parameters for Microsoft Smooth Streaming packaging.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-msspackage

origination

Controls video origination from this endpoint.

Valid values:

ALLOW - enables this endpoint to serve content to requesting devices.
DENY - prevents this endpoint from serving content. Denying origination is helpful for harvesting live-to-VOD assets. For more information about harvesting and origination, see Live-to-VOD Requirements .