interface ApiGatewayTargetParameters 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Pipes.Targets.Alpha.ApiGatewayTargetParameters
Go	github.com/aws/aws-cdk-go/awscdkpipestargetsalpha/v2#ApiGatewayTargetParameters
Java	software.amazon.awscdk.services.pipes.targets.alpha.ApiGatewayTargetParameters
Python	aws_cdk.aws_pipes_targets_alpha.ApiGatewayTargetParameters
TypeScript (source)	@aws-cdk/aws-pipes-targets-alpha » ApiGatewayTargetParameters

API Gateway REST API target properties.

Example

declare const sourceQueue: sqs.Queue;

const fn = new lambda.Function( this, 'MyFunc', {
  handler: 'index.handler',
  runtime: lambda.Runtime.NODEJS_LATEST,
  code: lambda.Code.fromInline( 'exports.handler = e => {}' ),
});

const restApi = new api.LambdaRestApi( this, 'MyRestAPI', { handler: fn } );
const apiTarget = new targets.ApiGatewayTarget(restApi, {
  inputTransformation: pipes.InputTransformation.fromObject({ body: "👀" }),
});

const pipe = new pipes.Pipe(this, 'Pipe', {
    source: new SqsSource(sourceQueue),
    target: apiTarget,
});

Properties

Name	Type	Description
headerParameters?🔹	{ [string]: string }	The headers to send as part of the request invoking the API Gateway REST API.
inputTransformation?🔹	IInputTransformation	The input transformation to apply to the message before sending it to the target.
method?🔹	string	The method for API Gateway resource.
path?🔹	string	The path for the API Gateway resource.
pathParameterValues?🔹	string[]	The path parameter values used to populate the API Gateway REST API path wildcards ("*").
queryStringParameters?🔹	{ [string]: string }	The query string keys/values that need to be sent as part of request invoking the API Gateway REST API.
stage?🔹	string	The deployment stage for the API Gateway resource.

---

headerParameters?🔹

Type: { [string]: string } (optional, default: none)

The headers to send as part of the request invoking the API Gateway REST API.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargethttpparameters.html#cfn-pipes-pipe-pipetargethttpparameters-headerparameters

---

inputTransformation?🔹

Type: IInputTransformation (optional, default: none)

The input transformation to apply to the message before sending it to the target.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-inputtemplate

---

method?🔹

Type: string (optional, default: '' - ANY)*

The method for API Gateway resource.

---

path?🔹

Type: string (optional, default: '/')

The path for the API Gateway resource.

---

pathParameterValues?🔹

Type: string[] (optional, default: none)

The path parameter values used to populate the API Gateway REST API path wildcards ("*").

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargethttpparameters.html#cfn-pipes-pipe-pipetargethttpparameters-pathparametervalues

---

queryStringParameters?🔹

Type: { [string]: string } (optional, default: none)

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

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargethttpparameters.html#cfn-pipes-pipe-pipetargethttpparameters-querystringparameters

---

stage?🔹

Type: string (optional, default: the value of deploymentStage.stageName of target API Gateway resource.)

The deployment stage for the API Gateway resource.