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	awscc.mediapackagev2.channel_policies

Fields

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

For more information, see AWS::MediaPackageV2::ChannelPolicy.

Methods

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

SELECT examples

Gets all properties from an individual channel_policy.

SELECT
  region,
  channel_group_name,
  channel_name,
  policy
FROM awscc.mediapackagev2.channel_policies
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ channel_group_name }}|{{ channel_name }}';

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 awscc.mediapackagev2.channel_policies (
  ChannelGroupName,
  ChannelName,
  Policy,
  region
)
SELECT
  '{{ channel_group_name }}',
  '{{ channel_name }}',
  '{{ policy }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.mediapackagev2.channel_policies (
  ChannelGroupName,
  ChannelName,
  Policy,
  region
)
SELECT
  '{{ channel_group_name }}',
  '{{ channel_name }}',
  '{{ 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: channel_group_name
        value: '{{ channel_group_name }}'
      - name: channel_name
        value: '{{ channel_name }}'
      - name: policy
        value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.mediapackagev2.channel_policies
SET PatchDocument = string('{{ {
    "Policy": policy
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ channel_group_name }}|{{ channel_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.mediapackagev2.channel_policies
WHERE
  Identifier = '{{ channel_group_name }}|{{ channel_name }}' 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