CfnFlow
- class aws_cdk.aws_mediaconnect.CfnFlow(scope, id, *, name, source, availability_zone=None, maintenance=None, media_streams=None, source_failover_config=None, source_monitoring_config=None, vpc_interfaces=None)
Bases:
CfnResourceThe AWS::MediaConnect::Flow resource 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
- 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 import aws_mediaconnect as mediaconnect cfn_flow = mediaconnect.CfnFlow(self, "MyCfnFlow", name="name", source=mediaconnect.CfnFlow.SourceProperty( decryption=mediaconnect.CfnFlow.EncryptionProperty( role_arn="roleArn", # the properties below are optional algorithm="algorithm", constant_initialization_vector="constantInitializationVector", device_id="deviceId", key_type="keyType", region="region", resource_id="resourceId", secret_arn="secretArn", url="url" ), description="description", entitlement_arn="entitlementArn", gateway_bridge_source=mediaconnect.CfnFlow.GatewayBridgeSourceProperty( bridge_arn="bridgeArn", # the properties below are optional vpc_interface_attachment=mediaconnect.CfnFlow.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.CfnFlow.MediaStreamSourceConfigurationProperty( encoding_name="encodingName", media_stream_name="mediaStreamName", # the properties below are optional input_configurations=[mediaconnect.CfnFlow.InputConfigurationProperty( input_port=123, interface=mediaconnect.CfnFlow.InterfaceProperty( name="name" ) )] )], min_latency=123, name="name", protocol="protocol", 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" ), # the properties below are optional availability_zone="availabilityZone", maintenance=mediaconnect.CfnFlow.MaintenanceProperty( maintenance_day="maintenanceDay", maintenance_start_hour="maintenanceStartHour" ), media_streams=[mediaconnect.CfnFlow.MediaStreamProperty( media_stream_id=123, media_stream_name="mediaStreamName", media_stream_type="mediaStreamType", # the properties below are optional attributes=mediaconnect.CfnFlow.MediaStreamAttributesProperty( fmtp=mediaconnect.CfnFlow.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, video_format="videoFormat" )], source_failover_config=mediaconnect.CfnFlow.FailoverConfigProperty( failover_mode="failoverMode", recovery_window=123, source_priority=mediaconnect.CfnFlow.SourcePriorityProperty( primary_source="primarySource" ), state="state" ), source_monitoring_config=mediaconnect.CfnFlow.SourceMonitoringConfigProperty( audio_monitoring_settings=[mediaconnect.CfnFlow.AudioMonitoringSettingProperty( silent_audio=mediaconnect.CfnFlow.SilentAudioProperty( state="state", threshold_seconds=123 ) )], content_quality_analysis_state="contentQualityAnalysisState", thumbnail_state="thumbnailState", video_monitoring_settings=[mediaconnect.CfnFlow.VideoMonitoringSettingProperty( black_frames=mediaconnect.CfnFlow.BlackFramesProperty( state="state", threshold_seconds=123 ), frozen_frames=mediaconnect.CfnFlow.FrozenFramesProperty( state="state", threshold_seconds=123 ) )] ), vpc_interfaces=[mediaconnect.CfnFlow.VpcInterfaceProperty( name="name", role_arn="roleArn", security_group_ids=["securityGroupIds"], subnet_id="subnetId", # the properties below are optional network_interface_ids=["networkInterfaceIds"], network_interface_type="networkInterfaceType" )] )
- Parameters:
scope (
Construct) – Scope in which this resource is defined.id (
str) – Construct identifier for this resource (unique in its scope).name (
str) – The name of the flow.source (
Union[IResolvable,SourceProperty,Dict[str,Any]]) – The settings for the source that you want to use for the new flow.availability_zone (
Optional[str]) – The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS Region.maintenance (
Union[IResolvable,MaintenanceProperty,Dict[str,Any],None]) – The maintenance settings you want to use for the flow.media_streams (
Union[IResolvable,Sequence[Union[IResolvable,MediaStreamProperty,Dict[str,Any]]],None]) – The media streams associated with the flow. You can associate any of these media streams with sources and outputs on the flow.source_failover_config (
Union[IResolvable,FailoverConfigProperty,Dict[str,Any],None]) – The settings for source failover.source_monitoring_config (
Union[IResolvable,SourceMonitoringConfigProperty,Dict[str,Any],None]) – The settings for source monitoring.vpc_interfaces (
Union[IResolvable,Sequence[Union[IResolvable,VpcInterfaceProperty,Dict[str,Any]]],None]) – The VPC interfaces that you added to this flow.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource) –- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str) –value (
Any) –
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “Properties.” (i.e.Properties.TopicName).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.in the property name, prefix with a\. In most programming languages you will need to write this as"\\."because the\itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional[RemovalPolicy]) –apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str) – The name of the attribute.type_hint (
Optional[ResolutionTypeHint]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str) –- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List[Union[Stack,CfnResource]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List[CfnResource]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource) – The dependency to replace.new_target (
CfnResource) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::MediaConnect::Flow'
- attr_egress_ip
The outgoing IP address that MediaConnect uses to send video from the flow.
- CloudformationAttribute:
EgressIp
- attr_flow_arn
The Amazon Resource Name (ARN) of the flow.
- CloudformationAttribute:
FlowArn
- attr_flow_availability_zone
The Availability Zone that the flow was created in.
These options are limited to the Availability Zones within the current AWS Region.
- CloudformationAttribute:
FlowAvailabilityZone
- attr_source_ingest_ip
The IP address that the flow listens on for incoming content.
- CloudformationAttribute:
Source.IngestIp
- attr_source_source_arn
The ARN of the source.
- CloudformationAttribute:
Source.SourceArn
- attr_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.
- CloudformationAttribute:
Source.SourceIngestPort
- availability_zone
The Availability Zone that you want to create the flow in.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- maintenance
The maintenance settings you want to use for the flow.
- media_streams
The media streams associated with the flow.
- name
The name of the flow.
- node
The tree node.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref }).
- source
The settings for the source that you want to use for the new flow.
- source_failover_config
The settings for source failover.
- source_monitoring_config
The settings for source monitoring.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- vpc_interfaces
The VPC interfaces that you added to this flow.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any) –- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any) –- Return type:
bool
- classmethod is_construct(x)
Checks if
xis a construct.Use this method instead of
instanceofto properly detectConstructinstances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructslibrary on disk are seen as independent, completely different libraries. As a consequence, the classConstructin each copy of theconstructslibrary is seen as a different class, and an instance of one class will not test asinstanceofthe other class.npm installwill not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructslibrary can be accidentally installed, andinstanceofwill behave unpredictably. It is safest to avoid usinginstanceof, and using this type-testing method instead.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsConstruct.
AudioMonitoringSettingProperty
- class CfnFlow.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 import aws_mediaconnect as mediaconnect audio_monitoring_setting_property = mediaconnect.CfnFlow.AudioMonitoringSettingProperty( silent_audio=mediaconnect.CfnFlow.SilentAudioProperty( state="state", threshold_seconds=123 ) )
Attributes
- silent_audio
Detects periods of silence.
BlackFramesProperty
- class CfnFlow.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 import aws_mediaconnect as mediaconnect black_frames_property = mediaconnect.CfnFlow.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 CfnFlow.EncryptionProperty(*, role_arn, algorithm=None, constant_initialization_vector=None, device_id=None, key_type=None, region=None, resource_id=None, secret_arn=None, url=None)
Bases:
objectInformation about the encryption of the flow.
- Parameters:
role_arn (
str) – The Amazon Resource Name (ARN) of the role that you created during setup (when you set up MediaConnect as a trusted entity).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.secret_arn (
Optional[str]) – The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.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 import aws_mediaconnect as mediaconnect encryption_property = mediaconnect.CfnFlow.EncryptionProperty( role_arn="roleArn", # the properties below are optional algorithm="algorithm", constant_initialization_vector="constantInitializationVector", device_id="deviceId", key_type="keyType", region="region", resource_id="resourceId", 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 Amazon Resource Name (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.
- 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 CfnFlow.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]) – The size of the buffer (delay) that the service maintains. A larger buffer means a longer delay in transmitting the stream, but more room for error correction. A smaller buffer means a shorter delay, but less room for error correction. You can choose a value from 100-500 ms. If you keep this field blank, the service uses the default value of 200 ms. This setting only applies when Failover Mode is set to MERGE.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. This setting only applies when Failover Mode is set to FAILOVER.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 import aws_mediaconnect as mediaconnect failover_config_property = mediaconnect.CfnFlow.FailoverConfigProperty( failover_mode="failoverMode", recovery_window=123, source_priority=mediaconnect.CfnFlow.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
The size of the buffer (delay) that the service maintains.
A larger buffer means a longer delay in transmitting the stream, but more room for error correction. A smaller buffer means a shorter delay, but less room for error correction. You can choose a value from 100-500 ms. If you keep this field blank, the service uses the default value of 200 ms. This setting only applies when Failover Mode is set to MERGE.
- 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. This setting only applies when Failover Mode is set to FAILOVER.
- 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.
FmtpProperty
- class CfnFlow.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 import aws_mediaconnect as mediaconnect fmtp_property = mediaconnect.CfnFlow.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 CfnFlow.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 import aws_mediaconnect as mediaconnect frozen_frames_property = mediaconnect.CfnFlow.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 CfnFlow.GatewayBridgeSourceProperty(*, bridge_arn, vpc_interface_attachment=None)
Bases:
objectThe source configuration for cloud flows receiving a stream from a bridge.
- Parameters:
bridge_arn (
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 import aws_mediaconnect as mediaconnect gateway_bridge_source_property = mediaconnect.CfnFlow.GatewayBridgeSourceProperty( bridge_arn="bridgeArn", # the properties below are optional vpc_interface_attachment=mediaconnect.CfnFlow.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 CfnFlow.InputConfigurationProperty(*, input_port, interface)
Bases:
objectThe transport parameters associated with an incoming media stream.
- Parameters:
input_port (
Union[int,float]) – The port that the flow listens on for an incoming media stream.interface (
Union[IResolvable,InterfaceProperty,Dict[str,Any]]) – 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 import aws_mediaconnect as mediaconnect input_configuration_property = mediaconnect.CfnFlow.InputConfigurationProperty( input_port=123, interface=mediaconnect.CfnFlow.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 CfnFlow.InterfaceProperty(*, name)
Bases:
objectThe VPC interface that you want to use for the media stream associated with the output.
- Parameters:
name (
str) – The name of the VPC interface that you want to use for the media stream associated with the 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 import aws_mediaconnect as mediaconnect interface_property = mediaconnect.CfnFlow.InterfaceProperty( name="name" )
Attributes
- name
The name of the VPC interface that you want to use for the media stream associated with the output.
MaintenanceProperty
- class CfnFlow.MaintenanceProperty(*, maintenance_day, maintenance_start_hour)
Bases:
objectThe maintenance setting of a flow.
MediaConnect routinely performs maintenance on underlying systems for security, reliability, and operational performance. The maintenance activities include actions such as patching the operating system, updating drivers, or installing software and patches.
You can select the day and time that maintenance events occur. This is called a maintenance window and is used every time a maintenance event is required. To change the day and time, you can edit the maintenance window using
MaintenanceDayandMaintenanceStartHour.- Parameters:
maintenance_day (
str) – A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.maintenance_start_hour (
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 import aws_mediaconnect as mediaconnect maintenance_property = mediaconnect.CfnFlow.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 CfnFlow.MediaStreamAttributesProperty(*, fmtp=None, lang=None)
Bases:
objectAttributes that are related to the media stream.
- Parameters:
fmtp (
Union[IResolvable,FmtpProperty,Dict[str,Any],None]) – A set of parameters that 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 import aws_mediaconnect as mediaconnect media_stream_attributes_property = mediaconnect.CfnFlow.MediaStreamAttributesProperty( fmtp=mediaconnect.CfnFlow.FmtpProperty( channel_order="channelOrder", colorimetry="colorimetry", exact_framerate="exactFramerate", par="par", range="range", scan_mode="scanMode", tcs="tcs" ), lang="lang" )
Attributes
- fmtp
A set of parameters that define the media stream.
- lang
The audio language, in a format that is recognized by the receiver.
MediaStreamProperty
- class CfnFlow.MediaStreamProperty(*, media_stream_id, media_stream_name, media_stream_type, attributes=None, clock_rate=None, description=None, fmt=None, video_format=None)
Bases:
objectA single track or stream of media that contains video, audio, or ancillary data.
After you add a media stream to a flow, you can associate it with sources and outputs on that flow, as long as they use the CDI protocol or the ST 2110 JPEG XS protocol. Each source or output can consist of one or many media streams.
- Parameters:
media_stream_id (
Union[int,float]) – A unique identifier for the media stream.media_stream_name (
str) – A name that helps you distinguish one media stream from another.media_stream_type (
str) – The type of media stream.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 in measured in kHz.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.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 import aws_mediaconnect as mediaconnect media_stream_property = mediaconnect.CfnFlow.MediaStreamProperty( media_stream_id=123, media_stream_name="mediaStreamName", media_stream_type="mediaStreamType", # the properties below are optional attributes=mediaconnect.CfnFlow.MediaStreamAttributesProperty( fmtp=mediaconnect.CfnFlow.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, video_format="videoFormat" )
Attributes
- attributes
Attributes that are related to the media stream.
- clock_rate
The sample rate for the stream.
This value in measured in kHz.
- 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 CfnFlow.MediaStreamSourceConfigurationProperty(*, encoding_name, media_stream_name, input_configurations=None)
Bases:
objectThe media stream that is associated with the source, and the parameters for that association.
- Parameters:
encoding_name (
str) – The format that was used to encode the data. For ancillary data streams, set the encoding name tosmpte291. For audio streams, set the encoding name topcm. For video, 2110 streams, set the encoding name toraw. For video, JPEG XS streams, set the encoding name tojxsv.media_stream_name (
str) – A name that helps you distinguish one media stream from another.input_configurations (
Union[IResolvable,Sequence[Union[IResolvable,InputConfigurationProperty,Dict[str,Any]]],None]) – The media streams that you want to associate with the 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 import aws_mediaconnect as mediaconnect media_stream_source_configuration_property = mediaconnect.CfnFlow.MediaStreamSourceConfigurationProperty( encoding_name="encodingName", media_stream_name="mediaStreamName", # the properties below are optional input_configurations=[mediaconnect.CfnFlow.InputConfigurationProperty( input_port=123, interface=mediaconnect.CfnFlow.InterfaceProperty( name="name" ) )] )
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.
SilentAudioProperty
- class CfnFlow.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 import aws_mediaconnect as mediaconnect silent_audio_property = mediaconnect.CfnFlow.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 CfnFlow.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 an AWS::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 import aws_mediaconnect as mediaconnect source_monitoring_config_property = mediaconnect.CfnFlow.SourceMonitoringConfigProperty( audio_monitoring_settings=[mediaconnect.CfnFlow.AudioMonitoringSettingProperty( silent_audio=mediaconnect.CfnFlow.SilentAudioProperty( state="state", threshold_seconds=123 ) )], content_quality_analysis_state="contentQualityAnalysisState", thumbnail_state="thumbnailState", video_monitoring_settings=[mediaconnect.CfnFlow.VideoMonitoringSettingProperty( black_frames=mediaconnect.CfnFlow.BlackFramesProperty( state="state", threshold_seconds=123 ), frozen_frames=mediaconnect.CfnFlow.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 CfnFlow.SourcePriorityProperty(*, primary_source)
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. This setting only applies when Failover Mode is set to FAILOVER.
- Parameters:
primary_source (
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 import aws_mediaconnect as mediaconnect source_priority_property = mediaconnect.CfnFlow.SourcePriorityProperty( primary_source="primarySource" )
Attributes
- primary_source
The name of the source you choose as the primary source for this flow.
SourceProperty
- class CfnFlow.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, 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 the source.description (
Optional[str]) – A description of the source. This description is not visible outside of the current AWS 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 listens on for incoming content.ingest_port (
Union[int,float,None]) – 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.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 stream that is associated with the source, and the parameters for that association.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.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 the source content comes from.whitelist_cidr (
Optional[str]) – The range of IP addresses that are allowed to contribute content to your source. Format the IP addresses as 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 import aws_mediaconnect as mediaconnect source_property = mediaconnect.CfnFlow.SourceProperty( decryption=mediaconnect.CfnFlow.EncryptionProperty( role_arn="roleArn", # the properties below are optional algorithm="algorithm", constant_initialization_vector="constantInitializationVector", device_id="deviceId", key_type="keyType", region="region", resource_id="resourceId", secret_arn="secretArn", url="url" ), description="description", entitlement_arn="entitlementArn", gateway_bridge_source=mediaconnect.CfnFlow.GatewayBridgeSourceProperty( bridge_arn="bridgeArn", # the properties below are optional vpc_interface_attachment=mediaconnect.CfnFlow.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.CfnFlow.MediaStreamSourceConfigurationProperty( encoding_name="encodingName", media_stream_name="mediaStreamName", # the properties below are optional input_configurations=[mediaconnect.CfnFlow.InputConfigurationProperty( input_port=123, interface=mediaconnect.CfnFlow.InterfaceProperty( name="name" ) )] )], min_latency=123, name="name", protocol="protocol", 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 the source.
- description
A description of the source.
This description is not visible outside of the current AWS 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 listens on for incoming content.
- 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.
- 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 stream that is associated with the source, and the parameters for that association.
- 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.
- 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 the source content comes from.
- whitelist_cidr
The range of IP addresses that are allowed to contribute content to your source.
Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
VideoMonitoringSettingProperty
- class CfnFlow.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 import aws_mediaconnect as mediaconnect video_monitoring_setting_property = mediaconnect.CfnFlow.VideoMonitoringSettingProperty( black_frames=mediaconnect.CfnFlow.BlackFramesProperty( state="state", threshold_seconds=123 ), frozen_frames=mediaconnect.CfnFlow.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 CfnFlow.VpcInterfaceAttachmentProperty(*, vpc_interface_name=None)
Bases:
objectThe VPC interface that you want to send your output to.
- Parameters:
vpc_interface_name (
Optional[str]) – The name of the VPC interface that you want to send your output to.- 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 import aws_mediaconnect as mediaconnect vpc_interface_attachment_property = mediaconnect.CfnFlow.VpcInterfaceAttachmentProperty( vpc_interface_name="vpcInterfaceName" )
Attributes
- vpc_interface_name
The name of the VPC interface that you want to send your output to.
VpcInterfaceProperty
- class CfnFlow.VpcInterfaceProperty(*, name, role_arn, security_group_ids, subnet_id, network_interface_ids=None, network_interface_type=None)
Bases:
objectThe details of a VPC interface.
- Parameters:
name (
str) – The name for the VPC interface. This name must be unique within the flow.role_arn (
str) – The ARN of the IAM role that you created when you set up MediaConnect as a trusted service.security_group_ids (
Sequence[str]) – A virtual firewall to control inbound and outbound traffic.subnet_id (
str) – The subnet IDs that you specified for your VPC interface. A subnet ID is a range of IP addresses in your VPC. When you create your VPC, you specify a range of IPv4 addresses for the VPC in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. This is the primary CIDR block for your VPC. When you create a subnet for your VPC, you specify the CIDR block for the subnet, which is a subset of the VPC CIDR block. The subnets that you use across all VPC interfaces on the flow must be in the same Availability Zone as the flow.network_interface_ids (
Optional[Sequence[str]]) – The IDs of the network interfaces that MediaConnect created in your account.network_interface_type (
Optional[str]) – The type of network 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 import aws_mediaconnect as mediaconnect vpc_interface_property = mediaconnect.CfnFlow.VpcInterfaceProperty( name="name", role_arn="roleArn", security_group_ids=["securityGroupIds"], subnet_id="subnetId", # the properties below are optional network_interface_ids=["networkInterfaceIds"], network_interface_type="networkInterfaceType" )
Attributes
- name
The name for the VPC interface.
This name must be unique within the flow.
- network_interface_ids
The IDs of the network interfaces that MediaConnect created in your account.
- network_interface_type
The type of network interface.
- role_arn
The ARN of the IAM role that you created when you set up MediaConnect as a trusted service.
- security_group_ids
A virtual firewall to control inbound and outbound traffic.
- subnet_id
The subnet IDs that you specified for your VPC interface.
A subnet ID is a range of IP addresses in your VPC. When you create your VPC, you specify a range of IPv4 addresses for the VPC in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. This is the primary CIDR block for your VPC. When you create a subnet for your VPC, you specify the CIDR block for the subnet, which is a subset of the VPC CIDR block.
The subnets that you use across all VPC interfaces on the flow must be in the same Availability Zone as the flow.