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

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

AWS Cloud Control v1.32.0 published on Wednesday, Aug 13, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.ivs.getStage

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.32.0 published on Wednesday, Aug 13, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Definition for type AWS::IVS::Stage.

    Using getStage

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getStage(args: GetStageArgs, opts?: InvokeOptions): Promise<GetStageResult>
function getStageOutput(args: GetStageOutputArgs, opts?: InvokeOptions): Output<GetStageResult>
    def get_stage(arn: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetStageResult
def get_stage_output(arn: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetStageResult]
    func LookupStage(ctx *Context, args *LookupStageArgs, opts ...InvokeOption) (*LookupStageResult, error)
func LookupStageOutput(ctx *Context, args *LookupStageOutputArgs, opts ...InvokeOption) LookupStageResultOutput

    > Note: This function is named LookupStage in the Go SDK.

    public static class GetStage 
{
    public static Task<GetStageResult> InvokeAsync(GetStageArgs args, InvokeOptions? opts = null)
    public static Output<GetStageResult> Invoke(GetStageInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetStageResult> getStage(GetStageArgs args, InvokeOptions options)
public static Output<GetStageResult> getStage(GetStageArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:ivs:getStage
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    Stage ARN is automatically generated on creation and assigned as the unique identifier.
    Arn string
    Stage ARN is automatically generated on creation and assigned as the unique identifier.
    arn String
    Stage ARN is automatically generated on creation and assigned as the unique identifier.
    arn string
    Stage ARN is automatically generated on creation and assigned as the unique identifier.
    arn str
    Stage ARN is automatically generated on creation and assigned as the unique identifier.
    arn String
    Stage ARN is automatically generated on creation and assigned as the unique identifier.

    getStage Result

    The following output properties are available:

    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.
    AutoParticipantRecordingConfiguration Pulumi.AwsNative.Ivs.Outputs.StageAutoParticipantRecordingConfiguration
    Name string
    Stage name
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this 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.
    AutoParticipantRecordingConfiguration StageAutoParticipantRecordingConfiguration
    Name string
    Stage name
    Tags Tag
    An array of key-value pairs to apply to this 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.
    autoParticipantRecordingConfiguration StageAutoParticipantRecordingConfiguration
    name String
    Stage name
    tags List<Tag>
    An array of key-value pairs to apply to this 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.
    autoParticipantRecordingConfiguration StageAutoParticipantRecordingConfiguration
    name string
    Stage name
    tags Tag[]
    An array of key-value pairs to apply to this 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.
    auto_participant_recording_configuration StageAutoParticipantRecordingConfiguration
    name str
    Stage name
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this 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.
    autoParticipantRecordingConfiguration Property Map
    name String
    Stage name
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Supporting Types

    StageAutoParticipantRecordingConfiguration

    StorageConfigurationArn string
    ARN of the StorageConfiguration resource to use for individual participant recording.
    HlsConfiguration Pulumi.AwsNative.Ivs.Inputs.StageAutoParticipantRecordingConfigurationHlsConfigurationProperties
    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.StageAutoParticipantRecordingConfigurationThumbnailConfigurationProperties
    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 StageAutoParticipantRecordingConfigurationHlsConfigurationProperties
    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 StageAutoParticipantRecordingConfigurationThumbnailConfigurationProperties
    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 StageAutoParticipantRecordingConfigurationHlsConfigurationProperties
    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 StageAutoParticipantRecordingConfigurationThumbnailConfigurationProperties
    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 StageAutoParticipantRecordingConfigurationHlsConfigurationProperties
    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 StageAutoParticipantRecordingConfigurationThumbnailConfigurationProperties
    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 StageAutoParticipantRecordingConfigurationHlsConfigurationProperties
    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 StageAutoParticipantRecordingConfigurationThumbnailConfigurationProperties
    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.

    StageAutoParticipantRecordingConfigurationHlsConfigurationProperties

    ParticipantRecordingHlsConfiguration StageAutoParticipantRecordingConfigurationHlsConfigurationPropertiesParticipantRecordingHlsConfigurationProperties
    An object representing a configuration of participant HLS recordings for individual participant recording.
    participantRecordingHlsConfiguration StageAutoParticipantRecordingConfigurationHlsConfigurationPropertiesParticipantRecordingHlsConfigurationProperties
    An object representing a configuration of participant HLS recordings for individual participant recording.
    participantRecordingHlsConfiguration StageAutoParticipantRecordingConfigurationHlsConfigurationPropertiesParticipantRecordingHlsConfigurationProperties
    An object representing a configuration of participant HLS recordings for individual participant recording.
    participant_recording_hls_configuration StageAutoParticipantRecordingConfigurationHlsConfigurationPropertiesParticipantRecordingHlsConfigurationProperties
    An object representing a configuration of participant HLS recordings for individual participant recording.
    participantRecordingHlsConfiguration Property Map
    An object representing a configuration of participant HLS recordings for individual participant recording.

    StageAutoParticipantRecordingConfigurationHlsConfigurationPropertiesParticipantRecordingHlsConfigurationProperties

    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.

    StageAutoParticipantRecordingConfigurationMediaTypesItem

    StageAutoParticipantRecordingConfigurationThumbnailConfigurationProperties

    ParticipantThumbnailConfiguration StageAutoParticipantRecordingConfigurationThumbnailConfigurationPropertiesParticipantThumbnailConfigurationProperties
    An object representing a configuration of thumbnails for recorded video from an individual participant.
    participantThumbnailConfiguration StageAutoParticipantRecordingConfigurationThumbnailConfigurationPropertiesParticipantThumbnailConfigurationProperties
    An object representing a configuration of thumbnails for recorded video from an individual participant.
    participantThumbnailConfiguration StageAutoParticipantRecordingConfigurationThumbnailConfigurationPropertiesParticipantThumbnailConfigurationProperties
    An object representing a configuration of thumbnails for recorded video from an individual participant.
    participant_thumbnail_configuration StageAutoParticipantRecordingConfigurationThumbnailConfigurationPropertiesParticipantThumbnailConfigurationProperties
    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.

    StageAutoParticipantRecordingConfigurationThumbnailConfigurationPropertiesParticipantThumbnailConfigurationProperties

    RecordingMode Pulumi.AwsNative.Ivs.StageAutoParticipantRecordingConfigurationThumbnailConfigurationPropertiesParticipantThumbnailConfigurationPropertiesRecordingMode
    Thumbnail recording mode. Default: DISABLED.
    Storage List<Pulumi.AwsNative.Ivs.StageAutoParticipantRecordingConfigurationThumbnailConfigurationPropertiesParticipantThumbnailConfigurationPropertiesStorageItem>
    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 StageAutoParticipantRecordingConfigurationThumbnailConfigurationPropertiesParticipantThumbnailConfigurationPropertiesRecordingMode
    Thumbnail recording mode. Default: DISABLED.
    Storage []StageAutoParticipantRecordingConfigurationThumbnailConfigurationPropertiesParticipantThumbnailConfigurationPropertiesStorageItem
    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 StageAutoParticipantRecordingConfigurationThumbnailConfigurationPropertiesParticipantThumbnailConfigurationPropertiesRecordingMode
    Thumbnail recording mode. Default: DISABLED.
    storage List<StageAutoParticipantRecordingConfigurationThumbnailConfigurationPropertiesParticipantThumbnailConfigurationPropertiesStorageItem>
    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 StageAutoParticipantRecordingConfigurationThumbnailConfigurationPropertiesParticipantThumbnailConfigurationPropertiesRecordingMode
    Thumbnail recording mode. Default: DISABLED.
    storage StageAutoParticipantRecordingConfigurationThumbnailConfigurationPropertiesParticipantThumbnailConfigurationPropertiesStorageItem[]
    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 StageAutoParticipantRecordingConfigurationThumbnailConfigurationPropertiesParticipantThumbnailConfigurationPropertiesRecordingMode
    Thumbnail recording mode. Default: DISABLED.
    storage Sequence[StageAutoParticipantRecordingConfigurationThumbnailConfigurationPropertiesParticipantThumbnailConfigurationPropertiesStorageItem]
    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.

    StageAutoParticipantRecordingConfigurationThumbnailConfigurationPropertiesParticipantThumbnailConfigurationPropertiesRecordingMode

    StageAutoParticipantRecordingConfigurationThumbnailConfigurationPropertiesParticipantThumbnailConfigurationPropertiesStorageItem

    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 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.32.0 published on Wednesday, Aug 13, 2025 by Pulumi
    pulumi/pulumi-aws-native