recording_configurations

Creates, updates, deletes or gets a recording_configuration resource or lists recording_configurations in a region

Overview

Name	recording_configurations
Type	Resource
Description	Resource Type definition for AWS::IVS::RecordingConfiguration
Id	aws.ivs.recording_configurations

Fields

Name	Datatype	Description
arn	string	Recording Configuration ARN is automatically generated on creation and assigned as the unique identifier.
name	string	Recording Configuration Name.
state	string	Recording Configuration State.
recording_reconnect_window_seconds	integer	Recording Reconnect Window Seconds. (0 means disabled)
destination_configuration	object	Recording Destination Configuration.
tags	array	A list of key-value pairs that contain metadata for the asset model.
thumbnail_configuration	object	Recording Thumbnail Configuration.
rendition_configuration	object	Rendition Configuration describes which renditions should be recorded for a stream.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DestinationConfiguration, 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 recording_configurations in a region.

SELECT
region,
arn,
name,
state,
recording_reconnect_window_seconds,
destination_configuration,
tags,
thumbnail_configuration,
rendition_configuration
FROM aws.ivs.recording_configurations
WHERE region = 'us-east-1';

Gets all properties from an individual recording_configuration.

SELECT
region,
arn,
name,
state,
recording_reconnect_window_seconds,
destination_configuration,
tags,
thumbnail_configuration,
rendition_configuration
FROM aws.ivs.recording_configurations
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO aws.ivs.recording_configurations (
 Name,
 RecordingReconnectWindowSeconds,
 DestinationConfiguration,
 Tags,
 ThumbnailConfiguration,
 RenditionConfiguration,
 region
)
SELECT 
 '{{ Name }}',
 '{{ RecordingReconnectWindowSeconds }}',
 '{{ DestinationConfiguration }}',
 '{{ Tags }}',
 '{{ ThumbnailConfiguration }}',
 '{{ RenditionConfiguration }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: recording_configuration
    props:
      - name: Name
        value: '{{ Name }}'
      - name: RecordingReconnectWindowSeconds
        value: '{{ RecordingReconnectWindowSeconds }}'
      - name: DestinationConfiguration
        value:
          S3:
            BucketName: '{{ BucketName }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: ThumbnailConfiguration
        value:
          RecordingMode: '{{ RecordingMode }}'
          TargetIntervalSeconds: '{{ TargetIntervalSeconds }}'
          Resolution: '{{ Resolution }}'
          Storage:
            - '{{ Storage[0] }}'
      - name: RenditionConfiguration
        value:
          RenditionSelection: '{{ RenditionSelection }}'
          Renditions:
            - '{{ Renditions[0] }}'

DELETE example

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

Permissions

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

Create

ivs:CreateRecordingConfiguration,
ivs:GetRecordingConfiguration,
ivs:TagResource,
iam:CreateServiceLinkedRole,
iam:PutRolePolicy,
iam:AttachRolePolicy,
s3:ListBucket,
s3:GetBucketLocation,
cloudformation:ListExports

Read

ivs:GetRecordingConfiguration,
s3:GetBucketLocation,
ivs:ListTagsForResource

Update

ivs:GetRecordingConfiguration,
sts:AssumeRole,
iam:CreateServiceLinkedRole,
iam:PutRolePolicy,
iam:AttachRolePolicy,
s3:ListBucket,
ivs:TagResource,
ivs:UntagResource,
ivs:ListTagsForResource

Delete

ivs:DeleteRecordingConfiguration,
ivs:UntagResource,
iam:CreateServiceLinkedRole

List

ivs:ListRecordingConfigurations,
s3:GetBucketLocation,
ivs:ListTagsForResource