CfnChannel

class aws_cdk.aws_mediatailor.CfnChannel(scope, id, *, channel_name, outputs, playback_mode, audiences=None, filler_slate=None, log_configuration=None, tags=None, tier=None, time_shift_configuration=None)

Bases: CfnResource

The configuration parameters for a channel.

For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html
CloudformationResource:: AWS::MediaTailor::Channel
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_mediatailor as mediatailor

cfn_channel = mediatailor.CfnChannel(self, "MyCfnChannel",
    channel_name="channelName",
    outputs=[mediatailor.CfnChannel.RequestOutputItemProperty(
        manifest_name="manifestName",
        source_group="sourceGroup",

        # the properties below are optional
        dash_playlist_settings=mediatailor.CfnChannel.DashPlaylistSettingsProperty(
            manifest_window_seconds=123,
            min_buffer_time_seconds=123,
            min_update_period_seconds=123,
            suggested_presentation_delay_seconds=123
        ),
        hls_playlist_settings=mediatailor.CfnChannel.HlsPlaylistSettingsProperty(
            ad_markup_type=["adMarkupType"],
            manifest_window_seconds=123
        )
    )],
    playback_mode="playbackMode",

    # the properties below are optional
    audiences=["audiences"],
    filler_slate=mediatailor.CfnChannel.SlateSourceProperty(
        source_location_name="sourceLocationName",
        vod_source_name="vodSourceName"
    ),
    log_configuration=mediatailor.CfnChannel.LogConfigurationForChannelProperty(
        log_types=["logTypes"]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    tier="tier",
    time_shift_configuration=mediatailor.CfnChannel.TimeShiftConfigurationProperty(
        max_time_delay_seconds=123
    )
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
channel_name (str) – The name of the channel.
outputs (Union[IResolvable, Sequence[Union[IResolvable, RequestOutputItemProperty, Dict[str, Any]]]]) – The channel’s output properties.
playback_mode (str) – The type of playback mode for this channel. LINEAR - Programs play back-to-back only once. LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.
audiences (Optional[Sequence[str]]) – The list of audiences defined in channel.
filler_slate (Union[IResolvable, SlateSourceProperty, Dict[str, Any], None]) – The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode . MediaTailor doesn’t support filler slate for channels using the LOOP PlaybackMode .
log_configuration (Union[IResolvable, LogConfigurationForChannelProperty, Dict[str, Any], None]) – The log configuration.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources .
tier (Optional[str]) – The tier for this channel. STANDARD tier channels can contain live programs.
time_shift_configuration (Union[IResolvable, TimeShiftConfigurationProperty, Dict[str, Any], None]) – The configuration for time-shifted viewing.

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:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

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::MediaTailor::Channel'

attr_arn

Arn

Type:: cloudformationAttribute

audiences: The list of audiences defined in channel.

cdk_tag_manager: Tag Manager which manages the tags for this resource.

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

cfn_resource_type: AWS resource type.

channel_name: The name of the channel.

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.

filler_slate: The slate used to fill gaps between programs in the schedule.

log_configuration: The log 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.

node: The tree node.

outputs: The channel’s output properties.

playback_mode: The type of playback mode for this channel.

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: The tags to assign to the channel.

tier: The tier for this channel.

time_shift_configuration: The configuration for time-shifted viewing.

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.

DashPlaylistSettingsProperty

class CfnChannel.DashPlaylistSettingsProperty(*, manifest_window_seconds=None, min_buffer_time_seconds=None, min_update_period_seconds=None, suggested_presentation_delay_seconds=None)

Bases: object

Dash manifest configuration parameters.

Parameters:

manifest_window_seconds (Union[int, float, None]) – The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
min_buffer_time_seconds (Union[int, float, None]) – Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.
min_update_period_seconds (Union[int, float, None]) – Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
suggested_presentation_delay_seconds (Union[int, float, None]) – Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.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_mediatailor as mediatailor

dash_playlist_settings_property = mediatailor.CfnChannel.DashPlaylistSettingsProperty(
    manifest_window_seconds=123,
    min_buffer_time_seconds=123,
    min_update_period_seconds=123,
    suggested_presentation_delay_seconds=123
)

Attributes

manifest_window_seconds

The total duration (in seconds) of each manifest.

Minimum value: 30 seconds. Maximum value: 3600 seconds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html#cfn-mediatailor-channel-dashplaylistsettings-manifestwindowseconds

min_buffer_time_seconds

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

Minimum value: 2 seconds. Maximum value: 60 seconds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html#cfn-mediatailor-channel-dashplaylistsettings-minbuffertimeseconds

min_update_period_seconds

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

Minimum value: 2 seconds. Maximum value: 60 seconds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html#cfn-mediatailor-channel-dashplaylistsettings-minupdateperiodseconds

suggested_presentation_delay_seconds

Amount of time (in seconds) that the player should be from the live point at the end of the manifest.

Minimum value: 2 seconds. Maximum value: 60 seconds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html#cfn-mediatailor-channel-dashplaylistsettings-suggestedpresentationdelayseconds

HlsPlaylistSettingsProperty

class CfnChannel.HlsPlaylistSettingsProperty(*, ad_markup_type=None, manifest_window_seconds=None)

Bases: object

HLS playlist configuration parameters.

Parameters:

ad_markup_type (Optional[Sequence[str]]) – Determines the type of SCTE 35 tags to use in ad markup. Specify DATERANGE to use DATERANGE tags (for live or VOD content). Specify SCTE35_ENHANCED to use EXT-X-CUE-OUT and EXT-X-CUE-IN tags (for VOD content only).
manifest_window_seconds (Union[int, float, None]) – The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-hlsplaylistsettings.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_mediatailor as mediatailor

hls_playlist_settings_property = mediatailor.CfnChannel.HlsPlaylistSettingsProperty(
    ad_markup_type=["adMarkupType"],
    manifest_window_seconds=123
)

Attributes

ad_markup_type

Determines the type of SCTE 35 tags to use in ad markup.

Specify DATERANGE to use DATERANGE tags (for live or VOD content). Specify SCTE35_ENHANCED to use EXT-X-CUE-OUT and EXT-X-CUE-IN tags (for VOD content only).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-hlsplaylistsettings.html#cfn-mediatailor-channel-hlsplaylistsettings-admarkuptype

manifest_window_seconds

The total duration (in seconds) of each manifest.

Minimum value: 30 seconds. Maximum value: 3600 seconds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-hlsplaylistsettings.html#cfn-mediatailor-channel-hlsplaylistsettings-manifestwindowseconds

LogConfigurationForChannelProperty

class CfnChannel.LogConfigurationForChannelProperty(*, log_types=None)

Bases: object

The log configuration for the channel.

Parameters:: log_types (Optional[Sequence[str]]) – The log types.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-logconfigurationforchannel.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_mediatailor as mediatailor

log_configuration_for_channel_property = mediatailor.CfnChannel.LogConfigurationForChannelProperty(
    log_types=["logTypes"]
)

Attributes

log_types

The log types.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-logconfigurationforchannel.html#cfn-mediatailor-channel-logconfigurationforchannel-logtypes

RequestOutputItemProperty

class CfnChannel.RequestOutputItemProperty(*, manifest_name, source_group, dash_playlist_settings=None, hls_playlist_settings=None)

Bases: object

The output configuration for this channel.

Parameters:

manifest_name (str) – The name of the manifest for the channel. The name appears in the PlaybackUrl .
source_group (str) – A string used to match which HttpPackageConfiguration is used for each VodSource .
dash_playlist_settings (Union[IResolvable, DashPlaylistSettingsProperty, Dict[str, Any], None]) – DASH manifest configuration parameters.
hls_playlist_settings (Union[IResolvable, HlsPlaylistSettingsProperty, Dict[str, Any], None]) – HLS playlist configuration parameters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.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_mediatailor as mediatailor

request_output_item_property = mediatailor.CfnChannel.RequestOutputItemProperty(
    manifest_name="manifestName",
    source_group="sourceGroup",

    # the properties below are optional
    dash_playlist_settings=mediatailor.CfnChannel.DashPlaylistSettingsProperty(
        manifest_window_seconds=123,
        min_buffer_time_seconds=123,
        min_update_period_seconds=123,
        suggested_presentation_delay_seconds=123
    ),
    hls_playlist_settings=mediatailor.CfnChannel.HlsPlaylistSettingsProperty(
        ad_markup_type=["adMarkupType"],
        manifest_window_seconds=123
    )
)

Attributes

dash_playlist_settings

DASH manifest configuration parameters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html#cfn-mediatailor-channel-requestoutputitem-dashplaylistsettings

hls_playlist_settings

HLS playlist configuration parameters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html#cfn-mediatailor-channel-requestoutputitem-hlsplaylistsettings

manifest_name

The name of the manifest for the channel.

The name appears in the PlaybackUrl .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html#cfn-mediatailor-channel-requestoutputitem-manifestname

source_group

A string used to match which HttpPackageConfiguration is used for each VodSource .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html#cfn-mediatailor-channel-requestoutputitem-sourcegroup

SlateSourceProperty

class CfnChannel.SlateSourceProperty(*, source_location_name=None, vod_source_name=None)

Bases: object

Slate VOD source configuration.

Parameters:

source_location_name (Optional[str]) – The name of the source location where the slate VOD source is stored.
vod_source_name (Optional[str]) – The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-slatesource.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_mediatailor as mediatailor

slate_source_property = mediatailor.CfnChannel.SlateSourceProperty(
    source_location_name="sourceLocationName",
    vod_source_name="vodSourceName"
)

Attributes

source_location_name

The name of the source location where the slate VOD source is stored.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-slatesource.html#cfn-mediatailor-channel-slatesource-sourcelocationname

vod_source_name

The slate VOD source name.

The VOD source must already exist in a source location before it can be used for slate.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-slatesource.html#cfn-mediatailor-channel-slatesource-vodsourcename

TimeShiftConfigurationProperty

class CfnChannel.TimeShiftConfigurationProperty(*, max_time_delay_seconds)

Bases: object

The configuration for time-shifted viewing.

Parameters:: max_time_delay_seconds (Union[int, float]) – The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours).
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-timeshiftconfiguration.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_mediatailor as mediatailor

time_shift_configuration_property = mediatailor.CfnChannel.TimeShiftConfigurationProperty(
    max_time_delay_seconds=123
)

Attributes

max_time_delay_seconds

The maximum time delay for time-shifted viewing.

The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-timeshiftconfiguration.html#cfn-mediatailor-channel-timeshiftconfiguration-maxtimedelayseconds