channel_policies

Creates, updates, deletes or gets a channel_policy resource or lists channel_policies in a region

Overview

Name	channel_policies
Type	Resource
Description	Represents a resource-based policy that allows or denies access to a channel.
Id	aws.mediapackagev2.channel_policies

Fields

Name	Datatype	Description
channel_group_name	string
channel_name	string
policy	object
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ChannelGroupName, ChannelName, Policy, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual channel_policy.

SELECT
region,
channel_group_name,
channel_name,
policy
FROM aws.mediapackagev2.channel_policies
WHERE region = 'us-east-1' AND data__Identifier = '<ChannelGroupName>|<ChannelName>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.mediapackagev2.channel_policies (
 ChannelGroupName,
 ChannelName,
 Policy,
 region
)
SELECT 
'{{ ChannelGroupName }}',
 '{{ ChannelName }}',
 '{{ Policy }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.mediapackagev2.channel_policies (
 ChannelGroupName,
 ChannelName,
 Policy,
 region
)
SELECT 
 '{{ ChannelGroupName }}',
 '{{ ChannelName }}',
 '{{ Policy }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: channel_policy
    props:
      - name: ChannelGroupName
        value: '{{ ChannelGroupName }}'
      - name: ChannelName
        value: '{{ ChannelName }}'
      - name: Policy
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.mediapackagev2.channel_policies
WHERE data__Identifier = '<ChannelGroupName|ChannelName>'
AND region = 'us-east-1';

Permissions

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

Create

mediapackagev2:GetChannelPolicy,
mediapackagev2:PutChannelPolicy

Read

mediapackagev2:GetChannelPolicy

Update

mediapackagev2:GetChannelPolicy,
mediapackagev2:PutChannelPolicy

Delete

mediapackagev2:GetChannelPolicy,
mediapackagev2:DeleteChannelPolicy