interface FunctionRefProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.MediaTailor.CfnFunction.FunctionRefProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsmediatailor#CfnFunction_FunctionRefProperty |
 Java | software.amazon.awscdk.services.mediatailor.CfnFunction.FunctionRefProperty |
 Python | aws_cdk.aws_mediatailor.CfnFunction.FunctionRefProperty |
 TypeScript | aws-cdk-lib » aws_mediatailor » CfnFunction » FunctionRefProperty |
A reference to a child function within an executor function.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediatailor as mediatailor } from 'aws-cdk-lib';
const functionRefProperty: mediatailor.CfnFunction.FunctionRefProperty = {
alias: 'alias',
functionId: 'functionId',
runCondition: 'runCondition',
};
Properties
| Name | Type | Description |
|---|---|---|
| alias? | string | An optional alternate name for the child function within the executor. |
| function | string | The identifier of the child function to execute. |
| run | string | An optional expression that evaluates to a boolean. |
alias?
Type:
string
(optional)
An optional alternate name for the child function within the executor.
MediaTailor uses this value as the namespace for the child function's output. If omitted, MediaTailor uses the function identifier. The resolved namespace must be unique across all child functions in the list.
functionId?
Type:
string
(optional)
The identifier of the child function to execute.
runCondition?
Type:
string
(optional)
An optional expression that evaluates to a boolean.
MediaTailor evaluates this expression immediately before running the child function, using the accumulated state at that point. If the expression evaluates to false, MediaTailor skips the child function. If omitted, the child function always runs.