EksCall.Builder

java.lang.Object
- software.amazon.awscdk.services.stepfunctions.tasks.EksCall.Builder

Enclosing class:: EksCall

public static final class EksCall.Builder
extends java.lang.Object

A fluent builder for EksCall.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EksCall`	`build()`
`EksCall.Builder`	`cluster(ICluster cluster)` The EKS cluster.
`EksCall.Builder`	`comment(java.lang.String comment)` An optional description for this state.
`static EksCall.Builder`	`create(software.constructs.Construct scope, java.lang.String id)`
`EksCall.Builder`	`heartbeat(Duration heartbeat)` Timeout for the heartbeat.
`EksCall.Builder`	`httpMethod(HttpMethods httpMethod)` HTTP method ("GET", "POST", "PUT", ...) part of HTTP request.
`EksCall.Builder`	`httpPath(java.lang.String httpPath)` HTTP path of the Kubernetes REST API operation For example: /api/v1/namespaces/default/pods.
`EksCall.Builder`	`inputPath(java.lang.String inputPath)` JSONPath expression to select part of the state to be the input to this state.
`EksCall.Builder`	`integrationPattern(IntegrationPattern integrationPattern)` AWS Step Functions integrates with services directly in the Amazon States Language.
`EksCall.Builder`	`outputPath(java.lang.String outputPath)` JSONPath expression to select select a portion of the state output to pass to the next state.
`EksCall.Builder`	`queryParameters(java.util.Map<java.lang.String,? extends java.util.List<java.lang.String>> queryParameters)` Query Parameters part of HTTP request.
`EksCall.Builder`	`requestBody(TaskInput requestBody)` Request body part of HTTP request.
`EksCall.Builder`	`resultPath(java.lang.String resultPath)` JSONPath expression to indicate where to inject the state's output.
`EksCall.Builder`	`resultSelector(java.util.Map<java.lang.String,? extends java.lang.Object> resultSelector)` The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
`EksCall.Builder`	`timeout(Duration timeout)` Timeout for the state machine.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static EksCall.Builder create(software.constructs.Construct scope,
                                     java.lang.String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of EksCall.Builder.
  - comment
```
public EksCall.Builder comment(java.lang.String comment)
```
    An optional description for this state.
    Default: - No comment
    
    Parameters:
    
    comment - An optional description for this state. This parameter is required.
    
    Returns:
    
    this
  - heartbeat
```
public EksCall.Builder heartbeat(Duration heartbeat)
```
    Timeout for the heartbeat.
    Default: - None
    
    Parameters:
    
    heartbeat - Timeout for the heartbeat. This parameter is required.
    
    Returns:
    
    this
  - inputPath
```
public EksCall.Builder inputPath(java.lang.String inputPath)
```
    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 {}.
    Default: - The entire task input (JSON path '$')
    
    Parameters:
    
    inputPath - JSONPath expression to select part of the state to be the input to this state. This parameter is required.
    
    Returns:
    
    this
  - integrationPattern
```
public EksCall.Builder integrationPattern(IntegrationPattern integrationPattern)
```
    AWS Step Functions integrates with services directly in the Amazon States Language.
    You can control these AWS services using service integration patterns
    Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.
    
    Parameters:
    
    integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
  - outputPath
```
public EksCall.Builder outputPath(java.lang.String outputPath)
```
    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 {}.
    Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
    
    Parameters:
    
    outputPath - JSONPath expression to select select a portion of the state output to pass to the next state. This parameter is required.
    
    Returns:
    
    this
  - resultPath
```
public EksCall.Builder resultPath(java.lang.String resultPath)
```
    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.
    Default: - Replaces the entire input with the result (JSON path '$')
    
    Parameters:
    
    resultPath - JSONPath expression to indicate where to inject the state's output. This parameter is required.
    
    Returns:
    
    this
  - resultSelector
```
public EksCall.Builder resultSelector(java.util.Map<java.lang.String,? extends java.lang.Object> resultSelector)
```
    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.
    Default: - None
    
    Parameters:
    
    resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector
  - timeout
```
public EksCall.Builder timeout(Duration timeout)
```
    Timeout for the state machine.
    Default: - None
    
    Parameters:
    
    timeout - Timeout for the state machine. This parameter is required.
    
    Returns:
    
    this
  - cluster
```
public EksCall.Builder cluster(ICluster cluster)
```
    The EKS cluster.
    
    Parameters:
    
    cluster - The EKS cluster. This parameter is required.
    
    Returns:
    
    this
  - httpMethod
```
public EksCall.Builder httpMethod(HttpMethods httpMethod)
```
    HTTP method ("GET", "POST", "PUT", ...) part of HTTP request.
    
    Parameters:
    
    httpMethod - HTTP method ("GET", "POST", "PUT", ...) part of HTTP request. This parameter is required.
    
    Returns:
    
    this
  - httpPath
```
public EksCall.Builder httpPath(java.lang.String httpPath)
```
    HTTP path of the Kubernetes REST API operation For example: /api/v1/namespaces/default/pods.
    
    Parameters:
    
    httpPath - HTTP path of the Kubernetes REST API operation For example: /api/v1/namespaces/default/pods. This parameter is required.
    
    Returns:
    
    this
  - queryParameters
```
public EksCall.Builder queryParameters(java.util.Map<java.lang.String,? extends java.util.List<java.lang.String>> queryParameters)
```
    Query Parameters part of HTTP request.
    Default: - no query parameters
    
    Parameters:
    
    queryParameters - Query Parameters part of HTTP request. This parameter is required.
    
    Returns:
    
    this
  - requestBody
```
public EksCall.Builder requestBody(TaskInput requestBody)
```
    Request body part of HTTP request.
    Default: - No request body
    
    Parameters:
    
    requestBody - Request body part of HTTP request. This parameter is required.
    
    Returns:
    
    this
  - build
```
public EksCall build()
```

Class EksCall.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

comment

heartbeat

inputPath

integrationPattern

outputPath

resultPath

resultSelector

timeout

cluster

httpMethod

httpPath

queryParameters

requestBody

build