Package software.amazon.awscdk.services.ivs.alpha

Interface IChannel.Jsii$Default

All Superinterfaces:
IChannel, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IChannel.Jsii$Proxy
Enclosing interface:
IChannel
@Internal public static interface IChannel.Jsii$Default extends IChannel, IResource.Jsii$Default
Internal default implementation for IChannel.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ivs.alpha.IChannel

    IChannel.Jsii$Default, IChannel.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.constructs.IDependable

    software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

    IResource.Jsii$Default, IResource.Jsii$Proxy

  • Method Summary

    Modifier and Type
    Method
    Description
    default StreamKey
    addStreamKey(String id)
    (experimental) Adds a stream key for this IVS Channel.
    default void
    applyRemovalPolicy(RemovalPolicy policy)
    Apply the given removal policy to this resource.
    default String
    getChannelArn()
    (experimental) The channel ARN.
    default ResourceEnvironment
    getEnv()
    The environment this resource belongs to.
    default software.constructs.Node
    getNode()
    The tree node.
    default Stack
    getStack()
    The stack in which this resource is defined.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct
      Specified by:
      getNode in interface software.constructs.IConstruct.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default ResourceEnvironment getEnv()
      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.

      Specified by:
      getEnv in interface IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull default Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • getChannelArn

      @Stability(Experimental) @NotNull default String getChannelArn()
      (experimental) The channel ARN.

      For example: arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh

      Specified by:
      getChannelArn in interface IChannel

    • applyRemovalPolicy

      @Stability(Stable) default void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      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).

      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • addStreamKey

      @Stability(Experimental) @NotNull default StreamKey addStreamKey(@NotNull String id)
      (experimental) Adds a stream key for this IVS Channel.

      Specified by:
      addStreamKey in interface IChannel
      Parameters:
      id - construct ID. This parameter is required.