channel_placement_groups

Creates, updates, deletes, gets or lists a channel_placement_groups resource.

Overview

Name	channel_placement_groups
Type	Resource
Id	aws.medialive.channel_placement_groups

Fields

The following fields are returned by SELECT queries:

describe_channel_placement_group

Name	Datatype	Description
arn	string	Placeholder documentation for __string
channels	array	Placeholder documentation for __listOf__string
cluster_id	string	Placeholder documentation for __string
id	string	Placeholder documentation for __string
name	string	Placeholder documentation for __string
nodes	array	Placeholder documentation for __listOf__string
state	string	The current state of the ChannelPlacementGroup. (UNASSIGNED, ASSIGNING, ASSIGNED, DELETING, DELETE_FAILED, DELETED, UNASSIGNING)

list_channel_placement_groups

Name	Datatype	Description
arn	string	Placeholder documentation for __string
channels	array	Placeholder documentation for __listOf__string
cluster_id	string	Placeholder documentation for __string
id	string	Placeholder documentation for __string
name	string	Placeholder documentation for __string
nodes	array	Placeholder documentation for __listOf__string
state	string	The current state of the ChannelPlacementGroup. (UNASSIGNED, ASSIGNING, ASSIGNED, DELETING, DELETE_FAILED, DELETED, UNASSIGNING)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_channel_placement_group	select	channel_placement_group_id, cluster_id, region		Get details about a ChannelPlacementGroup.
list_channel_placement_groups	select	cluster_id, region	maxResults, nextToken	Retrieve the list of ChannelPlacementGroups in the specified Cluster.
create_channel_placement_group	insert	cluster_id, region		Create a ChannelPlacementGroup in the specified Cluster. As part of the create operation, you specify the Nodes to attach the group to.After you create a ChannelPlacementGroup, you add Channels to the group (you do this by modifying the Channels to add them to a specific group). You now have an association of Channels to ChannelPlacementGroup, and ChannelPlacementGroup to Nodes. This association means that all the Channels in the group are able to run on any of the Nodes associated with the group.
update_channel_placement_group	update	channel_placement_group_id, cluster_id, region		Change the settings for a ChannelPlacementGroup.
delete_channel_placement_group	delete	channel_placement_group_id, cluster_id, region		Delete the specified ChannelPlacementGroup that exists in the specified Cluster.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
channel_placement_group_id	string	The ID of the channel placement group.
cluster_id	string	The ID of the cluster.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of items to return.
nextToken	string	The token to retrieve the next page of results.

SELECT examples

describe_channel_placement_group

Get details about a ChannelPlacementGroup.

SELECT
arn,
channels,
cluster_id,
id,
name,
nodes,
state
FROM aws.medialive.channel_placement_groups
WHERE channel_placement_group_id = '{{ channel_placement_group_id }}' -- required
AND cluster_id = '{{ cluster_id }}' -- required
AND region = '{{ region }}' -- required
;

list_channel_placement_groups

Retrieve the list of ChannelPlacementGroups in the specified Cluster.

SELECT
arn,
channels,
cluster_id,
id,
name,
nodes,
state
FROM aws.medialive.channel_placement_groups
WHERE cluster_id = '{{ cluster_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_channel_placement_group

Create a ChannelPlacementGroup in the specified Cluster. As part of the create operation, you specify the Nodes to attach the group to.After you create a ChannelPlacementGroup, you add Channels to the group (you do this by modifying the Channels to add them to a specific group). You now have an association of Channels to ChannelPlacementGroup, and ChannelPlacementGroup to Nodes. This association means that all the Channels in the group are able to run on any of the Nodes associated with the group.

INSERT INTO aws.medialive.channel_placement_groups (
Name,
Nodes,
RequestId,
Tags,
cluster_id,
region
)
SELECT 
'{{ Name }}',
'{{ Nodes }}',
'{{ RequestId }}',
'{{ Tags }}',
'{{ cluster_id }}',
'{{ region }}'
RETURNING
arn,
channels,
cluster_id,
id,
name,
nodes,
state
;

Manifest

# Description fields are for documentation purposes
- name: channel_placement_groups
props:
  - name: cluster_id
    value: "{{ cluster_id }}"
    description: Required parameter for the channel_placement_groups resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the channel_placement_groups resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      Placeholder documentation for __string
  - name: Nodes
    value:
      - "{{ Nodes }}"
    description: |
      Placeholder documentation for __listOf__string
  - name: RequestId
    value: "{{ RequestId }}"
    description: |
      Placeholder documentation for __string
  - name: Tags
    value: "{{ Tags }}"
    description: |
      Placeholder documentation for Tags

UPDATE examples

update_channel_placement_group

Change the settings for a ChannelPlacementGroup.

UPDATE aws.medialive.channel_placement_groups
SET 
Name = '{{ Name }}',
Nodes = '{{ Nodes }}'
WHERE 
channel_placement_group_id = '{{ channel_placement_group_id }}' --required
AND cluster_id = '{{ cluster_id }}' --required
AND region = '{{ region }}' --required
RETURNING
arn,
channels,
cluster_id,
id,
name,
nodes,
state;

DELETE examples

delete_channel_placement_group

Delete the specified ChannelPlacementGroup that exists in the specified Cluster.

DELETE FROM aws.medialive.channel_placement_groups
WHERE channel_placement_group_id = '{{ channel_placement_group_id }}' --required
AND cluster_id = '{{ cluster_id }}' --required
AND region = '{{ region }}' --required
;