CfnFlowOutput
- class aws_cdk.aws_mediaconnect.CfnFlowOutput(scope, id, *, flow_arn, protocol, cidr_allow_list=None, description=None, destination=None, encryption=None, max_latency=None, media_stream_output_configurations=None, min_latency=None, name=None, output_status=None, port=None, remote_id=None, smoothing_latency=None, stream_id=None, vpc_interface_attachment=None)
Bases:
CfnResource
The AWS::MediaConnect::FlowOutput resource defines the destination address, protocol, and port that AWS Elemental MediaConnect sends the ingested video to.
Each flow can have up to 50 outputs. An output can have the same protocol or a different protocol from the source. The following protocols are supported: RIST, RTP, RTP-FEC, SRT-listener, SRT-caller, Zixi pull, Zixi push, and Fujitsu-QoS. CDI and ST 2110 JPEG XS protocols are not currently supported by AWS CloudFormation.
- See:
- CloudformationResource:
AWS::MediaConnect::FlowOutput
- 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_output = mediaconnect.CfnFlowOutput(self, "MyCfnFlowOutput", flow_arn="flowArn", protocol="protocol", # the properties below are optional cidr_allow_list=["cidrAllowList"], description="description", destination="destination", encryption=mediaconnect.CfnFlowOutput.EncryptionProperty( role_arn="roleArn", secret_arn="secretArn", # the properties below are optional algorithm="algorithm", key_type="keyType" ), max_latency=123, media_stream_output_configurations=[mediaconnect.CfnFlowOutput.MediaStreamOutputConfigurationProperty( encoding_name="encodingName", media_stream_name="mediaStreamName", # the properties below are optional destination_configurations=[mediaconnect.CfnFlowOutput.DestinationConfigurationProperty( destination_ip="destinationIp", destination_port=123, interface=mediaconnect.CfnFlowOutput.InterfaceProperty( name="name" ) )], encoding_parameters=mediaconnect.CfnFlowOutput.EncodingParametersProperty( compression_factor=123, # the properties below are optional encoder_profile="encoderProfile" ) )], min_latency=123, name="name", output_status="outputStatus", port=123, remote_id="remoteId", smoothing_latency=123, stream_id="streamId", vpc_interface_attachment=mediaconnect.CfnFlowOutput.VpcInterfaceAttachmentProperty( vpc_interface_name="vpcInterfaceName" ) )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).flow_arn (
str
) – The Amazon Resource Name (ARN) of the flow this output is attached to.protocol (
str
) – The protocol to use for the output.cidr_allow_list (
Optional
[Sequence
[str
]]) – The range of IP addresses that are allowed to initiate output requests to this flow. Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.description (
Optional
[str
]) – A description of the output. This description is not visible outside of the current AWS account even if the account grants entitlements to other accounts.destination (
Optional
[str
]) – The IP address where you want to send the output.encryption (
Union
[IResolvable
,EncryptionProperty
,Dict
[str
,Any
],None
]) – The encryption credentials that you want to use for the output.max_latency (
Union
[int
,float
,None
]) – The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.media_stream_output_configurations (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,MediaStreamOutputConfigurationProperty
,Dict
[str
,Any
]]],None
]) – The definition for each media stream that is associated with the output.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 output. This value must be unique within the current flow.output_status (
Optional
[str
]) – An indication of whether the new output should be enabled or disabled as soon as it is created. If you don’t specify the outputStatus field in your request, MediaConnect sets it to ENABLED.port (
Union
[int
,float
,None
]) – The port to use when MediaConnect distributes content to the output.remote_id (
Optional
[str
]) – The identifier that is assigned to the Zixi receiver. This parameter applies only to outputs that use Zixi pull.smoothing_latency (
Union
[int
,float
,None
]) – The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.stream_id (
Optional
[str
]) – The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.vpc_interface_attachment (
Union
[IResolvable
,VpcInterfaceAttachmentProperty
,Dict
[str
,Any
],None
]) – The VPC interface that you want to send your output to.
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
addPropertyOverride
or prefixpath
with “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
value
argument toaddOverride
will 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::FlowOutput'
- attr_output_arn
The ARN of the output.
- CloudformationAttribute:
OutputArn
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- cidr_allow_list
The range of IP addresses that are allowed to initiate output requests to this flow.
- 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.
- description
A description of the output.
- destination
The IP address where you want to send the output.
- encryption
The encryption credentials that you want to use for the output.
- flow_arn
The Amazon Resource Name (ARN) of the flow this output is attached to.
- 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.
- max_latency
The maximum latency in milliseconds.
- media_stream_output_configurations
The definition for each media stream that is associated with the output.
- min_latency
The minimum latency in milliseconds for SRT-based streams.
- name
The name of the output.
- node
The tree node.
- output_status
An indication of whether the new output should be enabled or disabled as soon as it is created.
- port
The port to use when MediaConnect distributes content to the output.
- protocol
The protocol to use for the output.
- 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 })
.
- remote_id
The identifier that is assigned to the Zixi receiver.
- smoothing_latency
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- stream_id
The stream ID that you want to use for this transport.
- vpc_interface_attachment
The VPC interface that you want to send your output to.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to 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
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will 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
x
is an object created from a class which extendsConstruct
.
DestinationConfigurationProperty
- class CfnFlowOutput.DestinationConfigurationProperty(*, destination_ip, destination_port, interface)
Bases:
object
The definition of a media stream that is associated with the output.
- Parameters:
destination_ip (
str
) – The IP address where contents of the media stream will be sent.destination_port (
Union
[int
,float
]) – The port to use when the content of the media stream is distributed to the output.interface (
Union
[IResolvable
,InterfaceProperty
,Dict
[str
,Any
]]) – The VPC interface that is used 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 destination_configuration_property = mediaconnect.CfnFlowOutput.DestinationConfigurationProperty( destination_ip="destinationIp", destination_port=123, interface=mediaconnect.CfnFlowOutput.InterfaceProperty( name="name" ) )
Attributes
- destination_ip
The IP address where contents of the media stream will be sent.
- destination_port
The port to use when the content of the media stream is distributed to the output.
- interface
The VPC interface that is used for the media stream associated with the output.
EncodingParametersProperty
- class CfnFlowOutput.EncodingParametersProperty(*, compression_factor, encoder_profile=None)
Bases:
object
A collection of parameters that determine how MediaConnect will convert the content.
These fields only apply to outputs on flows that have a CDI source.
- Parameters:
compression_factor (
Union
[int
,float
]) – A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are in the range of 3.0 to 10.0, inclusive.encoder_profile (
Optional
[str
]) – A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.
- See:
- 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 encoding_parameters_property = mediaconnect.CfnFlowOutput.EncodingParametersProperty( compression_factor=123, # the properties below are optional encoder_profile="encoderProfile" )
Attributes
- compression_factor
A value that is used to calculate compression for an output.
The bitrate of the output is calculated as follows:
Output bitrate = (1 / compressionFactor) * (source bitrate)
This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are in the range of 3.0 to 10.0, inclusive.
- encoder_profile
A setting on the encoder that drives compression settings.
This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.
EncryptionProperty
- class CfnFlowOutput.EncryptionProperty(*, role_arn, secret_arn, algorithm=None, key_type=None)
Bases:
object
Information 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).secret_arn (
str
) – The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.algorithm (
Optional
[str
]) – The type of algorithm that is used for static key encryption (such as aes128, aes192, or aes256). If you are using SPEKE or SRT-password encryption, this property must be left blank.key_type (
Optional
[str
]) – The type of key that is used for the encryption. If you don’t specify akeyType
value, the service uses the default setting (static-key
). Valid key types are:static-key
,speke
, andsrt-password
. Default: - “static-key”
- 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.CfnFlowOutput.EncryptionProperty( role_arn="roleArn", secret_arn="secretArn", # the properties below are optional algorithm="algorithm", key_type="keyType" )
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.
- key_type
The type of key that is used for the encryption.
If you don’t specify a
keyType
value, the service uses the default setting (static-key
). Valid key types are:static-key
,speke
, andsrt-password
.
- 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.
InterfaceProperty
- class CfnFlowOutput.InterfaceProperty(*, name)
Bases:
object
The 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.CfnFlowOutput.InterfaceProperty( name="name" )
Attributes
- name
The name of the VPC interface that you want to use for the media stream associated with the output.
MediaStreamOutputConfigurationProperty
- class CfnFlowOutput.MediaStreamOutputConfigurationProperty(*, encoding_name, media_stream_name, destination_configurations=None, encoding_parameters=None)
Bases:
object
The media stream that is associated with the output, and the parameters for that association.
- Parameters:
encoding_name (
str
) – The format that will be used to encode the data. For ancillary data streams, set the encoding name tosmpte291
. For audio streams, set the encoding name topcm
. For video streams on sources or outputs that use the CDI protocol, set the encoding name toraw
. For video streams on sources or outputs that use the ST 2110 JPEG XS protocol, set the encoding name tojxsv
.media_stream_name (
str
) – A name that helps you distinguish one media stream from another.destination_configurations (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,DestinationConfigurationProperty
,Dict
[str
,Any
]]],None
]) – The media streams that you want to associate with the output.encoding_parameters (
Union
[IResolvable
,EncodingParametersProperty
,Dict
[str
,Any
],None
]) – A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.
- 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_output_configuration_property = mediaconnect.CfnFlowOutput.MediaStreamOutputConfigurationProperty( encoding_name="encodingName", media_stream_name="mediaStreamName", # the properties below are optional destination_configurations=[mediaconnect.CfnFlowOutput.DestinationConfigurationProperty( destination_ip="destinationIp", destination_port=123, interface=mediaconnect.CfnFlowOutput.InterfaceProperty( name="name" ) )], encoding_parameters=mediaconnect.CfnFlowOutput.EncodingParametersProperty( compression_factor=123, # the properties below are optional encoder_profile="encoderProfile" ) )
Attributes
- destination_configurations
The media streams that you want to associate with the output.
- encoding_name
The format that will be 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 streams on sources or outputs that use the CDI protocol, set the encoding name to
raw
.For video streams on sources or outputs that use the ST 2110 JPEG XS protocol, set the encoding name to
jxsv
.
- encoding_parameters
A collection of parameters that determine how MediaConnect will convert the content.
These fields only apply to outputs on flows that have a CDI source.
- media_stream_name
A name that helps you distinguish one media stream from another.
VpcInterfaceAttachmentProperty
- class CfnFlowOutput.VpcInterfaceAttachmentProperty(*, vpc_interface_name=None)
Bases:
object
The 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.CfnFlowOutput.VpcInterfaceAttachmentProperty( vpc_interface_name="vpcInterfaceName" )
Attributes
- vpc_interface_name
The name of the VPC interface that you want to send your output to.