awscdk-construct-mediaconnect-flow 0.0.6 → 0.0.8

package/.jsii

@@ -4064,7 +4064,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/LiveFeedFromFile.ts",
-        "line": 28
+        "line": 24
       },
       "name": "EncoderSettings",
       "properties": [
@@ -4076,7 +4076,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/LiveFeedFromFile.ts",
-            "line": 32
+            "line": 28
           },
           "name": "framerateDenominator",
           "optional": true,
@@ -4092,7 +4092,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/LiveFeedFromFile.ts",
-            "line": 31
+            "line": 27
           },
           "name": "framerateNumerator",
           "optional": true,
@@ -4108,7 +4108,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/LiveFeedFromFile.ts",
-            "line": 29
+            "line": 25
           },
           "name": "gopLengthInSeconds",
           "optional": true,
@@ -4124,7 +4124,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/LiveFeedFromFile.ts",
-            "line": 35
+            "line": 31
           },
           "name": "height",
           "optional": true,
@@ -4140,7 +4140,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/LiveFeedFromFile.ts",
-            "line": 33
+            "line": 29
           },
           "name": "scanType",
           "optional": true,
@@ -4156,7 +4156,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/LiveFeedFromFile.ts",
-            "line": 30
+            "line": 26
           },
           "name": "timecodeBurninPrefix",
           "optional": true,
@@ -4172,7 +4172,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/LiveFeedFromFile.ts",
-            "line": 34
+            "line": 30
           },
           "name": "width",
           "optional": true,
@@ -4193,7 +4193,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/LiveFeedFromFile.ts",
-        "line": 11
+        "line": 19
       },
       "name": "FileSpec",
       "properties": [
@@ -4205,7 +4205,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/LiveFeedFromFile.ts",
-            "line": 13
+            "line": 21
           },
           "name": "url",
           "type": {
@@ -4220,7 +4220,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/LiveFeedFromFile.ts",
-            "line": 12
+            "line": 20
           },
           "name": "type",
           "optional": true,
@@ -4231,6 +4231,96 @@
       ],
       "symbolId": "src/LiveFeedFromFile:FileSpec"
     },
+    "awscdk-construct-mediaconnect-flow.LiveFeed": {
+      "assembly": "awscdk-construct-mediaconnect-flow",
+      "base": "constructs.Construct",
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "awscdk-construct-mediaconnect-flow.LiveFeed",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/LiveFeed.ts",
+          "line": 30
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "type": {
+              "fqn": "awscdk-construct-mediaconnect-flow.LiveFeedProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/LiveFeed.ts",
+        "line": 25
+      },
+      "name": "LiveFeed",
+      "properties": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/LiveFeed.ts",
+            "line": 26
+          },
+          "name": "flow",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_mediaconnect.CfnFlow"
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/LiveFeed.ts",
+            "line": 28
+          },
+          "name": "ndiDiscoveryServer",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.Instance"
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/LiveFeed.ts",
+            "line": 27
+          },
+          "name": "vpc",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.IVpc"
+          }
+        }
+      ],
+      "symbolId": "src/LiveFeed:LiveFeed"
+    },
     "awscdk-construct-mediaconnect-flow.LiveFeedFromFile": {
       "assembly": "awscdk-construct-mediaconnect-flow",
       "base": "constructs.Construct",
@@ -4244,7 +4334,7 @@
         },
         "locationInModule": {
           "filename": "src/LiveFeedFromFile.ts",
-          "line": 55
+          "line": 47
         },
         "parameters": [
           {
@@ -4270,7 +4360,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/LiveFeedFromFile.ts",
-        "line": 50
+        "line": 42
       },
       "name": "LiveFeedFromFile",
       "properties": [
@@ -4281,7 +4371,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/LiveFeedFromFile.ts",
-            "line": 51
+            "line": 43
           },
           "name": "flow",
           "type": {
@@ -4295,7 +4385,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/LiveFeedFromFile.ts",
-            "line": 53
+            "line": 45
           },
           "name": "ndiDiscoveryServer",
           "optional": true,
@@ -4310,7 +4400,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/LiveFeedFromFile.ts",
-            "line": 52
+            "line": 44
           },
           "name": "vpc",
           "optional": true,
@@ -4331,7 +4421,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/LiveFeedFromFile.ts",
-        "line": 38
+        "line": 34
       },
       "name": "LiveFeedFromFileProps",
       "properties": [
@@ -4343,7 +4433,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/LiveFeedFromFile.ts",
-            "line": 39
+            "line": 35
           },
           "name": "file",
           "type": {
@@ -4358,7 +4448,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/LiveFeedFromFile.ts",
-            "line": 43
+            "line": 39
           },
           "name": "autoStart",
           "optional": true,
@@ -4374,7 +4464,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/LiveFeedFromFile.ts",
-            "line": 40
+            "line": 36
           },
           "name": "encoderSpec",
           "optional": true,
@@ -4390,7 +4480,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/LiveFeedFromFile.ts",
-            "line": 41
+            "line": 37
           },
           "name": "source",
           "optional": true,
