CfnRecordingConfigurationProps

class aws_cdk.aws_ivs.CfnRecordingConfigurationProps(*, destination_configuration, name=None, tags=None, thumbnail_configuration=None)

Bases: object

Properties for defining a CfnRecordingConfiguration.

Parameters
  • destination_configuration (Union[IResolvable, DestinationConfigurationProperty]) – A destination configuration contains information about where recorded video will be stored. See the DestinationConfiguration property type for more information.

  • name (Optional[str]) – Recording-configuration name. The value does not need to be unique.

  • tags (Optional[Sequence[CfnTag]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

  • thumbnail_configuration (Union[IResolvable, ThumbnailConfigurationProperty, None]) – 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.

Link

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

ExampleMetadata

fixture=_generated

Example:

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

cfn_recording_configuration_props = ivs.CfnRecordingConfigurationProps(
    destination_configuration=ivs.CfnRecordingConfiguration.DestinationConfigurationProperty(
        s3=ivs.CfnRecordingConfiguration.S3DestinationConfigurationProperty(
            bucket_name="bucketName"
        )
    ),

    # the properties below are optional
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    thumbnail_configuration=ivs.CfnRecordingConfiguration.ThumbnailConfigurationProperty(
        recording_mode="recordingMode",

        # the properties below are optional
        target_interval_seconds=123
    )
)

Attributes

destination_configuration

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

See the DestinationConfiguration property type for more information.

Link

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

Return type

Union[IResolvable, DestinationConfigurationProperty]

name

Recording-configuration name.

The value does not need to be unique.

Link

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

Return type

Optional[str]

tags

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

For more information, see Tag .

Link

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

Return type

Optional[List[CfnTag]]

thumbnail_configuration

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.

Link

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

Return type

Union[IResolvable, ThumbnailConfigurationProperty, None]