AWS::IVS::PlaybackKeyPair - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


The AWS::IVS::PlaybackKeyPair resource specifies an Amazon IVS playback key pair. Amazon IVS uses a public playback key to validate playback tokens that have been signed with the corresponding private key. For more information, see Setting Up Private Channels in the Amazon IVS Low-Latency Streaming User Guide.


To declare this entity in your Amazon CloudFormation template, use the following syntax:


{ "Type" : "AWS::IVS::PlaybackKeyPair", "Properties" : { "Name" : String, "PublicKeyMaterial" : String, "Tags" : [ Tag, ... ] } }


Type: AWS::IVS::PlaybackKeyPair Properties: Name: String PublicKeyMaterial: String Tags: - Tag



Playback-key-pair name. The value does not need to be unique.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9-_]*$

Minimum: 0

Maximum: 128

Update requires: Replacement


The public portion of a customer-generated key pair.

Required: No

Type: String

Update requires: Replacement


An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values


When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the playback key pair ARN. For example:

{ "Ref": "myPlaybackKeyPair" }

For the Amazon IVS playback key pair myPlaybackKeyPair, Ref returns the playback key pair ARN.

For more information about using the Ref function, see Ref.


The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.


Key-pair ARN. For example: arn:aws:ivs:us-west-2:693991300569:playback-key/f99cde61-c2b0-4df3-8941-ca7d38acca1a


Key-pair identifier. For example: 98:0d:1a:a0:19:96:1e:ea:0a:0a:2c:9a:42:19:2b:e7


Playback Key Pair Template Examples

The following examples specify an Amazon IVS playback key pair.


{ "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "PlaybackKeyPair": { "Type": "AWS::IVS::PlaybackKeyPair", "Properties": { "PublicKeyMaterial": "-----BEGIN PUBLIC KEY-----\nMHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEwOR43ETwEoWif1i14aL8GtDMNkT/kBQm\nh4sas9P//bjCU988rmQQXVBfftKT9xngg+W6hzOEpeUlCRlAtz6b6U79naYYRaSk\nK/UhYGWkXlbJlc9zn13imYWgVGe/BMFp\n-----END PUBLIC KEY-----\n", "Name": "MyPlaybackKeyPair", "Tags": [ { "Key": "MyKey", "Value": "MyValue" } ] } } }, "Outputs": { "PlaybackKeyPairArn": { "Value": {"Ref": "PlaybackKeyPair"} }, "PlaybackKeyPairFingerprint": { "Value": { "Fn::GetAtt": [ "PlaybackKeyPair", "Fingerprint" ] } } } }


AWSTemplateFormatVersion: 2010-09-09 Resources: PlaybackKeyPair: Type: AWS::IVS::PlaybackKeyPair Properties: PublicKeyMaterial: | -----BEGIN PUBLIC KEY----- MHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEwOR43ETwEoWif1i14aL8GtDMNkT/kBQm h4sas9P//bjCU988rmQQXVBfftKT9xngg+W6hzOEpeUlCRlAtz6b6U79naYYRaSk K/UhYGWkXlbJlc9zn13imYWgVGe/BMFp -----END PUBLIC KEY----- Name: MyPlaybackKeyPair Tags: - Key: MyKey Value: MyValue Outputs: PlaybackKeyPairArn: Value: !Ref PlaybackKeyPair PlaybackKeyPairFingerprint: Value: !GetAtt PlaybackKeyPair.Fingerprint

See also