channel_policies

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

Overview

Name	channel_policies
Type	Resource
Id	aws.mediapackagev2.channel_policies

Fields

The following fields are returned by SELECT queries:

get_channel_policy

Name	Datatype	Description
channel_group_name	string	The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name	string	The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
policy	string	The policy assigned to the channel.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_channel_policy	select	channel_group_name, channel_name, region		Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources.
put_channel_policy	replace	channel_group_name, channel_name, region		Attaches an IAM policy to the specified channel. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources. You can attach only one policy with each request.
delete_channel_policy	delete	channel_group_name, channel_name, region		Delete a channel policy.

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_group_name	string	The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name	string	The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
region	string	AWS region (default: us-east-1)

SELECT examples

get_channel_policy

Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources.

SELECT
channel_group_name,
channel_name,
policy
FROM aws.mediapackagev2.channel_policies
WHERE channel_group_name = '{{ channel_group_name }}' -- required
AND channel_name = '{{ channel_name }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_channel_policy

Attaches an IAM policy to the specified channel. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources. You can attach only one policy with each request.

REPLACE aws.mediapackagev2.channel_policies
SET 
Policy = '{{ Policy }}'
WHERE 
channel_group_name = '{{ channel_group_name }}' --required
AND channel_name = '{{ channel_name }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_channel_policy

Delete a channel policy.

DELETE FROM aws.mediapackagev2.channel_policies
WHERE channel_group_name = '{{ channel_group_name }}' --required
AND channel_name = '{{ channel_name }}' --required
AND region = '{{ region }}' --required
;