interface CfnStageProps

Language	Type name
.NET	Amazon.CDK.AWS.Ivs.CfnStageProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsivs#CfnStageProps
Java	software.amazon.awscdk.services.ivs.CfnStageProps
Python	aws_cdk.aws_ivs.CfnStageProps
TypeScript	aws-cdk-lib » aws_ivs » CfnStageProps

Properties for defining a CfnStage.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ivs as ivs } from 'aws-cdk-lib';
const cfnStageProps: ivs.CfnStageProps = {
  autoParticipantRecordingConfiguration: {
    storageConfigurationArn: 'storageConfigurationArn',

    // the properties below are optional
    hlsConfiguration: {
      participantRecordingHlsConfiguration: {
        targetSegmentDurationSeconds: 123,
      },
    },
    mediaTypes: ['mediaTypes'],
    recordingReconnectWindowSeconds: 123,
    thumbnailConfiguration: {
      participantThumbnailConfiguration: {
        recordingMode: 'recordingMode',
        storage: ['storage'],
        targetIntervalSeconds: 123,
      },
    },
  },
  name: 'name',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
autoParticipantRecordingConfiguration?	IResolvable | AutoParticipantRecordingConfigurationProperty	Configuration object for individual participant recording.
name?	string	Stage name.
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.

---

autoParticipantRecordingConfiguration?

Type: IResolvable | AutoParticipantRecordingConfigurationProperty (optional)

Configuration object for individual participant recording.

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

---

name?

Type: string (optional)

Stage name.

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

---

tags?

Type: CfnTag[] (optional)

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

For more information, see Tag .

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