Experimental
@aws-cdk/aws-mediaconnect-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
FlowSource L2 construct
Adds source to an existing flow.
Adding an additional source requires Failover to be enabled. When you enable Failover, the additional source must use the same protocol as the existing source. A source is the external video content that includes configuration information (encryption and source type) and a network address. Each flow has at least one source. A standard source comes from a source other than another AWS Elemental MediaConnect flow, such as an on-premises encoder.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as mediaconnect_alpha from '@aws-cdk/aws-mediaconnect-alpha';
declare const flow: mediaconnect_alpha.Flow;
declare const sourceConfiguration: mediaconnect_alpha.SourceConfiguration;
const flowSource = new mediaconnect_alpha.FlowSource(this, 'MyFlowSource', {
flow: flow,
source: sourceConfiguration,
});
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_mediaconnect_alpha as mediaconnect_alpha
# flow: mediaconnect_alpha.Flow
# source_configuration: mediaconnect_alpha.SourceConfiguration
flow_source = mediaconnect_alpha.FlowSource(self, "MyFlowSource",
flow=flow,
source=source_configuration
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.mediaconnect.alpha.*;
Flow flow;
SourceConfiguration sourceConfiguration;
FlowSource flowSource = FlowSource.Builder.create(this, "MyFlowSource")
.flow(flow)
.source(sourceConfiguration)
.build();
// Install: dotnet add package Amazon.CDK.AWS.MediaConnect.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MediaConnect.Alpha;
Flow flow;
SourceConfiguration sourceConfiguration;
var flowSource = new FlowSource(this, "MyFlowSource", new FlowSourceProps {
Flow = flow,
Source = sourceConfiguration
});
// Install: go get github.com/aws/aws-cdk-go/awsmediaconnectalpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import mediaconnect_alpha "github.com/aws/aws-cdk-go/awsmediaconnectalpha"
var flow Flow
var sourceConfiguration SourceConfiguration
flowSource := mediaconnect_alpha.NewFlowSource(this, jsii.String("MyFlowSource"), &FlowSourceProps{
Flow: flow,
Source: sourceConfiguration,
})
Initializer
new FlowSource(scope: Construct, id: string, props: FlowSourceProps)
FlowSource(scope: Construct, id: str, props: FlowSourceProps)
new FlowSource(Construct scope, String id, FlowSourceProps props)
new FlowSource(Construct scope, string id, FlowSourceProps props)
NewFlowSource(Scope Construct, Id *string, Props FlowSourceProps)
Construct Props
The flow must have Failover enabled to add an additional source.
sourceSourceConfigurationsourceSourceConfigurationsourceSourceConfigurationSourceSourceConfigurationSourceSourceConfigurationrequired#Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
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.
flowSourceArnstringflow_source_arnstrflowSourceArnStringFlowSourceArnstringFlowSourceArn*stringrequired#flowSourceNamestringflow_source_namestrflowSourceNameStringFlowSourceNamestringFlowSourceName*stringrequired#flowSourceRefFlowSourceReferenceflow_source_refFlowSourceReferenceflowSourceRefFlowSourceReferenceFlowSourceRefFlowSourceReferenceFlowSourceRefFlowSourceReferencerequired#PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#sourceIngestPortstringsource_ingest_portstrsourceIngestPortStringSourceIngestPortstringSourceIngestPort*stringrequired#Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
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.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
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).
fromFlowSourceArn(scope: Construct, id: string, flowSourceArn: string): IFlowSource@staticmethod def from_flow_source_arn(scope: Construct, id: str, flow_source_arn: str) -> IFlowSourcepublic static IFlowSource fromFlowSourceArn(Construct scope, String id, String flowSourceArn)public static IFlowSource FromFlowSourceArn(Construct scope, string id, string flowSourceArn)func FromFlowSourceArn(Scope Construct, Id *string, FlowSourceArn *string) IFlowSourcestatic#3 parameters · returns
Parameters
scopescopescopescopeScope— The parent construct.ididididId— The construct id.flowSourceArnflow_source_arnflowSourceArnflowSourceArnFlowSourceArn— The ARN of the Flow Source.
Returns: A Flow Source construct
fromFlowSourceAttributes(scope: Construct, id: string, attrs: FlowSourceAttributes): IFlowSource@staticmethod def from_flow_source_attributes(scope: Construct, id: str, attrs: FlowSourceAttributes) -> IFlowSourcepublic static IFlowSource fromFlowSourceAttributes(Construct scope, String id, FlowSourceAttributes attrs)public static IFlowSource FromFlowSourceAttributes(Construct scope, string id, FlowSourceAttributes attrs)func FromFlowSourceAttributes(Scope Construct, Id *string, Attrs FlowSourceAttributes) IFlowSourcestatic#Provide ingestIp and/or sourceIngestPort when importing a source that was deployed externally — otherwise accessing those properties on the imported construct will throw.
3 parameters · returns
Parameters
scopescopescopescopeScope— The parent construct.ididididId— The construct id.attrsattrsattrsattrsAttrs— The Flow Source attributes.
Returns: A Flow Source construct
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
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.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#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.