aws-cdk-lib.aws_stepfunctions_tasks.CallApiGatewayRestApiEndpointOptions

CallApiGatewayRestApiEndpointOptions Struct

Base properties for calling an REST API Endpoint.

Source

aws-stepfunctions-tasks/lib/apigateway/call-rest-api.ts

Type last changed

v2.179.0 · 18 Feb 2025

Example

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

declare const restApi: apigateway.RestApi;
const callApiGatewayRestApiEndpointOptions: stepfunctions_tasks.CallApiGatewayRestApiEndpointOptions = {
  api: restApi,
  stageName: 'stageName',

  // the properties below are optional
  region: 'region',
};

Properties

apiIRestApiapiIRestApiapiIRestApiApiIRestApiApiIRestApirequired#

API to call.

regionstringregionstrregionStringRegionstringRegion*string= Uses the Region of the stack con…#

Specify a custom Region where the API is deployed, e.g. 'us-east-1'.

default

Default: Uses the Region of the stack containing the api.

stageNamestringstage_namestrstageNameStringStageNamestringStageName*stringrequired#

Name of the stage where the API is deployed to in API Gateway.