Package software.amazon.awscdk.cfnpropertymixins.services.mediatailor

Interface CfnFunctionPropsMixin.FunctionRefProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFunctionPropsMixin.FunctionRefProperty.Jsii$Proxy

Enclosing class:

CfnFunctionPropsMixin

@Stability(Stable)
public static interface CfnFunctionPropsMixin.FunctionRefProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.cfnpropertymixins.services.mediatailor.*;
 FunctionRefProperty functionRefProperty = FunctionRefProperty.builder()
         .alias("alias")
         .functionId("functionId")
         .runCondition("runCondition")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFunctionPropsMixin.FunctionRefProperty.Builder	builder()
default String	getAlias()	An optional alternate name for the child function within the executor.
default String	getFunctionId()	The identifier of the child function to execute.
default String	getRunCondition()	An optional expression that evaluates to a boolean.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlias

@Stability(Stable)
@Nullable
default String getAlias()

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.

See Also:

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

getFunctionId

@Stability(Stable)
@Nullable
default String getFunctionId()

The identifier of the child function to execute.

See Also:

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

getRunCondition

@Stability(Stable)
@Nullable
default String getRunCondition()

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.

See Also:

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

builder

@Stability(Stable)
static CfnFunctionPropsMixin.FunctionRefProperty.Builder builder()

Returns:

a CfnFunctionPropsMixin.FunctionRefProperty.Builder of CfnFunctionPropsMixin.FunctionRefProperty