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

Interface EksCallProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

All Known Implementing Classes:

EksCallProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:47.967Z")
@Stability(Stable)
public interface EksCallProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

Properties for calling a EKS endpoint with EksCall.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	EksCallProps.Builder	A builder for EksCallProps
static final class	EksCallProps.Jsii$Proxy	An implementation for EksCallProps

Method Summary

Modifier and Type	Method	Description
static EksCallProps.Builder	builder()
ICluster	getCluster()	The EKS cluster.
HttpMethods	getHttpMethod()	HTTP method ("GET", "POST", "PUT", ...) part of HTTP request.
String	getHttpPath()	HTTP path of the Kubernetes REST API operation For example: /api/v1/namespaces/default/pods.
default Map<String,List<String>>	getQueryParameters()	Query Parameters part of HTTP request.
default TaskInput	getRequestBody()	Request body part of HTTP request.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps

getComment, getHeartbeat, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getTimeout

Method Details

getCluster

@Stability(Stable)
@NotNull
ICluster getCluster()

The EKS cluster.

getHttpMethod

@Stability(Stable)
@NotNull
HttpMethods getHttpMethod()

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

getHttpPath

@Stability(Stable)
@NotNull
String getHttpPath()

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

getQueryParameters

@Stability(Stable)
@Nullable
default Map<String,List<String>> getQueryParameters()

Query Parameters part of HTTP request.

Default: - no query parameters

getRequestBody

@Stability(Stable)
@Nullable
default TaskInput getRequestBody()

Request body part of HTTP request.

Default: - No request body

builder

@Stability(Stable)
static EksCallProps.Builder builder()

Returns:

a EksCallProps.Builder of EksCallProps