Package software.amazon.awscdk.services.mediaconnect

Interface CfnFlow.NdiConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlow.NdiConfigProperty.Jsii$Proxy

Enclosing class:

CfnFlow

@Stability(Stable)
public static interface CfnFlow.NdiConfigProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the configuration settings for NDI outputs.

Required when the flow includes NDI outputs.

Example:

 // 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.*;
 NdiConfigProperty ndiConfigProperty = NdiConfigProperty.builder()
         .machineName("machineName")
         .ndiDiscoveryServers(List.of(NdiDiscoveryServerConfigProperty.builder()
                 .discoveryServerAddress("discoveryServerAddress")
                 .vpcInterfaceAdapter("vpcInterfaceAdapter")
                 // the properties below are optional
                 .discoveryServerPort(123)
                 .build()))
         .ndiState("ndiState")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-ndiconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFlow.NdiConfigProperty.Builder	A builder for CfnFlow.NdiConfigProperty
static final class	CfnFlow.NdiConfigProperty.Jsii$Proxy	An implementation for CfnFlow.NdiConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnFlow.NdiConfigProperty.Builder	builder()
default String	getMachineName()	A prefix for the names of the NDI sources that the flow creates.
default Object	getNdiDiscoveryServers()	A list of up to three NDI discovery server configurations.
default String	getNdiState()	A setting that controls whether NDI outputs can be used in the flow.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMachineName

@Stability(Stable)
@Nullable
default String getMachineName()

A prefix for the names of the NDI sources that the flow creates.

If a custom name isn't specified, MediaConnect generates a unique 12-character ID as the prefix.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-ndiconfig.html#cfn-mediaconnect-flow-ndiconfig-machinename

getNdiDiscoveryServers

@Stability(Stable)
@Nullable
default Object getNdiDiscoveryServers()

A list of up to three NDI discovery server configurations.

While not required by the API, this configuration is necessary for NDI functionality to work properly.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnFlow.NdiDiscoveryServerConfigProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-ndiconfig.html#cfn-mediaconnect-flow-ndiconfig-ndidiscoveryservers

getNdiState

@Stability(Stable)
@Nullable
default String getNdiState()

A setting that controls whether NDI outputs can be used in the flow.

Must be ENABLED to add NDI outputs. Default is DISABLED.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-ndiconfig.html#cfn-mediaconnect-flow-ndiconfig-ndistate

builder

@Stability(Stable)
static CfnFlow.NdiConfigProperty.Builder builder()

Returns:

a CfnFlow.NdiConfigProperty.Builder of CfnFlow.NdiConfigProperty