class FlowOutput (construct)
| Language | Type name |
|---|---|
.NET | Amazon.CDK.AWS.MediaConnect.Alpha.FlowOutput |
Go | github.com/aws/aws-cdk-go/awsmediaconnectalpha/v2#FlowOutput |
Java | software.amazon.awscdk.services.mediaconnect.alpha.FlowOutput |
Python | aws_cdk.aws_mediaconnect_alpha.FlowOutput |
TypeScript (source) | @aws-cdk/aws-mediaconnect-alpha ยป FlowOutput |
Implements
IConstruct, IDependable, IResource, IEnvironment, IFlow, IFlow
Resource defines the destination address, protocol, and port that AWS Elemental MediaConnect sends the ingested video to.
Example
declare const stack: Stack;
declare const flow: Flow;
declare const role: iam.IRole;
declare const secret: secretsmanager.ISecret;
// SRT Caller output with encryption
const output = new FlowOutput(stack, 'EncryptedOutput', {
flow: flow,
description: 'Encrypted SRT output',
output: OutputConfiguration.srtCaller({
destination: '203.0.113.100',
port: 7000,
encryption: { role, secret },
}),
});
Initializer
new FlowOutput(scope: Construct, id: string, props: FlowOutputProps)
Parameters
- scope
Construct - id
string - props
FlowOutput Props
Construct Props
| Name | Type | Description |
|---|---|---|
| flow | IFlow | The flow this output is attached to. |
| output | Output | Output configuration. |
| description? | string | A description of the output. |
| flow | string | The name of the output. |
| output | State | An indication of whether the output should transmit data or not. |
flow
Type:
IFlow
The flow this output is attached to.
output
Type:
Output
Output configuration.
description?
Type:
string
(optional, default: no description)
A description of the output.
This description appears only on the MediaConnect console and will not be seen by the end user.
flowOutputName?
Type:
string
(optional, default: auto-generated)
The name of the output.
outputStatus?
Type:
State
(optional, default: undefined; when omitted, MediaConnect enables the output (ENABLED) at deploy time)
An indication of whether the output should transmit data or not.
Properties
| Name | Type | Description |
|---|---|---|
| env | Resource | The environment this resource belongs to. |
| flow | string | The Amazon Resource Name (ARN) of the flow output. |
| flow | Flow | A reference to a FlowOutput resource. |
| node | Node | The tree node. |
| stack | Stack | The stack in which this resource is defined. |
| static PROPERTY_INJECTION_ID | string | Uniquely identifies this class. |
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed in a Stack (those created by
creating new class instances like new Role(), new Bucket(), etc.), this
is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like
Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be
different than the stack they were imported into.
flowOutputArn
Type:
string
The Amazon Resource Name (ARN) of the flow output.
flowOutputRef
Type:
Flow
A reference to a FlowOutput resource.
node
Type:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
static PROPERTY_INJECTION_ID
Type:
string
Uniquely identifies this class.
Methods
| Name | Description |
|---|---|
| apply | Override the cross-stack reference strength for this resource. |
| apply | Apply the given removal policy to this resource. |
| to | Returns a string representation of this construct. |
| with(...mixins) | Applies one or more mixins to this construct. |
| static from | Creates a Flow Ouput construct that represents an external (imported) Flow Output. |
applyCrossStackReferenceStrength(strength)
public applyCrossStackReferenceStrength(strength: ReferenceStrength): void
Parameters
- strength
Referenceโ - The reference strength to use for this resource.Strength
Override the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified
mechanism instead of the global default determined by the
@aws-cdk/core:defaultCrossStackReferences context key. This is useful for
selectively weakening specific references to avoid the "deadly embrace" problem
without changing the app-wide default.
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
RemovalPolicy
Apply the given removal policy to this resource.
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).
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
with(...mixins)
public with(...mixins: IMixin[]): IConstruct
Parameters
- mixins
IMixin
Returns
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
static fromFlowOutputArn(scope, id, flowOutputArn)
public static fromFlowOutputArn(scope: Construct, id: string, flowOutputArn: string): IFlowOutput
Parameters
- scope
Construct - id
string - flowOutputArn
string
Returns
Creates a Flow Ouput construct that represents an external (imported) Flow Output.

.NET
Go
Java
Python
TypeScript (