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 = '{{ region }}' 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 = '{{ region }}';

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ivs.playback_key_pairs (
  Name,
  PublicKeyMaterial,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ public_key_material }}',
  '{{ 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: 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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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