@aws-cdk_aws-ivs-alpha.StreamKey

class StreamKey (construct) ๐Ÿ”น

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

Implements 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

NameTypeDescription
channel๐Ÿ”นIChannelChannel ARN for the stream.

channel๐Ÿ”น

Type: IChannel

Channel ARN for the stream.

Properties

NameTypeDescription
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
node๐Ÿ”นNodeThe tree node.
stack๐Ÿ”นStackThe stack in which this resource is defined.
streamKeyArn๐Ÿ”นstringThe stream-key ARN.
streamKeyValue๐Ÿ”นstringThe 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: Node

The tree node.


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

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.