interface CallApiGatewayHttpApiEndpointOptions
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.StepFunctions.Tasks.CallApiGatewayHttpApiEndpointOptions |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#CallApiGatewayHttpApiEndpointOptions |
 Java | software.amazon.awscdk.services.stepfunctions.tasks.CallApiGatewayHttpApiEndpointOptions |
 Python | aws_cdk.aws_stepfunctions_tasks.CallApiGatewayHttpApiEndpointOptions |
 TypeScript (source) | aws-cdk-lib » aws_stepfunctions_tasks » CallApiGatewayHttpApiEndpointOptions |
Base properties for calling an HTTP API Endpoint.
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
| Name | Type | Description |
|---|---|---|
| api | string | The Id of the API to call. |
| api | Stack | The Stack in which the API is defined. |
| stage | string | Name of the stage where the API is deployed to in API Gateway. |
apiId
Type:
string
The Id of the API to call.
apiStack
Type:
Stack
The Stack in which the API is defined.
stageName?
Type:
string
(optional, default: '$default')
Name of the stage where the API is deployed to in API Gateway.