class CfnFlow (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.MediaConnect.CfnFlow`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsmediaconnect#CfnFlow`
Java	`software.amazon.awscdk.services.mediaconnect.CfnFlow`
Python	`aws_cdk.aws_mediaconnect.CfnFlow`
TypeScript	`aws-cdk-lib` » `aws_mediaconnect` » `CfnFlow`

Implements IConstruct, IDependable, IInspectable

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediaconnect as mediaconnect } from 'aws-cdk-lib';
const cfnFlow = new mediaconnect.CfnFlow(this, 'MyCfnFlow', {
  name: 'name',
  source: {
    decryption: {
      roleArn: 'roleArn',

      // the properties below are optional
      algorithm: 'algorithm',
      constantInitializationVector: 'constantInitializationVector',
      deviceId: 'deviceId',
      keyType: 'keyType',
      region: 'region',
      resourceId: 'resourceId',
      secretArn: 'secretArn',
      url: 'url',
    },
    description: 'description',
    entitlementArn: 'entitlementArn',
    gatewayBridgeSource: {
      bridgeArn: 'bridgeArn',

      // the properties below are optional
      vpcInterfaceAttachment: {
        vpcInterfaceName: 'vpcInterfaceName',
      },
    },
    ingestIp: 'ingestIp',
    ingestPort: 123,
    maxBitrate: 123,
    maxLatency: 123,
    maxSyncBuffer: 123,
    mediaStreamSourceConfigurations: [{
      encodingName: 'encodingName',
      mediaStreamName: 'mediaStreamName',

      // the properties below are optional
      inputConfigurations: [{
        inputPort: 123,
        interface: {
          name: 'name',
        },
      }],
    }],
    minLatency: 123,
    name: 'name',
    protocol: 'protocol',
    senderControlPort: 123,
    senderIpAddress: 'senderIpAddress',
    sourceArn: 'sourceArn',
    sourceIngestPort: 'sourceIngestPort',
    sourceListenerAddress: 'sourceListenerAddress',
    sourceListenerPort: 123,
    streamId: 'streamId',
    vpcInterfaceName: 'vpcInterfaceName',
    whitelistCidr: 'whitelistCidr',
  },

  // the properties below are optional
  availabilityZone: 'availabilityZone',
  maintenance: {
    maintenanceDay: 'maintenanceDay',
    maintenanceStartHour: 'maintenanceStartHour',
  },
  mediaStreams: [{
    mediaStreamId: 123,
    mediaStreamName: 'mediaStreamName',
    mediaStreamType: 'mediaStreamType',

    // the properties below are optional
    attributes: {
      fmtp: {
        channelOrder: 'channelOrder',
        colorimetry: 'colorimetry',
        exactFramerate: 'exactFramerate',
        par: 'par',
        range: 'range',
        scanMode: 'scanMode',
        tcs: 'tcs',
      },
      lang: 'lang',
    },
    clockRate: 123,
    description: 'description',
    fmt: 123,
    videoFormat: 'videoFormat',
  }],
  sourceFailoverConfig: {
    failoverMode: 'failoverMode',
    recoveryWindow: 123,
    sourcePriority: {
      primarySource: 'primarySource',
    },
    state: 'state',
  },
  sourceMonitoringConfig: {
    thumbnailState: 'thumbnailState',
  },
  vpcInterfaces: [{
    name: 'name',
    roleArn: 'roleArn',
    securityGroupIds: ['securityGroupIds'],
    subnetId: 'subnetId',

    // the properties below are optional
    networkInterfaceIds: ['networkInterfaceIds'],
    networkInterfaceType: 'networkInterfaceType',
  }],
});

Initializer

