aws-cdk-lib.aws_stepfunctions_tasks.CallApiGatewayHttpApiEndpointOptions

CallApiGatewayHttpApiEndpointOptions Struct

Base properties for calling an HTTP API Endpoint.

Source

aws-stepfunctions-tasks/lib/apigateway/call-http-api.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 * as cdk from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';

declare const stack: cdk.Stack;
const callApiGatewayHttpApiEndpointOptions: stepfunctions_tasks.CallApiGatewayHttpApiEndpointOptions = {
  apiId: 'apiId',
  apiStack: stack,

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

Properties

apiIdstringapi_idstrapiIdStringApiIdstringApiId*stringrequired#

The Id of the API to call.

apiStackStackapi_stackStackapiStackStackApiStackStackApiStackStackrequired#

The Stack in which the API is defined.

stageNamestringstage_namestrstageNameStringStageNamestringStageName*string= '$default'#

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