> **Experimental**
>
> `@aws-cdk/aws-pipes-enrichments-alpha` is an [**experimental**](/stability) (alpha) package: its API may change in any release, without a major version bump.
# ApiGatewayEnrichmentProps

Properties for a ApiGatewayEnrichment.

Extends: ApiGatewayEnrichmentProps
Used as props by: ApiGatewayEnrichment

- Stability: [Experimental](/cdk/api/stability.html)
- Source: [`lib/api-gateway.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0-alpha.0/packages/@aws-cdk/aws-pipes-enrichments-alpha/lib/api-gateway.ts#L10)

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as pipes_alpha from '@aws-cdk/aws-pipes-alpha';
import * as pipes_enrichments_alpha from '@aws-cdk/aws-pipes-enrichments-alpha';

declare const inputTransformation: pipes_alpha.InputTransformation;
const apiGatewayEnrichmentProps: pipes_enrichments_alpha.ApiGatewayEnrichmentProps = {
  headerParameters: {
    headerParametersKey: 'headerParameters',
  },
  inputTransformation: inputTransformation,
  method: 'method',
  path: 'path',
  pathParameterValues: ['pathParameterValues'],
  queryStringParameters: {
    queryStringParametersKey: 'queryStringParameters',
  },
  stage: 'stage',
};
```

## Properties

- `headerParameters`: { [key: string]: string } = none — The headers that need to be sent as part of request invoking the API Gateway REST API.

- `inputTransformation`: [InputTransformation](/cdk/api/v2/docs/@aws-cdk_aws-pipes-alpha.InputTransformation.html) = None — The input transformation for the enrichment.

- `method`: string — The method for API Gateway resource.

  **Default:** '*' - ANY

- `path`: string = '/' — The path for the API Gateway resource.

- `pathParameterValues`: string[] = none — The path parameter values used to populate the API Gateway REST API path wildcards ("*").

- `queryStringParameters`: { [key: string]: string } = none — The query string keys/values that need to be sent as part of request invoking the EventBridge API destination.

- `stage`: string — The deployment stage for the API Gateway resource.

  **Default:** the value of `deploymentStage.stageName` of target API Gateway resource.