@aws-cdk_aws-ivs-alpha.PlaybackKeyPair

class PlaybackKeyPair (construct) ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Ivs.Alpha.PlaybackKeyPair
Gogithub.com/aws/aws-cdk-go/awscdkivsalpha/v2#PlaybackKeyPair
Javasoftware.amazon.awscdk.services.ivs.alpha.PlaybackKeyPair
Pythonaws_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

NameTypeDescription
publicKeyMaterial๐Ÿ”นstringThe public portion of a customer-generated key pair.
playbackKeyPairName?๐Ÿ”นstringAn 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

NameTypeDescription
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
node๐Ÿ”นNodeThe tree node.
playbackKeyPairArn๐Ÿ”นstringKey-pair ARN.
playbackKeyPairFingerprint๐Ÿ”นstringKey-pair identifier.
stack๐Ÿ”นStackThe 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

NameDescription
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.