Class EksCall.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<EksCall>
- Enclosing class:
EksCall
EksCall
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
The EKS cluster.An optional description for this state.static EksCall.Builder
credentials
(Credentials credentials) Credentials for an IAM Role that the State Machine assumes for executing the task.Deprecated.heartbeatTimeout
(Timeout heartbeatTimeout) Timeout for the heartbeat.httpMethod
(HttpMethods httpMethod) HTTP method ("GET", "POST", "PUT", ...) part of HTTP request.HTTP path of the Kubernetes REST API operation For example: /api/v1/namespaces/default/pods.JSONPath expression to select part of the state to be the input to this state.integrationPattern
(IntegrationPattern integrationPattern) AWS Step Functions integrates with services directly in the Amazon States Language.outputPath
(String outputPath) JSONPath expression to select select a portion of the state output to pass to the next state.queryParameters
(Map<String, ? extends List<String>> queryParameters) Query Parameters part of HTTP request.requestBody
(TaskInput requestBody) Request body part of HTTP request.resultPath
(String resultPath) JSONPath expression to indicate where to inject the state's output.resultSelector
(Map<String, ? extends Object> resultSelector) The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.Optional name for this state.taskTimeout
(Timeout taskTimeout) Timeout for the task.Deprecated.usetaskTimeout
-
Method Details
-
create
@Stability(Stable) public static EksCall.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- This parameter is required.id
- Descriptive identifier for this chainable. This parameter is required.- Returns:
- a new instance of
EksCall.Builder
.
-
comment
An optional description for this state.Default: - No comment
- Parameters:
comment
- An optional description for this state. This parameter is required.- Returns:
this
-
credentials
Credentials for an IAM Role that the State Machine assumes for executing the task.This enables cross-account resource invocations.
Default: - None (Task is executed using the State Machine's execution role)
- Parameters:
credentials
- Credentials for an IAM Role that the State Machine assumes for executing the task. This parameter is required.- Returns:
this
- See Also:
-
heartbeat
Deprecated.useheartbeatTimeout
(deprecated) Timeout for the heartbeat.Default: - None
- Parameters:
heartbeat
- Timeout for the heartbeat. This parameter is required.- Returns:
this
-
heartbeatTimeout
Timeout for the heartbeat.[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
- Parameters:
heartbeatTimeout
- Timeout for the heartbeat. This parameter is required.- Returns:
this
-
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
AWS Step Functions integrates with services directly in the Amazon States Language.You can control these AWS services using service integration patterns.
Depending on the AWS Service, the Service Integration Pattern availability will vary.
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:
-
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
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
@Stability(Stable) public EksCall.Builder resultSelector(Map<String, ? extends 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:
-
stateName
Optional name for this state.Default: - The construct ID will be used as state name
- Parameters:
stateName
- Optional name for this state. This parameter is required.- Returns:
this
-
taskTimeout
Timeout for the task.[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
- Parameters:
taskTimeout
- Timeout for the task. This parameter is required.- Returns:
this
-
timeout
Deprecated.usetaskTimeout
(deprecated) Timeout for the task.Default: - None
- Parameters:
timeout
- Timeout for the task. This parameter is required.- Returns:
this
-
cluster
The EKS cluster.- Parameters:
cluster
- The EKS cluster. This parameter is required.- Returns:
this
-
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
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
@Stability(Stable) public EksCall.Builder queryParameters(Map<String, ? extends List<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
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
-
heartbeatTimeout