CfnStageProps

class aws_cdk.aws_ivs.CfnStageProps(*, auto_participant_recording_configuration=None, name=None, tags=None)

Bases: object

Properties for defining a CfnStage.

Parameters:

auto_participant_recording_configuration (Union[IResolvable, AutoParticipantRecordingConfigurationProperty, Dict[str, Any], None]) – Configuration object for individual participant recording.
name (Optional[str]) – Stage name.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-stage.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ivs as ivs

cfn_stage_props = ivs.CfnStageProps(
    auto_participant_recording_configuration=ivs.CfnStage.AutoParticipantRecordingConfigurationProperty(
        storage_configuration_arn="storageConfigurationArn",

        # the properties below are optional
        hls_configuration=ivs.CfnStage.HlsConfigurationProperty(
            participant_recording_hls_configuration=ivs.CfnStage.ParticipantRecordingHlsConfigurationProperty(
                target_segment_duration_seconds=123
            )
        ),
        media_types=["mediaTypes"],
        recording_reconnect_window_seconds=123,
        thumbnail_configuration=ivs.CfnStage.ThumbnailConfigurationProperty(
            participant_thumbnail_configuration=ivs.CfnStage.ParticipantThumbnailConfigurationProperty(
                recording_mode="recordingMode",
                storage=["storage"],
                target_interval_seconds=123
            )
        )
    ),
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

auto_participant_recording_configuration

Configuration object for individual participant recording.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-stage.html#cfn-ivs-stage-autoparticipantrecordingconfiguration

name

Stage name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-stage.html#cfn-ivs-stage-name

tags

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-stage.html#cfn-ivs-stage-tags