aws-cdk-lib.aws_pipes.CfnPipe.PipeEnrichmentHttpParametersProperty

interface PipeEnrichmentHttpParametersProperty

LanguageType name
.NETAmazon.CDK.AWS.Pipes.CfnPipe.PipeEnrichmentHttpParametersProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awspipes#CfnPipe_PipeEnrichmentHttpParametersProperty
Javasoftware.amazon.awscdk.services.pipes.CfnPipe.PipeEnrichmentHttpParametersProperty
Pythonaws_cdk.aws_pipes.CfnPipe.PipeEnrichmentHttpParametersProperty
TypeScript aws-cdk-lib » aws_pipes » CfnPipe » PipeEnrichmentHttpParametersProperty

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

In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.

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 pipeEnrichmentHttpParametersProperty: pipes.CfnPipe.PipeEnrichmentHttpParametersProperty = {
  headerParameters: {
    headerParametersKey: 'headerParameters',
  },
  pathParameterValues: ['pathParameterValues'],
  queryStringParameters: {
    queryStringParametersKey: 'queryStringParameters',
  },
};

Properties

NameTypeDescription
headerParameters?IResolvable | { [string]: string }The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
pathParameterValues?string[]The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
queryStringParameters?IResolvable | { [string]: string }The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

headerParameters?

Type: IResolvable | { [string]: string } (optional)

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


pathParameterValues?

Type: string[] (optional)

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


queryStringParameters?

Type: IResolvable | { [string]: string } (optional)

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