Package software.amazon.awscdk.services.ivs

Interface CfnRecordingConfiguration.RenditionConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRecordingConfiguration.RenditionConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnRecordingConfiguration

@Stability(Stable)
public static interface CfnRecordingConfiguration.RenditionConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The RenditionConfiguration property type describes which renditions should be recorded for a stream.

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.*;
 RenditionConfigurationProperty renditionConfigurationProperty = RenditionConfigurationProperty.builder()
         .renditions(List.of("renditions"))
         .renditionSelection("renditionSelection")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-renditionconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRecordingConfiguration.RenditionConfigurationProperty.Builder	A builder for CfnRecordingConfiguration.RenditionConfigurationProperty
static final class	CfnRecordingConfiguration.RenditionConfigurationProperty.Jsii$Proxy	An implementation for CfnRecordingConfiguration.RenditionConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnRecordingConfiguration.RenditionConfigurationProperty.Builder	builder()
default List<String>	getRenditions()	A list of which renditions are recorded for a stream, if renditionSelection is CUSTOM ;
default String	getRenditionSelection()	The set of renditions are recorded for a stream.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRenditions

@Stability(Stable)
@Nullable
default List<String> getRenditions()

A list of which renditions are recorded for a stream, if renditionSelection is CUSTOM ;

otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-renditionconfiguration.html#cfn-ivs-recordingconfiguration-renditionconfiguration-renditions

getRenditionSelection

@Stability(Stable)
@Nullable
default String getRenditionSelection()

The set of renditions are recorded for a stream.

For BASIC channels, the CUSTOM value has no effect. If CUSTOM is specified, a set of renditions can be specified in the renditions field. Default: ALL .

Default: - "ALL"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-renditionconfiguration.html#cfn-ivs-recordingconfiguration-renditionconfiguration-renditionselection

builder

@Stability(Stable)
static CfnRecordingConfiguration.RenditionConfigurationProperty.Builder builder()

Returns:

a CfnRecordingConfiguration.RenditionConfigurationProperty.Builder of CfnRecordingConfiguration.RenditionConfigurationProperty