vod_sources

Creates, updates, deletes or gets a vod_source resource or lists vod_sources in a region

Overview

Name	vod_sources
Type	Resource
Description	Definition of AWS::MediaTailor::VodSource Resource Type
Id	awscc.mediatailor.vod_sources

Fields

get (all properties)

Name	Datatype	Description
arn	string	The ARN of the VOD source.
▶http_package_configurations	array	A list of HTTP package configuration parameters for this VOD source.
source_location_name	string
▶tags	array	The tags to assign to the VOD source.
vod_source_name	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
source_location_name	string
vod_source_name	string
region	string	AWS region.

For more information, see AWS::MediaTailor::VodSource.

Methods

Name	Resource	Accessible by	Required Params
create_resource	vod_sources	INSERT	HttpPackageConfigurations, SourceLocationName, VodSourceName, region
delete_resource	vod_sources	DELETE	Identifier, region
update_resource	vod_sources	UPDATE	Identifier, PatchDocument, region
list_resources	vod_sources_list_only	SELECT	region
get_resource	vod_sources	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual vod_source.

SELECT
  region,
  arn,
  http_package_configurations,
  source_location_name,
  tags,
  vod_source_name
FROM awscc.mediatailor.vod_sources
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ source_location_name }}|{{ vod_source_name }}';

list (identifiers only)

Lists all vod_sources in a region.

SELECT
  region,
  source_location_name,
  vod_source_name
FROM awscc.mediatailor.vod_sources_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.mediatailor.vod_sources (
  HttpPackageConfigurations,
  SourceLocationName,
  VodSourceName,
  region
)
SELECT
  '{{ http_package_configurations }}',
  '{{ source_location_name }}',
  '{{ vod_source_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.mediatailor.vod_sources (
  HttpPackageConfigurations,
  SourceLocationName,
  Tags,
  VodSourceName,
  region
)
SELECT
  '{{ http_package_configurations }}',
  '{{ source_location_name }}',
  '{{ tags }}',
  '{{ vod_source_name }}',
  '{{ 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: vod_source
  props:
    - name: http_package_configurations
      value:
        - path: '{{ path }}'
          source_group: '{{ source_group }}'
          type: '{{ type }}'
    - name: source_location_name
      value: '{{ source_location_name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: vod_source_name
      value: '{{ vod_source_name }}'

UPDATE example

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

/*+ update */
UPDATE awscc.mediatailor.vod_sources
SET PatchDocument = string('{{ {
    "HttpPackageConfigurations": http_package_configurations,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ source_location_name }}|{{ vod_source_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.mediatailor.vod_sources
WHERE
  Identifier = '{{ source_location_name }}|{{ vod_source_name }}' 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 vod_sources resource, the following permissions are required:

Create

mediatailor:CreateVodSource,
mediatailor:DescribeVodSource,
mediatailor:TagResource

Read

mediatailor:DescribeVodSource

Update

mediatailor:DescribeVodSource,
mediatailor:TagResource,
mediatailor:UntagResource,
mediatailor:UpdateVodSource

Delete

mediatailor:DeleteVodSource,
mediatailor:DescribeVodSource

List

mediatailor:ListVodSources