FlowSource

class aws_cdk.aws_mediaconnect_alpha.FlowSource(scope, id, *, flow, source)

Bases: Resource

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

Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

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

Parameters:

scope (Construct)
id (str)
flow (IFlow) – (experimental) The flow this source is connected to. The flow must have Failover enabled to add an additional source.
source (SourceConfiguration) – (experimental) Additional Source Configuration. Set the source’s name via name on the configuration (e.g. SourceConfiguration.rtp({ name })). When no name is set there, one is generated from construct naming.

Stability:

experimental

Methods

apply_cross_stack_reference_strength(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.

Parameters:

strength (ReferenceStrength) –

The reference strength to use for this resource.

Return type:

None

apply_removal_policy(policy)

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

Parameters:: policy (RemovalPolicy)
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str

with_(*mixins)

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.

Parameters:: mixins (IMixin)
Return type:: IConstruct

Attributes

PROPERTY_INJECTION_ID = '@aws-cdk.aws-mediaconnect-alpha.FlowSource'

env

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.

flow_source_arn

(experimental) The Amazon Resource Name (ARN) of the flow source.

Stability:: experimental

flow_source_name

(experimental) The name of the flow source.

Stability:: experimental

flow_source_ref

(experimental) A reference to a FlowSource resource.

Stability:: experimental

ingest_ip

(experimental) The IP address that the flow will be listening on for incoming content.

Stability:: experimental

node: The tree node.

source_ingest_port

(experimental) The port that the flow will be listening on for incoming content.

Stability:: experimental

stack: The stack in which this resource is defined.

Static Methods

classmethod from_flow_source_arn(scope, id, flow_source_arn)

(experimental) Import an existing Flow Source from its ARN.

Parameters:

scope (Construct) – The parent construct.
id (str) – The construct id.
flow_source_arn (str) – The ARN of the Flow Source.

Return type:

IFlowSource

Returns:

A Flow Source construct

Stability:

experimental

classmethod from_flow_source_attributes(scope, id, *, flow_source_arn, flow_source_name=None, ingest_ip=None, source_ingest_port=None)

(experimental) Import an existing Flow Source from its attributes.

Provide ingestIp and/or sourceIngestPort when importing a source that was deployed externally — otherwise accessing those properties on the imported construct will throw.

Parameters:

scope (Construct) – The parent construct.
id (str) – The construct id.
flow_source_arn (str) – (experimental) The Amazon Resource Name (ARN) of the flow source.
flow_source_name (Optional[str]) – (experimental) The name of the flow source. Default: - accessing flowSourceName on the imported source throws; only provide when available.
ingest_ip (Optional[str]) – (experimental) The IP address that the flow will be listening on for incoming content. Default: - accessing ingestIp on the imported source throws; only provide when available.
source_ingest_port (Optional[str]) – (experimental) The port that the flow will be listening on for incoming content. Default: - accessing sourceIngestPort on the imported source throws; only provide when available.

Return type:

IFlowSource

Returns:

A Flow Source construct

Stability:

experimental

classmethod is_construct(x)

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.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:: construct (IConstruct)
Return type:: bool