multiplexes

Creates, updates, deletes or gets a multiplex resource or lists multiplexes in a region

Overview

Name	multiplexes
Type	Resource
Description	Resource schema for AWS::MediaLive::Multiplex
Id	aws.medialive.multiplexes

Fields

Name	Datatype	Description
arn	string	The unique arn of the multiplex.
availability_zones	array	A list of availability zones for the multiplex.
destinations	array	A list of the multiplex output destinations.
id	string	The unique id of the multiplex.
multiplex_settings	object	Configuration for a multiplex event.
name	string	Name of multiplex.
pipelines_running_count	integer	The number of currently healthy pipelines.
program_count	integer	The number of programs in the multiplex.
state	string
tags	array	A collection of key-value pairs.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	AvailabilityZones, MultiplexSettings, Name, 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 multiplexes in a region.

SELECT
region,
arn,
availability_zones,
destinations,
id,
multiplex_settings,
name,
pipelines_running_count,
program_count,
state,
tags
FROM aws.medialive.multiplexes
WHERE region = 'us-east-1';

Gets all properties from an individual multiplex.

SELECT
region,
arn,
availability_zones,
destinations,
id,
multiplex_settings,
name,
pipelines_running_count,
program_count,
state,
tags
FROM aws.medialive.multiplexes
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.medialive.multiplexes (
 AvailabilityZones,
 MultiplexSettings,
 Name,
 region
)
SELECT 
'{{ AvailabilityZones }}',
 '{{ MultiplexSettings }}',
 '{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.medialive.multiplexes (
 AvailabilityZones,
 Destinations,
 MultiplexSettings,
 Name,
 Tags,
 region
)
SELECT 
 '{{ AvailabilityZones }}',
 '{{ Destinations }}',
 '{{ MultiplexSettings }}',
 '{{ Name }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: multiplex
    props:
      - name: AvailabilityZones
        value:
          - '{{ AvailabilityZones[0] }}'
      - name: Destinations
        value:
          - MultiplexMediaConnectOutputDestinationSettings: null
      - name: MultiplexSettings
        value:
          MaximumVideoBufferDelayMilliseconds: '{{ MaximumVideoBufferDelayMilliseconds }}'
          TransportStreamBitrate: '{{ TransportStreamBitrate }}'
          TransportStreamId: '{{ TransportStreamId }}'
          TransportStreamReservedBitrate: '{{ TransportStreamReservedBitrate }}'
      - name: Name
        value: '{{ Name }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.medialive.multiplexes
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

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

Create

medialive:CreateMultiplex,
medialive:DescribeMultiplex,
medialive:CreateTags

Read

medialive:DescribeMultiplex

Update

medialive:UpdateMultiplex,
medialive:DescribeMultiplex,
medialive:CreateTags,
medialive:DeleteTags

Delete

medialive:DeleteMultiplex,
medialive:DescribeMultiplex

List

medialive:ListMultiplexes