CfnFunctionProps

class aws_cdk.aws_mediatailor.CfnFunctionProps(*, function_id, function_type, custom_output_configuration=None, description=None, http_request_configuration=None, sequential_executor_configuration=None, tags=None)

Bases: object

Properties for defining a CfnFunction.

Parameters:
  • function_id (str) – The unique identifier for the function.

  • function_type (str)

  • custom_output_configuration (Union[IResolvable, CustomOutputConfigurationProperty, Dict[str, Any], None]) – Configuration for custom output functions.

  • description (Optional[str]) – A description of the function.

  • http_request_configuration (Union[IResolvable, HttpRequestConfigurationProperty, Dict[str, Any], None]) – Configuration for HTTP request functions.

  • sequential_executor_configuration (Union[IResolvable, SequentialExecutorConfigurationProperty, Dict[str, Any], None]) – Configuration for sequential executor functions.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags to assign to the function resource.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

cfn_function_props = mediatailor.CfnFunctionProps(
    function_id="functionId",
    function_type="functionType",

    # the properties below are optional
    custom_output_configuration=mediatailor.CfnFunction.CustomOutputConfigurationProperty(
        runtime="runtime",

        # the properties below are optional
        output={
            "output_key": "output"
        }
    ),
    description="description",
    http_request_configuration=mediatailor.CfnFunction.HttpRequestConfigurationProperty(
        method_type="methodType",
        request_timeout_milliseconds=123,
        runtime="runtime",
        url="url",

        # the properties below are optional
        body="body",
        headers={
            "headers_key": "headers"
        },
        output={
            "output_key": "output"
        }
    ),
    sequential_executor_configuration=mediatailor.CfnFunction.SequentialExecutorConfigurationProperty(
        function_list=[mediatailor.CfnFunction.FunctionRefProperty(
            function_id="functionId",
            run_condition="runCondition"
        )],
        runtime="runtime",
        timeout_milliseconds=123,

        # the properties below are optional
        output={
            "output_key": "output"
        }
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

custom_output_configuration

Configuration for custom output functions.

See:

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

description

A description of the function.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html#cfn-mediatailor-function-description

function_id

The unique identifier for the function.

See:

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

function_type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html#cfn-mediatailor-function-functiontype

Type:

see

http_request_configuration

Configuration for HTTP request functions.

See:

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

sequential_executor_configuration

Configuration for sequential executor functions.

See:

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

tags

The tags to assign to the function resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html#cfn-mediatailor-function-tags