@aws-cdk_aws-ivs-alpha.IPlaybackKeyPair

interface IPlaybackKeyPair ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Ivs.Alpha.IPlaybackKeyPair
Gogithub.com/aws/aws-cdk-go/awscdkivsalpha/v2#IPlaybackKeyPair
Javasoftware.amazon.awscdk.services.ivs.alpha.IPlaybackKeyPair
Pythonaws_cdk.aws_ivs_alpha.IPlaybackKeyPair
TypeScript (source)@aws-cdk/aws-ivs-alpha ยป IPlaybackKeyPair

Implemented by PlaybackKeyPair

Represents an IVS Playback Key Pair.

Properties

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


stack๐Ÿ”น

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.

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