Class EmrContainersCreateVirtualCluster.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<EmrContainersCreateVirtualCluster>
- Enclosing class:
EmrContainersCreateVirtualCluster
EmrContainersCreateVirtualCluster
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
An optional description for this state.credentials
(Credentials credentials) Credentials for an IAM Role that the State Machine assumes for executing the task.eksCluster
(EksClusterInput eksCluster) EKS Cluster or task input that contains the name of the cluster.eksNamespace
(String eksNamespace) The namespace of an EKS cluster.Deprecated.heartbeatTimeout
(Timeout heartbeatTimeout) Timeout for the heartbeat.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.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.The tags assigned to the virtual cluster.taskTimeout
(Timeout taskTimeout) Timeout for the task.Deprecated.usetaskTimeout
virtualClusterName
(String virtualClusterName) Name of the virtual cluster that will be created.
-
Method Details
-
create
@Stability(Stable) public static EmrContainersCreateVirtualCluster.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
EmrContainersCreateVirtualCluster.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
@Stability(Stable) public EmrContainersCreateVirtualCluster.Builder credentials(Credentials 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
@Stability(Deprecated) @Deprecated public EmrContainersCreateVirtualCluster.Builder heartbeat(Duration heartbeat) Deprecated.useheartbeatTimeout
(deprecated) Timeout for the heartbeat.Default: - None
- Parameters:
heartbeat
- Timeout for the heartbeat. This parameter is required.- Returns:
this
-
heartbeatTimeout
@Stability(Stable) public EmrContainersCreateVirtualCluster.Builder heartbeatTimeout(Timeout 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
@Stability(Stable) public EmrContainersCreateVirtualCluster.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.
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 EmrContainersCreateVirtualCluster.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
@Stability(Stable) public EmrContainersCreateVirtualCluster.Builder taskTimeout(Timeout 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
@Stability(Deprecated) @Deprecated public EmrContainersCreateVirtualCluster.Builder timeout(Duration timeout) Deprecated.usetaskTimeout
(deprecated) Timeout for the task.Default: - None
- Parameters:
timeout
- Timeout for the task. This parameter is required.- Returns:
this
-
eksCluster
@Stability(Stable) public EmrContainersCreateVirtualCluster.Builder eksCluster(EksClusterInput eksCluster) EKS Cluster or task input that contains the name of the cluster.- Parameters:
eksCluster
- EKS Cluster or task input that contains the name of the cluster. This parameter is required.- Returns:
this
-
eksNamespace
@Stability(Stable) public EmrContainersCreateVirtualCluster.Builder eksNamespace(String eksNamespace) The namespace of an EKS cluster.Default: - 'default'
- Parameters:
eksNamespace
- The namespace of an EKS cluster. This parameter is required.- Returns:
this
-
tags
The tags assigned to the virtual cluster.Default: {}
- Parameters:
tags
- The tags assigned to the virtual cluster. This parameter is required.- Returns:
this
-
virtualClusterName
@Stability(Stable) public EmrContainersCreateVirtualCluster.Builder virtualClusterName(String virtualClusterName) Name of the virtual cluster that will be created.Default: - the name of the state machine execution that runs this task and state name
- Parameters:
virtualClusterName
- Name of the virtual cluster that will be created. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<EmrContainersCreateVirtualCluster>
- Returns:
- a newly built instance of
EmrContainersCreateVirtualCluster
.
-
heartbeatTimeout