awscdk-construct-mediaconnect-flow 0.0.0

package/API.md

@@ -0,0 +1,343 @@
+# API Reference <a name="API Reference" id="api-reference"></a>
+
+## Constructs <a name="Constructs" id="Constructs"></a>
+
+### LiveFeedFromFile <a name="LiveFeedFromFile" id="awscdk-construct-mediaconnect-flow.LiveFeedFromFile"></a>
+
+#### Initializers <a name="Initializers" id="awscdk-construct-mediaconnect-flow.LiveFeedFromFile.Initializer"></a>
+
+```typescript
+import { LiveFeedFromFile } from 'awscdk-construct-mediaconnect-flow'
+
+new LiveFeedFromFile(scope: Construct, id: string, props: LiveFeedFromFileProps)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeedFromFile.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeedFromFile.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeedFromFile.Initializer.parameter.props">props</a></code> | <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeedFromFileProps">LiveFeedFromFileProps</a></code> | *No description.* |
+
+---
+
+##### `scope`<sup>Required</sup> <a name="scope" id="awscdk-construct-mediaconnect-flow.LiveFeedFromFile.Initializer.parameter.scope"></a>
+
+- *Type:* constructs.Construct
+
+---
+
+##### `id`<sup>Required</sup> <a name="id" id="awscdk-construct-mediaconnect-flow.LiveFeedFromFile.Initializer.parameter.id"></a>
+
+- *Type:* string
+
+---
+
+##### `props`<sup>Required</sup> <a name="props" id="awscdk-construct-mediaconnect-flow.LiveFeedFromFile.Initializer.parameter.props"></a>
+
+- *Type:* <a href="#awscdk-construct-mediaconnect-flow.LiveFeedFromFileProps">LiveFeedFromFileProps</a>
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeedFromFile.toString">toString</a></code> | Returns a string representation of this construct. |
+
+---
+
+##### `toString` <a name="toString" id="awscdk-construct-mediaconnect-flow.LiveFeedFromFile.toString"></a>
+
+```typescript
+public toString(): string
+```
+
+Returns a string representation of this construct.
+
+#### Static Functions <a name="Static Functions" id="Static Functions"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeedFromFile.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
+
+---
+
+##### `isConstruct` <a name="isConstruct" id="awscdk-construct-mediaconnect-flow.LiveFeedFromFile.isConstruct"></a>
+
+```typescript
+import { LiveFeedFromFile } from 'awscdk-construct-mediaconnect-flow'
+
+LiveFeedFromFile.isConstruct(x: any)
+```
+
+Checks if `x` is a construct.
+
+Use this method instead of `instanceof` to properly detect `Construct`
+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 class `Construct` in each copy of the `constructs` library
+is seen as a different class, and an instance of one class will not test as
+`instanceof` 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 the `constructs`
+library can be accidentally installed, and `instanceof` will behave
+unpredictably. It is safest to avoid using `instanceof`, and using
+this type-testing method instead.
+
+###### `x`<sup>Required</sup> <a name="x" id="awscdk-construct-mediaconnect-flow.LiveFeedFromFile.isConstruct.parameter.x"></a>
+
+- *Type:* any
+
+Any object.
+
+---
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeedFromFile.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeedFromFile.property.flow">flow</a></code> | <code>aws-cdk-lib.aws_mediaconnect.CfnFlow</code> | *No description.* |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeedFromFile.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | *No description.* |
+
+---
+
+##### `node`<sup>Required</sup> <a name="node" id="awscdk-construct-mediaconnect-flow.LiveFeedFromFile.property.node"></a>
+
+```typescript
+public readonly node: Node;
+```
+
+- *Type:* constructs.Node
+
+The tree node.
+
+---
+
+##### `flow`<sup>Required</sup> <a name="flow" id="awscdk-construct-mediaconnect-flow.LiveFeedFromFile.property.flow"></a>
+
+```typescript
+public readonly flow: CfnFlow;
+```
+
+- *Type:* aws-cdk-lib.aws_mediaconnect.CfnFlow
+
+---
+
+##### `vpc`<sup>Optional</sup> <a name="vpc" id="awscdk-construct-mediaconnect-flow.LiveFeedFromFile.property.vpc"></a>
+
+```typescript
+public readonly vpc: IVpc;
+```
+
+- *Type:* aws-cdk-lib.aws_ec2.IVpc
+
+---
+
+
+## Structs <a name="Structs" id="Structs"></a>
+
+### FileSpec <a name="FileSpec" id="awscdk-construct-mediaconnect-flow.FileSpec"></a>
+
+#### Initializer <a name="Initializer" id="awscdk-construct-mediaconnect-flow.FileSpec.Initializer"></a>
+
+```typescript
+import { FileSpec } from 'awscdk-construct-mediaconnect-flow'
+
+const fileSpec: FileSpec = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#awscdk-construct-mediaconnect-flow.FileSpec.property.url">url</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#awscdk-construct-mediaconnect-flow.FileSpec.property.type">type</a></code> | <code>string</code> | *No description.* |
+
+---
+
+##### `url`<sup>Required</sup> <a name="url" id="awscdk-construct-mediaconnect-flow.FileSpec.property.url"></a>
+
+```typescript
+public readonly url: string;
+```
+
+- *Type:* string
+
+---
+
+##### `type`<sup>Optional</sup> <a name="type" id="awscdk-construct-mediaconnect-flow.FileSpec.property.type"></a>
+
+```typescript
+public readonly type: string;
+```
+
+- *Type:* string
+
+---
+
+### LiveFeedFromFileProps <a name="LiveFeedFromFileProps" id="awscdk-construct-mediaconnect-flow.LiveFeedFromFileProps"></a>
+
+#### Initializer <a name="Initializer" id="awscdk-construct-mediaconnect-flow.LiveFeedFromFileProps.Initializer"></a>
+
+```typescript
+import { LiveFeedFromFileProps } from 'awscdk-construct-mediaconnect-flow'
+
+const liveFeedFromFileProps: LiveFeedFromFileProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeedFromFileProps.property.file">file</a></code> | <code><a href="#awscdk-construct-mediaconnect-flow.FileSpec">FileSpec</a></code> | *No description.* |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeedFromFileProps.property.autoStart">autoStart</a></code> | <code>boolean</code> | *No description.* |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeedFromFileProps.property.source">source</a></code> | <code><a href="#awscdk-construct-mediaconnect-flow.LiveSourceSpec">LiveSourceSpec</a></code> | *No description.* |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeedFromFileProps.property.vpcConfig">vpcConfig</a></code> | <code><a href="#awscdk-construct-mediaconnect-flow.VpcConfig">VpcConfig</a></code> | *No description.* |
+
+---
+
+##### `file`<sup>Required</sup> <a name="file" id="awscdk-construct-mediaconnect-flow.LiveFeedFromFileProps.property.file"></a>
+
+```typescript
+public readonly file: FileSpec;
+```
+
+- *Type:* <a href="#awscdk-construct-mediaconnect-flow.FileSpec">FileSpec</a>
+
+---
+
+##### `autoStart`<sup>Optional</sup> <a name="autoStart" id="awscdk-construct-mediaconnect-flow.LiveFeedFromFileProps.property.autoStart"></a>
+
+```typescript
+public readonly autoStart: boolean;
+```
+
+- *Type:* boolean
+
+---
+
+##### `source`<sup>Optional</sup> <a name="source" id="awscdk-construct-mediaconnect-flow.LiveFeedFromFileProps.property.source"></a>
+
+```typescript
+public readonly source: LiveSourceSpec;
+```
+
+- *Type:* <a href="#awscdk-construct-mediaconnect-flow.LiveSourceSpec">LiveSourceSpec</a>
+
+---
+
+##### `vpcConfig`<sup>Optional</sup> <a name="vpcConfig" id="awscdk-construct-mediaconnect-flow.LiveFeedFromFileProps.property.vpcConfig"></a>
+
+```typescript
+public readonly vpcConfig: VpcConfig;
+```
+
+- *Type:* <a href="#awscdk-construct-mediaconnect-flow.VpcConfig">VpcConfig</a>
+
+---
+
+### LiveSourceSpec <a name="LiveSourceSpec" id="awscdk-construct-mediaconnect-flow.LiveSourceSpec"></a>
+
+#### Initializer <a name="Initializer" id="awscdk-construct-mediaconnect-flow.LiveSourceSpec.Initializer"></a>
+
+```typescript
+import { LiveSourceSpec } from 'awscdk-construct-mediaconnect-flow'
+
+const liveSourceSpec: LiveSourceSpec = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveSourceSpec.property.protocol">protocol</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveSourceSpec.property.type">type</a></code> | <code>string</code> | *No description.* |
+
+---
+
+##### `protocol`<sup>Required</sup> <a name="protocol" id="awscdk-construct-mediaconnect-flow.LiveSourceSpec.property.protocol"></a>
+
+```typescript
+public readonly protocol: string;
+```
+
+- *Type:* string
+
+---
+
+##### `type`<sup>Required</sup> <a name="type" id="awscdk-construct-mediaconnect-flow.LiveSourceSpec.property.type"></a>
+
+```typescript
+public readonly type: string;
+```
+
+- *Type:* string
+
+---
+
+### VpcConfig <a name="VpcConfig" id="awscdk-construct-mediaconnect-flow.VpcConfig"></a>
+
+#### Initializer <a name="Initializer" id="awscdk-construct-mediaconnect-flow.VpcConfig.Initializer"></a>
+
+```typescript
+import { VpcConfig } from 'awscdk-construct-mediaconnect-flow'
+
+const vpcConfig: VpcConfig = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#awscdk-construct-mediaconnect-flow.VpcConfig.property.props">props</a></code> | <code>aws-cdk-lib.aws_ec2.VpcProps</code> | *No description.* |
+| <code><a href="#awscdk-construct-mediaconnect-flow.VpcConfig.property.availabilityZone">availabilityZone</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#awscdk-construct-mediaconnect-flow.VpcConfig.property.enableNDI">enableNDI</a></code> | <code>boolean</code> | *No description.* |
+| <code><a href="#awscdk-construct-mediaconnect-flow.VpcConfig.property.subnetId">subnetId</a></code> | <code>string</code> | *No description.* |
+
+---
+
+##### `props`<sup>Required</sup> <a name="props" id="awscdk-construct-mediaconnect-flow.VpcConfig.property.props"></a>
+
+```typescript
+public readonly props: VpcProps;
+```
+
+- *Type:* aws-cdk-lib.aws_ec2.VpcProps
+
+---
+
+##### `availabilityZone`<sup>Optional</sup> <a name="availabilityZone" id="awscdk-construct-mediaconnect-flow.VpcConfig.property.availabilityZone"></a>
+
+```typescript
+public readonly availabilityZone: string;
+```
+
+- *Type:* string
+
+---
+
+##### `enableNDI`<sup>Optional</sup> <a name="enableNDI" id="awscdk-construct-mediaconnect-flow.VpcConfig.property.enableNDI"></a>
+
+```typescript
+public readonly enableNDI: boolean;
+```
+
+- *Type:* boolean
+
+---
+
+##### `subnetId`<sup>Optional</sup> <a name="subnetId" id="awscdk-construct-mediaconnect-flow.VpcConfig.property.subnetId"></a>
+
+```typescript
+public readonly subnetId: string;
+```
+
+- *Type:* string
+
+---
+
+
+

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2025 Kuu Miyazaki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,75 @@
+# awscdk-construct-mediaconnect-flow
+[![View on Construct Hub](https://constructs.dev/badge?package=awscdk-construct-mediaconnect-flow)](https://constructs.dev/packages/awscdk-construct-mediaconnect-flow)
+
+CDK Construct for creating MediaConnect flow using a file as a source
+* The file can be either MP4 or TS
+* MediaLive channel will be created internally for producing a live source (SRT or RTP) of the loop playback of the file
+* MediaConnect flow will be returned so you can freely add outputs to it
+
+## Install
+[![NPM](https://nodei.co/npm/awscdk-construct-mediaconnect-flow.png?mini=true)](https://nodei.co/npm/awscdk-construct-mediaconnect-flow/)
+
+## Usage
+
+### Sample code
+Here's an example of setting up a MediaConnect flow using an MP4 file in your S3 bucket as a source.
+The source can be VPC-SOURCE or STANRDAR-SOURCE. A separate VPC will be created internally if you specify vpcConfig.
+2 outputs are created, a VPC output for NDI protocol and a Standard output for SRT-Listener protocol.
+
+```ts
+import * as cdk from 'aws-cdk-lib';
+import { Construct } from 'constructs';
+import { LiveFeedFromFile } from 'awscdk-construct-mediaconnect-flow';
+
+export class ExampleStack extends cdk.Stack {
+  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
+    super(scope, id, props);
+
+    const {flow, vpc} = new LiveFeedFromFile(this, 'MediaConnectFlow', {
+      file: {
+        type: 'MP4_FILE',
+        url: 's3://bucket/test.mp4',
+      },
+      source: {
+        protocol: 'SRT',
+        type: 'VPC-SOURCE',
+      },
+      vpcConfig: {
+        props: {
+          ipAddresses: ec2.IpAddresses.cidr('10.0.0.0/16'),
+          flowLogs: {
+            'video-flow-logs': {
+              destination: ec2.FlowLogDestination.toCloudWatchLogs(),
+            },
+          },
+        },
+        enableNDI: true,
+      },
+    });
+
+    if (vpc) {
+      // Create a VPC output
+      new CfnFlowOutput(this, 'VpcOutput', {
+        flowArn: flow.attrFlowArn,
+        name: 'vpc-output',
+        protocol: 'ndi-speed-hq',
+        ndiSpeedHqQuality: 100,
+      });
+    }
+    // Create a Standard output
+    new CfnFlowOutput(this, 'StandardOutput', {
+      flowArn: flow.attrFlowArn,
+      name: 'standard-output',
+      protocol: 'srt-listener',
+      destination,
+    });
+
+    // Access MediaConnect flow attributes via `flow`
+    new cdk.CfnOutput(this, "MediaConnectFlow", {
+      value: flow.attrFlowArn,
+      exportName: cdk.Aws.STACK_NAME + "MediaConnectFlow",
+      description: "MediaConnect Flow ARN",
+    });
+  }
+}
+```

package/lib/LiveFeedFromFile.d.ts

@@ -0,0 +1,29 @@
+import * as ec2 from 'aws-cdk-lib/aws-ec2';
+import { CfnFlow } from 'aws-cdk-lib/aws-mediaconnect';
+import { Construct } from 'constructs';
+export interface FileSpec {
+    readonly type?: 'MP4_FILE' | 'TS_FILE';
+    readonly url: string;
+}
+export interface LiveSourceSpec {
+    readonly protocol: 'RTP' | 'RTP-FEC' | 'SRT';
+    readonly type: 'STANDARD-SOURCE' | 'VPC-SOURCE';
+}
+export interface VpcConfig {
+    readonly props: ec2.VpcProps;
+    readonly availabilityZone?: string;
+    readonly subnetId?: string;
+    readonly enableNDI?: boolean;
+}
+export interface LiveFeedFromFileProps {
+    readonly file: FileSpec;
+    readonly source?: LiveSourceSpec;
+    readonly vpcConfig?: VpcConfig;
+    readonly autoStart?: boolean;
+}
+export declare class LiveFeedFromFile extends Construct {
+    readonly flow: CfnFlow;
+    readonly vpc?: ec2.IVpc;
+    constructor(scope: Construct, id: string, props: LiveFeedFromFileProps);
+}
+export declare function startFlow(scope: Construct, id: string, flowArn: string): Date;