Class CfnStreamKey

All Implemented Interfaces:
IConstruct, IDependable, IInspectable,, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:58.043Z") @Stability(Stable) public class CfnStreamKey extends CfnResource implements IInspectable
A CloudFormation AWS::IVS::StreamKey.

The AWS::IVS::StreamKey resource specifies an stream key associated with the referenced channel. Use a stream key to initiate a live stream.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CfnStreamKey cfnStreamKey = CfnStreamKey.Builder.create(this, "MyCfnStreamKey")
         // the properties below are optional
  • Field Details


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

    • CfnStreamKey

      protected CfnStreamKey( objRef)
    • CfnStreamKey

      protected CfnStreamKey( initializationMode)
    • CfnStreamKey

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

      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.
  • Method Details

    • inspect

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

      Specified by:
      inspect in interface IInspectable
      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)
      renderProperties in class CfnResource
      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()
      getCfnProperties in class CfnResource
    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

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