Package software.amazon.awscdk.services.stepfunctions.tasks

Class EksCall

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.stepfunctions.State

software.amazon.awscdk.services.stepfunctions.TaskStateBase

software.amazon.awscdk.services.stepfunctions.tasks.EksCall

All Implemented Interfaces:

IConstruct, IDependable, IChainable, INextable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:47.966Z")
@Stability(Stable)
public class EksCall
extends TaskStateBase

Call a EKS endpoint as a Task.

Example:

 import software.amazon.awscdk.services.eks.*;
 Cluster myEksCluster = Cluster.Builder.create(this, "my sample cluster")
         .version(KubernetesVersion.V1_18)
         .clusterName("myEksCluster")
         .build();
 EksCall.Builder.create(this, "Call a EKS Endpoint")
         .cluster(myEksCluster)
         .httpMethod(HttpMethods.GET)
         .httpPath("/api/v1/namespaces/default/pods")
         .build();
 

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/connect-eks.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EksCall.Builder	A fluent builder for EksCall.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.IChainable

IChainable.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.INextable

INextable.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EksCall(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	EksCall(software.amazon.jsii.JsiiObjectRef objRef)
	EksCall(software.constructs.Construct scope, String id, EksCallProps props)

Method Summary

Modifier and Type	Method	Description
protected TaskMetricsConfig	getTaskMetrics()	No policies are required due to eks:call is an Http service integration and does not call and EKS API directly.
protected List<PolicyStatement>	getTaskPolicies()

Methods inherited from class software.amazon.awscdk.services.stepfunctions.TaskStateBase

addCatch, addCatch, addRetry, addRetry, getEndStates, metric, metric, metricFailed, metricFailed, metricHeartbeatTimedOut, metricHeartbeatTimedOut, metricRunTime, metricRunTime, metricScheduled, metricScheduled, metricScheduleTime, metricScheduleTime, metricStarted, metricStarted, metricSucceeded, metricSucceeded, metricTime, metricTime, metricTimedOut, metricTimedOut, next, toStateJson, whenBoundToGraph

Methods inherited from class software.amazon.awscdk.services.stepfunctions.State

addBranch, addChoice, addIterator, addPrefix, bindToGraph, filterNextables, findReachableEndStates, findReachableEndStates, findReachableStates, findReachableStates, getBranches, getComment, getDefaultChoice, getId, getInputPath, getIteration, getOutputPath, getParameters, getResultPath, getResultSelector, getStartState, getStateId, makeDefault, makeNext, prefixStates, renderBranches, renderChoices, renderInputOutput, renderIterator, renderNextEnd, renderResultSelector, renderRetryCatch, setDefaultChoice, setIteration

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

EksCall

protected EksCall(software.amazon.jsii.JsiiObjectRef objRef)

EksCall

protected EksCall(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

EksCall

@Stability(Stable)
public EksCall(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 EksCallProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

getTaskMetrics

@Stability(Stable)
@Nullable
protected TaskMetricsConfig getTaskMetrics()

No policies are required due to eks:call is an Http service integration and does not call and EKS API directly.

Specified by:

getTaskMetrics in class TaskStateBase

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/connect-eks.html#connect-eks-permissions

getTaskPolicies

@Stability(Stable)
@Nullable
protected List<PolicyStatement> getTaskPolicies()

Specified by:

getTaskPolicies in class TaskStateBase