aws-cdk-lib.aws_pipes.CfnPipe.PipeTargetHttpParametersProperty

PipeTargetHttpParametersProperty Struct

These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pipes as pipes } from 'aws-cdk-lib';
const pipeTargetHttpParametersProperty: pipes.CfnPipe.PipeTargetHttpParametersProperty = {
  headerParameters: {
    headerParametersKey: 'headerParameters',
  },
  pathParameterValues: ['pathParameterValues'],
  queryStringParameters: {
    queryStringParametersKey: 'queryStringParameters',
  },
};

Properties

headerParameters?optionalIResolvable | { [key: string]: string }header_parameters?optionaltyping.Union[IResolvable, typing.Mapping[str, str]]headerParameters?optionalIResolvableHeaderParameters?optionalIResolvableHeaderParameters?optionalinterface{}#

The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

pathParameterValues?optionalstring[]path_parameter_values?optionaltyping.List[str]pathParameterValues?optionalList<String>PathParameterValues?optionalstring[]PathParameterValues?optional*[]*string#

The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").

queryStringParameters?optionalIResolvable | { [key: string]: string }query_string_parameters?optionaltyping.Union[IResolvable, typing.Mapping[str, str]]queryStringParameters?optionalIResolvableQueryStringParameters?optionalIResolvableQueryStringParameters?optionalinterface{}#

The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.