Skip to content
v2.275.0

HttpRequestConfigurationProperty Struct ​

Configuration for HTTP request functions.

Example ​

ts
// 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 httpRequestConfigurationProperty: mediatailor.CfnFunction.HttpRequestConfigurationProperty = {
  methodType: 'methodType',
  requestTimeoutMilliseconds: 123,
  runtime: 'runtime',
  url: 'url',

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

Properties ​

bodyoptionalstringbodyoptionalstrbodyoptionalStringBodyoptionalstringBodyoptional*string#
The body of the HTTP request.
headersoptionalIResolvable | { [key: string]: string }headersoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]headersoptionalIResolvableHeadersoptionalIResolvableHeadersoptionalinterface{}#
methodTypestringmethod_typestrmethodTypeStringMethodTypestringMethodType*stringrequired#
outputoptionalIResolvable | { [key: string]: string }outputoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]outputoptionalIResolvableOutputoptionalIResolvableOutputoptionalinterface{}#
requestTimeoutMillisecondsnumberrequest_timeout_millisecondsint | floatrequestTimeoutMillisecondsNumberRequestTimeoutMillisecondsdoubleRequestTimeoutMilliseconds*float64required#
The timeout in milliseconds for the HTTP request.

Maximum value is 2000.

runtimestringruntimestrruntimeStringRuntimestringRuntime*stringrequired#
The expression language used to evaluate expressions in the function configuration.

Set this to JSONATA.

urlstringurlstrurlStringUrlstringUrl*stringrequired#
The URL endpoint for the HTTP request.