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

Fields

get (all properties)

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.

list (identifiers only)

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

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	stream_keys	INSERT	ChannelArn, region
delete_resource	stream_keys	DELETE	Identifier, region
update_resource	stream_keys	UPDATE	Identifier, PatchDocument, region
list_resources	stream_keys_list_only	SELECT	region
get_resource	stream_keys	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual stream_key.

SELECT
  region,
  arn,
  channel_arn,
  tags,
  value
FROM awscc.ivs.stream_keys
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all stream_keys in a region.

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

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

All Properties

/*+ create */
INSERT INTO awscc.ivs.stream_keys (
  ChannelArn,
  Tags,
  region
)
SELECT
  '{{ channel_arn }}',
  '{{ 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: stream_key
  props:
    - name: channel_arn
      value: '{{ channel_arn }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ivs.stream_keys
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.stream_keys
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 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