CfnFunctionPropsMixin

class aws_cdk.cfn_property_mixins.aws_mediatailor.CfnFunctionPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::MediaTailor::Function.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html
CloudformationResource:: AWS::MediaTailor::Function
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_function_props_mixin = mediatailor.CfnFunctionPropsMixin(mediatailor.CfnFunctionMixinProps(
    concurrent_executor_configuration=mediatailor.CfnFunctionPropsMixin.ConcurrentExecutorConfigurationProperty(
        function_list=[mediatailor.CfnFunctionPropsMixin.FunctionRefProperty(
            alias="alias",
            function_id="functionId",
            run_condition="runCondition"
        )],
        max_concurrency=123,
        output={
            "output_key": "output"
        },
        runtime="runtime",
        timeout_milliseconds=123
    ),
    custom_output_configuration=mediatailor.CfnFunctionPropsMixin.CustomOutputConfigurationProperty(
        output={
            "output_key": "output"
        },
        runtime="runtime"
    ),
    description="description",
    function_id="functionId",
    function_type="functionType",
    http_request_configuration=mediatailor.CfnFunctionPropsMixin.HttpRequestConfigurationProperty(
        body="body",
        headers={
            "headers_key": "headers"
        },
        method_type="methodType",
        output={
            "output_key": "output"
        },
        request_timeout_milliseconds=123,
        runtime="runtime",
        url="url"
    ),
    sequential_executor_configuration=mediatailor.CfnFunctionPropsMixin.SequentialExecutorConfigurationProperty(
        function_list=[mediatailor.CfnFunctionPropsMixin.FunctionRefProperty(
            alias="alias",
            function_id="functionId",
            run_condition="runCondition"
        )],
        output={
            "output_key": "output"
        },
        runtime="runtime",
        timeout_milliseconds=123
    ),
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::MediaTailor::Function.

Parameters:

props (Union[CfnFunctionMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['concurrentExecutorConfiguration', 'customOutputConfiguration', 'description', 'functionId', 'functionType', 'httpRequestConfiguration', 'sequentialExecutorConfiguration', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

ConcurrentExecutorConfigurationProperty

class CfnFunctionPropsMixin.ConcurrentExecutorConfigurationProperty(*, function_list=None, max_concurrency=None, output=None, runtime=None, timeout_milliseconds=None)

Bases: object

The configuration for a CONCURRENT_EXECUTOR function.

A CONCURRENT_EXECUTOR runs a set of child functions in parallel, up to a maximum concurrency, and combines their output when all functions complete. 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.

Parameters:

function_list (Union[IResolvable, Sequence[Union[IResolvable, FunctionRefProperty, Dict[str, Any]]], None]) – The list of 1 to 10 child functions that MediaTailor runs in parallel. Each entry specifies a child function to execute and an optional run condition expression that controls whether the function runs. Child functions cannot themselves be executors, and each child function’s resolved namespace must be unique across the list.
max_concurrency (Union[int, float, None]) – The maximum number of child functions that MediaTailor runs simultaneously. When the list contains more functions than MaxConcurrency, MediaTailor starts additional functions as running ones complete, so that no more than MaxConcurrency functions run at the same time. Valid values are 1 to 2.
output (Union[IResolvable, Mapping[str, str], None]) – A map of output bindings that controls which bindings the executor commits to the session state after all child functions complete. Each key is a namespaced output path, and each value is an expression that MediaTailor evaluates against the combined results of the child functions.
runtime (Optional[str]) – The expression language used to evaluate expressions in the function configuration. Set this to JSONATA.
timeout_milliseconds (Union[int, float, None]) – The maximum time, in milliseconds, for all child functions to complete. This timeout covers every function in the list, including any HTTP calls the child functions make. If the executor exceeds this timeout, MediaTailor discards all output from the executor and proceeds with default behavior. Valid values are 100 to 2000.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor

concurrent_executor_configuration_property = mediatailor.CfnFunctionPropsMixin.ConcurrentExecutorConfigurationProperty(
    function_list=[mediatailor.CfnFunctionPropsMixin.FunctionRefProperty(
        alias="alias",
        function_id="functionId",
        run_condition="runCondition"
    )],
    max_concurrency=123,
    output={
        "output_key": "output"
    },
    runtime="runtime",
    timeout_milliseconds=123
)

Attributes

function_list

The list of 1 to 10 child functions that MediaTailor runs in parallel.

Each entry specifies a child function to execute and an optional run condition expression that controls whether the function runs. Child functions cannot themselves be executors, and each child function’s resolved namespace must be unique across the list.

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

max_concurrency

The maximum number of child functions that MediaTailor runs simultaneously.

When the list contains more functions than MaxConcurrency, MediaTailor starts additional functions as running ones complete, so that no more than MaxConcurrency functions run at the same time. Valid values are 1 to 2.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-concurrentexecutorconfiguration.html#cfn-mediatailor-function-concurrentexecutorconfiguration-maxconcurrency

output

A map of output bindings that controls which bindings the executor commits to the session state after all child functions complete.

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

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

runtime

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

Set this to JSONATA.

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

timeout_milliseconds

The maximum time, in milliseconds, for all child functions to complete.

This timeout covers every function in the list, including any HTTP calls the child functions make. If the executor exceeds this timeout, MediaTailor discards all output from the executor and proceeds with default behavior. Valid values are 100 to 2000.

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

CustomOutputConfigurationProperty

class CfnFunctionPropsMixin.CustomOutputConfigurationProperty(*, output=None, runtime=None)

Bases: object

Configuration for custom output functions.

Parameters:

output (Union[IResolvable, Mapping[str, str], None])
runtime (Optional[str]) – The expression language used to evaluate expressions in the function configuration. Set this to JSONATA.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor

custom_output_configuration_property = mediatailor.CfnFunctionPropsMixin.CustomOutputConfigurationProperty(
    output={
        "output_key": "output"
    },
    runtime="runtime"
)

Attributes

output

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

Type:: see

runtime

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

Set this to JSONATA.

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

FunctionRefProperty

class CfnFunctionPropsMixin.FunctionRefProperty(*, alias=None, function_id=None, run_condition=None)

Bases: object

A reference to a child function within an executor function.

Parameters:

alias (Optional[str]) – 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.
function_id (Optional[str]) – The identifier of the child function to execute.
run_condition (Optional[str]) – 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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor

function_ref_property = mediatailor.CfnFunctionPropsMixin.FunctionRefProperty(
    alias="alias",
    function_id="functionId",
    run_condition="runCondition"
)

Attributes

alias

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-functionref.html#cfn-mediatailor-function-functionref-alias

function_id

The identifier of the child function to execute.

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

run_condition

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-functionref.html#cfn-mediatailor-function-functionref-runcondition

HttpRequestConfigurationProperty

class CfnFunctionPropsMixin.HttpRequestConfigurationProperty(*, body=None, headers=None, method_type=None, output=None, request_timeout_milliseconds=None, runtime=None, url=None)

Bases: object

Configuration for HTTP request functions.

Parameters:

body (Optional[str]) – The body of the HTTP request.
headers (Union[IResolvable, Mapping[str, str], None])
method_type (Optional[str])
output (Union[IResolvable, Mapping[str, str], None])
request_timeout_milliseconds (Union[int, float, None]) – The timeout in milliseconds for the HTTP request. Maximum value is 2000.
runtime (Optional[str]) – The expression language used to evaluate expressions in the function configuration. Set this to JSONATA.
url (Optional[str]) – The URL endpoint for the HTTP request.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor

http_request_configuration_property = mediatailor.CfnFunctionPropsMixin.HttpRequestConfigurationProperty(
    body="body",
    headers={
        "headers_key": "headers"
    },
    method_type="methodType",
    output={
        "output_key": "output"
    },
    request_timeout_milliseconds=123,
    runtime="runtime",
    url="url"
)

Attributes

body

The body of the HTTP request.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-httprequestconfiguration.html#cfn-mediatailor-function-httprequestconfiguration-body

headers

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-httprequestconfiguration.html#cfn-mediatailor-function-httprequestconfiguration-headers

Type:: see

method_type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-httprequestconfiguration.html#cfn-mediatailor-function-httprequestconfiguration-methodtype

Type:: see

output

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

Type:: see

request_timeout_milliseconds

The timeout in milliseconds for the HTTP request.

Maximum value is 2000.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-httprequestconfiguration.html#cfn-mediatailor-function-httprequestconfiguration-requesttimeoutmilliseconds

runtime

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

Set this to JSONATA.

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

url

The URL endpoint for the HTTP request.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-httprequestconfiguration.html#cfn-mediatailor-function-httprequestconfiguration-url

SequentialExecutorConfigurationProperty

class CfnFunctionPropsMixin.SequentialExecutorConfigurationProperty(*, function_list=None, output=None, runtime=None, timeout_milliseconds=None)

Bases: object

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.

Parameters:

function_list (Union[IResolvable, Sequence[Union[IResolvable, FunctionRefProperty, Dict[str, Any]]], None]) – 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.
output (Union[IResolvable, Mapping[str, str], None]) – 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.
runtime (Optional[str]) – The expression language used to evaluate expressions in the function configuration. Set this to JSONATA.
timeout_milliseconds (Union[int, float, None]) – 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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_mediatailor as mediatailor

sequential_executor_configuration_property = mediatailor.CfnFunctionPropsMixin.SequentialExecutorConfigurationProperty(
    function_list=[mediatailor.CfnFunctionPropsMixin.FunctionRefProperty(
        alias="alias",
        function_id="functionId",
        run_condition="runCondition"
    )],
    output={
        "output_key": "output"
    },
    runtime="runtime",
    timeout_milliseconds=123
)

Attributes

function_list

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.

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

output

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.

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

runtime

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

Set this to JSONATA.

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

timeout_milliseconds

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-sequentialexecutorconfiguration.html#cfn-mediatailor-function-sequentialexecutorconfiguration-timeoutmilliseconds