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, min_latency=None, name=None, port=None, remote_id=None, smoothing_latency=None, stream_id=None, vpc_interface_attachment=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::MediaConnect::FlowOutput.

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.

CloudformationResource

AWS::MediaConnect::FlowOutput

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.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_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,
    min_latency=123,
    name="name",
    port=123,
    remote_id="remoteId",
    smoothing_latency=123,
    stream_id="streamId",
    vpc_interface_attachment=mediaconnect.CfnFlowOutput.VpcInterfaceAttachmentProperty(
        vpc_interface_name="vpcInterfaceName"
    )
)

Create a new AWS::MediaConnect::FlowOutput.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • flow_arn (str) – The Amazon Resource Name (ARN) of the flow.

  • 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, None]) – The encryption credentials that you want to use for the output.

  • max_latency (Union[int, float, None]) – The maximum latency in milliseconds for Zixi-based streams.

  • 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 VPC interface.

  • 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 the transport. This parameter applies only to Zixi-based streams.

  • vpc_interface_attachment (Union[IResolvable, VpcInterfaceAttachmentProperty, 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_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 prefix path 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"
       ...
     },
   ]
   ...
}
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: true

  • default (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

Reference

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::FlowOutput'
attr_output_arn

The ARN of the output.

CloudformationAttribute

OutputArn

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

cidr_allow_list

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-cidrallowlist

Return type

Optional[List[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]

description

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-description

Return type

Optional[str]

destination

The IP address where you want to send the output.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-destination

Return type

Optional[str]

encryption

The encryption credentials that you want to use for the output.

Link

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

Return type

Union[IResolvable, EncryptionProperty, None]

flow_arn

The Amazon Resource Name (ARN) of the flow.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-flowarn

Return type

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.

max_latency

The maximum latency in milliseconds for Zixi-based streams.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-maxlatency

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

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-minlatency

Return type

Union[int, float, None]

name

The name of the VPC interface.

Link

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

Return type

Optional[str]

node

The construct tree node associated with this construct.

Return type

ConstructNode

port

The port to use when MediaConnect distributes content to the output.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-port

Return type

Union[int, float, None]

protocol

The protocol to use for the output.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-protocol

Return type

str

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

remote_id

The identifier that is assigned to the Zixi receiver.

This parameter applies only to outputs that use Zixi pull.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-remoteid

Return type

Optional[str]

smoothing_latency

The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-smoothinglatency

Return type

Union[int, float, None]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

stream_id

The stream ID that you want to use for the transport.

This parameter applies only to Zixi-based streams.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-streamid

Return type

Optional[str]

vpc_interface_attachment

The VPC interface that you want to send your output to.

Link

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

Return type

Union[IResolvable, VpcInterfaceAttachmentProperty, None]

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 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 the encryption (such as aes128, aes192, or aes256).

  • key_type (Optional[str]) – The type of key that is used for the encryption. If you don’t specify a keyType value, the service uses the default setting ( static-key ).

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.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 the encryption (such as aes128, aes192, or aes256).

Link

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

Return type

Optional[str]

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 ).

Link

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

Return type

Optional[str]

role_arn

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

Link

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

Return type

str

secret_arn

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

Link

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

Return type

str

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.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.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.

Link

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

Return type

Optional[str]