@@ -4406,7 +4496,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/LiveFeedFromFile.ts",
-            "line": 42
+            "line": 38
           },
           "name": "vpcConfig",
           "optional": true,
@@ -4417,6 +4507,71 @@
       ],
       "symbolId": "src/LiveFeedFromFile:LiveFeedFromFileProps"
     },
+    "awscdk-construct-mediaconnect-flow.LiveFeedProps": {
+      "assembly": "awscdk-construct-mediaconnect-flow",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "awscdk-construct-mediaconnect-flow.LiveFeedProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/LiveFeed.ts",
+        "line": 19
+      },
+      "name": "LiveFeedProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/LiveFeed.ts",
+            "line": 22
+          },
+          "name": "autoStart",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/LiveFeed.ts",
+            "line": 20
+          },
+          "name": "source",
+          "optional": true,
+          "type": {
+            "fqn": "awscdk-construct-mediaconnect-flow.LiveSourceSpec"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/LiveFeed.ts",
+            "line": 21
+          },
+          "name": "vpcConfig",
+          "optional": true,
+          "type": {
+            "fqn": "awscdk-construct-mediaconnect-flow.VpcConfig"
+          }
+        }
+      ],
+      "symbolId": "src/LiveFeed:LiveFeedProps"
+    },
     "awscdk-construct-mediaconnect-flow.LiveSourceSpec": {
       "assembly": "awscdk-construct-mediaconnect-flow",
       "datatype": true,
@@ -4426,8 +4581,8 @@
       "fqn": "awscdk-construct-mediaconnect-flow.LiveSourceSpec",
       "kind": "interface",
       "locationInModule": {
-        "filename": "src/LiveFeedFromFile.ts",
-        "line": 16
+        "filename": "src/util.ts",
+        "line": 7
       },
       "name": "LiveSourceSpec",
       "properties": [
@@ -4438,8 +4593,8 @@
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/LiveFeedFromFile.ts",
-            "line": 17
+            "filename": "src/util.ts",
+            "line": 8
           },
           "name": "protocol",
           "type": {
@@ -4453,8 +4608,8 @@
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/LiveFeedFromFile.ts",
-            "line": 18
+            "filename": "src/util.ts",
+            "line": 9
           },
           "name": "type",
           "type": {
@@ -4462,7 +4617,7 @@
           }
         }
       ],
-      "symbolId": "src/LiveFeedFromFile:LiveSourceSpec"
+      "symbolId": "src/util:LiveSourceSpec"
     },
     "awscdk-construct-mediaconnect-flow.VpcConfig": {
       "assembly": "awscdk-construct-mediaconnect-flow",
@@ -4473,8 +4628,8 @@
       "fqn": "awscdk-construct-mediaconnect-flow.VpcConfig",
       "kind": "interface",
       "locationInModule": {
-        "filename": "src/LiveFeedFromFile.ts",
-        "line": 21
+        "filename": "src/util.ts",
+        "line": 12
       },
       "name": "VpcConfig",
       "properties": [
@@ -4485,8 +4640,8 @@
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/LiveFeedFromFile.ts",
-            "line": 22
+            "filename": "src/util.ts",
+            "line": 13
           },
           "name": "props",
           "type": {
@@ -4500,8 +4655,8 @@
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/LiveFeedFromFile.ts",
-            "line": 23
+            "filename": "src/util.ts",
+            "line": 14
           },
           "name": "availabilityZone",
           "optional": true,
@@ -4516,8 +4671,8 @@
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/LiveFeedFromFile.ts",
-            "line": 25
+            "filename": "src/util.ts",
+            "line": 16
           },
           "name": "enableNDI",
           "optional": true,
@@ -4532,8 +4687,8 @@
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/LiveFeedFromFile.ts",
-            "line": 24
+            "filename": "src/util.ts",
+            "line": 15
           },
           "name": "subnetId",
           "optional": true,
@@ -4542,9 +4697,9 @@
           }
         }
       ],
-      "symbolId": "src/LiveFeedFromFile:VpcConfig"
+      "symbolId": "src/util:VpcConfig"
     }
   },
-  "version": "0.0.6",
-  "fingerprint": "OXI0IGq0nd+p3SGpjxhRRpgkGznJ0fV9jytilIyRWQo="
+  "version": "0.0.8",
+  "fingerprint": "/GzTT9Amm14gKD3/QLOsyHpFtaBB2I8uSBhJplsyL0Y="
 }

package/API.md

@@ -2,6 +2,152 @@
 
 ## Constructs <a name="Constructs" id="Constructs"></a>
 
