software.amazon.awscdk.services.ivs

Interface CfnRecordingConfigurationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRecordingConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:36.402Z")
 @Stability(value=Stable)
public interface CfnRecordingConfigurationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnRecordingConfiguration`.

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.*;
 CfnRecordingConfigurationProps cfnRecordingConfigurationProps = CfnRecordingConfigurationProps.builder()
         .destinationConfiguration(DestinationConfigurationProperty.builder()
                 .s3(S3DestinationConfigurationProperty.builder()
                         .bucketName("bucketName")
                         .build())
                 .build())
         // the properties below are optional
         .name("name")
         .recordingReconnectWindowSeconds(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .thumbnailConfiguration(ThumbnailConfigurationProperty.builder()
                 .recordingMode("recordingMode")
                 // the properties below are optional
                 .targetIntervalSeconds(123)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnRecordingConfigurationProps.Builder	builder()
Object	getDestinationConfiguration() A destination configuration contains information about where recorded video will be stored.
default String	getName() Recording-configuration name.
default Number	getRecordingReconnectWindowSeconds() If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
default List<CfnTag>	getTags() An array of key-value pairs to apply to this resource.
default Object	getThumbnailConfiguration() A thumbnail configuration enables/disables the recording of thumbnails for a live session and controls the interval at which thumbnails are generated for the live session.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDestinationConfiguration

@Stability(value=Stable)
 @NotNull
Object getDestinationConfiguration()

A destination configuration contains information about where recorded video will be stored.

See the DestinationConfiguration property type for more information.

getName

@Stability(value=Stable)
 @Nullable
default String getName()

Recording-configuration name.

The value does not need to be unique.

getRecordingReconnectWindowSeconds

@Stability(value=Stable)
 @Nullable
default Number getRecordingReconnectWindowSeconds()

If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.

Default : 0

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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

For more information, see Tag .

getThumbnailConfiguration

@Stability(value=Stable)
 @Nullable
default Object getThumbnailConfiguration()

A thumbnail configuration enables/disables the recording of thumbnails for a live session and controls the interval at which thumbnails are generated for the live session.

See the ThumbnailConfiguration property type for more information.

builder

@Stability(value=Stable)
static CfnRecordingConfigurationProps.Builder builder()

Returns:

a CfnRecordingConfigurationProps.Builder of CfnRecordingConfigurationProps