multiplexprograms

Creates, updates, deletes or gets a multiplexprogram resource or lists multiplexprograms in a region

Overview

Name	multiplexprograms
Type	Resource
Description	Resource schema for AWS::MediaLive::Multiplexprogram
Id	aws.medialive.multiplexprograms

Fields

Name	Datatype	Description
channel_id	string	The MediaLive channel associated with the program.
multiplex_id	string	The ID of the multiplex that the program belongs to.
multiplex_program_settings	object	The settings for this multiplex program.
preferred_channel_pipeline	string	The settings for this multiplex program.
packet_identifiers_map	object	The packet identifier map for this multiplex program.
pipeline_details	array	Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time.
program_name	string	The name of the multiplex program.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all multiplexprograms in a region.

SELECT
region,
channel_id,
multiplex_id,
multiplex_program_settings,
preferred_channel_pipeline,
packet_identifiers_map,
pipeline_details,
program_name
FROM aws.medialive.multiplexprograms
WHERE region = 'us-east-1';

Gets all properties from an individual multiplexprogram.

SELECT
region,
channel_id,
multiplex_id,
multiplex_program_settings,
preferred_channel_pipeline,
packet_identifiers_map,
pipeline_details,
program_name
FROM aws.medialive.multiplexprograms
WHERE region = 'us-east-1' AND data__Identifier = '<ProgramName>|<MultiplexId>';

INSERT example

Use the following StackQL query and manifest file to create a new multiplexprogram resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.medialive.multiplexprograms (
 ChannelId,
 MultiplexId,
 MultiplexProgramSettings,
 PreferredChannelPipeline,
 PacketIdentifiersMap,
 PipelineDetails,
 ProgramName,
 region
)
SELECT 
'{{ ChannelId }}',
 '{{ MultiplexId }}',
 '{{ MultiplexProgramSettings }}',
 '{{ PreferredChannelPipeline }}',
 '{{ PacketIdentifiersMap }}',
 '{{ PipelineDetails }}',
 '{{ ProgramName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.medialive.multiplexprograms (
 ChannelId,
 MultiplexId,
 MultiplexProgramSettings,
 PreferredChannelPipeline,
 PacketIdentifiersMap,
 PipelineDetails,
 ProgramName,
 region
)
SELECT 
 '{{ ChannelId }}',
 '{{ MultiplexId }}',
 '{{ MultiplexProgramSettings }}',
 '{{ PreferredChannelPipeline }}',
 '{{ PacketIdentifiersMap }}',
 '{{ PipelineDetails }}',
 '{{ ProgramName }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: multiplexprogram
    props:
      - name: ChannelId
        value: '{{ ChannelId }}'
      - name: MultiplexId
        value: '{{ MultiplexId }}'
      - name: MultiplexProgramSettings
        value:
          PreferredChannelPipeline: '{{ PreferredChannelPipeline }}'
          ProgramNumber: '{{ ProgramNumber }}'
          ServiceDescriptor:
            ProviderName: '{{ ProviderName }}'
            ServiceName: '{{ ServiceName }}'
          VideoSettings: {}
      - name: PreferredChannelPipeline
        value: null
      - name: PacketIdentifiersMap
        value:
          AudioPids:
            - '{{ AudioPids[0] }}'
          DvbSubPids:
            - '{{ DvbSubPids[0] }}'
          DvbTeletextPid: '{{ DvbTeletextPid }}'
          EtvPlatformPid: '{{ EtvPlatformPid }}'
          EtvSignalPid: '{{ EtvSignalPid }}'
          KlvDataPids:
            - '{{ KlvDataPids[0] }}'
          PcrPid: '{{ PcrPid }}'
          PmtPid: '{{ PmtPid }}'
          PrivateMetadataPid: '{{ PrivateMetadataPid }}'
          Scte27Pids:
            - '{{ Scte27Pids[0] }}'
          Scte35Pid: '{{ Scte35Pid }}'
          TimedMetadataPid: '{{ TimedMetadataPid }}'
          VideoPid: '{{ VideoPid }}'
      - name: PipelineDetails
        value:
          - ActiveChannelPipeline: '{{ ActiveChannelPipeline }}'
            PipelineId: '{{ PipelineId }}'
      - name: ProgramName
        value: '{{ ProgramName }}'

DELETE example

/*+ delete */
DELETE FROM aws.medialive.multiplexprograms
WHERE data__Identifier = '<ProgramName|MultiplexId>'
AND region = 'us-east-1';

Permissions

To operate on the multiplexprograms resource, the following permissions are required:

Create

medialive:CreateMultiplexProgram,
medialive:DescribeMultiplexProgram

Read

medialive:DescribeMultiplexProgram

Update

medialive:UpdateMultiplexProgram,
medialive:DescribeMultiplexProgram

Delete

medialive:DeleteMultiplexProgram,
medialive:DescribeMultiplexProgram

List

medialive:ListMultiplexPrograms