Class EventBridgePutEventsJsonataProps.Builder
java.lang.Object
software.amazon.awscdk.services.stepfunctions.tasks.EventBridgePutEventsJsonataProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<EventBridgePutEventsJsonataProps>
- Enclosing interface:
EventBridgePutEventsJsonataProps
@Stability(Stable)
public static final class EventBridgePutEventsJsonataProps.Builder
extends Object
implements software.amazon.jsii.Builder<EventBridgePutEventsJsonataProps>
A builder for
EventBridgePutEventsJsonataProps
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionSets the value ofAssignableStateOptions.getAssign()
build()
Builds the configured instance.Sets the value ofStateBaseProps.getComment()
credentials
(Credentials credentials) Sets the value ofTaskStateBaseOptions.getCredentials()
entries
(List<? extends EventBridgePutEventsEntry> entries) Sets the value ofEventBridgePutEventsJsonataProps.getEntries()
Deprecated.use `heartbeatTimeout`heartbeatTimeout
(Timeout heartbeatTimeout) Sets the value ofTaskStateBaseOptions.getHeartbeatTimeout()
integrationPattern
(IntegrationPattern integrationPattern) Sets the value ofTaskStateBaseOptions.getIntegrationPattern()
Sets the value ofJsonataCommonOptions.getOutputs()
queryLanguage
(QueryLanguage queryLanguage) Sets the value ofStateBaseProps.getQueryLanguage()
Sets the value ofStateBaseProps.getStateName()
taskTimeout
(Timeout taskTimeout) Sets the value ofTaskStateBaseOptions.getTaskTimeout()
Deprecated.use `taskTimeout`
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
entries
@Stability(Stable) public EventBridgePutEventsJsonataProps.Builder entries(List<? extends EventBridgePutEventsEntry> entries) Sets the value ofEventBridgePutEventsJsonataProps.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 ofStateBaseProps.getComment()
- Parameters:
comment
- A comment describing this state.- Returns:
this
-
queryLanguage
@Stability(Stable) public EventBridgePutEventsJsonataProps.Builder queryLanguage(QueryLanguage queryLanguage) Sets the value ofStateBaseProps.getQueryLanguage()
- Parameters:
queryLanguage
- The name of the query language used by the state. If the state does not contain aqueryLanguage
field, then it will use the query language specified in the top-levelqueryLanguage
field.- Returns:
this
-
stateName
Sets the value ofStateBaseProps.getStateName()
- Parameters:
stateName
- Optional name for this state.- Returns:
this
-
credentials
@Stability(Stable) public EventBridgePutEventsJsonataProps.Builder credentials(Credentials credentials) Sets the value ofTaskStateBaseOptions.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 EventBridgePutEventsJsonataProps.Builder heartbeat(Duration heartbeat) Deprecated.use `heartbeatTimeout`Sets the value ofTaskStateBaseOptions.getHeartbeat()
- Parameters:
heartbeat
- Timeout for the heartbeat.- Returns:
this
-
heartbeatTimeout
@Stability(Stable) public EventBridgePutEventsJsonataProps.Builder heartbeatTimeout(Timeout heartbeatTimeout) Sets the value ofTaskStateBaseOptions.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
-
integrationPattern
@Stability(Stable) public EventBridgePutEventsJsonataProps.Builder integrationPattern(IntegrationPattern integrationPattern) Sets the value ofTaskStateBaseOptions.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
-
taskTimeout
Sets the value ofTaskStateBaseOptions.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 EventBridgePutEventsJsonataProps.Builder timeout(Duration timeout) Deprecated.use `taskTimeout`Sets the value ofTaskStateBaseOptions.getTimeout()
- Parameters:
timeout
- Timeout for the task.- Returns:
this
-
assign
@Stability(Stable) public EventBridgePutEventsJsonataProps.Builder assign(Map<String, ? extends Object> assign) Sets the value ofAssignableStateOptions.getAssign()
- Parameters:
assign
- Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps.- Returns:
this
-
outputs
Sets the value ofJsonataCommonOptions.getOutputs()
- Parameters:
outputs
- Used to specify and transform output from the state. When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<EventBridgePutEventsJsonataProps>
- Returns:
- a new instance of
EventBridgePutEventsJsonataProps
- Throws:
NullPointerException
- if any required attribute was not provided
-