interface PipeTargetHttpParametersProperty
| Language | Type name |
|---|---|
.NET | Amazon.CDK.Mixins.Preview.AWS.Pipes.Mixins.CfnPipePropsMixin.PipeTargetHttpParametersProperty |
Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awspipes/mixins#CfnPipePropsMixin_PipeTargetHttpParametersProperty |
Java | software.amazon.awscdk.mixins.preview.services.pipes.mixins.CfnPipePropsMixin.PipeTargetHttpParametersProperty |
Python | aws_cdk.mixins_preview.aws_pipes.mixins.CfnPipePropsMixin.PipeTargetHttpParametersProperty |
TypeScript | @aws-cdk/mixins-preview » aws_pipes » mixins » CfnPipePropsMixin » 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 { mixins as pipes_mixins } from '@aws-cdk/mixins-preview/aws-pipes';
const pipeTargetHttpParametersProperty: pipes_mixins.CfnPipePropsMixin.PipeTargetHttpParametersProperty = {
headerParameters: {
headerParametersKey: 'headerParameters',
},
pathParameterValues: ['pathParameterValues'],
queryStringParameters: {
queryStringParametersKey: 'queryStringParameters',
},
};
Properties
| Name | Type | Description |
|---|---|---|
| header | { [string]: string } | IResolvable | The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination. |
| path | string[] | The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*"). |
| query | { [string]: string } | IResolvable | 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:
{ [string]: string } | IResolvable
(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:
{ [string]: string } | IResolvable
(optional)
The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

.NET
Go
Java
Python
TypeScript