+### LiveFeed <a name="LiveFeed" id="awscdk-construct-mediaconnect-flow.LiveFeed"></a>
+
+#### Initializers <a name="Initializers" id="awscdk-construct-mediaconnect-flow.LiveFeed.Initializer"></a>
+
+```typescript
+import { LiveFeed } from 'awscdk-construct-mediaconnect-flow'
+
+new LiveFeed(scope: Construct, id: string, props: LiveFeedProps)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeed.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeed.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeed.Initializer.parameter.props">props</a></code> | <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeedProps">LiveFeedProps</a></code> | *No description.* |
+
+---
+
+##### `scope`<sup>Required</sup> <a name="scope" id="awscdk-construct-mediaconnect-flow.LiveFeed.Initializer.parameter.scope"></a>
+
+- *Type:* constructs.Construct
+
+---
+
+##### `id`<sup>Required</sup> <a name="id" id="awscdk-construct-mediaconnect-flow.LiveFeed.Initializer.parameter.id"></a>
+
+- *Type:* string
+
+---
+
+##### `props`<sup>Required</sup> <a name="props" id="awscdk-construct-mediaconnect-flow.LiveFeed.Initializer.parameter.props"></a>
+
+- *Type:* <a href="#awscdk-construct-mediaconnect-flow.LiveFeedProps">LiveFeedProps</a>
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeed.toString">toString</a></code> | Returns a string representation of this construct. |
+
+---
+
+##### `toString` <a name="toString" id="awscdk-construct-mediaconnect-flow.LiveFeed.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.LiveFeed.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
+
+---
+
+##### `isConstruct` <a name="isConstruct" id="awscdk-construct-mediaconnect-flow.LiveFeed.isConstruct"></a>
+
+```typescript
+import { LiveFeed } from 'awscdk-construct-mediaconnect-flow'
+
+LiveFeed.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.LiveFeed.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.LiveFeed.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeed.property.flow">flow</a></code> | <code>aws-cdk-lib.aws_mediaconnect.CfnFlow</code> | *No description.* |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeed.property.ndiDiscoveryServer">ndiDiscoveryServer</a></code> | <code>aws-cdk-lib.aws_ec2.Instance</code> | *No description.* |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeed.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.LiveFeed.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.LiveFeed.property.flow"></a>
+
+```typescript
+public readonly flow: CfnFlow;
+```
+
+- *Type:* aws-cdk-lib.aws_mediaconnect.CfnFlow
+
+---
+
+##### `ndiDiscoveryServer`<sup>Optional</sup> <a name="ndiDiscoveryServer" id="awscdk-construct-mediaconnect-flow.LiveFeed.property.ndiDiscoveryServer"></a>
+
+```typescript
+public readonly ndiDiscoveryServer: Instance;
+```
+
+- *Type:* aws-cdk-lib.aws_ec2.Instance
+
+---
+
+##### `vpc`<sup>Optional</sup> <a name="vpc" id="awscdk-construct-mediaconnect-flow.LiveFeed.property.vpc"></a>
+
+```typescript
+public readonly vpc: IVpc;
+```
+
+- *Type:* aws-cdk-lib.aws_ec2.IVpc
+
+---
+
+
 ### LiveFeedFromFile <a name="LiveFeedFromFile" id="awscdk-construct-mediaconnect-flow.LiveFeedFromFile"></a>
 
 #### Initializers <a name="Initializers" id="awscdk-construct-mediaconnect-flow.LiveFeedFromFile.Initializer"></a>
@@ -355,6 +501,56 @@ public readonly vpcConfig: VpcConfig;
 
 ---
 
+### LiveFeedProps <a name="LiveFeedProps" id="awscdk-construct-mediaconnect-flow.LiveFeedProps"></a>
+
+#### Initializer <a name="Initializer" id="awscdk-construct-mediaconnect-flow.LiveFeedProps.Initializer"></a>
+
+```typescript
+import { LiveFeedProps } from 'awscdk-construct-mediaconnect-flow'
+
+const liveFeedProps: LiveFeedProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeedProps.property.autoStart">autoStart</a></code> | <code>boolean</code> | *No description.* |
+| <code><a href="#awscdk-construct-mediaconnect-flow.LiveFeedProps.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.LiveFeedProps.property.vpcConfig">vpcConfig</a></code> | <code><a href="#awscdk-construct-mediaconnect-flow.VpcConfig">VpcConfig</a></code> | *No description.* |
+
+---
+
+##### `autoStart`<sup>Optional</sup> <a name="autoStart" id="awscdk-construct-mediaconnect-flow.LiveFeedProps.property.autoStart"></a>
+
+```typescript
+public readonly autoStart: boolean;
+```
+
+- *Type:* boolean
+
+---
+
+##### `source`<sup>Optional</sup> <a name="source" id="awscdk-construct-mediaconnect-flow.LiveFeedProps.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.LiveFeedProps.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>

package/lib/LiveFeed.d.ts

@@ -0,0 +1,15 @@
+import * as ec2 from 'aws-cdk-lib/aws-ec2';
+import { CfnFlow } from 'aws-cdk-lib/aws-mediaconnect';
+import { Construct } from 'constructs';
+import { LiveSourceSpec, VpcConfig } from './util';
+export interface LiveFeedProps {
+    readonly source?: LiveSourceSpec;
+    readonly vpcConfig?: VpcConfig;
+    readonly autoStart?: boolean;
+}
+export declare class LiveFeed extends Construct {
+    readonly flow: CfnFlow;
+    readonly vpc?: ec2.IVpc;
+    readonly ndiDiscoveryServer?: ec2.Instance;
+    constructor(scope: Construct, id: string, props: LiveFeedProps);
+}