Experimental

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

RouterOutput L2 construct

Defines an AWS Elemental MediaConnect Router Output.

Stability: Experimental
Source: lib/router-output.ts

Example

declare const stack: Stack;
declare const networkInterface: RouterNetworkInterface;

const output = new RouterOutput(stack, 'SrtOutput', {
  routerOutputName: 'srt-output',
  maximumBitrate: Bitrate.mbps(10),
  routingScope: RoutingScope.REGIONAL,
  // tier defaults to RouterOutputTier.OUTPUT_20 (lowest cost)
  configuration: RouterOutputConfiguration.standard({
    protocol: RouterOutputProtocol.srtListener({
      port: 9001,
      minimumLatency: Duration.millis(200),
    }),
    networkInterface: networkInterface,
  }),
});

python

# stack: Stack
# network_interface: RouterNetworkInterface


output = RouterOutput(stack, "SrtOutput",
    router_output_name="srt-output",
    maximum_bitrate=Bitrate.mbps(10),
    routing_scope=RoutingScope.REGIONAL,
    # tier defaults to RouterOutputTier.OUTPUT_20 (lowest cost)
    configuration=RouterOutputConfiguration.standard(
        protocol=RouterOutputProtocol.srt_listener(
            port=9001,
            minimum_latency=Duration.millis(200)
        ),
        network_interface=network_interface
    )
)

java

Stack stack;
RouterNetworkInterface networkInterface;


RouterOutput output = RouterOutput.Builder.create(stack, "SrtOutput")
        .routerOutputName("srt-output")
        .maximumBitrate(Bitrate.mbps(10))
        .routingScope(RoutingScope.REGIONAL)
        // tier defaults to RouterOutputTier.OUTPUT_20 (lowest cost)
        .configuration(RouterOutputConfiguration.standard(StandardOutputConfigurationProps.builder()
                .protocol(RouterOutputProtocol.srtListener(SrtListenerOutputProtocolProps.builder()
                        .port(9001)
                        .minimumLatency(Duration.millis(200))
                        .build()))
                .networkInterface(networkInterface)
                .build()))
        .build();

csharp

// Install: dotnet add package Amazon.CDK.AWS.MediaConnect.Alpha
Stack stack;
RouterNetworkInterface networkInterface;


var output = new RouterOutput(stack, "SrtOutput", new RouterOutputProps {
    RouterOutputName = "srt-output",
    MaximumBitrate = Bitrate.Mbps(10),
    RoutingScope = RoutingScope.REGIONAL,
    // tier defaults to RouterOutputTier.OUTPUT_20 (lowest cost)
    Configuration = RouterOutputConfiguration.Standard(new StandardOutputConfigurationProps {
        Protocol = RouterOutputProtocol.SrtListener(new SrtListenerOutputProtocolProps {
            Port = 9001,
            MinimumLatency = Duration.Millis(200)
        }),
        NetworkInterface = networkInterface
    })
});

// Install: go get github.com/aws/aws-cdk-go/awsmediaconnectalpha/v2
var stack Stack
var networkInterface RouterNetworkInterface


output := awsmediaconnectalpha.NewRouterOutput(stack, jsii.String("SrtOutput"), &RouterOutputProps{
	RouterOutputName: jsii.String("srt-output"),
	MaximumBitrate: awscdk.Bitrate_Mbps(jsii.Number(10)),
	RoutingScope: awsmediaconnectalpha.RoutingScope_REGIONAL(),
	// tier defaults to RouterOutputTier.OUTPUT_20 (lowest cost)
	Configuration: awsmediaconnectalpha.RouterOutputConfiguration_Standard(&StandardOutputConfigurationProps{
		Protocol: awsmediaconnectalpha.RouterOutputProtocol_SrtListener(&SrtListenerOutputProtocolProps{
			Port: jsii.Number(9001),
			MinimumLatency: awscdk.Duration_Millis(jsii.Number(200)),
		}),
		NetworkInterface: networkInterface,
	}),
})

Initializer

new RouterOutput(scope: Construct, id: string, props: RouterOutputProps)

python

RouterOutput(scope: Construct, id: str, props: RouterOutputProps)

java

new RouterOutput(Construct scope, String id, RouterOutputProps props)

csharp

new RouterOutput(Construct scope, string id, RouterOutputProps props)

NewRouterOutput(Scope Construct, Id *string, Props RouterOutputProps)

Construct Props

configurationRouterOutputConfigurationconfigurationRouterOutputConfigurationconfigurationRouterOutputConfigurationConfigurationRouterOutputConfigurationConfigurationRouterOutputConfigurationrequired#

Configuration for the Router Output (standard, MediaConnect Flow, or MediaLive).

maintenanceConfigurationoptionalMaintenanceConfigurationmaintenance_configurationoptionalMaintenanceConfigurationmaintenanceConfigurationoptionalMaintenanceConfigurationMaintenanceConfigurationoptionalMaintenanceConfigurationMaintenanceConfigurationoptionalMaintenanceConfiguration#

Maintenance window configuration.

Default: Default maintenance window will be used

maximumBitrateBitratemaximum_bitrateBitratemaximumBitrateBitrateMaximumBitrateBitrateMaximumBitrateBitraterequired#

The maximum bitrate for the router output.

Must fall within the limits of the selected tier.

regionNameoptionalstringregion_nameoptionalstrregionNameoptionalStringRegionNameoptionalstringRegionNameoptional*string#

The AWS Region where the router output is located.

Default: Defaults to the same region as stack

routerOutputNameoptionalstringrouter_output_nameoptionalstrrouterOutputNameoptionalStringRouterOutputNameoptionalstringRouterOutputNameoptional*string#

Name of the Router Output.

Default: Generated automatically

