aws-cdk-lib.aws_pipes.CfnPipe.PipeTargetHttpParametersProperty

interface PipeTargetHttpParametersProperty

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

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

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

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.