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

Fields

get (all properties)

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. This field is required to create the AWS::IVS::PlaybackKeyPair resource.
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.

list (identifiers only)

Name	Datatype	Description
arn	string	Key-pair identifier.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	playback_key_pairs	INSERT	region
delete_resource	playback_key_pairs	DELETE	Identifier, region
update_resource	playback_key_pairs	UPDATE	Identifier, PatchDocument, region
list_resources	playback_key_pairs_list_only	SELECT	region
get_resource	playback_key_pairs	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual playback_key_pair.

SELECT
  region,
  name,
  public_key_material,
  fingerprint,
  arn,
  tags
FROM awscc.ivs.playback_key_pairs
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all playback_key_pairs in a region.

SELECT
  region,
  arn
FROM awscc.ivs.playback_key_pairs_list_only
WHERE
  region = 'us-east-1';

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 awscc.ivs.playback_key_pairs (
  Name,
  PublicKeyMaterial,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ public_key_material }}',
  '{{ tags }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.ivs.playback_key_pairs (
  Name,
  PublicKeyMaterial,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ public_key_material }}',
  '{{ 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: public_key_material
        value: '{{ public_key_material }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ivs.playback_key_pairs
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.ivs.playback_key_pairs
WHERE
  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