class PlaybackKeyPair (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Ivs.Alpha.PlaybackKeyPair
Go	github.com/aws/aws-cdk-go/awscdkivsalpha/v2#PlaybackKeyPair
Java	software.amazon.awscdk.services.ivs.alpha.PlaybackKeyPair
Python	aws_cdk.aws_ivs_alpha.PlaybackKeyPair
TypeScript (source)	@aws-cdk/aws-ivs-alpha » PlaybackKeyPair

Implements IConstruct, IDependable, IResource, IPlaybackKeyPair

A new IVS Playback Key Pair.

Example

const keyPair = new ivs.PlaybackKeyPair(this, 'PlaybackKeyPair', {
  publicKeyMaterial: myPublicKeyPemString,
});

Initializer

new PlaybackKeyPair(scope: Construct, id: string, props: PlaybackKeyPairProps)

Parameters

• scope Construct
• id string
• props PlaybackKeyPairProps

Construct Props

Name	Type	Description
publicKeyMaterial🔹	string	The public portion of a customer-generated key pair.
playbackKeyPairName?🔹	string	An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource.

---

publicKeyMaterial🔹

Type: string

The public portion of a customer-generated key pair.

---

playbackKeyPairName?🔹

Type: string (optional, default: Automatically generated name)

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.

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
playbackKeyPairArn🔹	string	Key-pair ARN.
playbackKeyPairFingerprint🔹	string	Key-pair identifier.
stack🔹	Stack	The stack in which this resource is defined.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node🔹

Type: Node

The tree node.

---

playbackKeyPairArn🔹

Type: string

Key-pair ARN.

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

---

playbackKeyPairFingerprint🔹

Type: string

Key-pair identifier.

For example: 98:0d:1a:a0:19:96:1e:ea:0a:0a:2c:9a:42:19:2b:e7

---

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
toString()🔹	Returns a string representation of this construct.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.