Skip to content
v2.275.0

HttpParametersProperty Struct Added in v2.275.0 ​

Parameters for invoking an HTTP endpoint target, such as an Amazon API Gateway endpoint or an EventBridge API destination.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_eventsv2 as eventsv2 } from 'aws-cdk-lib';
const httpParametersProperty: eventsv2.CfnSubscriber.HttpParametersProperty = {
  headerParameters: {
    headerParametersKey: 'headerParameters',
  },
  invocationTimeoutSeconds: 'invocationTimeoutSeconds',
  pathParameterValues: ['pathParameterValues'],
  queryStringParameters: {
    queryStringParametersKey: 'queryStringParameters',
  },
};

Properties ​

headerParametersoptionalIResolvable | { [key: string]: string }header_parametersoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]headerParametersoptionalIResolvableHeaderParametersoptionalIResolvableHeaderParametersoptionalinterface{}#
A map of HTTP header names to values.

A header name or value may also be a JSONata expression.

invocationTimeoutSecondsoptionalstringinvocation_timeout_secondsoptionalstrinvocationTimeoutSecondsoptionalStringInvocationTimeoutSecondsoptionalstringInvocationTimeoutSecondsoptional*string#
The timeout in seconds for each invocation of the target, written as a string.

Accepts a literal value or a JSONata expression.

pathParameterValuesoptionalstring[]path_parameter_valuesoptionaltyping.List[str]pathParameterValuesoptionalList<String>PathParameterValuesoptionalstring[]PathParameterValuesoptional*[]*string#
Values for the path parameters (wildcards) in the target URL, in order.
queryStringParametersoptionalIResolvable | { [key: string]: string }query_string_parametersoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]queryStringParametersoptionalIResolvableQueryStringParametersoptionalIResolvableQueryStringParametersoptionalinterface{}#
A map of query string parameter names to values.