Package software.amazon.awscdk.services.ivs

Class CfnStage

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.CfnStage
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IStageRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:46.113Z") @Stability(Stable) public class CfnStage extends CfnResource implements IInspectable, IStageRef, ITaggableV2
The AWS::IVS::Stage resource specifies an stage.

A stage is a virtual space where participants can exchange video in real time. For more information, see CreateStage in the Amazon IVS Real-Time Streaming API Reference .

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.*;
 CfnStage cfnStage = CfnStage.Builder.create(this, "MyCfnStage")
         .autoParticipantRecordingConfiguration(AutoParticipantRecordingConfigurationProperty.builder()
                 .storageConfigurationArn("storageConfigurationArn")
                 // the properties below are optional
                 .hlsConfiguration(HlsConfigurationProperty.builder()
                         .participantRecordingHlsConfiguration(ParticipantRecordingHlsConfigurationProperty.builder()
                                 .targetSegmentDurationSeconds(123)
                                 .build())
                         .build())
                 .mediaTypes(List.of("mediaTypes"))
                 .recordingReconnectWindowSeconds(123)
                 .thumbnailConfiguration(ThumbnailConfigurationProperty.builder()
                         .participantThumbnailConfiguration(ParticipantThumbnailConfigurationProperty.builder()
                                 .recordingMode("recordingMode")
                                 .storage(List.of("storage"))
                                 .targetIntervalSeconds(123)
                                 .build())
                         .build())
                 .build())
         .name("name")
         .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

    • CfnStage

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

    • CfnStage

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

    • CfnStage

      @Stability(Stable) public CfnStage(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnStageProps props)
      Create a new AWS::IVS::Stage.

      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.

    • CfnStage

      @Stability(Stable) public CfnStage(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::IVS::Stage.

      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.

  • Method Details

    • arnForStage

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

    • isCfnStage

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

      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.

    • getAttrActiveSessionId

      @Stability(Stable) @NotNull public String getAttrActiveSessionId()
      ID of the active session within the stage.

      For example: st-a1b2c3d4e5f6g

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The stage ARN.

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

    • getCdkTagManager

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

    • getCfnProperties

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

    • getStageRef

      @Stability(Stable) @NotNull public StageReference getStageRef()
      A reference to a Stage resource.
      Specified by:
      getStageRef in interface IStageRef

    • getAutoParticipantRecordingConfiguration

      @Stability(Stable) @Nullable public Object getAutoParticipantRecordingConfiguration()
      Configuration object for individual participant recording.

      Returns union: either IResolvable or CfnStage.AutoParticipantRecordingConfigurationProperty

    • setAutoParticipantRecordingConfiguration

      @Stability(Stable) public void setAutoParticipantRecordingConfiguration(@Nullable IResolvable value)
      Configuration object for individual participant recording.

    • setAutoParticipantRecordingConfiguration

      @Stability(Stable) public void setAutoParticipantRecordingConfiguration(@Nullable CfnStage.AutoParticipantRecordingConfigurationProperty value)
      Configuration object for individual participant recording.

    • getName

      @Stability(Stable) @Nullable public String getName()
      Stage name.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      Stage name.

    • getTags

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

    • setTags

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