AWS CDK Reference

Appearance

v2.276.0

Experimental

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

RouterInputProps Struct ​

Properties for creating a Router Input.

Stability
Experimental
Source
lib/router-input.ts

Example ​

ts
declare const stack: Stack;
declare const mediaLiveChannel: medialive.IChannel;

const input = new RouterInput(stack, 'ChannelInput', {
  routerInputName: 'channel-input',
  maximumBitrate: Bitrate.mbps(20),
  routingScope: RoutingScope.REGIONAL,
  tier: RouterInputTier.INPUT_20,
  configuration: RouterInputConfiguration.mediaLiveChannel({
    channel: mediaLiveChannel,
    outputName: 'router-ts',
    pipeline: MediaLivePipeline.PIPELINE_0,
  }),
});
python
# stack: Stack
# media_live_channel: medialive.IChannel


input = RouterInput(stack, "ChannelInput",
    router_input_name="channel-input",
    maximum_bitrate=Bitrate.mbps(20),
    routing_scope=RoutingScope.REGIONAL,
    tier=RouterInputTier.INPUT_20,
    configuration=RouterInputConfiguration.media_live_channel(
        channel=media_live_channel,
        output_name="router-ts",
        pipeline=MediaLivePipeline.PIPELINE_0
    )
)
java
Stack stack;
IChannel mediaLiveChannel;


RouterInput input = RouterInput.Builder.create(stack, "ChannelInput")
        .routerInputName("channel-input")
        .maximumBitrate(Bitrate.mbps(20))
        .routingScope(RoutingScope.REGIONAL)
        .tier(RouterInputTier.INPUT_20)
        .configuration(RouterInputConfiguration.mediaLiveChannel(MediaLiveChannelConfigurationProps.builder()
                .channel(mediaLiveChannel)
                .outputName("router-ts")
                .pipeline(MediaLivePipeline.PIPELINE_0)
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.MediaConnect.Alpha
Stack stack;
IChannel mediaLiveChannel;


var input = new RouterInput(stack, "ChannelInput", new RouterInputProps {
    RouterInputName = "channel-input",
    MaximumBitrate = Bitrate.Mbps(20),
    RoutingScope = RoutingScope.REGIONAL,
    Tier = RouterInputTier.INPUT_20,
    Configuration = RouterInputConfiguration.MediaLiveChannel(new MediaLiveChannelConfigurationProps {
        Channel = mediaLiveChannel,
        OutputName = "router-ts",
        Pipeline = MediaLivePipeline.PIPELINE_0
    })
});
go
// Install: go get github.com/aws/aws-cdk-go/awsmediaconnectalpha/v2
var stack Stack
var mediaLiveChannel IChannel


input := awsmediaconnectalpha.NewRouterInput(stack, jsii.String("ChannelInput"), &RouterInputProps{
	RouterInputName: jsii.String("channel-input"),
	MaximumBitrate: awscdk.Bitrate_Mbps(jsii.Number(20)),
	RoutingScope: awsmediaconnectalpha.RoutingScope_REGIONAL(),
	Tier: awsmediaconnectalpha.RouterInputTier_INPUT_20(),
	Configuration: awsmediaconnectalpha.RouterInputConfiguration_MediaLiveChannel(&MediaLiveChannelConfigurationProps{
		Channel: mediaLiveChannel,
		OutputName: jsii.String("router-ts"),
		Pipeline: awsmediaconnectalpha.MediaLivePipeline_PIPELINE_0,
	}),
})

Properties ​

configurationRouterInputConfigurationconfigurationRouterInputConfigurationconfigurationRouterInputConfigurationConfigurationRouterInputConfigurationConfigurationRouterInputConfigurationrequired#
Configuration for the Router Input (standard, failover, merge, or MediaConnect flow).
maintenanceConfigurationoptionalMaintenanceConfigurationmaintenance_configurationoptionalMaintenanceConfigurationmaintenanceConfigurationoptionalMaintenanceConfigurationMaintenanceConfigurationoptionalMaintenanceConfigurationMaintenanceConfigurationoptionalMaintenanceConfiguration#
Maintenance window configuration.

Default: Default maintenance window will be used

maximumBitrateBitratemaximum_bitrateBitratemaximumBitrateBitrateMaximumBitrateBitrateMaximumBitrateBitraterequired#
The maximum bitrate for the router input.

Must fall within the limits of the selected tier.

regionNameoptionalstringregion_nameoptionalstrregionNameoptionalStringRegionNameoptionalstringRegionNameoptional*string#
The AWS Region where the router input is located.

Default: Defaults to the same region as stack

routerInputNameoptionalstringrouter_input_nameoptionalstrrouterInputNameoptionalStringRouterInputNameoptionalstringRouterInputNameoptional*string#
Name of the Router Input.

Default: Generated automatically

routingScopeRoutingScoperouting_scopeRoutingScoperoutingScopeRoutingScopeRoutingScopeRoutingScopeRoutingScopeRoutingScoperequired#
Indicates whether the router input 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 Input.

Default: No tagging

tieroptionalRouterInputTiertieroptionalRouterInputTiertieroptionalRouterInputTierTieroptionalRouterInputTierTieroptionalRouterInputTier= RouterInputTier.INPUT_20#
Tier for this input.

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

transitEncryptionoptionalTransitEncryptiontransit_encryptionoptionalTransitEncryptiontransitEncryptionoptionalTransitEncryptionTransitEncryptionoptionalTransitEncryptionTransitEncryptionoptionalTransitEncryption#
Transit encryption configuration using AWS Secrets Manager.

Default: Automatic encryption will be configured

When provided without a role, a scoped IAM role is automatically created with read access to the secret.