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(
    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(
            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 = ['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.

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])

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

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

Type:: see

FunctionRefProperty

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

Bases: object

A reference to a function with an optional run condition.

Parameters:

function_id (Optional[str]) – The identifier of the function to execute.
run_condition (Optional[str]) – A conditional expression that determines whether this function should execute.

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(
    function_id="functionId",
    run_condition="runCondition"
)

Attributes

function_id

The identifier of the 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

A conditional expression that determines whether this function should execute.

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])
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

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

Type:: see

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

Configuration for sequential executor functions.

Parameters:

function_list (Union[IResolvable, Sequence[Union[IResolvable, FunctionRefProperty, Dict[str, Any]]], None]) – The list of functions to execute sequentially.
output (Union[IResolvable, Mapping[str, str], None])
runtime (Optional[str])
timeout_milliseconds (Union[int, float, None]) – The timeout in milliseconds for the entire sequential execution chain.

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(
        function_id="functionId",
        run_condition="runCondition"
    )],
    output={
        "output_key": "output"
    },
    runtime="runtime",
    timeout_milliseconds=123
)

Attributes

function_list

The list of functions to execute sequentially.

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

output

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

Type:: see

runtime

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

Type:: see

timeout_milliseconds

The timeout in milliseconds for the entire sequential execution chain.

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