class StreamKey (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.IVS.StreamKey
Java	software.amazon.awscdk.services.ivs.StreamKey
Python	aws_cdk.aws_ivs.StreamKey
TypeScript (source)	@aws-cdk/aws-ivs » StreamKey

Implements IConstruct, IConstruct, IDependable, IResource, IStreamKey

A new IVS Stream Key.

Example

const myStreamKey = myChannel.addStreamKey('StreamKey');

Initializer

new StreamKey(scope: Construct, id: string, props: StreamKeyProps)

Parameters

• scope Construct
• id string
• props StreamKeyProps

Construct Props

Name	Type	Description
channel🔹	IChannel	Channel ARN for the stream.

---

channel🔹

Type: IChannel

Channel ARN for the stream.

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	ConstructNode	The construct tree node associated with this construct.
stack🔹	Stack	The stack in which this resource is defined.
streamKeyArn🔹	string	The stream-key ARN.
streamKeyValue🔹	string	The stream-key value.

---

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: ConstructNode

The construct tree node associated with this construct.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

streamKeyArn🔹

Type: string

The stream-key ARN.

For example: arn:aws:ivs:us-west-2:123456789012:stream-key/g1H2I3j4k5L6

---

streamKeyValue🔹

Type: string

The stream-key value.

For example: sk_us-west-2_abcdABCDefgh_567890abcdef

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.