origin_endpoint_policies

Creates, updates, deletes, gets or lists an origin_endpoint_policies resource.

Overview

Name	origin_endpoint_policies
Type	Resource
Id	aws.mediapackagev2.origin_endpoint_policies

Fields

The following fields are returned by SELECT queries:

get_origin_endpoint_policy

Name	Datatype	Description
cdn_auth_configuration	object	The settings for using authorization headers between the MediaPackage endpoint and your CDN. For information about CDN authorization, see CDN authorization in Elemental MediaPackage in the MediaPackage user guide.
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. (pattern: <code>[a-zA-Z0-9_-]+</code>)
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. (pattern: <code>[a-zA-Z0-9_-]+</code>)
origin_endpoint_name	string	The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. (pattern: <code>[a-zA-Z0-9_-]+</code>)
policy	string	The policy assigned to the origin endpoint.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_origin_endpoint_policy	select	channel_group_name, channel_name, origin_endpoint_name, region		Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.
put_origin_endpoint_policy	replace	channel_group_name, channel_name, origin_endpoint_name, region		Attaches an IAM policy to the specified origin endpoint. You can attach only one policy with each request.
delete_origin_endpoint_policy	delete	channel_group_name, channel_name, origin_endpoint_name, region		Delete an origin endpoint 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.
origin_endpoint_name	string	The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
region	string	AWS region (default: us-east-1)

SELECT examples

get_origin_endpoint_policy

Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.

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

REPLACE examples

put_origin_endpoint_policy

Attaches an IAM policy to the specified origin endpoint. You can attach only one policy with each request.

REPLACE aws.mediapackagev2.origin_endpoint_policies
SET 
Policy = '{{ Policy }}',
CdnAuthConfiguration = '{{ CdnAuthConfiguration }}'
WHERE 
channel_group_name = '{{ channel_group_name }}' --required
AND channel_name = '{{ channel_name }}' --required
AND origin_endpoint_name = '{{ origin_endpoint_name }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_origin_endpoint_policy

Delete an origin endpoint policy.

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