interface CallApiGatewayEndpointBaseProps

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.Tasks.CallApiGatewayEndpointBaseProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#CallApiGatewayEndpointBaseProps
Java	software.amazon.awscdk.services.stepfunctions.tasks.CallApiGatewayEndpointBaseProps
Python	aws_cdk.aws_stepfunctions_tasks.CallApiGatewayEndpointBaseProps
TypeScript (source)	aws-cdk-lib » aws_stepfunctions_tasks » CallApiGatewayEndpointBaseProps

Base CallApiGatewayEdnpoint Task Props.

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 as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';

declare const resultSelector: any;
declare const taskInput: stepfunctions.TaskInput;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const callApiGatewayEndpointBaseProps: stepfunctions_tasks.CallApiGatewayEndpointBaseProps = {
  method: stepfunctions_tasks.HttpMethod.GET,

  // the properties below are optional
  apiPath: 'apiPath',
  authType: stepfunctions_tasks.AuthType.NO_AUTH,
  comment: 'comment',
  credentials: {
    role: taskRole,
  },
  headers: taskInput,
  heartbeat: cdk.Duration.minutes(30),
  heartbeatTimeout: timeout,
  inputPath: 'inputPath',
  integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
  outputPath: 'outputPath',
  queryParameters: taskInput,
  requestBody: taskInput,
  resultPath: 'resultPath',
  resultSelector: {
    resultSelectorKey: resultSelector,
  },
  stateName: 'stateName',
  taskTimeout: timeout,
  timeout: cdk.Duration.minutes(30),
};

Properties

Name	Type	Description
method	HttpMethod	Http method for the API.
apiPath?	string	Path parameters appended after API endpoint.
authType?	AuthType	Authentication methods.
comment?	string	An optional description for this state.
credentials?	Credentials	Credentials for an IAM Role that the State Machine assumes for executing the task.
headers?	TaskInput	HTTP request information that does not relate to contents of the request.
heartbeat?⚠️	Duration	Timeout for the heartbeat.
heartbeatTimeout?	Timeout	Timeout for the heartbeat.
inputPath?	string	JSONPath expression to select part of the state to be the input to this state.
integrationPattern?	IntegrationPattern	AWS Step Functions integrates with services directly in the Amazon States Language.
outputPath?	string	JSONPath expression to select select a portion of the state output to pass to the next state.
queryParameters?	TaskInput	Query strings attatched to end of request.
requestBody?	TaskInput	HTTP Request body.
resultPath?	string	JSONPath expression to indicate where to inject the state's output.
resultSelector?	{ [string]: any }	The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
stateName?	string	Optional name for this state.
taskTimeout?	Timeout	Timeout for the task.
timeout?⚠️	Duration	Timeout for the task.

---

method

Type: HttpMethod

Http method for the API.

---

apiPath?

Type: string (optional, default: No path)

Path parameters appended after API endpoint.

---

authType?

Type: AuthType (optional, default: AuthType.NO_AUTH)

Authentication methods.

---

comment?

Type: string (optional, default: No comment)

An optional description for this state.

---

credentials?

Type: Credentials (optional, default: None (Task is executed using the State Machine's execution role))

Credentials for an IAM Role that the State Machine assumes for executing the task.

This enables cross-account resource invocations.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html

---

headers?

Type: TaskInput (optional, default: No headers)

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

---

heartbeat?⚠️

⚠️ Deprecated: use heartbeatTimeout

Type: Duration (optional, default: None)

Timeout for the heartbeat.

---

heartbeatTimeout?

Type: Timeout (optional, default: None)

Timeout for the heartbeat.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

---

inputPath?

Type: string (optional, default: The entire task input (JSON path '$'))

JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

---

integrationPattern?

Type: IntegrationPattern (optional, default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.)

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html

---

outputPath?

Type: string (optional, default: The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$'))

JSONPath expression to select select a portion of the state output to pass to the next state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

---

queryParameters?

Type: TaskInput (optional, default: No query parameters)

Query strings attatched to end of request.

---

requestBody?

Type: TaskInput (optional, default: No request body)

HTTP Request body.

---

resultPath?

Type: string (optional, default: Replaces the entire input with the result (JSON path '$'))

JSONPath expression to indicate where to inject the state's output.

May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

---

resultSelector?

Type: { [string]: any } (optional, default: None)

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

---

stateName?

Type: string (optional, default: The construct ID will be used as state name)

Optional name for this state.

---

taskTimeout?

Type: Timeout (optional, default: None)

Timeout for the task.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

---

timeout?⚠️

⚠️ Deprecated: use taskTimeout

Type: Duration (optional, default: None)

Timeout for the task.