interface CfnFunctionProps

Language	Type name
.NET	Amazon.CDK.AWS.MediaTailor.CfnFunctionProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsmediatailor#CfnFunctionProps
Java	software.amazon.awscdk.services.mediatailor.CfnFunctionProps
Python	aws_cdk.aws_mediatailor.CfnFunctionProps
TypeScript	aws-cdk-lib » aws_mediatailor » CfnFunctionProps

Properties for defining a CfnFunction.

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-lib';
const cfnFunctionProps: mediatailor.CfnFunctionProps = {
  functionId: 'functionId',
  functionType: 'functionType',

  // the properties below are optional
  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: [{
      functionId: 'functionId',
      runCondition: 'runCondition',
    }],
    runtime: 'runtime',
    timeoutMilliseconds: 123,

    // the properties below are optional
    output: {
      outputKey: 'output',
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
functionId	string	The unique identifier for the function.
functionType	string
customOutputConfiguration?	IResolvable | CustomOutputConfigurationProperty	Configuration for custom output functions.
description?	string	A description of the function.
httpRequestConfiguration?	IResolvable | HttpRequestConfigurationProperty	Configuration for HTTP request functions.
sequentialExecutorConfiguration?	IResolvable | SequentialExecutorConfigurationProperty	Configuration for sequential executor functions.
tags?	CfnTag[]	The tags to assign to the function resource.

---

functionId

Type: string

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

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

---

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

---

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)

Configuration for sequential executor functions.

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