channel_placement_groups

Creates, updates, deletes or gets a channel_placement_group resource or lists channel_placement_groups in a region

Overview

Name	channel_placement_groups
Type	Resource
Description	Definition of AWS::MediaLive::ChannelPlacementGroup Resource Type
Id	aws.medialive.channel_placement_groups

Fields

Name	Datatype	Description
arn	string	The ARN of the channel placement group.
channels	array	List of channel IDs added to the channel placement group.
cluster_id	string	The ID of the cluster the node is on.
id	string	Unique internal identifier.
name	string	The name of the channel placement group.
nodes	array	List of nodes added to the channel placement group
state	string	The current state of the ChannelPlacementGroupState
tags	array	A collection of key-value pairs.
region	string	AWS region.

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

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 channel_placement_groups in a region.

SELECT
region,
arn,
channels,
cluster_id,
id,
name,
nodes,
state,
tags
FROM aws.medialive.channel_placement_groups
WHERE region = 'us-east-1';

Gets all properties from an individual channel_placement_group.

SELECT
region,
arn,
channels,
cluster_id,
id,
name,
nodes,
state,
tags
FROM aws.medialive.channel_placement_groups
WHERE region = 'us-east-1' AND data__Identifier = '<Id>|<ClusterId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.medialive.channel_placement_groups (
 ClusterId,
 Name,
 Nodes,
 Tags,
 region
)
SELECT 
'{{ ClusterId }}',
 '{{ Name }}',
 '{{ Nodes }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.medialive.channel_placement_groups (
 ClusterId,
 Name,
 Nodes,
 Tags,
 region
)
SELECT 
 '{{ ClusterId }}',
 '{{ Name }}',
 '{{ Nodes }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: channel_placement_group
    props:
      - name: ClusterId
        value: '{{ ClusterId }}'
      - name: Name
        value: '{{ Name }}'
      - name: Nodes
        value:
          - '{{ Nodes[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

medialive:CreateChannelPlacementGroup,
medialive:DescribeChannelPlacementGroup,
medialive:CreateTags,
medialive:ListTagsForResource

Read

medialive:DescribeChannelPlacementGroup,
medialive:ListTagsForResource

Update

medialive:UpdateChannelPlacementGroup,
medialive:DescribeChannelPlacementGroup,
medialive:CreateTags,
medialive:DeleteTags,
medialive:ListTagsForResource

Delete

medialive:DeleteChannelPlacementGroup,
medialive:DescribeChannelPlacementGroup

List

medialive:ListChannelPlacementGroups