CfnChannelPropsMixin

class aws_cdk.mixins_preview.aws_mediapackage.mixins.CfnChannelPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a channel to receive content.

After it’s created, a channel provides static input URLs. These URLs remain the same throughout the lifetime of the channel, regardless of any failures or upgrades that might occur. Use these URLs to configure the outputs of your upstream encoder.

See:

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

CloudformationResource:

AWS::MediaPackage::Channel

Mixin:

true

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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_mediapackage import mixins as mediapackage_mixins

cfn_channel_props_mixin = mediapackage_mixins.CfnChannelPropsMixin(mediapackage_mixins.CfnChannelMixinProps(
    description="description",
    egress_access_logs=mediapackage_mixins.CfnChannelPropsMixin.LogConfigurationProperty(
        log_group_name="logGroupName"
    ),
    hls_ingest=mediapackage_mixins.CfnChannelPropsMixin.HlsIngestProperty(
        ingest_endpoints=[mediapackage_mixins.CfnChannelPropsMixin.IngestEndpointProperty(
            id="id",
            password="password",
            url="url",
            username="username"
        )]
    ),
    id="id",
    ingress_access_logs=mediapackage_mixins.CfnChannelPropsMixin.LogConfigurationProperty(
        log_group_name="logGroupName"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::MediaPackage::Channel.

Parameters:
  • props (Union[CfnChannelMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'egressAccessLogs', 'hlsIngest', 'id', 'ingressAccessLogs', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

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

Stability:

experimental

HlsIngestProperty

class CfnChannelPropsMixin.HlsIngestProperty(*, ingest_endpoints=None)

Bases: object

HLS ingest configuration.

Parameters:

ingest_endpoints (Union[IResolvable, Sequence[Union[IResolvable, IngestEndpointProperty, Dict[str, Any]]], None]) – The input URL where the source stream should be sent.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-hlsingest.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.mixins_preview.aws_mediapackage import mixins as mediapackage_mixins

hls_ingest_property = mediapackage_mixins.CfnChannelPropsMixin.HlsIngestProperty(
    ingest_endpoints=[mediapackage_mixins.CfnChannelPropsMixin.IngestEndpointProperty(
        id="id",
        password="password",
        url="url",
        username="username"
    )]
)

Attributes

ingest_endpoints

The input URL where the source stream should be sent.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-hlsingest.html#cfn-mediapackage-channel-hlsingest-ingestendpoints

IngestEndpointProperty

class CfnChannelPropsMixin.IngestEndpointProperty(*, id=None, password=None, url=None, username=None)

Bases: object

An endpoint for ingesting source content for a channel.

Parameters:
  • id (Optional[str]) – The endpoint identifier.

  • password (Optional[str]) – The system-generated password for WebDAV input authentication.

  • url (Optional[str]) – The input URL where the source stream should be sent.

  • username (Optional[str]) – The system-generated username for WebDAV input authentication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-ingestendpoint.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.mixins_preview.aws_mediapackage import mixins as mediapackage_mixins

ingest_endpoint_property = mediapackage_mixins.CfnChannelPropsMixin.IngestEndpointProperty(
    id="id",
    password="password",
    url="url",
    username="username"
)

Attributes

id

The endpoint identifier.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-ingestendpoint.html#cfn-mediapackage-channel-ingestendpoint-id

password

The system-generated password for WebDAV input authentication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-ingestendpoint.html#cfn-mediapackage-channel-ingestendpoint-password

url

The input URL where the source stream should be sent.

See:

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

username

The system-generated username for WebDAV input authentication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-ingestendpoint.html#cfn-mediapackage-channel-ingestendpoint-username

LogConfigurationProperty

class CfnChannelPropsMixin.LogConfigurationProperty(*, log_group_name=None)

Bases: object

The access log configuration parameters for your channel.

Parameters:

log_group_name (Optional[str]) – Sets a custom Amazon CloudWatch log group name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-logconfiguration.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.mixins_preview.aws_mediapackage import mixins as mediapackage_mixins

log_configuration_property = mediapackage_mixins.CfnChannelPropsMixin.LogConfigurationProperty(
    log_group_name="logGroupName"
)

Attributes

log_group_name

Sets a custom Amazon CloudWatch log group name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-logconfiguration.html#cfn-mediapackage-channel-logconfiguration-loggroupname