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

Experimental

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

IRouterOutput Interface

Interface for Router Output.

IRouterOutput

extends

• IResource,
• IRouterOutputRef

implemented by

• RouterOutput

Stability

Experimental

Source

lib/router-output.ts

Properties

createdAt?may be undefinedstringcreated_at?may be undefinedstrcreatedAt?may be undefinedStringCreatedAt?may be undefinedstringCreatedAt?may be undefined*string#

The timestamp when the router output was created.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

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*string#

The IP address of the router output.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

routerOutputArnstringrouter_output_arnstrrouterOutputArnStringRouterOutputArnstringRouterOutputArn*string#

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

routerOutputIdstringrouter_output_idstrrouterOutputIdStringRouterOutputIdstringRouterOutputId*string#

The unique identifier of the router output.

routerOutputNamestringrouter_output_namestrrouterOutputNameStringRouterOutputNamestringRouterOutputName*string#

The name of the router output.

routerOutputRefRouterOutputReferencerouter_output_refRouterOutputReferencerouterOutputRefRouterOutputReferenceRouterOutputRefRouterOutputReferenceRouterOutputRefRouterOutputReference#

A reference to a RouterOutput resource.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

updatedAt?may be undefinedstringupdated_at?may be undefinedstrupdatedAt?may be undefinedStringUpdatedAt?may be undefinedstringUpdatedAt?may be undefined*string#

The timestamp when the router output was last updated.

Methods

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

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.

Router output metrics are dimensioned by RouterOutputARN. See the MediaConnect documentation for available metric names (e.g. RouterOutputBitRate, RouterOutputTotalPackets).

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 automatic repeat request (ARQ).

Applies to RIST and SRT outputs only.

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.

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.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining