Class EventBridgePutEventsProps.Builder
java.lang.Object
software.amazon.awscdk.services.stepfunctions.tasks.EventBridgePutEventsProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<EventBridgePutEventsProps>
- Enclosing interface:
EventBridgePutEventsProps
@Stability(Stable)
public static final class EventBridgePutEventsProps.Builder
extends Object
implements software.amazon.jsii.Builder<EventBridgePutEventsProps>
A builder for
EventBridgePutEventsProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.Sets the value ofTaskStateBaseProps.getComment()
credentials
(Credentials credentials) Sets the value ofTaskStateBaseProps.getCredentials()
entries
(List<? extends EventBridgePutEventsEntry> entries) Sets the value ofEventBridgePutEventsProps.getEntries()
Deprecated.use `heartbeatTimeout`heartbeatTimeout
(Timeout heartbeatTimeout) Sets the value ofTaskStateBaseProps.getHeartbeatTimeout()
Sets the value ofTaskStateBaseProps.getInputPath()
integrationPattern
(IntegrationPattern integrationPattern) Sets the value ofTaskStateBaseProps.getIntegrationPattern()
outputPath
(String outputPath) Sets the value ofTaskStateBaseProps.getOutputPath()
resultPath
(String resultPath) Sets the value ofTaskStateBaseProps.getResultPath()
resultSelector
(Map<String, ? extends Object> resultSelector) Sets the value ofTaskStateBaseProps.getResultSelector()
Sets the value ofTaskStateBaseProps.getStateName()
taskTimeout
(Timeout taskTimeout) Sets the value ofTaskStateBaseProps.getTaskTimeout()
Deprecated.use `taskTimeout`
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
entries
@Stability(Stable) public EventBridgePutEventsProps.Builder entries(List<? extends EventBridgePutEventsEntry> entries) Sets the value ofEventBridgePutEventsProps.getEntries()
- Parameters:
entries
- The entries that will be sent. This parameter is required. Minimum number of entries is 1 and maximum is 10, unless PutEvents API limit has changed.- Returns:
this
-
comment
Sets the value ofTaskStateBaseProps.getComment()
- Parameters:
comment
- An optional description for this state.- Returns:
this
-
credentials
Sets the value ofTaskStateBaseProps.getCredentials()
- Parameters:
credentials
- Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations.- Returns:
this
-
heartbeat
@Stability(Deprecated) @Deprecated public EventBridgePutEventsProps.Builder heartbeat(Duration heartbeat) Deprecated.use `heartbeatTimeout`Sets the value ofTaskStateBaseProps.getHeartbeat()
- Parameters:
heartbeat
- Timeout for the heartbeat.- Returns:
this
-
heartbeatTimeout
@Stability(Stable) public EventBridgePutEventsProps.Builder heartbeatTimeout(Timeout heartbeatTimeout) Sets the value ofTaskStateBaseProps.getHeartbeatTimeout()
- Parameters:
heartbeatTimeout
- Timeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface- Returns:
this
-
inputPath
Sets the value ofTaskStateBaseProps.getInputPath()
- Parameters:
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 {}.- Returns:
this
-
integrationPattern
@Stability(Stable) public EventBridgePutEventsProps.Builder integrationPattern(IntegrationPattern integrationPattern) Sets the value ofTaskStateBaseProps.getIntegrationPattern()
- Parameters:
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.
- Returns:
this
-
outputPath
Sets the value ofTaskStateBaseProps.getOutputPath()
- Parameters:
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 {}.- Returns:
this
-
resultPath
Sets the value ofTaskStateBaseProps.getResultPath()
- Parameters:
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.- Returns:
this
-
resultSelector
@Stability(Stable) public EventBridgePutEventsProps.Builder resultSelector(Map<String, ? extends Object> resultSelector) Sets the value ofTaskStateBaseProps.getResultSelector()
- Parameters:
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.- Returns:
this
-
stateName
Sets the value ofTaskStateBaseProps.getStateName()
- Parameters:
stateName
- Optional name for this state.- Returns:
this
-
taskTimeout
Sets the value ofTaskStateBaseProps.getTaskTimeout()
- Parameters:
taskTimeout
- Timeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface- Returns:
this
-
timeout
@Stability(Deprecated) @Deprecated public EventBridgePutEventsProps.Builder timeout(Duration timeout) Deprecated.use `taskTimeout`Sets the value ofTaskStateBaseProps.getTimeout()
- Parameters:
timeout
- Timeout for the task.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<EventBridgePutEventsProps>
- Returns:
- a new instance of
EventBridgePutEventsProps
- Throws:
NullPointerException
- if any required attribute was not provided
-