interface EksCallProps

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.Tasks.EksCallProps
Java	software.amazon.awscdk.services.stepfunctions.tasks.EksCallProps
Python	aws_cdk.aws_stepfunctions_tasks.EksCallProps
TypeScript (source)	@aws-cdk/aws-stepfunctions-tasks » EksCallProps

Properties for calling a EKS endpoint with EksCall.

Example

import * as eks from '@aws-cdk/aws-eks';

const myEksCluster = new eks.Cluster(this, 'my sample cluster', {
  version: eks.KubernetesVersion.V1_18,
  clusterName: 'myEksCluster',
});

new tasks.EksCall(this, 'Call a EKS Endpoint', {
  cluster: myEksCluster,
  httpMethod: tasks.HttpMethods.GET,
  httpPath: '/api/v1/namespaces/default/pods',
});

Properties

Name	Type	Description
cluster	ICluster	The EKS cluster.
httpMethod	HttpMethods	HTTP method ("GET", "POST", "PUT", ...) part of HTTP request.
httpPath	string	HTTP path of the Kubernetes REST API operation For example: /api/v1/namespaces/default/pods.
comment?	string	An optional description for this state.
heartbeat?	Duration	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?	{ [string]: string[] }	Query Parameters part of HTTP request.
requestBody?	TaskInput	Request body part of HTTP request.
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.
timeout?	Duration	Timeout for the state machine.

---

cluster

Type: ICluster

The EKS cluster.

---

httpMethod

Type: HttpMethods

HTTP method ("GET", "POST", "PUT", ...) part of HTTP request.

---

httpPath

Type: string

HTTP path of the Kubernetes REST API operation For example: /api/v1/namespaces/default/pods.

---

comment?

Type: string (optional, default: No comment)

An optional description for this state.

---

heartbeat?

Type: Duration (optional, default: None)

Timeout for the heartbeat.

---

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

See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token

---

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: { [string]: string[] } (optional, default: no query parameters)

Query Parameters part of HTTP request.

---

requestBody?

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

Request body part of HTTP request.

---

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

---

timeout?

Type: Duration (optional, default: None)

Timeout for the state machine.