playback_key_pairs

Creates, updates, deletes or gets a playback_key_pair resource or lists playback_key_pairs in a region

Overview

Name	playback_key_pairs
Type	Resource
Description	Resource Type definition for AWS::IVS::PlaybackKeyPair
Id	aws.ivs.playback_key_pairs

Fields

Name	Datatype	Description
name	string	An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique.
public_key_material	string	The public portion of a customer-generated key pair.
fingerprint	string	Key-pair identifier.
arn	string	Key-pair identifier.
tags	array	A list of key-value pairs that contain metadata for the asset model.
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 playback_key_pairs in a region.

SELECT
region,
name,
public_key_material,
fingerprint,
arn,
tags
FROM aws.ivs.playback_key_pairs
WHERE region = 'us-east-1';

Gets all properties from an individual playback_key_pair.

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

INSERT example

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

Required Properties

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

All Properties

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

Manifest

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

DELETE example

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

Permissions

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

Create

ivs:ImportPlaybackKeyPair,
ivs:TagResource

Read

ivs:GetPlaybackKeyPair

Update

ivs:GetPlaybackKeyPair,
ivs:ListTagsForResource,
ivs:UntagResource,
ivs:TagResource

Delete

ivs:DeletePlaybackKeyPair,
ivs:UntagResource

List

ivs:ListPlaybackKeyPairs,
ivs:ListTagsForResource