CfnFlow¶
-
class
aws_cdk.aws_mediaconnect.
CfnFlow
(scope, id, *, name, source, availability_zone=None, source_failover_config=None)¶ Bases:
aws_cdk.core.CfnResource
A CloudFormation
AWS::MediaConnect::Flow
.The 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.
- CloudformationResource
AWS::MediaConnect::Flow
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.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", ingest_ip="ingestIp", ingest_port=123, max_bitrate=123, max_latency=123, min_latency=123, name="name", protocol="protocol", source_arn="sourceArn", source_ingest_port="sourceIngestPort", stream_id="streamId", vpc_interface_name="vpcInterfaceName", whitelist_cidr="whitelistCidr" ), # the properties below are optional availability_zone="availabilityZone", source_failover_config=mediaconnect.CfnFlow.FailoverConfigProperty( recovery_window=123, state="state" ) )
Create a new
AWS::MediaConnect::Flow
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
name (
str
) – The name of the flow.source (
Union
[SourceProperty
,IResolvable
]) – 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.source_failover_config (
Union
[IResolvable
,FailoverConfigProperty
,None
]) – The settings for source failover.
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_depends_on
(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_metadata
(key, value)¶ Add a value to the CloudFormation Resource Metadata.
- Parameters
key (
str
) –value (
Any
) –
- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
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.
- Return type
None
-
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 intermdediate 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
).- 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 resoure, please consult that specific resource’s documentation.
- Return type
None
-
get_att
(attribute_name)¶ 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.- Return type
-
get_metadata
(key)¶ Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters
key (
str
) –- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
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.
- Return type
Any
-
inspect
(inspector)¶ Examines the CloudFormation resource and discloses attributes.
- Parameters
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type
None
-
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
-
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_flow_arn
¶ The Amazon Resource Name (ARN) of the flow.
- CloudformationAttribute
FlowArn
- Return type
str
-
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
- Return type
str
-
attr_source_ingest_ip
¶ The IP address that the flow listens on for incoming content.
- CloudformationAttribute
Source.IngestIp
- Return type
str
-
attr_source_source_arn
¶ The ARN of the source.
- CloudformationAttribute
Source.SourceArn
- Return type
str
-
attr_source_source_ingest_port
¶ The port that the flow will be listening on for incoming content.
- CloudformationAttribute
Source.SourceIngestPort
- Return type
str
-
availability_zone
¶ The Availability Zone that you want to create the flow in.
These options are limited to the Availability Zones within the current AWS Region.
-
cfn_options
¶ Options for this resource, such as condition, update policy etc.
- Return type
-
cfn_resource_type
¶ AWS resource type.
- Return type
str
-
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.
- Return type
List
[str
]
-
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)
.- Return type
str
- Returns
the logical ID as a stringified token. This value will only get resolved during synthesis.
-
name
¶ The name of the flow.
-
node
¶ The construct tree node associated with this construct.
- Return type
-
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 })
.- Return type
str
-
source
¶ The settings for the source that you want to use for the new flow.
-
source_failover_config
¶ The settings for source failover.
-
stack
¶ The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- Return type
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
(construct)¶ Check whether the given construct is a CfnResource.
- Parameters
construct (
IConstruct
) –- Return type
bool
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
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:
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).algorithm (
Optional
[str
]) – The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).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 akeyType
value, the service uses the default setting (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.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.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 the encryption (such as aes128, aes192, or aes256).
-
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
keyType
value, the service uses the default setting (static-key
).
-
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
(*, recovery_window=None, state=None)¶ Bases:
object
The settings for source failover.
- Parameters
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.state (
Optional
[str
]) – The state of source failover on the flow. If the state is disabled, the flow can have only one source. If the state is enabled, the flow can have one or two sources.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_mediaconnect as mediaconnect failover_config_property = mediaconnect.CfnFlow.FailoverConfigProperty( recovery_window=123, state="state" )
Attributes
-
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.
-
state
¶ The state of source failover on the flow.
If the state is disabled, the flow can have only one source. If the state is enabled, the flow can have one or two sources.
SourceProperty¶
-
class
CfnFlow.
SourceProperty
(*, decryption=None, description=None, entitlement_arn=None, ingest_ip=None, ingest_port=None, max_bitrate=None, max_latency=None, min_latency=None, name=None, protocol=None, source_arn=None, source_ingest_port=None, stream_id=None, vpc_interface_name=None, whitelist_cidr=None)¶ Bases:
object
The 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
,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.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.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. For a full list of available protocols, see: Source protocols in the AWS Elemental MediaConnect API Reference .source_arn (
Optional
[str
]) – The ARN of the source.source_ingest_port (
Optional
[str
]) – The port that the flow will be listening on for incoming content.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.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.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", ingest_ip="ingestIp", ingest_port=123, max_bitrate=123, max_latency=123, min_latency=123, name="name", protocol="protocol", source_arn="sourceArn", source_ingest_port="sourceIngestPort", 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.
-
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.
- Link
- Return type
Union
[int
,float
,None
]
-
max_bitrate
¶ The maximum bitrate for RIST, RTP, and RTP-FEC streams.
- Link
- Return type
Union
[int
,float
,None
]
-
max_latency
¶ The maximum latency in milliseconds for a RIST or Zixi-based source.
- Link
- Return type
Union
[int
,float
,None
]
-
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.
- Link
- Return type
Union
[int
,float
,None
]
-
name
¶ The name of the source.
-
protocol
¶ The protocol that is used by the source.
For a full list of available protocols, see: Source protocols in the AWS Elemental MediaConnect API Reference .
-
source_arn
¶ The ARN of the source.
-
source_ingest_port
¶ The port that the flow will be listening on for incoming content.
-
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.