interface CfnFunctionMixinProps

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.MediaTailor.CfnFunctionMixinProps
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsmediatailor#CfnFunctionMixinProps
Java	software.amazon.awscdk.cfnpropertymixins.services.mediatailor.CfnFunctionMixinProps
Python	aws_cdk.cfn_property_mixins.aws_mediatailor.CfnFunctionMixinProps
TypeScript	@aws-cdk/cfn-property-mixins » aws_mediatailor » CfnFunctionMixinProps

Properties for CfnFunctionPropsMixin.

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

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/cfn-property-mixins';
const cfnFunctionMixinProps: mediatailor.CfnFunctionMixinProps = {
  awsServiceRequestConfiguration: {
    body: 'body',
    headers: {
      headersKey: 'headers',
    },
    methodType: 'methodType',
    output: {
      outputKey: 'output',
    },
    requestTimeoutMilliseconds: 123,
    runtime: 'runtime',
    targetRegion: 'targetRegion',
    targetService: 'targetService',
    url: 'url',
  },
  concurrentExecutorConfiguration: {
    functionList: [{
      alias: 'alias',
      functionId: 'functionId',
      runCondition: 'runCondition',
    }],
    maxConcurrency: 123,
    output: {
      outputKey: 'output',
    },
    runtime: 'runtime',
    timeoutMilliseconds: 123,
  },
  customOutputConfiguration: {
    output: {
      outputKey: 'output',
    },
    runtime: 'runtime',
  },
  description: 'description',
  functionId: 'functionId',
  functionType: 'functionType',
  httpRequestConfiguration: {
    body: 'body',
    headers: {
      headersKey: 'headers',
    },
    methodType: 'methodType',
    output: {
      outputKey: 'output',
    },
    requestTimeoutMilliseconds: 123,
    runtime: 'runtime',
    url: 'url',
  },
  sequentialExecutorConfiguration: {
    functionList: [{
      alias: 'alias',
      functionId: 'functionId',
      runCondition: 'runCondition',
    }],
    output: {
      outputKey: 'output',
    },
    runtime: 'runtime',
    timeoutMilliseconds: 123,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vastRequestConfiguration: {
    body: 'body',
    headers: {
      headersKey: 'headers',
    },
    methodType: 'methodType',
    output: {
      outputKey: 'output',
    },
    requestTimeoutMilliseconds: 123,
    runtime: 'runtime',
    url: 'url',
  },
};

Properties

Name	Type	Description
awsServiceRequestConfiguration?	IResolvable | AwsServiceRequestConfigurationProperty	The configuration for an AWS_SERVICE_REQUEST function.
concurrentExecutorConfiguration?	IResolvable | ConcurrentExecutorConfigurationProperty	The configuration for a CONCURRENT_EXECUTOR function.
customOutputConfiguration?	IResolvable | CustomOutputConfigurationProperty	Configuration for custom output functions.
description?	string	A description of the function.
functionId?	string	The unique identifier for the function.
functionType?	string
httpRequestConfiguration?	IResolvable | HttpRequestConfigurationProperty	Configuration for HTTP request functions.
sequentialExecutorConfiguration?	IResolvable | SequentialExecutorConfigurationProperty	The configuration for a SEQUENTIAL_EXECUTOR function.
tags?	CfnTag[]	The tags to assign to the function resource.
vastRequestConfiguration?	IResolvable | VastRequestConfigurationProperty	The configuration for a VAST_REQUEST function.

---

awsServiceRequestConfiguration?

Type: IResolvable | AwsServiceRequestConfigurationProperty (optional)

The configuration for an AWS_SERVICE_REQUEST function.

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.

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

---

concurrentExecutorConfiguration?

Type: IResolvable | ConcurrentExecutorConfigurationProperty (optional)

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.

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

---

customOutputConfiguration?

Type: IResolvable | CustomOutputConfigurationProperty (optional)

Configuration for custom output functions.

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

---

description?

Type: string (optional)

A description of the function.

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

---

functionId?

Type: string (optional)

The unique identifier for the function.

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

---

functionType?

Type: string (optional)

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

---

httpRequestConfiguration?

Type: IResolvable | HttpRequestConfigurationProperty (optional)

Configuration for HTTP request functions.

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

---

sequentialExecutorConfiguration?

Type: IResolvable | SequentialExecutorConfigurationProperty (optional)

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.

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

---

tags?

Type: CfnTag[] (optional)

The tags to assign to the function resource.

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

---

vastRequestConfiguration?

Type: IResolvable | VastRequestConfigurationProperty (optional)

The configuration for a VAST_REQUEST function.

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.

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