Package software.amazon.awscdk.services.mediatailor

Interface CfnFunction.SequentialExecutorConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFunction.SequentialExecutorConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnFunction

@Stability(Stable)
public static interface CfnFunction.SequentialExecutorConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The configuration for a SEQUENTIAL_EXECUTOR function.

A SEQUENTIAL_EXECUTOR runs an ordered list of child functions one at a time, passing data between them. For more information about functions, see Working with functions (https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions.html) in the MediaTailor User Guide.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.mediatailor.*;
 SequentialExecutorConfigurationProperty sequentialExecutorConfigurationProperty = SequentialExecutorConfigurationProperty.builder()
         .functionList(List.of(FunctionRefProperty.builder()
                 .alias("alias")
                 .functionId("functionId")
                 .runCondition("runCondition")
                 .build()))
         .runtime("runtime")
         .timeoutMilliseconds(123)
         // the properties below are optional
         .output(Map.of(
                 "outputKey", "output"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-sequentialexecutorconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFunction.SequentialExecutorConfigurationProperty.Builder	A builder for CfnFunction.SequentialExecutorConfigurationProperty
static final class	CfnFunction.SequentialExecutorConfigurationProperty.Jsii$Proxy	An implementation for CfnFunction.SequentialExecutorConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnFunction.SequentialExecutorConfigurationProperty.Builder	builder()
Object	getFunctionList()	An ordered list of 1 to 10 steps.
default Object	getOutput()	A map of output bindings that controls which bindings the sequence commits to the session state after all steps complete.
String	getRuntime()	The expression language used to evaluate expressions in the function configuration.
Number	getTimeoutMilliseconds()	The maximum time, in milliseconds, for the entire sequence to complete.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFunctionList

@Stability(Stable)
@NotNull
Object getFunctionList()

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 the steps in order, passing data between steps through temporary data. Each step's resolved namespace must be unique across the list.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnFunction.FunctionRefProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-sequentialexecutorconfiguration.html#cfn-mediatailor-function-sequentialexecutorconfiguration-functionlist

getRuntime

@Stability(Stable)
@NotNull
String getRuntime()

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

Set this to JSONATA.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-sequentialexecutorconfiguration.html#cfn-mediatailor-function-sequentialexecutorconfiguration-runtime

getTimeoutMilliseconds

@Stability(Stable)
@NotNull
Number getTimeoutMilliseconds()

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. Valid values are 100 to 2000.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-sequentialexecutorconfiguration.html#cfn-mediatailor-function-sequentialexecutorconfiguration-timeoutmilliseconds

getOutput

@Stability(Stable)
@Nullable
default Object getOutput()

A map of output bindings that controls which bindings the sequence commits to the session state after all steps complete.

Each key is a namespaced output path, and each value is an expression that MediaTailor evaluates against the accumulated results of the steps.

Returns union: either IResolvable or Mapinvalid input: '<'String, String>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-sequentialexecutorconfiguration.html#cfn-mediatailor-function-sequentialexecutorconfiguration-output

builder

@Stability(Stable)
static CfnFunction.SequentialExecutorConfigurationProperty.Builder builder()

Returns:

a CfnFunction.SequentialExecutorConfigurationProperty.Builder of CfnFunction.SequentialExecutorConfigurationProperty