CfnEncoderConfigurationPropsMixin

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

Bases: Mixin

The AWS::IVS::EncoderConfiguration resource specifies an encoder configuration.

An encoder configuration describes a stream’s video configuration. For more information, see Streaming Configuration in the Amazon IVS Low-Latency Streaming User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-encoderconfiguration.html
CloudformationResource:: AWS::IVS::EncoderConfiguration
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_encoder_configuration_props_mixin = ivs_mixins.CfnEncoderConfigurationPropsMixin(ivs_mixins.CfnEncoderConfigurationMixinProps(
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    video=ivs_mixins.CfnEncoderConfigurationPropsMixin.VideoProperty(
        bitrate=123,
        framerate=123,
        height=123,
        width=123
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnEncoderConfigurationMixinProps, 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 = ['name', 'tags', 'video']

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

VideoProperty

class CfnEncoderConfigurationPropsMixin.VideoProperty(*, bitrate=None, framerate=None, height=None, width=None)

Bases: object

The Video property type describes a stream’s video configuration.

Parameters:

bitrate (Union[int, float, None]) – Bitrate for generated output, in bps. Default: 2500000. Default: - 2500000
framerate (Union[int, float, None]) – Video frame rate, in fps. Default: 30. Default: - 30
height (Union[int, float, None]) – Video-resolution height. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720. Default: - 720
width (Union[int, float, None]) – Video-resolution width. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280. Default: - 1280

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-encoderconfiguration-video.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

video_property = ivs_mixins.CfnEncoderConfigurationPropsMixin.VideoProperty(
    bitrate=123,
    framerate=123,
    height=123,
    width=123
)

Attributes

bitrate

Bitrate for generated output, in bps.

Default: 2500000.

Default:

2500000

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-encoderconfiguration-video.html#cfn-ivs-encoderconfiguration-video-bitrate

framerate

Video frame rate, in fps.

Default: 30.

Default:

30

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-encoderconfiguration-video.html#cfn-ivs-encoderconfiguration-video-framerate

height

Video-resolution height.

Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.

Default:

720

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-encoderconfiguration-video.html#cfn-ivs-encoderconfiguration-video-height

width

Video-resolution width.

Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.

Default:

1280

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-encoderconfiguration-video.html#cfn-ivs-encoderconfiguration-video-width