stream_keys

Creates, updates, deletes or gets a stream_key resource or lists stream_keys in a region

Overview

Name	stream_keys
Type	Resource
Description	Resource Type definition for AWS::IVS::StreamKey
Id	aws.ivs.stream_keys

Fields

Name	Datatype	Description
arn	string	Stream Key ARN is automatically generated on creation and assigned as the unique identifier.
channel_arn	string	Channel ARN for the stream.
tags	array	A list of key-value pairs that contain metadata for the asset model.
value	string	Stream-key value.
region	string	AWS region.

Methods

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

SELECT
region,
arn,
channel_arn,
tags,
value
FROM aws.ivs.stream_keys
WHERE region = 'us-east-1';

Gets all properties from an individual stream_key.

SELECT
region,
arn,
channel_arn,
tags,
value
FROM aws.ivs.stream_keys
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

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

All Properties

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

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: stream_key
    props:
      - name: ChannelArn
        value: '{{ ChannelArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

ivs:TagResource,
ivs:UntagResource,
ivs:CreateStreamKey

Read

ivs:GetStreamKey,
ivs:ListTagsForResource

Update

ivs:GetStreamKey,
ivs:TagResource,
ivs:UntagResource,
ivs:ListTagsForResource

Delete

ivs:DeleteStreamKey,
ivs:UntagResource

List

ivs:ListStreamKeys,
ivs:ListTagsForResource