aws-cdk-lib.aws_stepfunctions_tasks.CallApiGatewayEndpointBaseOptions

CallApiGatewayEndpointBaseOptions Struct

Base CallApiGatewayEdnpoint Task Props.

Source

aws-stepfunctions-tasks/lib/apigateway/base-types.ts

Type last changed

v2.178.0 · 6 Feb 2025

Example

// 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

apiPathstringapi_pathstrapiPathStringApiPathstringApiPath*string= No path#

Path parameters appended after API endpoint.

authTypeAuthTypeauth_typeAuthTypeauthTypeAuthTypeAuthTypeAuthTypeAuthTypeAuthType= AuthType.NO_AUTH#

Authentication methods.

headersTaskInputheadersTaskInputheadersTaskInputHeadersTaskInputHeadersTaskInput= No headers#

HTTP request information that does not relate to contents of the request.

methodHttpMethodmethodHttpMethodmethodHttpMethodMethodHttpMethodMethodHttpMethodrequired#

Http method for the API.

queryParametersTaskInputquery_parametersTaskInputqueryParametersTaskInputQueryParametersTaskInputQueryParametersTaskInput= No query parameters#

Query strings attached to end of request.

requestBodyTaskInputrequest_bodyTaskInputrequestBodyTaskInputRequestBodyTaskInputRequestBodyTaskInput= No request body#

HTTP Request body.