CfnFlowPropsMixin
- class aws_cdk.mixins_preview.aws_mediaconnect.mixins.CfnFlowPropsMixin(props, *, strategy=None)
Bases:
MixinThe
AWS::MediaConnect::Flowresource defines a connection between one or more video sources and one or more outputs.For each flow, you specify the transport protocol to use, encryption information, and details for any outputs or entitlements that you want. AWS Elemental MediaConnect returns an ingest endpoint where you can send your live video as a single unicast stream. The service replicates and distributes the video to every output that you specify, whether inside or outside the AWS Cloud. You can also set up entitlements on a flow to allow other AWS accounts to access your content.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html
- CloudformationResource:
AWS::MediaConnect::Flow
- 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_props_mixin = mediaconnect_mixins.CfnFlowPropsMixin(mediaconnect_mixins.CfnFlowMixinProps( availability_zone="availabilityZone", flow_size="flowSize", maintenance=mediaconnect_mixins.CfnFlowPropsMixin.MaintenanceProperty( maintenance_day="maintenanceDay", maintenance_start_hour="maintenanceStartHour" ), media_streams=[mediaconnect_mixins.CfnFlowPropsMixin.MediaStreamProperty( attributes=mediaconnect_mixins.CfnFlowPropsMixin.MediaStreamAttributesProperty( fmtp=mediaconnect_mixins.CfnFlowPropsMixin.FmtpProperty( channel_order="channelOrder", colorimetry="colorimetry", exact_framerate="exactFramerate", par="par", range="range", scan_mode="scanMode", tcs="tcs" ), lang="lang" ), clock_rate=123, description="description", fmt=123, media_stream_id=123, media_stream_name="mediaStreamName", media_stream_type="mediaStreamType", video_format="videoFormat" )], name="name", ndi_config=mediaconnect_mixins.CfnFlowPropsMixin.NdiConfigProperty( machine_name="machineName", ndi_discovery_servers=[mediaconnect_mixins.CfnFlowPropsMixin.NdiDiscoveryServerConfigProperty( discovery_server_address="discoveryServerAddress", discovery_server_port=123, vpc_interface_adapter="vpcInterfaceAdapter" )], ndi_state="ndiState" ), source=mediaconnect_mixins.CfnFlowPropsMixin.SourceProperty( decryption=mediaconnect_mixins.CfnFlowPropsMixin.EncryptionProperty( algorithm="algorithm", constant_initialization_vector="constantInitializationVector", device_id="deviceId", key_type="keyType", region="region", resource_id="resourceId", role_arn="roleArn", secret_arn="secretArn", url="url" ), description="description", entitlement_arn="entitlementArn", gateway_bridge_source=mediaconnect_mixins.CfnFlowPropsMixin.GatewayBridgeSourceProperty( bridge_arn="bridgeArn", vpc_interface_attachment=mediaconnect_mixins.CfnFlowPropsMixin.VpcInterfaceAttachmentProperty( vpc_interface_name="vpcInterfaceName" ) ), ingest_ip="ingestIp", ingest_port=123, max_bitrate=123, max_latency=123, max_sync_buffer=123, media_stream_source_configurations=[mediaconnect_mixins.CfnFlowPropsMixin.MediaStreamSourceConfigurationProperty( encoding_name="encodingName", input_configurations=[mediaconnect_mixins.CfnFlowPropsMixin.InputConfigurationProperty( input_port=123, interface=mediaconnect_mixins.CfnFlowPropsMixin.InterfaceProperty( name="name" ) )], media_stream_name="mediaStreamName" )], min_latency=123, name="name", protocol="protocol", router_integration_state="routerIntegrationState", router_integration_transit_decryption=mediaconnect_mixins.CfnFlowPropsMixin.FlowTransitEncryptionProperty( encryption_key_configuration=mediaconnect_mixins.CfnFlowPropsMixin.FlowTransitEncryptionKeyConfigurationProperty( automatic=automatic, secrets_manager=mediaconnect_mixins.CfnFlowPropsMixin.SecretsManagerEncryptionKeyConfigurationProperty( role_arn="roleArn", secret_arn="secretArn" ) ), encryption_key_type="encryptionKeyType" ), sender_control_port=123, sender_ip_address="senderIpAddress", source_arn="sourceArn", source_ingest_port="sourceIngestPort", source_listener_address="sourceListenerAddress", source_listener_port=123, stream_id="streamId", vpc_interface_name="vpcInterfaceName", whitelist_cidr="whitelistCidr" ), source_failover_config=mediaconnect_mixins.CfnFlowPropsMixin.FailoverConfigProperty( failover_mode="failoverMode", recovery_window=123, source_priority=mediaconnect_mixins.CfnFlowPropsMixin.SourcePriorityProperty( primary_source="primarySource" ), state="state" ), source_monitoring_config=mediaconnect_mixins.CfnFlowPropsMixin.SourceMonitoringConfigProperty( audio_monitoring_settings=[mediaconnect_mixins.CfnFlowPropsMixin.AudioMonitoringSettingProperty( silent_audio=mediaconnect_mixins.CfnFlowPropsMixin.SilentAudioProperty( state="state", threshold_seconds=123 ) )], content_quality_analysis_state="contentQualityAnalysisState", thumbnail_state="thumbnailState", video_monitoring_settings=[mediaconnect_mixins.CfnFlowPropsMixin.VideoMonitoringSettingProperty( black_frames=mediaconnect_mixins.CfnFlowPropsMixin.BlackFramesProperty( state="state", threshold_seconds=123 ), frozen_frames=mediaconnect_mixins.CfnFlowPropsMixin.FrozenFramesProperty( state="state", threshold_seconds=123 ) )] ), vpc_interfaces=[mediaconnect_mixins.CfnFlowPropsMixin.VpcInterfaceProperty( name="name", network_interface_ids=["networkInterfaceIds"], network_interface_type="networkInterfaceType", role_arn="roleArn", security_group_ids=["securityGroupIds"], subnet_id="subnetId" )] ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::MediaConnect::Flow.- Parameters:
props (
Union[CfnFlowMixinProps,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:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['availabilityZone', 'flowSize', 'maintenance', 'mediaStreams', 'name', 'ndiConfig', 'source', 'sourceFailoverConfig', 'sourceMonitoringConfig', 'vpcInterfaces']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
AudioMonitoringSettingProperty
- class CfnFlowPropsMixin.AudioMonitoringSettingProperty(*, silent_audio=None)
Bases:
objectSpecifies the configuration for audio stream metrics monitoring.
- Parameters:
silent_audio (
Union[IResolvable,SilentAudioProperty,Dict[str,Any],None]) – Detects periods of silence.- See:
- 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 audio_monitoring_setting_property = mediaconnect_mixins.CfnFlowPropsMixin.AudioMonitoringSettingProperty( silent_audio=mediaconnect_mixins.CfnFlowPropsMixin.SilentAudioProperty( state="state", threshold_seconds=123 ) )
Attributes
- silent_audio
Detects periods of silence.
BlackFramesProperty
- class CfnFlowPropsMixin.BlackFramesProperty(*, state=None, threshold_seconds=None)
Bases:
objectConfigures settings for the
BlackFramesmetric.- Parameters:
state (
Optional[str]) – Indicates whether theBlackFramesmetric is enabled or disabled..threshold_seconds (
Union[int,float,None]) – Specifies the number of consecutive seconds of black frames that triggers an event or alert.
- See:
- 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 black_frames_property = mediaconnect_mixins.CfnFlowPropsMixin.BlackFramesProperty( state="state", threshold_seconds=123 )
Attributes
- state
Indicates whether the
BlackFramesmetric is enabled or disabled..
- threshold_seconds
Specifies the number of consecutive seconds of black frames that triggers an event or alert.
EncryptionProperty
- class CfnFlowPropsMixin.EncryptionProperty(*, algorithm=None, constant_initialization_vector=None, device_id=None, key_type=None, region=None, resource_id=None, role_arn=None, secret_arn=None, url=None)
Bases:
objectEncryption 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.constant_initialization_vector (
Optional[str]) – A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.device_id (
Optional[str]) – The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.key_type (
Optional[str]) – The type of key that is used for the encryption. If you don’t specify akeyTypevalue, the service uses the default setting (static-key). Valid key types are:static-key,speke, andsrt-password. Default: - “static-key”region (
Optional[str]) – The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.resource_id (
Optional[str]) – An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.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.url (
Optional[str]) – The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
- See:
- 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.CfnFlowPropsMixin.EncryptionProperty( algorithm="algorithm", constant_initialization_vector="constantInitializationVector", device_id="deviceId", key_type="keyType", region="region", resource_id="resourceId", role_arn="roleArn", secret_arn="secretArn", url="url" )
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.
- constant_initialization_vector
A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content.
This parameter is not valid for static key encryption.
- device_id
The value of one of the devices that you configured with your digital rights management (DRM) platform key provider.
This parameter is required for SPEKE encryption and is not valid for static key encryption.
- key_type
The type of key that is used for the encryption.
If you don’t specify a
keyTypevalue, the service uses the default setting (static-key). Valid key types are:static-key,speke, andsrt-password.
- region
The AWS Region that the API Gateway proxy endpoint was created in.
This parameter is required for SPEKE encryption and is not valid for static key encryption.
- resource_id
An identifier for the content.
The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
- role_arn
The ARN of the role that you created during setup (when you set up MediaConnect as a trusted entity).
- 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.
- url
The URL from the API Gateway proxy that you set up to talk to your key server.
This parameter is required for SPEKE encryption and is not valid for static key encryption.
FailoverConfigProperty
- class CfnFlowPropsMixin.FailoverConfigProperty(*, failover_mode=None, recovery_window=None, source_priority=None, state=None)
Bases:
objectThe settings for source failover.
- Parameters:
failover_mode (
Optional[str]) – The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams. The string for this property must be entered as MERGE or FAILOVER. No other string entry is valid.recovery_window (
Union[int,float,None]) – Search window time to look for dash-7 packets.source_priority (
Union[IResolvable,SourcePriorityProperty,Dict[str,Any],None]) – The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.state (
Optional[str]) – The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.
- See:
- 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 failover_config_property = mediaconnect_mixins.CfnFlowPropsMixin.FailoverConfigProperty( failover_mode="failoverMode", recovery_window=123, source_priority=mediaconnect_mixins.CfnFlowPropsMixin.SourcePriorityProperty( primary_source="primarySource" ), state="state" )
Attributes
- failover_mode
The type of failover you choose for this flow.
MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams. The string for this property must be entered as MERGE or FAILOVER. No other string entry is valid.
- recovery_window
Search window time to look for dash-7 packets.
- source_priority
The priority you want to assign to a source.
You can have a primary stream and a backup stream or two equally prioritized streams.
- state
The state of source failover on the flow.
If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.
FlowTransitEncryptionKeyConfigurationProperty
- class CfnFlowPropsMixin.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 source using AWS Secrets Manager, including the secret ARN and role ARN.
- See:
- 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.CfnFlowPropsMixin.FlowTransitEncryptionKeyConfigurationProperty( automatic=automatic, secrets_manager=mediaconnect_mixins.CfnFlowPropsMixin.SecretsManagerEncryptionKeyConfigurationProperty( role_arn="roleArn", secret_arn="secretArn" ) )
Attributes
- automatic
Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
- secrets_manager
The configuration settings for transit encryption of a flow source using AWS Secrets Manager, including the secret ARN and role ARN.
FlowTransitEncryptionProperty
- class CfnFlowPropsMixin.FlowTransitEncryptionProperty(*, encryption_key_configuration=None, encryption_key_type=None)
Bases:
objectThe 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:
- 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.CfnFlowPropsMixin.FlowTransitEncryptionProperty( encryption_key_configuration=mediaconnect_mixins.CfnFlowPropsMixin.FlowTransitEncryptionKeyConfigurationProperty( automatic=automatic, secrets_manager=mediaconnect_mixins.CfnFlowPropsMixin.SecretsManagerEncryptionKeyConfigurationProperty( role_arn="roleArn", secret_arn="secretArn" ) ), encryption_key_type="encryptionKeyType" )
Attributes
- encryption_key_configuration
Configuration settings for flow transit encryption keys.
FmtpProperty
- class CfnFlowPropsMixin.FmtpProperty(*, channel_order=None, colorimetry=None, exact_framerate=None, par=None, range=None, scan_mode=None, tcs=None)
Bases:
objectA set of parameters that define the media stream.
- Parameters:
channel_order (
Optional[str]) – The format of the audio channel.colorimetry (
Optional[str]) – The format used for the representation of color.exact_framerate (
Optional[str]) – The frame rate for the video stream, in frames/second. For example: 60000/1001.par (
Optional[str]) – The pixel aspect ratio (PAR) of the video.range (
Optional[str]) – The encoding range of the video.scan_mode (
Optional[str]) – The type of compression that was used to smooth the video’s appearance.tcs (
Optional[str]) – The transfer characteristic system (TCS) that is used in the video.
- See:
- 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 fmtp_property = mediaconnect_mixins.CfnFlowPropsMixin.FmtpProperty( channel_order="channelOrder", colorimetry="colorimetry", exact_framerate="exactFramerate", par="par", range="range", scan_mode="scanMode", tcs="tcs" )
Attributes
- channel_order
The format of the audio channel.
- colorimetry
The format used for the representation of color.
- exact_framerate
The frame rate for the video stream, in frames/second.
For example: 60000/1001.
- par
The pixel aspect ratio (PAR) of the video.
- range
The encoding range of the video.
- scan_mode
The type of compression that was used to smooth the video’s appearance.
- tcs
The transfer characteristic system (TCS) that is used in the video.
FrozenFramesProperty
- class CfnFlowPropsMixin.FrozenFramesProperty(*, state=None, threshold_seconds=None)
Bases:
objectConfigures settings for the
FrozenFramesmetric.- Parameters:
state (
Optional[str]) – Indicates whether theFrozenFramesmetric is enabled or disabled.threshold_seconds (
Union[int,float,None]) – Specifies the number of consecutive seconds of a static image that triggers an event or alert.
- See:
- 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 frozen_frames_property = mediaconnect_mixins.CfnFlowPropsMixin.FrozenFramesProperty( state="state", threshold_seconds=123 )
Attributes
- state
Indicates whether the
FrozenFramesmetric is enabled or disabled.
- threshold_seconds
Specifies the number of consecutive seconds of a static image that triggers an event or alert.
GatewayBridgeSourceProperty
- class CfnFlowPropsMixin.GatewayBridgeSourceProperty(*, bridge_arn=None, vpc_interface_attachment=None)
Bases:
objectThe source configuration for cloud flows receiving a stream from a bridge.
- Parameters:
bridge_arn (
Optional[str]) – The ARN of the bridge feeding this flow.vpc_interface_attachment (
Union[IResolvable,VpcInterfaceAttachmentProperty,Dict[str,Any],None]) – The name of the VPC interface attachment to use for this bridge source.
- See:
- 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 gateway_bridge_source_property = mediaconnect_mixins.CfnFlowPropsMixin.GatewayBridgeSourceProperty( bridge_arn="bridgeArn", vpc_interface_attachment=mediaconnect_mixins.CfnFlowPropsMixin.VpcInterfaceAttachmentProperty( vpc_interface_name="vpcInterfaceName" ) )
Attributes
- bridge_arn
The ARN of the bridge feeding this flow.
- vpc_interface_attachment
The name of the VPC interface attachment to use for this bridge source.
InputConfigurationProperty
- class CfnFlowPropsMixin.InputConfigurationProperty(*, input_port=None, interface=None)
Bases:
objectThe transport parameters that are associated with an incoming media stream.
- Parameters:
input_port (
Union[int,float,None]) – The port that the flow listens on for an incoming media stream.interface (
Union[IResolvable,InterfaceProperty,Dict[str,Any],None]) – The VPC interface where the media stream comes in from.
- See:
- 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 input_configuration_property = mediaconnect_mixins.CfnFlowPropsMixin.InputConfigurationProperty( input_port=123, interface=mediaconnect_mixins.CfnFlowPropsMixin.InterfaceProperty( name="name" ) )
Attributes
- input_port
The port that the flow listens on for an incoming media stream.
- interface
The VPC interface where the media stream comes in from.
InterfaceProperty
- class CfnFlowPropsMixin.InterfaceProperty(*, name=None)
Bases:
objectThe 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:
- 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.CfnFlowPropsMixin.InterfaceProperty( name="name" )
Attributes
- name
The name of the VPC interface.
MaintenanceProperty
- class CfnFlowPropsMixin.MaintenanceProperty(*, maintenance_day=None, maintenance_start_hour=None)
Bases:
objectThe maintenance setting of a flow.
- Parameters:
maintenance_day (
Optional[str]) – A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.maintenance_start_hour (
Optional[str]) – UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.
- See:
- 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 maintenance_property = mediaconnect_mixins.CfnFlowPropsMixin.MaintenanceProperty( maintenance_day="maintenanceDay", maintenance_start_hour="maintenanceStartHour" )
Attributes
- maintenance_day
A day of a week when the maintenance will happen.
Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
- maintenance_start_hour
UTC time when the maintenance will happen.
Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.
MediaStreamAttributesProperty
- class CfnFlowPropsMixin.MediaStreamAttributesProperty(*, fmtp=None, lang=None)
Bases:
objectAttributes that are related to the media stream.
- Parameters:
fmtp (
Union[IResolvable,FmtpProperty,Dict[str,Any],None]) – The settings that you want to use to define the media stream.lang (
Optional[str]) – The audio language, in a format that is recognized by the receiver.
- See:
- 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_attributes_property = mediaconnect_mixins.CfnFlowPropsMixin.MediaStreamAttributesProperty( fmtp=mediaconnect_mixins.CfnFlowPropsMixin.FmtpProperty( channel_order="channelOrder", colorimetry="colorimetry", exact_framerate="exactFramerate", par="par", range="range", scan_mode="scanMode", tcs="tcs" ), lang="lang" )
Attributes
- fmtp
The settings that you want to use to define the media stream.
- lang
The audio language, in a format that is recognized by the receiver.
MediaStreamProperty
- class CfnFlowPropsMixin.MediaStreamProperty(*, attributes=None, clock_rate=None, description=None, fmt=None, media_stream_id=None, media_stream_name=None, media_stream_type=None, video_format=None)
Bases:
objectA media stream represents one component of your content, such as video, audio, or ancillary data.
After you add a media stream to your flow, you can associate it with sources and outputs that use the ST 2110 JPEG XS or CDI protocol.
- Parameters:
attributes (
Union[IResolvable,MediaStreamAttributesProperty,Dict[str,Any],None]) – Attributes that are related to the media stream.clock_rate (
Union[int,float,None]) – The sample rate for the stream. This value is measured in Hz.description (
Optional[str]) – A description that can help you quickly identify what your media stream is used for.fmt (
Union[int,float,None]) – The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.media_stream_id (
Union[int,float,None]) – A unique identifier for the media stream.media_stream_name (
Optional[str]) – A name that helps you distinguish one media stream from another.media_stream_type (
Optional[str]) – The type of media stream.video_format (
Optional[str]) – The resolution of the video.
- See:
- 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_property = mediaconnect_mixins.CfnFlowPropsMixin.MediaStreamProperty( attributes=mediaconnect_mixins.CfnFlowPropsMixin.MediaStreamAttributesProperty( fmtp=mediaconnect_mixins.CfnFlowPropsMixin.FmtpProperty( channel_order="channelOrder", colorimetry="colorimetry", exact_framerate="exactFramerate", par="par", range="range", scan_mode="scanMode", tcs="tcs" ), lang="lang" ), clock_rate=123, description="description", fmt=123, media_stream_id=123, media_stream_name="mediaStreamName", media_stream_type="mediaStreamType", video_format="videoFormat" )
Attributes
- attributes
Attributes that are related to the media stream.
- clock_rate
The sample rate for the stream.
This value is measured in Hz.
- description
A description that can help you quickly identify what your media stream is used for.
- fmt
The format type number (sometimes referred to as RTP payload type) of the media stream.
MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.
- media_stream_id
A unique identifier for the media stream.
- media_stream_name
A name that helps you distinguish one media stream from another.
- media_stream_type
The type of media stream.
- video_format
The resolution of the video.
MediaStreamSourceConfigurationProperty
- class CfnFlowPropsMixin.MediaStreamSourceConfigurationProperty(*, encoding_name=None, input_configurations=None, media_stream_name=None)
Bases:
objectThe media stream that is associated with the source, and the parameters for that association.
- Parameters:
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.input_configurations (
Union[IResolvable,Sequence[Union[IResolvable,InputConfigurationProperty,Dict[str,Any]]],None]) – The media streams that you want to associate with the source.media_stream_name (
Optional[str]) – A name that helps you distinguish one media stream from another.
- See:
- 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_source_configuration_property = mediaconnect_mixins.CfnFlowPropsMixin.MediaStreamSourceConfigurationProperty( encoding_name="encodingName", input_configurations=[mediaconnect_mixins.CfnFlowPropsMixin.InputConfigurationProperty( input_port=123, interface=mediaconnect_mixins.CfnFlowPropsMixin.InterfaceProperty( name="name" ) )], media_stream_name="mediaStreamName" )
Attributes
- 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.
- input_configurations
The media streams that you want to associate with the source.
- media_stream_name
A name that helps you distinguish one media stream from another.
NdiConfigProperty
- class CfnFlowPropsMixin.NdiConfigProperty(*, machine_name=None, ndi_discovery_servers=None, ndi_state=None)
Bases:
objectSpecifies the configuration settings for NDI outputs.
Required when the flow includes NDI outputs.
- Parameters:
machine_name (
Optional[str]) – A prefix for the names of the NDI sources that the flow creates. If a custom name isn’t specified, MediaConnect generates a unique 12-character ID as the prefix.ndi_discovery_servers (
Union[IResolvable,Sequence[Union[IResolvable,NdiDiscoveryServerConfigProperty,Dict[str,Any]]],None]) – A list of up to three NDI discovery server configurations. While not required by the API, this configuration is necessary for NDI functionality to work properly.ndi_state (
Optional[str]) – A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED.
- See:
- 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 ndi_config_property = mediaconnect_mixins.CfnFlowPropsMixin.NdiConfigProperty( machine_name="machineName", ndi_discovery_servers=[mediaconnect_mixins.CfnFlowPropsMixin.NdiDiscoveryServerConfigProperty( discovery_server_address="discoveryServerAddress", discovery_server_port=123, vpc_interface_adapter="vpcInterfaceAdapter" )], ndi_state="ndiState" )
Attributes
- machine_name
A prefix for the names of the NDI sources that the flow creates.
If a custom name isn’t specified, MediaConnect generates a unique 12-character ID as the prefix.
- ndi_discovery_servers
A list of up to three NDI discovery server configurations.
While not required by the API, this configuration is necessary for NDI functionality to work properly.
- ndi_state
A setting that controls whether NDI outputs can be used in the flow.
Must be ENABLED to add NDI outputs. Default is DISABLED.
NdiDiscoveryServerConfigProperty
- class CfnFlowPropsMixin.NdiDiscoveryServerConfigProperty(*, discovery_server_address=None, discovery_server_port=None, vpc_interface_adapter=None)
Bases:
objectSpecifies the configuration settings for individual NDI discovery servers.
A maximum of 3 servers is allowed.
- Parameters:
discovery_server_address (
Optional[str]) – The unique network address of the NDI discovery server.discovery_server_port (
Union[int,float,None]) – The port for the NDI discovery server. Defaults to 5959 if a custom port isn’t specified.vpc_interface_adapter (
Optional[str]) – The identifier for the Virtual Private Cloud (VPC) network interface used by the flow.
- See:
- 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 ndi_discovery_server_config_property = mediaconnect_mixins.CfnFlowPropsMixin.NdiDiscoveryServerConfigProperty( discovery_server_address="discoveryServerAddress", discovery_server_port=123, vpc_interface_adapter="vpcInterfaceAdapter" )
Attributes
- discovery_server_address
The unique network address of the NDI discovery server.
- discovery_server_port
The port for the NDI discovery server.
Defaults to 5959 if a custom port isn’t specified.
- vpc_interface_adapter
The identifier for the Virtual Private Cloud (VPC) network interface used by the flow.
SecretsManagerEncryptionKeyConfigurationProperty
- class CfnFlowPropsMixin.SecretsManagerEncryptionKeyConfigurationProperty(*, role_arn=None, secret_arn=None)
Bases:
objectThe configuration settings for transit encryption of a flow source 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 from the router output using AWS Secrets Manager.secret_arn (
Optional[str]) – The ARN of the AWS Secrets Manager secret used for transit encryption from the router output.
- See:
- 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.CfnFlowPropsMixin.SecretsManagerEncryptionKeyConfigurationProperty( role_arn="roleArn", secret_arn="secretArn" )
Attributes
- role_arn
The ARN of the IAM role used for transit encryption from the router output using AWS Secrets Manager.
- secret_arn
The ARN of the AWS Secrets Manager secret used for transit encryption from the router output.
SilentAudioProperty
- class CfnFlowPropsMixin.SilentAudioProperty(*, state=None, threshold_seconds=None)
Bases:
objectConfigures settings for the
SilentAudiometric.- Parameters:
state (
Optional[str]) – Indicates whether theSilentAudiometric is enabled or disabled.threshold_seconds (
Union[int,float,None]) – Specifies the number of consecutive seconds of silence that triggers an event or alert.
- See:
- 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 silent_audio_property = mediaconnect_mixins.CfnFlowPropsMixin.SilentAudioProperty( state="state", threshold_seconds=123 )
Attributes
- state
Indicates whether the
SilentAudiometric is enabled or disabled.
- threshold_seconds
Specifies the number of consecutive seconds of silence that triggers an event or alert.
SourceMonitoringConfigProperty
- class CfnFlowPropsMixin.SourceMonitoringConfigProperty(*, audio_monitoring_settings=None, content_quality_analysis_state=None, thumbnail_state=None, video_monitoring_settings=None)
Bases:
objectThe
SourceMonitoringConfigproperty type specifies the source monitoring settings for anAWS::MediaConnect::Flow.- Parameters:
audio_monitoring_settings (
Union[IResolvable,Sequence[Union[IResolvable,AudioMonitoringSettingProperty,Dict[str,Any]]],None]) – Contains the settings for audio stream metrics monitoring.content_quality_analysis_state (
Optional[str]) – Indicates whether content quality analysis is enabled or disabled.thumbnail_state (
Optional[str]) – The current state of the thumbnail monitoring. - If you don’t explicitly specify a value when creating a flow, no thumbnail state will be set. - If you update an existing flow and remove a previously set thumbnail state, the value will change toDISABLED.video_monitoring_settings (
Union[IResolvable,Sequence[Union[IResolvable,VideoMonitoringSettingProperty,Dict[str,Any]]],None]) – Contains the settings for video stream metrics monitoring.
- See:
- 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 source_monitoring_config_property = mediaconnect_mixins.CfnFlowPropsMixin.SourceMonitoringConfigProperty( audio_monitoring_settings=[mediaconnect_mixins.CfnFlowPropsMixin.AudioMonitoringSettingProperty( silent_audio=mediaconnect_mixins.CfnFlowPropsMixin.SilentAudioProperty( state="state", threshold_seconds=123 ) )], content_quality_analysis_state="contentQualityAnalysisState", thumbnail_state="thumbnailState", video_monitoring_settings=[mediaconnect_mixins.CfnFlowPropsMixin.VideoMonitoringSettingProperty( black_frames=mediaconnect_mixins.CfnFlowPropsMixin.BlackFramesProperty( state="state", threshold_seconds=123 ), frozen_frames=mediaconnect_mixins.CfnFlowPropsMixin.FrozenFramesProperty( state="state", threshold_seconds=123 ) )] )
Attributes
- audio_monitoring_settings
Contains the settings for audio stream metrics monitoring.
- content_quality_analysis_state
Indicates whether content quality analysis is enabled or disabled.
- thumbnail_state
The current state of the thumbnail monitoring.
If you don’t explicitly specify a value when creating a flow, no thumbnail state will be set.
If you update an existing flow and remove a previously set thumbnail state, the value will change to
DISABLED.
- video_monitoring_settings
Contains the settings for video stream metrics monitoring.
SourcePriorityProperty
- class CfnFlowPropsMixin.SourcePriorityProperty(*, primary_source=None)
Bases:
objectThe priority you want to assign to a source.
You can have a primary stream and a backup stream or two equally prioritized streams.
- Parameters:
primary_source (
Optional[str]) – The name of the source you choose as the primary source for this flow.- See:
- 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 source_priority_property = mediaconnect_mixins.CfnFlowPropsMixin.SourcePriorityProperty( primary_source="primarySource" )
Attributes
- primary_source
The name of the source you choose as the primary source for this flow.
SourceProperty
- class CfnFlowPropsMixin.SourceProperty(*, decryption=None, description=None, entitlement_arn=None, gateway_bridge_source=None, ingest_ip=None, ingest_port=None, max_bitrate=None, max_latency=None, max_sync_buffer=None, media_stream_source_configurations=None, min_latency=None, name=None, protocol=None, router_integration_state=None, router_integration_transit_decryption=None, sender_control_port=None, sender_ip_address=None, source_arn=None, source_ingest_port=None, source_listener_address=None, source_listener_port=None, stream_id=None, vpc_interface_name=None, whitelist_cidr=None)
Bases:
objectThe details of the sources of the flow.
If you are creating a flow with a VPC source, you must first create the flow with a temporary standard source by doing the following:
Use CloudFormation to create a flow with a standard source that uses the flow’s public IP address.
Use CloudFormation to create the VPC interface to add to this flow. This can also be done as part of the previous step.
After CloudFormation has created the flow and the VPC interface, update the source to point to the VPC interface that you created.
- Parameters:
decryption (
Union[IResolvable,EncryptionProperty,Dict[str,Any],None]) – The type of encryption that is used on the content ingested from this source.description (
Optional[str]) – A description for the source. This value is not used or seen outside of the current MediaConnect account.entitlement_arn (
Optional[str]) – The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator’s flow.gateway_bridge_source (
Union[IResolvable,GatewayBridgeSourceProperty,Dict[str,Any],None]) – The source configuration for cloud flows receiving a stream from a bridge.ingest_ip (
Optional[str]) – The IP address that the flow will be listening on for incoming content.ingest_port (
Union[int,float,None]) – The port that the flow will be listening on for incoming content.max_bitrate (
Union[int,float,None]) – The maximum bitrate for RIST, RTP, and RTP-FEC streams.max_latency (
Union[int,float,None]) – The maximum latency in milliseconds for a RIST or Zixi-based source.max_sync_buffer (
Union[int,float,None]) – The size of the buffer (in milliseconds) to use to sync incoming source data.media_stream_source_configurations (
Union[IResolvable,Sequence[Union[IResolvable,MediaStreamSourceConfigurationProperty,Dict[str,Any]]],None]) – The media streams that are associated with the source, and the parameters for those associations.min_latency (
Union[int,float,None]) – The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.name (
Optional[str]) – The name of the source.protocol (
Optional[str]) – The protocol that is used by the source. AWS CloudFormation does not currently support CDI or ST 2110 JPEG XS source protocols. .. epigraph:: AWS Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.router_integration_state (
Optional[str]) – Indicates if router integration is enabled or disabled on the flow source.router_integration_transit_decryption (
Union[IResolvable,FlowTransitEncryptionProperty,Dict[str,Any],None]) – The decryption configuration for the flow source when router integration is enabled.sender_control_port (
Union[int,float,None]) – The port that the flow uses to send outbound requests to initiate connection with the sender.sender_ip_address (
Optional[str]) – The IP address that the flow communicates with to initiate connection with the sender.source_arn (
Optional[str]) – The ARN of the source.source_ingest_port (
Optional[str]) – The port that the flow listens on for incoming content. If the protocol of the source is Zixi, the port must be set to 2088.source_listener_address (
Optional[str]) – Source IP or domain name for SRT-caller protocol.source_listener_port (
Union[int,float,None]) – Source port for SRT-caller protocol.stream_id (
Optional[str]) – The stream ID that you want to use for the transport. This parameter applies only to Zixi-based streams.vpc_interface_name (
Optional[str]) – The name of the VPC interface that is used for this source.whitelist_cidr (
Optional[str]) – The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
- See:
- 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 source_property = mediaconnect_mixins.CfnFlowPropsMixin.SourceProperty( decryption=mediaconnect_mixins.CfnFlowPropsMixin.EncryptionProperty( algorithm="algorithm", constant_initialization_vector="constantInitializationVector", device_id="deviceId", key_type="keyType", region="region", resource_id="resourceId", role_arn="roleArn", secret_arn="secretArn", url="url" ), description="description", entitlement_arn="entitlementArn", gateway_bridge_source=mediaconnect_mixins.CfnFlowPropsMixin.GatewayBridgeSourceProperty( bridge_arn="bridgeArn", vpc_interface_attachment=mediaconnect_mixins.CfnFlowPropsMixin.VpcInterfaceAttachmentProperty( vpc_interface_name="vpcInterfaceName" ) ), ingest_ip="ingestIp", ingest_port=123, max_bitrate=123, max_latency=123, max_sync_buffer=123, media_stream_source_configurations=[mediaconnect_mixins.CfnFlowPropsMixin.MediaStreamSourceConfigurationProperty( encoding_name="encodingName", input_configurations=[mediaconnect_mixins.CfnFlowPropsMixin.InputConfigurationProperty( input_port=123, interface=mediaconnect_mixins.CfnFlowPropsMixin.InterfaceProperty( name="name" ) )], media_stream_name="mediaStreamName" )], min_latency=123, name="name", protocol="protocol", router_integration_state="routerIntegrationState", router_integration_transit_decryption=mediaconnect_mixins.CfnFlowPropsMixin.FlowTransitEncryptionProperty( encryption_key_configuration=mediaconnect_mixins.CfnFlowPropsMixin.FlowTransitEncryptionKeyConfigurationProperty( automatic=automatic, secrets_manager=mediaconnect_mixins.CfnFlowPropsMixin.SecretsManagerEncryptionKeyConfigurationProperty( role_arn="roleArn", secret_arn="secretArn" ) ), encryption_key_type="encryptionKeyType" ), sender_control_port=123, sender_ip_address="senderIpAddress", source_arn="sourceArn", source_ingest_port="sourceIngestPort", source_listener_address="sourceListenerAddress", source_listener_port=123, stream_id="streamId", vpc_interface_name="vpcInterfaceName", whitelist_cidr="whitelistCidr" )
Attributes
- decryption
The type of encryption that is used on the content ingested from this source.
- description
A description for the source.
This value is not used or seen outside of the current MediaConnect account.
- entitlement_arn
The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account.
The entitlement is set by the content originator and the ARN is generated as part of the originator’s flow.
- gateway_bridge_source
The source configuration for cloud flows receiving a stream from a bridge.
- ingest_ip
The IP address that the flow will be listening on for incoming content.
- ingest_port
The port that the flow will be listening on for incoming content.
- max_bitrate
The maximum bitrate for RIST, RTP, and RTP-FEC streams.
- max_latency
The maximum latency in milliseconds for a RIST or Zixi-based source.
- max_sync_buffer
The size of the buffer (in milliseconds) to use to sync incoming source data.
- media_stream_source_configurations
The media streams that are associated with the source, and the parameters for those associations.
- min_latency
The minimum latency in milliseconds for SRT-based streams.
In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
- name
The name of the source.
- protocol
The protocol that is used by the source.
AWS CloudFormation does not currently support CDI or ST 2110 JPEG XS source protocols. .. epigraph:
AWS Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
- router_integration_state
Indicates if router integration is enabled or disabled on the flow source.
- router_integration_transit_decryption
The decryption configuration for the flow source when router integration is enabled.
- sender_control_port
The port that the flow uses to send outbound requests to initiate connection with the sender.
- sender_ip_address
The IP address that the flow communicates with to initiate connection with the sender.
- source_arn
The ARN of the source.
- source_ingest_port
The port that the flow listens on for incoming content.
If the protocol of the source is Zixi, the port must be set to 2088.
- source_listener_address
Source IP or domain name for SRT-caller protocol.
- source_listener_port
Source port for SRT-caller protocol.
- stream_id
The stream ID that you want to use for the transport.
This parameter applies only to Zixi-based streams.
- vpc_interface_name
The name of the VPC interface that is used for this source.
- whitelist_cidr
The range of IP addresses that should be allowed to contribute content to your source.
These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
VideoMonitoringSettingProperty
- class CfnFlowPropsMixin.VideoMonitoringSettingProperty(*, black_frames=None, frozen_frames=None)
Bases:
objectSpecifies the configuration for video stream metrics monitoring.
- Parameters:
black_frames (
Union[IResolvable,BlackFramesProperty,Dict[str,Any],None]) – Detects video frames that are black.frozen_frames (
Union[IResolvable,FrozenFramesProperty,Dict[str,Any],None]) – Detects video frames that have not changed.
- See:
- 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 video_monitoring_setting_property = mediaconnect_mixins.CfnFlowPropsMixin.VideoMonitoringSettingProperty( black_frames=mediaconnect_mixins.CfnFlowPropsMixin.BlackFramesProperty( state="state", threshold_seconds=123 ), frozen_frames=mediaconnect_mixins.CfnFlowPropsMixin.FrozenFramesProperty( state="state", threshold_seconds=123 ) )
Attributes
- black_frames
Detects video frames that are black.
- frozen_frames
Detects video frames that have not changed.
VpcInterfaceAttachmentProperty
- class CfnFlowPropsMixin.VpcInterfaceAttachmentProperty(*, vpc_interface_name=None)
Bases:
objectThe 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:
- 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.CfnFlowPropsMixin.VpcInterfaceAttachmentProperty( vpc_interface_name="vpcInterfaceName" )
Attributes
- vpc_interface_name
The name of the VPC interface to use for this resource.
VpcInterfaceProperty
- class CfnFlowPropsMixin.VpcInterfaceProperty(*, name=None, network_interface_ids=None, network_interface_type=None, role_arn=None, security_group_ids=None, subnet_id=None)
Bases:
objectThe details of a VPC interface.
When configuring VPC interfaces for NDI outputs, keep in mind the following:
VPC interfaces must be defined as nested attributes within the
AWS::MediaConnect::Flowresource, and not within the top-levelAWS::MediaConnect::FlowVpcInterfaceresource.There’s a maximum limit of three VPC interfaces for each flow. If you’ve already reached this limit, you can’t update the flow to use a different VPC interface without first removing an existing one.
To update your VPC interfaces in this scenario, you must first remove the VPC interface that’s not being used. Next, add the new VPC interfaces. Lastly, update the
VpcInterfaceAdapterin theNDIConfigproperty. These changes must be performed as separate manual operations and cannot be done through a single template update.- Parameters:
name (
Optional[str]) – Immutable and has to be a unique against other VpcInterfaces in this Flow.network_interface_ids (
Optional[Sequence[str]]) – IDs of the network interfaces created in customer’s account by MediaConnect .network_interface_type (
Optional[str]) – The type of network interface.role_arn (
Optional[str]) – A role Arn MediaConnect can assume to create ENIs in your account.security_group_ids (
Optional[Sequence[str]]) – Security Group IDs to be used on ENI.subnet_id (
Optional[str]) – Subnet must be in the AZ of the Flow.
- See:
- 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_property = mediaconnect_mixins.CfnFlowPropsMixin.VpcInterfaceProperty( name="name", network_interface_ids=["networkInterfaceIds"], network_interface_type="networkInterfaceType", role_arn="roleArn", security_group_ids=["securityGroupIds"], subnet_id="subnetId" )
Attributes
- name
Immutable and has to be a unique against other VpcInterfaces in this Flow.
- network_interface_ids
IDs of the network interfaces created in customer’s account by MediaConnect .
- network_interface_type
The type of network interface.
- role_arn
A role Arn MediaConnect can assume to create ENIs in your account.
- security_group_ids
Security Group IDs to be used on ENI.
- subnet_id
Subnet must be in the AZ of the Flow.