Package software.amazon.awscdk.services.ivs

Class CfnStreamKey

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ivs.CfnStreamKey
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IStreamKeyRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:12.142Z") @Stability(Stable) public class CfnStreamKey extends CfnResource implements IInspectable, IStreamKeyRef, ITaggable
The AWS::IVS::StreamKey resource specifies an stream key associated with the referenced channel.

Use a stream key to initiate a live stream.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ivs.*;
 CfnStreamKey cfnStreamKey = CfnStreamKey.Builder.create(this, "MyCfnStreamKey")
         .channelArn("channelArn")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnStreamKey

      protected CfnStreamKey(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnStreamKey

      protected CfnStreamKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnStreamKey

      @Stability(Stable) public CfnStreamKey(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnStreamKeyProps props)
      Create a new AWS::IVS::StreamKey.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForStreamKey

      @Stability(Stable) @NotNull public static String arnForStreamKey(@NotNull IStreamKeyRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnStreamKey

      @Stability(Stable) @NotNull public static Boolean isCfnStreamKey(@NotNull Object x)
      Checks whether the given object is a CfnStreamKey.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The stream-key ARN.

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

    • getAttrValue

      @Stability(Stable) @NotNull public String getAttrValue()
      The stream-key value.

      For example: sk_us-west-2_abcdABCDefgh_567890abcdef

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getStreamKeyRef

      @Stability(Stable) @NotNull public StreamKeyReference getStreamKeyRef()
      A reference to a StreamKey resource.
      Specified by:
      getStreamKeyRef in interface IStreamKeyRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getChannelArn

      @Stability(Stable) @NotNull public String getChannelArn()
      Channel ARN for the stream.

    • setChannelArn

      @Stability(Stable) public void setChannelArn(@NotNull String value)
      Channel ARN for the stream.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.