@aws-cdk/aws-mediaconnect-alpha.FlowAttributes

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.

Stability

Experimental

Source

lib/flow.ts

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

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

# 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_attributes = mediaconnect_alpha.FlowAttributes(
    flow_arn="flowArn",

    # the properties below are optional
    egress_ip="egressIp",
    flow_availability_zone="flowAvailabilityZone",
    is_failover_enabled=False,
    source_arn="sourceArn",
    source_ingest_ip="sourceIngestIp",
    source_ingest_port="sourceIngestPort"
)

// 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.*;

FlowAttributes flowAttributes = FlowAttributes.builder()
        .flowArn("flowArn")

        // the properties below are optional
        .egressIp("egressIp")
        .flowAvailabilityZone("flowAvailabilityZone")
        .isFailoverEnabled(false)
        .sourceArn("sourceArn")
        .sourceIngestIp("sourceIngestIp")
        .sourceIngestPort("sourceIngestPort")
        .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;

var flowAttributes = new FlowAttributes {
    FlowArn = "flowArn",

    // the properties below are optional
    EgressIp = "egressIp",
    FlowAvailabilityZone = "flowAvailabilityZone",
    IsFailoverEnabled = false,
    SourceArn = "sourceArn",
    SourceIngestIp = "sourceIngestIp",
    SourceIngestPort = "sourceIngestPort"
};

// 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"

flowAttributes := &FlowAttributes{
	FlowArn: jsii.String("flowArn"),

	// the properties below are optional
	EgressIp: jsii.String("egressIp"),
	FlowAvailabilityZone: jsii.String("flowAvailabilityZone"),
	IsFailoverEnabled: jsii.Boolean(false),
	SourceArn: jsii.String("sourceArn"),
	SourceIngestIp: jsii.String("sourceIngestIp"),
	SourceIngestPort: jsii.String("sourceIngestPort"),
}

Properties

egressIp?optionalstringegress_ip?optionalstregressIp?optionalStringEgressIp?optionalstringEgressIp?optional*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.

flowAvailabilityZone?optionalstringflow_availability_zone?optionalstrflowAvailabilityZone?optionalStringFlowAvailabilityZone?optionalstringFlowAvailabilityZone?optional*string#

The Availability Zone that the flow was created in.

Default: flowAvailabilityZone is undefined on the imported flow.

isFailoverEnabled?optionalbooleanis_failover_enabled?optionalboolisFailoverEnabled?optionalBooleanIsFailoverEnabled?optionalboolIsFailoverEnabled?optional*bool= false#

Indicates whether failover configured.

sourceArn?optionalstringsource_arn?optionalstrsourceArn?optionalStringSourceArn?optionalstringSourceArn?optional*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.

sourceIngestIp?optionalstringsource_ingest_ip?optionalstrsourceIngestIp?optionalStringSourceIngestIp?optionalstringSourceIngestIp?optional*string#

The IP address that the flow listens on for incoming content.

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

sourceIngestPort?optionalstringsource_ingest_port?optionalstrsourceIngestPort?optionalStringSourceIngestPort?optionalstringSourceIngestPort?optional*string#

The port that the flow listens on for incoming content.

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