encoder_configurations

Creates, updates, deletes or gets an encoder_configuration resource or lists encoder_configurations in a region

Overview

Name	encoder_configurations
Type	Resource
Description	Resource Type definition for AWS::IVS::EncoderConfiguration.
Id	aws.ivs.encoder_configurations

Fields

Name	Datatype	Description
arn	string	Encoder configuration identifier.
video	object	Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
name	string	Encoder configuration name.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all encoder_configurations in a region.

SELECT
region,
arn,
video,
name,
tags
FROM aws.ivs.encoder_configurations
WHERE region = 'us-east-1';

Gets all properties from an individual encoder_configuration.

SELECT
region,
arn,
video,
name,
tags
FROM aws.ivs.encoder_configurations
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.ivs.encoder_configurations (
 ,
 region
)
SELECT 
'{{  }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ivs.encoder_configurations (
 Video,
 Name,
 Tags,
 region
)
SELECT 
 '{{ Video }}',
 '{{ Name }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: encoder_configuration
    props:
      - name: Video
        value:
          Bitrate: '{{ Bitrate }}'
          Framerate: null
          Height: '{{ Height }}'
          Width: '{{ Width }}'
      - name: Name
        value: '{{ Name }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.ivs.encoder_configurations
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

To operate on the encoder_configurations resource, the following permissions are required:

Create

ivs:CreateEncoderConfiguration,
ivs:TagResource

Read

ivs:GetEncoderConfiguration,
ivs:ListTagsForResource

Update

ivs:GetEncoderConfiguration,
ivs:ListTagsForResource,
ivs:UntagResource,
ivs:TagResource

Delete

ivs:DeleteEncoderConfiguration,
ivs:UntagResource

List

ivs:ListEncoderConfigurations,
ivs:ListTagsForResource