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	awscc.medialive.multiplexprograms

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
multiplex_id	string	The ID of the multiplex that the program belongs to.
program_name	string	The name of the multiplex program.
region	string	AWS region.

For more information, see AWS::MediaLive::Multiplexprogram.

Methods

Name	Resource	Accessible by	Required Params
create_resource	multiplexprograms	INSERT	region
delete_resource	multiplexprograms	DELETE	Identifier, region
update_resource	multiplexprograms	UPDATE	Identifier, PatchDocument, region
list_resources	multiplexprograms_list_only	SELECT	region
get_resource	multiplexprograms	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.medialive.multiplexprograms
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ program_name }}|{{ multiplex_id }}';

list (identifiers only)

Lists all multiplexprograms in a region.

SELECT
  region,
  program_name,
  multiplex_id
FROM awscc.medialive.multiplexprograms_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.medialive.multiplexprograms (
  MultiplexId,
  MultiplexProgramSettings,
  PreferredChannelPipeline,
  PacketIdentifiersMap,
  PipelineDetails,
  ProgramName,
  region
)
SELECT
  '{{ multiplex_id }}',
  '{{ multiplex_program_settings }}',
  '{{ preferred_channel_pipeline }}',
  '{{ packet_identifiers_map }}',
  '{{ pipeline_details }}',
  '{{ program_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.medialive.multiplexprograms (
  MultiplexId,
  MultiplexProgramSettings,
  PreferredChannelPipeline,
  PacketIdentifiersMap,
  PipelineDetails,
  ProgramName,
  region
)
SELECT
  '{{ multiplex_id }}',
  '{{ multiplex_program_settings }}',
  '{{ preferred_channel_pipeline }}',
  '{{ packet_identifiers_map }}',
  '{{ pipeline_details }}',
  '{{ program_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: multiplexprogram
  props:
    - name: multiplex_id
      value: '{{ multiplex_id }}'
    - name: multiplex_program_settings
      value:
        preferred_channel_pipeline: '{{ preferred_channel_pipeline }}'
        program_number: '{{ program_number }}'
        service_descriptor:
          provider_name: '{{ provider_name }}'
          service_name: '{{ service_name }}'
        video_settings: {}
    - name: preferred_channel_pipeline
      value: null
    - name: packet_identifiers_map
      value:
        audio_pids:
          - '{{ audio_pids[0] }}'
        dvb_sub_pids:
          - '{{ dvb_sub_pids[0] }}'
        dvb_teletext_pid: '{{ dvb_teletext_pid }}'
        etv_platform_pid: '{{ etv_platform_pid }}'
        etv_signal_pid: '{{ etv_signal_pid }}'
        klv_data_pids:
          - '{{ klv_data_pids[0] }}'
        pcr_pid: '{{ pcr_pid }}'
        pmt_pid: '{{ pmt_pid }}'
        private_metadata_pid: '{{ private_metadata_pid }}'
        scte27_pids:
          - '{{ scte27_pids[0] }}'
        scte35_pid: '{{ scte35_pid }}'
        timed_metadata_pid: '{{ timed_metadata_pid }}'
        video_pid: '{{ video_pid }}'
    - name: pipeline_details
      value:
        - active_channel_pipeline: '{{ active_channel_pipeline }}'
          pipeline_id: '{{ pipeline_id }}'
    - name: program_name
      value: '{{ program_name }}'

UPDATE example

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

/*+ update */
UPDATE awscc.medialive.multiplexprograms
SET PatchDocument = string('{{ {
    "MultiplexProgramSettings": multiplex_program_settings,
    "PreferredChannelPipeline": preferred_channel_pipeline,
    "PacketIdentifiersMap": packet_identifiers_map,
    "PipelineDetails": pipeline_details
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ program_name }}|{{ multiplex_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.medialive.multiplexprograms
WHERE
  Identifier = '{{ program_name }}|{{ multiplex_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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