PipeTargetHttpParametersProperty Struct
These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
Example
ts
// 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',
},
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_pipes as pipes
pipe_target_http_parameters_property = pipes.CfnPipe.PipeTargetHttpParametersProperty(
header_parameters={
"header_parameters_key": "headerParameters"
},
path_parameter_values=["pathParameterValues"],
query_string_parameters={
"query_string_parameters_key": "queryStringParameters"
}
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.pipes.*;
PipeTargetHttpParametersProperty pipeTargetHttpParametersProperty = PipeTargetHttpParametersProperty.builder()
.headerParameters(Map.of(
"headerParametersKey", "headerParameters"))
.pathParameterValues(List.of("pathParameterValues"))
.queryStringParameters(Map.of(
"queryStringParametersKey", "queryStringParameters"))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Pipes;
var pipeTargetHttpParametersProperty = new PipeTargetHttpParametersProperty {
HeaderParameters = new Dictionary<string, string> {
{ "headerParametersKey", "headerParameters" }
},
PathParameterValues = new [] { "pathParameterValues" },
QueryStringParameters = new Dictionary<string, string> {
{ "queryStringParametersKey", "queryStringParameters" }
}
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
pipeTargetHttpParametersProperty := &PipeTargetHttpParametersProperty{
HeaderParameters: map[string]*string{
"headerParametersKey": jsii.String("headerParameters"),
},
PathParameterValues: []*string{
jsii.String("pathParameterValues"),
},
QueryStringParameters: map[string]*string{
"queryStringParametersKey": jsii.String("queryStringParameters"),
},
}
Properties
headerParametersoptionalIResolvable | { [key: string]: string }header_parametersoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]headerParametersoptionalIResolvableHeaderParametersoptionalIResolvableHeaderParametersoptionalinterface{}#The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
pathParameterValuesoptionalstring[]path_parameter_valuesoptionaltyping.List[str]pathParameterValuesoptionalList<String>PathParameterValuesoptionalstring[]PathParameterValuesoptional*[]*string#The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
queryStringParametersoptionalIResolvable | { [key: string]: string }query_string_parametersoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]queryStringParametersoptionalIResolvableQueryStringParametersoptionalIResolvableQueryStringParametersoptionalinterface{}#The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.