packaging_configurations

Creates, updates, deletes or gets a packaging_configuration resource or lists packaging_configurations in a region

Overview

Name	packaging_configurations
Type	Resource
Description	Resource schema for AWS::MediaPackage::PackagingConfiguration
Id	awscc.mediapackage.packaging_configurations

Fields

get (all properties)

Name	Datatype	Description
id	string	The ID of the PackagingConfiguration.
packaging_group_id	string	The ID of a PackagingGroup.
arn	string	The ARN of the PackagingConfiguration.
▶cmaf_package	object	A CMAF packaging configuration.
▶dash_package	object	A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
▶hls_package	object	An HTTP Live Streaming (HLS) packaging configuration.
▶mss_package	object	A Microsoft Smooth Streaming (MSS) PackagingConfiguration.
▶tags	array	A collection of tags associated with a resource
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string	The ID of the PackagingConfiguration.
region	string	AWS region.

For more information, see AWS::MediaPackage::PackagingConfiguration.

Methods

Name	Resource	Accessible by	Required Params
create_resource	packaging_configurations	INSERT	PackagingGroupId, Id, region
delete_resource	packaging_configurations	DELETE	Identifier, region
list_resources	packaging_configurations_list_only	SELECT	region
get_resource	packaging_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual packaging_configuration.

SELECT
  region,
  id,
  packaging_group_id,
  arn,
  cmaf_package,
  dash_package,
  hls_package,
  mss_package,
  tags
FROM awscc.mediapackage.packaging_configurations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all packaging_configurations in a region.

SELECT
  region,
  id
FROM awscc.mediapackage.packaging_configurations_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.mediapackage.packaging_configurations (
  Id,
  PackagingGroupId,
  region
)
SELECT
  '{{ id }}',
  '{{ packaging_group_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.mediapackage.packaging_configurations (
  Id,
  PackagingGroupId,
  CmafPackage,
  DashPackage,
  HlsPackage,
  MssPackage,
  Tags,
  region
)
SELECT
  '{{ id }}',
  '{{ packaging_group_id }}',
  '{{ cmaf_package }}',
  '{{ dash_package }}',
  '{{ hls_package }}',
  '{{ mss_package }}',
  '{{ tags }}',
  '{{ 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: packaging_configuration
  props:
    - name: id
      value: '{{ id }}'
    - name: packaging_group_id
      value: '{{ packaging_group_id }}'
    - name: cmaf_package
      value:
        encryption:
          speke_key_provider:
            encryption_contract_configuration:
              preset_speke20_audio: '{{ preset_speke20_audio }}'
              preset_speke20_video: '{{ preset_speke20_video }}'
            role_arn: '{{ role_arn }}'
            system_ids:
              - '{{ system_ids[0] }}'
            url: '{{ url }}'
        hls_manifests:
          - ad_markers: '{{ ad_markers }}'
            include_iframe_only_stream: '{{ include_iframe_only_stream }}'
            manifest_name: '{{ manifest_name }}'
            program_date_time_interval_seconds: '{{ program_date_time_interval_seconds }}'
            repeat_ext_xkey: '{{ repeat_ext_xkey }}'
            stream_selection:
              max_video_bits_per_second: '{{ max_video_bits_per_second }}'
              min_video_bits_per_second: '{{ min_video_bits_per_second }}'
              stream_order: '{{ stream_order }}'
        segment_duration_seconds: '{{ segment_duration_seconds }}'
        include_encoder_configuration_in_segments: '{{ include_encoder_configuration_in_segments }}'
    - name: dash_package
      value:
        dash_manifests:
          - manifest_layout: '{{ manifest_layout }}'
            manifest_name: null
            min_buffer_time_seconds: '{{ min_buffer_time_seconds }}'
            profile: '{{ profile }}'
            scte_markers_source: '{{ scte_markers_source }}'
            stream_selection: null
        encryption:
          speke_key_provider: null
        period_triggers:
          - '{{ period_triggers[0] }}'
        segment_duration_seconds: null
        segment_template_format: '{{ segment_template_format }}'
        include_encoder_configuration_in_segments: '{{ include_encoder_configuration_in_segments }}'
        include_iframe_only_stream: '{{ include_iframe_only_stream }}'
    - name: hls_package
      value:
        encryption:
          constant_initialization_vector: '{{ constant_initialization_vector }}'
          encryption_method: '{{ encryption_method }}'
          speke_key_provider: null
        hls_manifests:
          - null
        include_dvb_subtitles: '{{ include_dvb_subtitles }}'
        segment_duration_seconds: null
        use_audio_rendition_group: '{{ use_audio_rendition_group }}'
    - name: mss_package
      value:
        encryption:
          speke_key_provider: null
        mss_manifests:
          - manifest_name: null
            stream_selection: null
        segment_duration_seconds: null
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

DELETE example

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

Create

mediapackage-vod:CreatePackagingConfiguration,
mediapackage-vod:DescribePackagingConfiguration,
mediapackage-vod:TagResource,
iam:PassRole

Read

mediapackage-vod:DescribePackagingConfiguration

Delete

mediapackage-vod:DescribePackagingConfiguration,
mediapackage-vod:DeletePackagingConfiguration

List

mediapackage-vod:ListPackagingConfigurations,
mediapackage-vod:DescribePackagingGroup