Skip to content
v2.275.0

Experimental

@aws-cdk/aws-mediaconnect-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

FlowAttributes Struct ​

Attributes for importing an existing Flow.

Example ​

ts
// 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';
const flowAttributes: mediaconnect_alpha.FlowAttributes = {
  flowArn: 'flowArn',

  // the properties below are optional
  egressIp: 'egressIp',
  flowAvailabilityZone: 'flowAvailabilityZone',
  isFailoverEnabled: false,
  sourceArn: 'sourceArn',
  sourceIngestIp: 'sourceIngestIp',
  sourceIngestPort: 'sourceIngestPort',
};

Properties ​

egressIpoptionalstringegress_ipoptionalstregressIpoptionalStringEgressIpoptionalstringEgressIpoptional*string#
The IP address that the flow uses to send outbound content.

Default: accessing egressIp on the imported flow throws; only provide when available.

flowArnstringflow_arnstrflowArnStringFlowArnstringFlowArn*stringrequired#
The ARN of the flow.
flowAvailabilityZoneoptionalstringflow_availability_zoneoptionalstrflowAvailabilityZoneoptionalStringFlowAvailabilityZoneoptionalstringFlowAvailabilityZoneoptional*string#
The Availability Zone that the flow was created in.

Default: flowAvailabilityZone is undefined on the imported flow.

isFailoverEnabledoptionalbooleanis_failover_enabledoptionalboolisFailoverEnabledoptionalBooleanIsFailoverEnabledoptionalboolIsFailoverEnabledoptional*bool= false#
Indicates whether failover configured.
sourceArnoptionalstringsource_arnoptionalstrsourceArnoptionalStringSourceArnoptionalstringSourceArnoptional*string#
ARN of the source defined on the flow.

Default: sourceArn is not available on the imported construct

Not encoded in the flow ARN, so must be provided explicitly when you need access to sourceArn on the imported construct.

sourceIngestIpoptionalstringsource_ingest_ipoptionalstrsourceIngestIpoptionalStringSourceIngestIpoptionalstringSourceIngestIpoptional*string#
The IP address that the flow listens on for incoming content.

Default: accessing sourceIngestIp on the imported flow throws; only provide when available.

sourceIngestPortoptionalstringsource_ingest_portoptionalstrsourceIngestPortoptionalStringSourceIngestPortoptionalstringSourceIngestPortoptional*string#
The port that the flow listens on for incoming content.

Default: accessing sourceIngestPort on the imported flow throws; only provide when available.