Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. ivs
  5. Stage

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.35.0 published on Monday, Sep 22, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.ivs.Stage

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.35.0 published on Monday, Sep 22, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::IVS::Stage.

    Create Stage Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Stage(name: string, args?: StageArgs, opts?: CustomResourceOptions);
    @overload
def Stage(resource_name: str,
          args: Optional[StageArgs] = None,
          opts: Optional[ResourceOptions] = None)

@overload
def Stage(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          auto_participant_recording_configuration: Optional[StageAutoParticipantRecordingConfigurationArgs] = None,
          name: Optional[str] = None,
          tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewStage(ctx *Context, name string, args *StageArgs, opts ...ResourceOption) (*Stage, error)
    public Stage(string name, StageArgs? args = null, CustomResourceOptions? opts = null)
    public Stage(String name, StageArgs args)
public Stage(String name, StageArgs args, CustomResourceOptions options)

    type: aws-native:ivs:Stage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args StageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args StageArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args StageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StageArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Stage Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Stage resource accepts the following input properties:

    AutoParticipantRecordingConfiguration Pulumi.AwsNative.Ivs.Inputs.StageAutoParticipantRecordingConfiguration
    Configuration object for individual participant recording.
    Name string
    Stage name
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    AutoParticipantRecordingConfiguration StageAutoParticipantRecordingConfigurationArgs
    Configuration object for individual participant recording.
    Name string
    Stage name
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    autoParticipantRecordingConfiguration StageAutoParticipantRecordingConfiguration
    Configuration object for individual participant recording.
    name String
    Stage name
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    autoParticipantRecordingConfiguration StageAutoParticipantRecordingConfiguration
    Configuration object for individual participant recording.
    name string
    Stage name
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    auto_participant_recording_configuration StageAutoParticipantRecordingConfigurationArgs
    Configuration object for individual participant recording.
    name str
    Stage name
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    autoParticipantRecordingConfiguration Property Map
    Configuration object for individual participant recording.
    name String
    Stage name
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Stage resource produces the following output properties:

    ActiveSessionId string
    ID of the active session within the stage.
    Arn string
    Stage ARN is automatically generated on creation and assigned as the unique identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    ActiveSessionId string
    ID of the active session within the stage.
    Arn string
    Stage ARN is automatically generated on creation and assigned as the unique identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    activeSessionId String
    ID of the active session within the stage.
    arn String
    Stage ARN is automatically generated on creation and assigned as the unique identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    activeSessionId string
    ID of the active session within the stage.
    arn string
    Stage ARN is automatically generated on creation and assigned as the unique identifier.
    id string
    The provider-assigned unique ID for this managed resource.
    active_session_id str
    ID of the active session within the stage.
    arn str
    Stage ARN is automatically generated on creation and assigned as the unique identifier.
    id str
    The provider-assigned unique ID for this managed resource.
    activeSessionId String
    ID of the active session within the stage.
    arn String
    Stage ARN is automatically generated on creation and assigned as the unique identifier.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    StageAutoParticipantRecordingConfiguration, StageAutoParticipantRecordingConfigurationArgs

    StorageConfigurationArn string
    ARN of the StorageConfiguration resource to use for individual participant recording.
    HlsConfiguration Pulumi.AwsNative.Ivs.Inputs.StageHlsConfiguration
    HLS configuration object for individual participant recording.
    MediaTypes List<Pulumi.AwsNative.Ivs.StageAutoParticipantRecordingConfigurationMediaTypesItem>
    Types of media to be recorded. Default: AUDIO_VIDEO.
    RecordingReconnectWindowSeconds int
    If a stage publisher disconnects and then reconnects within the specified interval, the multiple recordings will be considered a single recording and merged together. The default value is 0, which disables merging.
    ThumbnailConfiguration Pulumi.AwsNative.Ivs.Inputs.StageThumbnailConfiguration
    A complex type that allows you to enable/disable the recording of thumbnails for individual participant recording and modify the interval at which thumbnails are generated for the live session.
    StorageConfigurationArn string
    ARN of the StorageConfiguration resource to use for individual participant recording.
    HlsConfiguration StageHlsConfiguration
    HLS configuration object for individual participant recording.
    MediaTypes []StageAutoParticipantRecordingConfigurationMediaTypesItem
    Types of media to be recorded. Default: AUDIO_VIDEO.
    RecordingReconnectWindowSeconds int
    If a stage publisher disconnects and then reconnects within the specified interval, the multiple recordings will be considered a single recording and merged together. The default value is 0, which disables merging.
    ThumbnailConfiguration StageThumbnailConfiguration
    A complex type that allows you to enable/disable the recording of thumbnails for individual participant recording and modify the interval at which thumbnails are generated for the live session.
    storageConfigurationArn String
    ARN of the StorageConfiguration resource to use for individual participant recording.
    hlsConfiguration StageHlsConfiguration
    HLS configuration object for individual participant recording.
    mediaTypes List<StageAutoParticipantRecordingConfigurationMediaTypesItem>
    Types of media to be recorded. Default: AUDIO_VIDEO.
    recordingReconnectWindowSeconds Integer
    If a stage publisher disconnects and then reconnects within the specified interval, the multiple recordings will be considered a single recording and merged together. The default value is 0, which disables merging.
    thumbnailConfiguration StageThumbnailConfiguration
    A complex type that allows you to enable/disable the recording of thumbnails for individual participant recording and modify the interval at which thumbnails are generated for the live session.
    storageConfigurationArn string
    ARN of the StorageConfiguration resource to use for individual participant recording.
    hlsConfiguration StageHlsConfiguration
    HLS configuration object for individual participant recording.
    mediaTypes StageAutoParticipantRecordingConfigurationMediaTypesItem[]
    Types of media to be recorded. Default: AUDIO_VIDEO.
    recordingReconnectWindowSeconds number
    If a stage publisher disconnects and then reconnects within the specified interval, the multiple recordings will be considered a single recording and merged together. The default value is 0, which disables merging.
    thumbnailConfiguration StageThumbnailConfiguration
    A complex type that allows you to enable/disable the recording of thumbnails for individual participant recording and modify the interval at which thumbnails are generated for the live session.
    storage_configuration_arn str
    ARN of the StorageConfiguration resource to use for individual participant recording.
    hls_configuration StageHlsConfiguration
    HLS configuration object for individual participant recording.
    media_types Sequence[StageAutoParticipantRecordingConfigurationMediaTypesItem]
    Types of media to be recorded. Default: AUDIO_VIDEO.
    recording_reconnect_window_seconds int
    If a stage publisher disconnects and then reconnects within the specified interval, the multiple recordings will be considered a single recording and merged together. The default value is 0, which disables merging.
    thumbnail_configuration StageThumbnailConfiguration
    A complex type that allows you to enable/disable the recording of thumbnails for individual participant recording and modify the interval at which thumbnails are generated for the live session.
    storageConfigurationArn String
    ARN of the StorageConfiguration resource to use for individual participant recording.
    hlsConfiguration Property Map
    HLS configuration object for individual participant recording.
    mediaTypes List<"AUDIO_VIDEO" | "AUDIO_ONLY">
    Types of media to be recorded. Default: AUDIO_VIDEO.
    recordingReconnectWindowSeconds Number
    If a stage publisher disconnects and then reconnects within the specified interval, the multiple recordings will be considered a single recording and merged together. The default value is 0, which disables merging.
    thumbnailConfiguration Property Map
    A complex type that allows you to enable/disable the recording of thumbnails for individual participant recording and modify the interval at which thumbnails are generated for the live session.

    StageAutoParticipantRecordingConfigurationMediaTypesItem, StageAutoParticipantRecordingConfigurationMediaTypesItemArgs

    AudioVideo
    AUDIO_VIDEO
    AudioOnly
    AUDIO_ONLY
    StageAutoParticipantRecordingConfigurationMediaTypesItemAudioVideo
    AUDIO_VIDEO
    StageAutoParticipantRecordingConfigurationMediaTypesItemAudioOnly
    AUDIO_ONLY
    AudioVideo
    AUDIO_VIDEO
    AudioOnly
    AUDIO_ONLY
    AudioVideo
    AUDIO_VIDEO
    AudioOnly
    AUDIO_ONLY
    AUDIO_VIDEO
    AUDIO_VIDEO
    AUDIO_ONLY
    AUDIO_ONLY
    "AUDIO_VIDEO"
    AUDIO_VIDEO
    "AUDIO_ONLY"
    AUDIO_ONLY

    StageHlsConfiguration, StageHlsConfigurationArgs

    ParticipantRecordingHlsConfiguration Pulumi.AwsNative.Ivs.Inputs.StageParticipantRecordingHlsConfiguration
    Object specifying a configuration of participant HLS recordings for individual participant recording.
    ParticipantRecordingHlsConfiguration StageParticipantRecordingHlsConfiguration
    Object specifying a configuration of participant HLS recordings for individual participant recording.
    participantRecordingHlsConfiguration StageParticipantRecordingHlsConfiguration
    Object specifying a configuration of participant HLS recordings for individual participant recording.
    participantRecordingHlsConfiguration StageParticipantRecordingHlsConfiguration
    Object specifying a configuration of participant HLS recordings for individual participant recording.
    participant_recording_hls_configuration StageParticipantRecordingHlsConfiguration
    Object specifying a configuration of participant HLS recordings for individual participant recording.
    participantRecordingHlsConfiguration Property Map
    Object specifying a configuration of participant HLS recordings for individual participant recording.

    StageParticipantRecordingHlsConfiguration, StageParticipantRecordingHlsConfigurationArgs

    TargetSegmentDurationSeconds int
    Defines the target duration for recorded segments generated when recording a stage participant. Segments may have durations longer than the specified value when needed to ensure each segment begins with a keyframe. Default: 6.
    TargetSegmentDurationSeconds int
    Defines the target duration for recorded segments generated when recording a stage participant. Segments may have durations longer than the specified value when needed to ensure each segment begins with a keyframe. Default: 6.
    targetSegmentDurationSeconds Integer
    Defines the target duration for recorded segments generated when recording a stage participant. Segments may have durations longer than the specified value when needed to ensure each segment begins with a keyframe. Default: 6.
    targetSegmentDurationSeconds number
    Defines the target duration for recorded segments generated when recording a stage participant. Segments may have durations longer than the specified value when needed to ensure each segment begins with a keyframe. Default: 6.
    target_segment_duration_seconds int
    Defines the target duration for recorded segments generated when recording a stage participant. Segments may have durations longer than the specified value when needed to ensure each segment begins with a keyframe. Default: 6.
    targetSegmentDurationSeconds Number
    Defines the target duration for recorded segments generated when recording a stage participant. Segments may have durations longer than the specified value when needed to ensure each segment begins with a keyframe. Default: 6.

    StageThumbnailConfiguration, StageThumbnailConfigurationArgs

    ParticipantThumbnailConfiguration Pulumi.AwsNative.Ivs.Inputs.StageThumbnailConfigurationParticipantThumbnailConfigurationProperties
    An object representing a configuration of thumbnails for recorded video from an individual participant.
    ParticipantThumbnailConfiguration StageThumbnailConfigurationParticipantThumbnailConfigurationProperties
    An object representing a configuration of thumbnails for recorded video from an individual participant.
    participantThumbnailConfiguration StageThumbnailConfigurationParticipantThumbnailConfigurationProperties
    An object representing a configuration of thumbnails for recorded video from an individual participant.
    participantThumbnailConfiguration StageThumbnailConfigurationParticipantThumbnailConfigurationProperties
    An object representing a configuration of thumbnails for recorded video from an individual participant.
    participant_thumbnail_configuration StageThumbnailConfigurationParticipantThumbnailConfigurationProperties
    An object representing a configuration of thumbnails for recorded video from an individual participant.
    participantThumbnailConfiguration Property Map
    An object representing a configuration of thumbnails for recorded video from an individual participant.

    StageThumbnailConfigurationParticipantThumbnailConfigurationProperties, StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesArgs

    RecordingMode Pulumi.AwsNative.Ivs.StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesRecordingMode
    Thumbnail recording mode. Default: DISABLED.
    Storage List<Pulumi.AwsNative.Ivs.StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesStorageItem>
    Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails/high directory. LATEST saves the latest thumbnail in media/latest_thumbnail/high/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.
    TargetIntervalSeconds int
    The targeted thumbnail-generation interval in seconds. This is configurable only if recordingMode is INTERVAL. Default: 60.
    RecordingMode StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesRecordingMode
    Thumbnail recording mode. Default: DISABLED.
    Storage []StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesStorageItem
    Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails/high directory. LATEST saves the latest thumbnail in media/latest_thumbnail/high/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.
    TargetIntervalSeconds int
    The targeted thumbnail-generation interval in seconds. This is configurable only if recordingMode is INTERVAL. Default: 60.
    recordingMode StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesRecordingMode
    Thumbnail recording mode. Default: DISABLED.
    storage List<StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesStorageItem>
    Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails/high directory. LATEST saves the latest thumbnail in media/latest_thumbnail/high/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.
    targetIntervalSeconds Integer
    The targeted thumbnail-generation interval in seconds. This is configurable only if recordingMode is INTERVAL. Default: 60.
    recordingMode StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesRecordingMode
    Thumbnail recording mode. Default: DISABLED.
    storage StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesStorageItem[]
    Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails/high directory. LATEST saves the latest thumbnail in media/latest_thumbnail/high/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.
    targetIntervalSeconds number
    The targeted thumbnail-generation interval in seconds. This is configurable only if recordingMode is INTERVAL. Default: 60.
    recording_mode StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesRecordingMode
    Thumbnail recording mode. Default: DISABLED.
    storage Sequence[StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesStorageItem]
    Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails/high directory. LATEST saves the latest thumbnail in media/latest_thumbnail/high/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.
    target_interval_seconds int
    The targeted thumbnail-generation interval in seconds. This is configurable only if recordingMode is INTERVAL. Default: 60.
    recordingMode "INTERVAL" | "DISABLED"
    Thumbnail recording mode. Default: DISABLED.
    storage List<"SEQUENTIAL" | "LATEST">
    Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails/high directory. LATEST saves the latest thumbnail in media/latest_thumbnail/high/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.
    targetIntervalSeconds Number
    The targeted thumbnail-generation interval in seconds. This is configurable only if recordingMode is INTERVAL. Default: 60.

    StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesRecordingMode, StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesRecordingModeArgs

    Interval
    INTERVAL
    Disabled
    DISABLED
    StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesRecordingModeInterval
    INTERVAL
    StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesRecordingModeDisabled
    DISABLED
    Interval
    INTERVAL
    Disabled
    DISABLED
    Interval
    INTERVAL
    Disabled
    DISABLED
    INTERVAL
    INTERVAL
    DISABLED
    DISABLED
    "INTERVAL"
    INTERVAL
    "DISABLED"
    DISABLED

    StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesStorageItem, StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesStorageItemArgs

    Sequential
    SEQUENTIAL
    Latest
    LATEST
    StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesStorageItemSequential
    SEQUENTIAL
    StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesStorageItemLatest
    LATEST
    Sequential
    SEQUENTIAL
    Latest
    LATEST
    Sequential
    SEQUENTIAL
    Latest
    LATEST
    SEQUENTIAL
    SEQUENTIAL
    LATEST
    LATEST
    "SEQUENTIAL"
    SEQUENTIAL
    "LATEST"
    LATEST

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.35.0 published on Monday, Sep 22, 2025 by Pulumi
    pulumi/pulumi-aws-native