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	awscc.ivs.recording_configurations

Fields

get (all properties)

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	A complex type that allows you to enable/disable the recording of thumbnails for individual participant recording and modify the interval at which thumbnails are generated for the live session.
▶rendition_configuration	object	Rendition Configuration describes which renditions should be recorded for a stream.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string	Recording Configuration ARN is automatically generated on creation and assigned as the unique identifier.
region	string	AWS region.

For more information, see AWS::IVS::RecordingConfiguration.

Methods

Name	Resource	Accessible by	Required Params
create_resource	recording_configurations	INSERT	DestinationConfiguration, region
delete_resource	recording_configurations	DELETE	Identifier, region
update_resource	recording_configurations	UPDATE	Identifier, PatchDocument, region
list_resources	recording_configurations_list_only	SELECT	region
get_resource	recording_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.ivs.recording_configurations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all recording_configurations in a region.

SELECT
  region,
  arn
FROM awscc.ivs.recording_configurations_list_only
WHERE
  region = '{{ region }}';

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 awscc.ivs.recording_configurations (
  DestinationConfiguration,
  region
)
SELECT
  '{{ destination_configuration }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ivs.recording_configurations (
  Name,
  RecordingReconnectWindowSeconds,
  DestinationConfiguration,
  Tags,
  ThumbnailConfiguration,
  RenditionConfiguration,
  region
)
SELECT
  '{{ name }}',
  '{{ recording_reconnect_window_seconds }}',
  '{{ destination_configuration }}',
  '{{ tags }}',
  '{{ thumbnail_configuration }}',
  '{{ rendition_configuration }}',
  '{{ 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: recording_configuration
  props:
    - name: name
      value: '{{ name }}'
    - name: recording_reconnect_window_seconds
      value: '{{ recording_reconnect_window_seconds }}'
    - name: destination_configuration
      value:
        s3:
          bucket_name: '{{ bucket_name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: thumbnail_configuration
      value:
        participant_thumbnail_configuration:
          recording_mode: '{{ recording_mode }}'
          storage:
            - '{{ storage[0] }}'
          target_interval_seconds: '{{ target_interval_seconds }}'
    - name: rendition_configuration
      value:
        rendition_selection: '{{ rendition_selection }}'
        renditions:
          - '{{ renditions[0] }}'

UPDATE example

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

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

DELETE example

/*+ delete */
DELETE FROM awscc.ivs.recording_configurations
WHERE
  Identifier = '{{ arn }}' 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 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