aws-cdk-lib.aws_mediatailor.CfnFunctionProps

CfnFunctionProps Struct

Properties for defining a CfnFunction.

CfnFunctionProps

used as props by

• CfnFunction

Source

Generated code

Type last changed

v2.273.0 · 8 Oct 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediatailor as mediatailor } from 'aws-cdk-lib';
const cfnFunctionProps: mediatailor.CfnFunctionProps = {
  functionId: 'functionId',
  functionType: 'functionType',

  // the properties below are optional
  awsServiceRequestConfiguration: {
    methodType: 'methodType',
    requestTimeoutMilliseconds: 123,
    runtime: 'runtime',
    targetRegion: 'targetRegion',
    targetService: 'targetService',
    url: 'url',

    // the properties below are optional
    body: 'body',
    headers: {
      headersKey: 'headers',
    },
    output: {
      outputKey: 'output',
    },
  },
  concurrentExecutorConfiguration: {
    functionList: [{
      alias: 'alias',
      functionId: 'functionId',
      runCondition: 'runCondition',
    }],
    maxConcurrency: 123,
    output: {
      outputKey: 'output',
    },
    runtime: 'runtime',
    timeoutMilliseconds: 123,
  },
  customOutputConfiguration: {
    runtime: 'runtime',

    // the properties below are optional
    output: {
      outputKey: 'output',
    },
  },
  description: 'description',
  httpRequestConfiguration: {
    methodType: 'methodType',
    requestTimeoutMilliseconds: 123,
    runtime: 'runtime',
    url: 'url',

    // the properties below are optional
    body: 'body',
    headers: {
      headersKey: 'headers',
    },
    output: {
      outputKey: 'output',
    },
  },
  sequentialExecutorConfiguration: {
    functionList: [{
      alias: 'alias',
      functionId: 'functionId',
      runCondition: 'runCondition',
    }],
    runtime: 'runtime',
    timeoutMilliseconds: 123,

    // the properties below are optional
    output: {
      outputKey: 'output',
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vastRequestConfiguration: {
    methodType: 'methodType',
    requestTimeoutMilliseconds: 123,
    runtime: 'runtime',
    url: 'url',

    // the properties below are optional
    body: 'body',
    headers: {
      headersKey: 'headers',
    },
    output: {
      outputKey: 'output',
    },
  },
};

Properties

awsServiceRequestConfiguration?optionalIResolvable | CfnFunction.AwsServiceRequestConfigurationPropertyaws_service_request_configuration?optionaltyping.Union[IResolvable, AwsServiceRequestConfigurationProperty]awsServiceRequestConfiguration?optionalIResolvableAwsServiceRequestConfiguration?optionalIResolvableAwsServiceRequestConfiguration?optionalinterface{}#

The configuration for an AWS_SERVICE_REQUEST function.

notes

Contains the target service, target Region, and request parameters that the function uses to call an AWS service API. For more information, see AWS_SERVICE_REQUEST (https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions-types-aws-service-request.html) in the MediaTailor User Guide.

concurrentExecutorConfiguration?optionalIResolvable | CfnFunction.ConcurrentExecutorConfigurationPropertyconcurrent_executor_configuration?optionaltyping.Union[IResolvable, ConcurrentExecutorConfigurationProperty]concurrentExecutorConfiguration?optionalIResolvableConcurrentExecutorConfiguration?optionalIResolvableConcurrentExecutorConfiguration?optionalinterface{}#

The configuration for a CONCURRENT_EXECUTOR function.

notes

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.

customOutputConfiguration?optionalIResolvable | CfnFunction.CustomOutputConfigurationPropertycustom_output_configuration?optionaltyping.Union[IResolvable, CustomOutputConfigurationProperty]customOutputConfiguration?optionalIResolvableCustomOutputConfiguration?optionalIResolvableCustomOutputConfiguration?optionalinterface{}#

Configuration for custom output functions.

description?optionalstringdescription?optionalstrdescription?optionalStringDescription?optionalstringDescription?optional*string#

A description of the function.

functionIdstringfunction_idstrfunctionIdStringFunctionIdstringFunctionId*stringrequired#

The unique identifier for the function.

functionTypestringfunction_typestrfunctionTypeStringFunctionTypestringFunctionType*stringrequired#

httpRequestConfiguration?optionalIResolvable | CfnFunction.HttpRequestConfigurationPropertyhttp_request_configuration?optionaltyping.Union[IResolvable, HttpRequestConfigurationProperty]httpRequestConfiguration?optionalIResolvableHttpRequestConfiguration?optionalIResolvableHttpRequestConfiguration?optionalinterface{}#

Configuration for HTTP request functions.

sequentialExecutorConfiguration?optionalIResolvable | CfnFunction.SequentialExecutorConfigurationPropertysequential_executor_configuration?optionaltyping.Union[IResolvable, SequentialExecutorConfigurationProperty]sequentialExecutorConfiguration?optionalIResolvableSequentialExecutorConfiguration?optionalIResolvableSequentialExecutorConfiguration?optionalinterface{}#

The configuration for a SEQUENTIAL_EXECUTOR function.

notes

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.

tags?optionalCfnTag[]tags?optionaltyping.List[CfnTag]tags?optionalList<CfnTag>Tags?optionalCfnTag[]Tags?optional*[]CfnTag#

The tags to assign to the function resource.

vastRequestConfiguration?optionalIResolvable | CfnFunction.VastRequestConfigurationPropertyvast_request_configuration?optionaltyping.Union[IResolvable, VastRequestConfigurationProperty]vastRequestConfiguration?optionalIResolvableVastRequestConfiguration?optionalIResolvableVastRequestConfiguration?optionalinterface{}#

The configuration for a VAST_REQUEST function.

notes

Specifies the HTTP method, URL, headers, body, timeout, and output expressions for a request to a VAST endpoint. MediaTailor parses the response as VAST and resolves wrapper redirects, then makes the parsed ads available to the function's output expressions. For more information, see Function types and composition (https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions-types.html) in the MediaTailor User Guide.