CfnRecordingConfigurationPropsMixin

class aws_cdk.mixins_preview.aws_ivs.mixins.CfnRecordingConfigurationPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::IVS::RecordingConfiguration resource specifies an recording configuration.

A recording configuration enables the recording of a channel’s live streams to a data store. Multiple channels can reference the same recording configuration. For more information, see RecordingConfiguration in the Amazon IVS Low-Latency Streaming API Reference .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-recordingconfiguration.html
CloudformationResource:: AWS::IVS::RecordingConfiguration
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_ivs import mixins as ivs_mixins

cfn_recording_configuration_props_mixin = ivs_mixins.CfnRecordingConfigurationPropsMixin(ivs_mixins.CfnRecordingConfigurationMixinProps(
    destination_configuration=ivs_mixins.CfnRecordingConfigurationPropsMixin.DestinationConfigurationProperty(
        s3=ivs_mixins.CfnRecordingConfigurationPropsMixin.S3DestinationConfigurationProperty(
            bucket_name="bucketName"
        )
    ),
    name="name",
    recording_reconnect_window_seconds=123,
    rendition_configuration=ivs_mixins.CfnRecordingConfigurationPropsMixin.RenditionConfigurationProperty(
        renditions=["renditions"],
        rendition_selection="renditionSelection"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    thumbnail_configuration=ivs_mixins.CfnRecordingConfigurationPropsMixin.ThumbnailConfigurationProperty(
        recording_mode="recordingMode",
        resolution="resolution",
        storage=["storage"],
        target_interval_seconds=123
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IVS::RecordingConfiguration.

Parameters:

props (Union[CfnRecordingConfigurationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['destinationConfiguration', 'name', 'recordingReconnectWindowSeconds', 'renditionConfiguration', 'tags', 'thumbnailConfiguration']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

DestinationConfigurationProperty

class CfnRecordingConfigurationPropsMixin.DestinationConfigurationProperty(*, s3=None)

Bases: object

The DestinationConfiguration property type describes the location where recorded videos will be stored.

Each member represents a type of destination configuration. For recording, you define one and only one type of destination configuration.

Parameters:: s3 (Union[IResolvable, S3DestinationConfigurationProperty, Dict[str, Any], None]) – An S3 destination configuration where recorded videos will be stored. See the S3DestinationConfiguration property type for more information.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-destinationconfiguration.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.mixins_preview.aws_ivs import mixins as ivs_mixins

destination_configuration_property = ivs_mixins.CfnRecordingConfigurationPropsMixin.DestinationConfigurationProperty(
    s3=ivs_mixins.CfnRecordingConfigurationPropsMixin.S3DestinationConfigurationProperty(
        bucket_name="bucketName"
    )
)

Attributes

s3

An S3 destination configuration where recorded videos will be stored.

See the S3DestinationConfiguration property type for more information.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-destinationconfiguration.html#cfn-ivs-recordingconfiguration-destinationconfiguration-s3

RenditionConfigurationProperty

class CfnRecordingConfigurationPropsMixin.RenditionConfigurationProperty(*, renditions=None, rendition_selection=None)

Bases: object

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

Parameters:

renditions (Optional[Sequence[str]]) – 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 .
rendition_selection (Optional[str]) – 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-renditionconfiguration.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.mixins_preview.aws_ivs import mixins as ivs_mixins

rendition_configuration_property = ivs_mixins.CfnRecordingConfigurationPropsMixin.RenditionConfigurationProperty(
    renditions=["renditions"],
    rendition_selection="renditionSelection"
)

Attributes

rendition_selection

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:

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

renditions

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-renditionconfiguration.html#cfn-ivs-recordingconfiguration-renditionconfiguration-renditions

S3DestinationConfigurationProperty

class CfnRecordingConfigurationPropsMixin.S3DestinationConfigurationProperty(*, bucket_name=None)

Bases: object

The S3DestinationConfiguration property type describes an S3 location where recorded videos will be stored.

Parameters:: bucket_name (Optional[str]) – Location (S3 bucket name) where recorded videos will be stored.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-s3destinationconfiguration.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.mixins_preview.aws_ivs import mixins as ivs_mixins

s3_destination_configuration_property = ivs_mixins.CfnRecordingConfigurationPropsMixin.S3DestinationConfigurationProperty(
    bucket_name="bucketName"
)

Attributes

bucket_name

Location (S3 bucket name) where recorded videos will be stored.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-s3destinationconfiguration.html#cfn-ivs-recordingconfiguration-s3destinationconfiguration-bucketname

ThumbnailConfigurationProperty

class CfnRecordingConfigurationPropsMixin.ThumbnailConfigurationProperty(*, recording_mode=None, resolution=None, storage=None, target_interval_seconds=None)

Bases: object

The ThumbnailConfiguration property type describes a configuration of thumbnails for recorded video.

Parameters:

recording_mode (Optional[str]) – Thumbnail recording mode. Valid values:. - DISABLED : Use DISABLED to disable the generation of thumbnails for recorded video. - INTERVAL : Use INTERVAL to enable the generation of thumbnails for recorded video at a time interval controlled by the TargetIntervalSeconds property. Default : INTERVAL Default: - “INTERVAL”
resolution (Optional[str]) –
The desired resolution of recorded thumbnails for a stream. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3 .
storage (Optional[Sequence[str]]) – The format in which thumbnails are recorded for a stream. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/thumbnails/latest/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds . You can enable both SEQUENTIAL and LATEST . Default: SEQUENTIAL .
target_interval_seconds (Union[int, float, None]) – The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if RecordingMode is INTERVAL . .. epigraph:: Setting a value for TargetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the TargetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the TargetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings. Default : 60 Default: - 60

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.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.mixins_preview.aws_ivs import mixins as ivs_mixins

thumbnail_configuration_property = ivs_mixins.CfnRecordingConfigurationPropsMixin.ThumbnailConfigurationProperty(
    recording_mode="recordingMode",
    resolution="resolution",
    storage=["storage"],
    target_interval_seconds=123
)

Attributes

recording_mode

.

DISABLED : Use DISABLED to disable the generation of thumbnails for recorded video.
INTERVAL : Use INTERVAL to enable the generation of thumbnails for recorded video at a time interval controlled by the TargetIntervalSeconds property.

Default : INTERVAL

Default:

“INTERVAL”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html#cfn-ivs-recordingconfiguration-thumbnailconfiguration-recordingmode

Type:

Thumbnail recording mode. Valid values

resolution

The desired resolution of recorded thumbnails for a stream.

Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html#cfn-ivs-recordingconfiguration-thumbnailconfiguration-resolution

storage

The format in which thumbnails are recorded for a stream.

SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/thumbnails/latest/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds . You can enable both SEQUENTIAL and LATEST . Default: SEQUENTIAL .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html#cfn-ivs-recordingconfiguration-thumbnailconfiguration-storage

target_interval_seconds

The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if RecordingMode is INTERVAL .

Setting a value for TargetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the TargetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the TargetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

Default : 60

Default:

60

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html#cfn-ivs-recordingconfiguration-thumbnailconfiguration-targetintervalseconds