new CfnFlow(scope: Construct, id: string, props: CfnFlowProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnFlowProps — Resource properties.

Construct Props

Name	Type	Description
name	`string`	The name of the flow.
source	`IResolvable` `\|` `SourceProperty`	The settings for the source that you want to use for the new flow.
availabilityZone?	`string`	The Availability Zone that you want to create the flow in.
maintenance?	`IResolvable` `\|` `MaintenanceProperty`	The maintenance settings you want to use for the flow.
mediaStreams?	`IResolvable` `\|` `IResolvable` `\|` `MediaStreamProperty[]`	The media streams associated with the flow.
sourceFailoverConfig?	`IResolvable` `\|` `FailoverConfigProperty`	The settings for source failover.
sourceMonitoringConfig?	`IResolvable` `\|` `SourceMonitoringConfigProperty`	The settings for source monitoring.
vpcInterfaces?	`IResolvable` `\|` `IResolvable` `\|` `VpcInterfaceProperty[]`	The VPC interfaces that you added to this flow.

name

Type: string

The name of the flow.

source

Type: IResolvable | SourceProperty

The settings for the source that you want to use for the new flow.

availabilityZone?

Type: string (optional)

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?

Type: IResolvable | MaintenanceProperty (optional)

The maintenance settings you want to use for the flow.

mediaStreams?

Type: IResolvable | IResolvable | MediaStreamProperty[] (optional)

The media streams associated with the flow.

You can associate any of these media streams with sources and outputs on the flow.

sourceFailoverConfig?

Type: IResolvable | FailoverConfigProperty (optional)

The settings for source failover.

sourceMonitoringConfig?

Type: IResolvable | SourceMonitoringConfigProperty (optional)

The settings for source monitoring.

vpcInterfaces?

Type: IResolvable | IResolvable | VpcInterfaceProperty[] (optional)

The VPC interfaces that you added to this flow.

Properties

Name	Type	Description
attrEgressIp	`string`	The outgoing IP address that MediaConnect uses to send video from the flow.
attrFlowArn	`string`	The Amazon Resource Name (ARN) of the flow.
attrFlowAvailabilityZone	`string`	The Availability Zone that the flow was created in.
attrSourceIngestIp	`string`	The IP address that the flow listens on for incoming content.
attrSourceSourceArn	`string`	The ARN of the source.
attrSourceSourceIngestPort	`string`	The port that the flow listens on for incoming content.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
name	`string`	The name of the flow.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
source	`IResolvable` `\|` `SourceProperty`	The settings for the source that you want to use for the new flow.
stack	`Stack`	The stack in which this element is defined.
availabilityZone?	`string`	The Availability Zone that you want to create the flow in.
maintenance?	`IResolvable` `\|` `MaintenanceProperty`	The maintenance settings you want to use for the flow.
mediaStreams?	`IResolvable` `\|` `IResolvable` `\|` `MediaStreamProperty[]`	The media streams associated with the flow.
sourceFailoverConfig?	`IResolvable` `\|` `FailoverConfigProperty`	The settings for source failover.
sourceMonitoringConfig?	`IResolvable` `\|` `SourceMonitoringConfigProperty`	The settings for source monitoring.
vpcInterfaces?	`IResolvable` `\|` `IResolvable` `\|` `VpcInterfaceProperty[]`	The VPC interfaces that you added to this flow.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrEgressIp

Type: string

The outgoing IP address that MediaConnect uses to send video from the flow.

attrFlowArn

Type: string

The Amazon Resource Name (ARN) of the flow.

attrFlowAvailabilityZone

Type: string

The Availability Zone that the flow was created in.

These options are limited to the Availability Zones within the current AWS Region.

attrSourceIngestIp

Type: string

The IP address that the flow listens on for incoming content.

attrSourceSourceArn

Type: string

The ARN of the source.

attrSourceSourceIngestPort

Type: string

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.

cfnOptions

Type: ICfnResourceOptions

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

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

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

name

Type: string

The name of the flow.

node

Type: Node

The tree node.

ref

Type: string

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

Type: IResolvable | SourceProperty

The settings for the source that you want to use for the new flow.

stack

Type: Stack

The stack in which this element is defined.

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

availabilityZone?

Type: string (optional)

The Availability Zone that you want to create the flow in.

maintenance?

Type: IResolvable | MaintenanceProperty (optional)

The maintenance settings you want to use for the flow.

mediaStreams?

Type: IResolvable | IResolvable | MediaStreamProperty[] (optional)

The media streams associated with the flow.

sourceFailoverConfig?

Type: IResolvable | FailoverConfigProperty (optional)

The settings for source failover.

sourceMonitoringConfig?

Type: IResolvable | SourceMonitoringConfigProperty (optional)

The settings for source monitoring.

vpcInterfaces?

Type: IResolvable | IResolvable | VpcInterfaceProperty[] (optional)

The VPC interfaces that you added to this flow.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

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.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

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

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The 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,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride 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.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

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:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

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.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

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)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

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.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }