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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
id	string	The unique id of the multiplex.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	multiplexes	INSERT	AvailabilityZones, MultiplexSettings, Name, region
delete_resource	multiplexes	DELETE	Identifier, region
update_resource	multiplexes	UPDATE	Identifier, PatchDocument, region
list_resources	multiplexes_list_only	SELECT	region
get_resource	multiplexes	SELECT	Identifier, region

SELECT examples

get (all properties)

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

list (identifiers only)

Lists all multiplexes in a region.

SELECT
  region,
  id
FROM awscc.medialive.multiplexes_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.medialive.multiplexes (
  AvailabilityZones,
  MultiplexSettings,
  Name,
  region
)
SELECT
  '{{ availability_zones }}',
  '{{ multiplex_settings }}',
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.medialive.multiplexes (
  AvailabilityZones,
  Destinations,
  MultiplexSettings,
  Name,
  Tags,
  region
)
SELECT
  '{{ availability_zones }}',
  '{{ destinations }}',
  '{{ multiplex_settings }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ 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: multiplex
  props:
    - name: availability_zones
      value:
        - '{{ availability_zones[0] }}'
    - name: destinations
      value:
        - multiplex_media_connect_output_destination_settings: null
    - name: multiplex_settings
      value:
        maximum_video_buffer_delay_milliseconds: '{{ maximum_video_buffer_delay_milliseconds }}'
        transport_stream_bitrate: '{{ transport_stream_bitrate }}'
        transport_stream_id: '{{ transport_stream_id }}'
        transport_stream_reserved_bitrate: '{{ transport_stream_reserved_bitrate }}'
    - name: name
      value: '{{ name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.medialive.multiplexes
SET PatchDocument = string('{{ {
    "Destinations": destinations,
    "MultiplexSettings": multiplex_settings,
    "Name": name,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.medialive.multiplexes
WHERE
  Identifier = '{{ 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 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