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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
cluster_id	string	The ID of the cluster the node is on.
id	string	Unique internal identifier.
region	string	AWS region.

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual channel_placement_group.

SELECT
  region,
  arn,
  channels,
  cluster_id,
  id,
  name,
  nodes,
  state,
  tags
FROM awscc.medialive.channel_placement_groups
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}|{{ cluster_id }}';

list (identifiers only)

Lists all channel_placement_groups in a region.

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

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 awscc.medialive.channel_placement_groups (
  ClusterId,
  Name,
  Nodes,
  Tags,
  region
)
SELECT
  '{{ cluster_id }}',
  '{{ name }}',
  '{{ nodes }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.medialive.channel_placement_groups (
  ClusterId,
  Name,
  Nodes,
  Tags,
  region
)
SELECT
  '{{ cluster_id }}',
  '{{ name }}',
  '{{ nodes }}',
  '{{ 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: channel_placement_group
  props:
    - name: cluster_id
      value: '{{ cluster_id }}'
    - name: name
      value: '{{ name }}'
    - name: nodes
      value:
        - '{{ nodes[0] }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

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

DELETE example

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