CfnFlowOutputPropsMixin

class aws_cdk.mixins_preview.aws_mediaconnect.mixins.CfnFlowOutputPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::MediaConnect::FlowOutput resource defines the destination address, protocol, and port that AWS Elemental MediaConnect sends the ingested video to.

Each flow can have up to 50 outputs. An output can have the same protocol or a different protocol from the source. The following protocols are supported: RIST, RTP, RTP-FEC, SRT-listener, SRT-caller, Zixi pull, and Zixi push. CDI and ST 2110 JPEG XS protocols are not currently supported by AWS CloudFormation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html
CloudformationResource:: AWS::MediaConnect::FlowOutput
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_mediaconnect import mixins as mediaconnect_mixins

# automatic: Any

cfn_flow_output_props_mixin = mediaconnect_mixins.CfnFlowOutputPropsMixin(mediaconnect_mixins.CfnFlowOutputMixinProps(
    cidr_allow_list=["cidrAllowList"],
    description="description",
    destination="destination",
    encryption=mediaconnect_mixins.CfnFlowOutputPropsMixin.EncryptionProperty(
        algorithm="algorithm",
        key_type="keyType",
        role_arn="roleArn",
        secret_arn="secretArn"
    ),
    flow_arn="flowArn",
    max_latency=123,
    media_stream_output_configurations=[mediaconnect_mixins.CfnFlowOutputPropsMixin.MediaStreamOutputConfigurationProperty(
        destination_configurations=[mediaconnect_mixins.CfnFlowOutputPropsMixin.DestinationConfigurationProperty(
            destination_ip="destinationIp",
            destination_port=123,
            interface=mediaconnect_mixins.CfnFlowOutputPropsMixin.InterfaceProperty(
                name="name"
            )
        )],
        encoding_name="encodingName",
        encoding_parameters=mediaconnect_mixins.CfnFlowOutputPropsMixin.EncodingParametersProperty(
            compression_factor=123,
            encoder_profile="encoderProfile"
        ),
        media_stream_name="mediaStreamName"
    )],
    min_latency=123,
    name="name",
    ndi_program_name="ndiProgramName",
    ndi_speed_hq_quality=123,
    output_status="outputStatus",
    port=123,
    protocol="protocol",
    remote_id="remoteId",
    router_integration_state="routerIntegrationState",
    router_integration_transit_encryption=mediaconnect_mixins.CfnFlowOutputPropsMixin.FlowTransitEncryptionProperty(
        encryption_key_configuration=mediaconnect_mixins.CfnFlowOutputPropsMixin.FlowTransitEncryptionKeyConfigurationProperty(
            automatic=automatic,
            secrets_manager=mediaconnect_mixins.CfnFlowOutputPropsMixin.SecretsManagerEncryptionKeyConfigurationProperty(
                role_arn="roleArn",
                secret_arn="secretArn"
            )
        ),
        encryption_key_type="encryptionKeyType"
    ),
    smoothing_latency=123,
    stream_id="streamId",
    vpc_interface_attachment=mediaconnect_mixins.CfnFlowOutputPropsMixin.VpcInterfaceAttachmentProperty(
        vpc_interface_name="vpcInterfaceName"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::MediaConnect::FlowOutput.

Parameters:

props (Union[CfnFlowOutputMixinProps, 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 = ['cidrAllowList', 'description', 'destination', 'encryption', 'flowArn', 'maxLatency', 'mediaStreamOutputConfigurations', 'minLatency', 'name', 'ndiProgramName', 'ndiSpeedHqQuality', 'outputStatus', 'port', 'protocol', 'remoteId', 'routerIntegrationState', 'routerIntegrationTransitEncryption', 'smoothingLatency', 'streamId', 'vpcInterfaceAttachment']

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 CfnFlowOutputPropsMixin.DestinationConfigurationProperty(*, destination_ip=None, destination_port=None, interface=None)

Bases: object

The transport parameters that you want to associate with an outbound media stream.

Parameters:

destination_ip (Optional[str]) – The IP address where you want MediaConnect to send contents of the media stream.
destination_port (Union[int, float, None]) – The port that you want MediaConnect to use when it distributes the media stream to the output.
interface (Union[IResolvable, InterfaceProperty, Dict[str, Any], None]) – The VPC interface that you want to use for the media stream associated with the output.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-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_mediaconnect import mixins as mediaconnect_mixins

destination_configuration_property = mediaconnect_mixins.CfnFlowOutputPropsMixin.DestinationConfigurationProperty(
    destination_ip="destinationIp",
    destination_port=123,
    interface=mediaconnect_mixins.CfnFlowOutputPropsMixin.InterfaceProperty(
        name="name"
    )
)

Attributes

destination_ip

The IP address where you want MediaConnect to send contents of the media stream.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-destinationconfiguration.html#cfn-mediaconnect-flowoutput-destinationconfiguration-destinationip

destination_port

The port that you want MediaConnect to use when it distributes the media stream to the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-destinationconfiguration.html#cfn-mediaconnect-flowoutput-destinationconfiguration-destinationport

interface

The VPC interface that you want to use for the media stream associated with the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-destinationconfiguration.html#cfn-mediaconnect-flowoutput-destinationconfiguration-interface

EncodingParametersProperty

class CfnFlowOutputPropsMixin.EncodingParametersProperty(*, compression_factor=None, encoder_profile=None)

Bases: object

A collection of parameters that determine how MediaConnect will convert the content.

These fields only apply to outputs on flows that have a CDI source.

Parameters:

compression_factor (Union[int, float, None]) – A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
encoder_profile (Optional[str]) – A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-encodingparameters.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_mediaconnect import mixins as mediaconnect_mixins

encoding_parameters_property = mediaconnect_mixins.CfnFlowOutputPropsMixin.EncodingParametersProperty(
    compression_factor=123,
    encoder_profile="encoderProfile"
)

Attributes

compression_factor

A value that is used to calculate compression for an output.

The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-encodingparameters.html#cfn-mediaconnect-flowoutput-encodingparameters-compressionfactor

encoder_profile

A setting on the encoder that drives compression settings.

This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-encodingparameters.html#cfn-mediaconnect-flowoutput-encodingparameters-encoderprofile

EncryptionProperty

class CfnFlowOutputPropsMixin.EncryptionProperty(*, algorithm=None, key_type=None, role_arn=None, secret_arn=None)

Bases: object

Encryption information.

Parameters:

algorithm (Optional[str]) – The type of algorithm that is used for static key encryption (such as aes128, aes192, or aes256). If you are using SPEKE or SRT-password encryption, this property must be left blank.
key_type (Optional[str]) – The type of key that is used for the encryption. If you don’t specify a keyType value, the service uses the default setting ( static-key ). Valid key types are: static-key , speke , and srt-password . Default: - “static-key”
role_arn (Optional[str]) – The ARN of the role that you created during setup (when you set up MediaConnect as a trusted entity).
secret_arn (Optional[str]) – The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-encryption.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_mediaconnect import mixins as mediaconnect_mixins

encryption_property = mediaconnect_mixins.CfnFlowOutputPropsMixin.EncryptionProperty(
    algorithm="algorithm",
    key_type="keyType",
    role_arn="roleArn",
    secret_arn="secretArn"
)

Attributes

algorithm

The type of algorithm that is used for static key encryption (such as aes128, aes192, or aes256).

If you are using SPEKE or SRT-password encryption, this property must be left blank.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-encryption.html#cfn-mediaconnect-flowoutput-encryption-algorithm

key_type

The type of key that is used for the encryption.

If you don’t specify a keyType value, the service uses the default setting ( static-key ). Valid key types are: static-key , speke , and srt-password .

Default:

“static-key”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-encryption.html#cfn-mediaconnect-flowoutput-encryption-keytype

role_arn

The ARN of the role that you created during setup (when you set up MediaConnect as a trusted entity).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-encryption.html#cfn-mediaconnect-flowoutput-encryption-rolearn

secret_arn

The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.

This parameter is required for static key encryption and is not valid for SPEKE encryption.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-encryption.html#cfn-mediaconnect-flowoutput-encryption-secretarn

FlowTransitEncryptionKeyConfigurationProperty

class CfnFlowOutputPropsMixin.FlowTransitEncryptionKeyConfigurationProperty(*, automatic=None, secrets_manager=None)

Bases: object

Parameters:

automatic (Any) – Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
secrets_manager (Union[IResolvable, SecretsManagerEncryptionKeyConfigurationProperty, Dict[str, Any], None]) – The configuration settings for transit encryption of a flow output using AWS Secrets Manager, including the secret ARN and role ARN.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-flowtransitencryptionkeyconfiguration.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_mediaconnect import mixins as mediaconnect_mixins

# automatic: Any

flow_transit_encryption_key_configuration_property = mediaconnect_mixins.CfnFlowOutputPropsMixin.FlowTransitEncryptionKeyConfigurationProperty(
    automatic=automatic,
    secrets_manager=mediaconnect_mixins.CfnFlowOutputPropsMixin.SecretsManagerEncryptionKeyConfigurationProperty(
        role_arn="roleArn",
        secret_arn="secretArn"
    )
)

Attributes

automatic

Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-flowtransitencryptionkeyconfiguration.html#cfn-mediaconnect-flowoutput-flowtransitencryptionkeyconfiguration-automatic

secrets_manager

The configuration settings for transit encryption of a flow output using AWS Secrets Manager, including the secret ARN and role ARN.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-flowtransitencryptionkeyconfiguration.html#cfn-mediaconnect-flowoutput-flowtransitencryptionkeyconfiguration-secretsmanager

FlowTransitEncryptionProperty

class CfnFlowOutputPropsMixin.FlowTransitEncryptionProperty(*, encryption_key_configuration=None, encryption_key_type=None)

Bases: object

The configuration that defines how content is encrypted during transit between the MediaConnect router and a MediaConnect flow.

Parameters:

encryption_key_configuration (Union[IResolvable, FlowTransitEncryptionKeyConfigurationProperty, Dict[str, Any], None]) – Configuration settings for flow transit encryption keys.
encryption_key_type (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-flowtransitencryption.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_mediaconnect import mixins as mediaconnect_mixins

# automatic: Any

flow_transit_encryption_property = mediaconnect_mixins.CfnFlowOutputPropsMixin.FlowTransitEncryptionProperty(
    encryption_key_configuration=mediaconnect_mixins.CfnFlowOutputPropsMixin.FlowTransitEncryptionKeyConfigurationProperty(
        automatic=automatic,
        secrets_manager=mediaconnect_mixins.CfnFlowOutputPropsMixin.SecretsManagerEncryptionKeyConfigurationProperty(
            role_arn="roleArn",
            secret_arn="secretArn"
        )
    ),
    encryption_key_type="encryptionKeyType"
)

Attributes

encryption_key_configuration

Configuration settings for flow transit encryption keys.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-flowtransitencryption.html#cfn-mediaconnect-flowoutput-flowtransitencryption-encryptionkeyconfiguration

encryption_key_type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-flowtransitencryption.html#cfn-mediaconnect-flowoutput-flowtransitencryption-encryptionkeytype

Type:: see

InterfaceProperty

class CfnFlowOutputPropsMixin.InterfaceProperty(*, name=None)

Bases: object

The VPC interface that is used for the media stream associated with the source or output.

Parameters:: name (Optional[str]) – The name of the VPC interface.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-interface.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_mediaconnect import mixins as mediaconnect_mixins

interface_property = mediaconnect_mixins.CfnFlowOutputPropsMixin.InterfaceProperty(
    name="name"
)

Attributes

name

The name of the VPC interface.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-interface.html#cfn-mediaconnect-flowoutput-interface-name

MediaStreamOutputConfigurationProperty

class CfnFlowOutputPropsMixin.MediaStreamOutputConfigurationProperty(*, destination_configurations=None, encoding_name=None, encoding_parameters=None, media_stream_name=None)

Bases: object

The media stream that is associated with the output, and the parameters for that association.

Parameters:

destination_configurations (Union[IResolvable, Sequence[Union[IResolvable, DestinationConfigurationProperty, Dict[str, Any]]], None]) – The transport parameters that are associated with each outbound media stream.
encoding_name (Optional[str]) – The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
encoding_parameters (Union[IResolvable, EncodingParametersProperty, Dict[str, Any], None]) – A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.
media_stream_name (Optional[str]) – The name of the media stream.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-mediastreamoutputconfiguration.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_mediaconnect import mixins as mediaconnect_mixins

media_stream_output_configuration_property = mediaconnect_mixins.CfnFlowOutputPropsMixin.MediaStreamOutputConfigurationProperty(
    destination_configurations=[mediaconnect_mixins.CfnFlowOutputPropsMixin.DestinationConfigurationProperty(
        destination_ip="destinationIp",
        destination_port=123,
        interface=mediaconnect_mixins.CfnFlowOutputPropsMixin.InterfaceProperty(
            name="name"
        )
    )],
    encoding_name="encodingName",
    encoding_parameters=mediaconnect_mixins.CfnFlowOutputPropsMixin.EncodingParametersProperty(
        compression_factor=123,
        encoder_profile="encoderProfile"
    ),
    media_stream_name="mediaStreamName"
)

Attributes

destination_configurations

The transport parameters that are associated with each outbound media stream.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-mediastreamoutputconfiguration.html#cfn-mediaconnect-flowoutput-mediastreamoutputconfiguration-destinationconfigurations

encoding_name

The format that was used to encode the data.

For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-mediastreamoutputconfiguration.html#cfn-mediaconnect-flowoutput-mediastreamoutputconfiguration-encodingname

encoding_parameters

A collection of parameters that determine how MediaConnect will convert the content.

These fields only apply to outputs on flows that have a CDI source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-mediastreamoutputconfiguration.html#cfn-mediaconnect-flowoutput-mediastreamoutputconfiguration-encodingparameters

media_stream_name

The name of the media stream.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-mediastreamoutputconfiguration.html#cfn-mediaconnect-flowoutput-mediastreamoutputconfiguration-mediastreamname

SecretsManagerEncryptionKeyConfigurationProperty

class CfnFlowOutputPropsMixin.SecretsManagerEncryptionKeyConfigurationProperty(*, role_arn=None, secret_arn=None)

Bases: object

The configuration settings for transit encryption of a flow output using AWS Secrets Manager, including the secret ARN and role ARN.

Parameters:

role_arn (Optional[str]) – The ARN of the IAM role used for transit encryption to the router input using AWS Secrets Manager.
secret_arn (Optional[str]) – The ARN of the AWS Secrets Manager secret used for transit encryption to the router input.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-secretsmanagerencryptionkeyconfiguration.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_mediaconnect import mixins as mediaconnect_mixins

secrets_manager_encryption_key_configuration_property = mediaconnect_mixins.CfnFlowOutputPropsMixin.SecretsManagerEncryptionKeyConfigurationProperty(
    role_arn="roleArn",
    secret_arn="secretArn"
)

Attributes

role_arn

The ARN of the IAM role used for transit encryption to the router input using AWS Secrets Manager.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-secretsmanagerencryptionkeyconfiguration.html#cfn-mediaconnect-flowoutput-secretsmanagerencryptionkeyconfiguration-rolearn

secret_arn

The ARN of the AWS Secrets Manager secret used for transit encryption to the router input.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-secretsmanagerencryptionkeyconfiguration.html#cfn-mediaconnect-flowoutput-secretsmanagerencryptionkeyconfiguration-secretarn

VpcInterfaceAttachmentProperty

class CfnFlowOutputPropsMixin.VpcInterfaceAttachmentProperty(*, vpc_interface_name=None)

Bases: object

The settings for attaching a VPC interface to an resource.

Parameters:: vpc_interface_name (Optional[str]) – The name of the VPC interface to use for this resource.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-vpcinterfaceattachment.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_mediaconnect import mixins as mediaconnect_mixins

vpc_interface_attachment_property = mediaconnect_mixins.CfnFlowOutputPropsMixin.VpcInterfaceAttachmentProperty(
    vpc_interface_name="vpcInterfaceName"
)

Attributes

vpc_interface_name

The name of the VPC interface to use for this resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-vpcinterfaceattachment.html#cfn-mediaconnect-flowoutput-vpcinterfaceattachment-vpcinterfacename