View a markdown version of this page

AWS::MediaTailor::Function SequentialExecutorConfiguration - AWS CloudFormation
SyntaxProperties

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::MediaTailor::Function SequentialExecutorConfiguration

The configuration for a SEQUENTIAL_EXECUTOR function. A SEQUENTIAL_EXECUTOR runs a sequence of child functions in order, passing data between steps through temporary data. For more information, see SEQUENTIAL_EXECUTOR in the MediaTailor User Guide.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "FunctionList" : [ FunctionRef, ... ],
  "Output" : {Key: Value, ...},
  "Runtime" : String,
  "TimeoutMilliseconds" : Integer
}

YAML

  FunctionList: 
    - FunctionRef
  Output: 
    Key: Value
  Runtime: String
  TimeoutMilliseconds: Integer

Properties

FunctionList

An ordered list of 1 to 10 steps. Each step specifies a child function to execute and an optional run condition expression that controls whether the step runs. MediaTailor executes steps in order, passing data between steps through temporary data.

Required: Yes

Type: Array of FunctionRef

Update requires: No interruption

Output

An optional map of output bindings that controls which bindings the sequence commits to the session state after all steps complete. If omitted, MediaTailor commits all accumulated output bindings from all child steps.

Required: No

Type: Object of String

Pattern: .*

Update requires: No interruption

Runtime

The expression language used to evaluate expressions in the function configuration. Set this to JSONata.

Required: Yes

Type: String

Allowed values: JSONATA

Update requires: No interruption

TimeoutMilliseconds

The maximum time, in milliseconds, for the entire sequence to complete. This timeout covers all steps, including any HTTP calls made by child functions. If the sequence exceeds this timeout, MediaTailor discards all output from the sequence and proceeds with default behavior.

Required: Yes

Type: Integer

Update requires: No interruption