routingScopeRoutingScoperouting_scopeRoutingScoperoutingScopeRoutingScopeRoutingScopeRoutingScopeRoutingScopeRoutingScoperequired#

Indicates whether the router output is configured for Regional or global routing.

tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#

Tags to add to the Router Output.

Default: No tagging

tieroptionalRouterOutputTiertieroptionalRouterOutputTiertieroptionalRouterOutputTierTieroptionalRouterOutputTierTieroptionalRouterOutputTier= RouterOutputTier.OUTPUT_20#

Tier for this output.

The tier determines the capacity limits, performance characteristics, and associated costs; maximumBitrate must fall within its limits.

Properties

createdAtmay be undefinedstringcreated_atmay be undefinedstrcreatedAtmay be undefinedStringCreatedAtmay be undefinedstringCreatedAtmay be undefined*string#

The timestamp when the router output was created.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

The environment this resource belongs to.

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.

ipAddressstringip_addressstripAddressStringIpAddressstringIpAddress*stringrequired#

The IP address of the router output.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#

Uniquely identifies this class.

routerOutputArnstringrouter_output_arnstrrouterOutputArnStringRouterOutputArnstringRouterOutputArn*stringrequired#

The Amazon Resource Name (ARN) of the router output.

routerOutputIdstringrouter_output_idstrrouterOutputIdStringRouterOutputIdstringRouterOutputId*stringrequired#

The unique identifier of the router output.

routerOutputNamestringrouter_output_namestrrouterOutputNameStringRouterOutputNamestringRouterOutputName*stringrequired#

The name of the router output.

routerOutputRefRouterOutputReferencerouter_output_refRouterOutputReferencerouterOutputRefRouterOutputReferenceRouterOutputRefRouterOutputReferenceRouterOutputRefRouterOutputReferencerequired#

A reference to this Router Output resource.

Required by the auto-generated IRouterOutputRef interface.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

updatedAtmay be undefinedstringupdated_atmay be undefinedstrupdatedAtmay be undefinedStringUpdatedAtmay be undefinedstringUpdatedAtmay be undefined*string#

The timestamp when the router output was last updated.

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

Override the cross-stack reference strength for this resource.

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

Apply the given removal policy to this resource.

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

fromRouterOutputArn(scope: Construct, id: string, routerOutputArn: string): IRouterOutput@staticmethod def from_router_output_arn(scope: Construct, id: str, router_output_arn: str) -> IRouterOutputpublic static IRouterOutput fromRouterOutputArn(Construct scope, String id, String routerOutputArn)public static IRouterOutput FromRouterOutputArn(Construct scope, string id, string routerOutputArn)func FromRouterOutputArn(Scope Construct, Id *string, RouterOutputArn *string) IRouterOutputstatic#

Import an existing Router Output from its ARN.

The ARN only contains the service-generated ID (not the router output name). Accessing routerOutputName on an ARN import throws — use fromRouterOutputAttributes() to provide the name explicitly.

3 parameters · returns

Parameters

scopescopescopescopeScope — The parent construct.
ididididId — The construct id.
routerOutputArnrouter_output_arnrouterOutputArnrouterOutputArnRouterOutputArn — The ARN of the Router Output.

Returns: A Router Output construct

fromRouterOutputAttributes(scope: Construct, id: string, attrs: RouterOutputAttributes): IRouterOutput

@staticmethod def from_router_output_attributes(scope: Construct, id: str, attrs: RouterOutputAttributes) -> IRouterOutput

public static IRouterOutput fromRouterOutputAttributes(Construct scope, String id, RouterOutputAttributes attrs)public static IRouterOutput FromRouterOutputAttributes(Construct scope, string id, RouterOutputAttributes attrs)func FromRouterOutputAttributes(Scope Construct, Id *string, Attrs RouterOutputAttributes) IRouterOutputstatic#

Import an existing Router Output from attributes.

Use this when you need to reference a router output by name.

3 parameters · returns

Parameters

scopescopescopescopeScope — The parent construct.
ididididId — The construct id.
attrsattrsattrsattrsAttrs — The Router Output attributes.

Returns: A Router Output 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#

Checks if `x` is a construct.

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#

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

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#

Check whether the given construct is a Resource.

metric(metricName: string, props?: MetricOptions): Metricdef metric(self, metric_name: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, MetricOptions props)public Metric Metric(string metricName, MetricOptions? props = null)func Metric(MetricName *string, Props MetricOptions) Metric#

Create a CloudWatch metric for this router output.

metricArqRequests(props?: MetricOptions): Metricdef metric_arq_requests(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricArqRequests(MetricOptions props)public Metric MetricArqRequests(MetricOptions? props = null)func MetricArqRequests(Props MetricOptions) Metric#

Metric for the number of retransmitted packets requested through ARQ.

Applies to RIST and SRT outputs.

metricBitrate(props?: MetricOptions): Metricdef metric_bitrate(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricBitrate(MetricOptions props)public Metric MetricBitrate(MetricOptions? props = null)func MetricBitrate(Props MetricOptions) Metric#

Metric for the bitrate of the router output's payload.

metricConnected(props?: MetricOptions): Metricdef metric_connected(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricConnected(MetricOptions props)public Metric MetricConnected(MetricOptions? props = null)func MetricConnected(Props MetricOptions) Metric#

Metric for the router output connection state (1 connected, 0 disconnected).

Applies to SRT outputs only.

metricTotalPackets(props?: MetricOptions): Metricdef metric_total_packets(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricTotalPackets(MetricOptions props)public Metric MetricTotalPackets(MetricOptions? props = null)func MetricTotalPackets(Props MetricOptions) Metric#

Metric for the total number of packets sent by the router output.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

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.

RouterOutput L2 construct ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​

RouterOutput L2 construct

Example

Initializer

Construct Props

Properties

Methods