# CallApiGatewayEndpointBaseOptions

Base CallApiGatewayEdnpoint Task Props.

- Source: [`aws-stepfunctions-tasks/lib/apigateway/base-types.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/apigateway/base-types.ts#L44)
- Type last changed: v2.178.0 · 6 Feb 2025

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';

declare const taskInput: stepfunctions.TaskInput;
const callApiGatewayEndpointBaseOptions: stepfunctions_tasks.CallApiGatewayEndpointBaseOptions = {
  method: stepfunctions_tasks.HttpMethod.GET,

  // the properties below are optional
  apiPath: 'apiPath',
  authType: stepfunctions_tasks.AuthType.NO_AUTH,
  headers: taskInput,
  queryParameters: taskInput,
  requestBody: taskInput,
};
```

## Properties

- `apiPath`: string — Path parameters appended after API endpoint.

  **Default:** No path

- `authType`: [AuthType](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.AuthType.html) = AuthType.NO_AUTH — Authentication methods.

- `headers`: [TaskInput](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.TaskInput.html) — HTTP request information that does not relate to contents of the request.

  **Default:** No headers

- `method`: [HttpMethod](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.HttpMethod.html) (required) — Http method for the API.

- `queryParameters`: [TaskInput](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.TaskInput.html) — Query strings attached to end of request.

  **Default:** No query parameters

- `requestBody`: [TaskInput](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.TaskInput.html) — HTTP Request body.

  **Default:** No request body