aws-cdk-lib.aws_stepfunctions_tasks.EksCallProps

interface EksCallProps

LanguageType name
.NETAmazon.CDK.AWS.StepFunctions.Tasks.EksCallProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#EksCallProps
Javasoftware.amazon.awscdk.services.stepfunctions.tasks.EksCallProps
Pythonaws_cdk.aws_stepfunctions_tasks.EksCallProps
TypeScript (source)aws-cdk-lib » aws_stepfunctions_tasks » EksCallProps

Properties for calling a EKS endpoint with EksCall.

Example

import * as eks from 'aws-cdk-lib/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

NameTypeDescription
clusterIClusterThe EKS cluster.
httpMethodHttpMethodsHTTP method ("GET", "POST", "PUT", ...) part of HTTP request.
httpPathstringHTTP path of the Kubernetes REST API operation For example: /api/v1/namespaces/default/pods.
comment?stringAn optional description for this state.
credentials?CredentialsCredentials for an IAM Role that the State Machine assumes for executing the task.
heartbeat?⚠️DurationTimeout for the heartbeat.
heartbeatTimeout?TimeoutTimeout for the heartbeat.
inputPath?stringJSONPath expression to select part of the state to be the input to this state.
integrationPattern?IntegrationPatternAWS Step Functions integrates with services directly in the Amazon States Language.
outputPath?stringJSONPath 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?TaskInputRequest body part of HTTP request.
resultPath?stringJSONPath 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.
taskTimeout?TimeoutTimeout for the task.
timeout?⚠️DurationTimeout for the task.

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.


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


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

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


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.