Package software.amazon.awscdk.services.stepfunctions

Class TaskStateBaseOptions.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.TaskStateBaseOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<TaskStateBaseOptions>

Enclosing interface:

TaskStateBaseOptions

@Stability(Stable)
public static final class TaskStateBaseOptions.Builder
extends Object
implements software.amazon.jsii.Builder<TaskStateBaseOptions>

A builder for TaskStateBaseOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TaskStateBaseOptions	build()	Builds the configured instance.
TaskStateBaseOptions.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseOptions.getCredentials()
TaskStateBaseOptions.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
TaskStateBaseOptions.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()
TaskStateBaseOptions.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseOptions.getIntegrationPattern()
TaskStateBaseOptions.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseOptions.getTaskTimeout()
TaskStateBaseOptions.Builder	timeout(Duration timeout)	Deprecated. use `taskTimeout`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

credentials

@Stability(Stable)
public TaskStateBaseOptions.Builder credentials(Credentials credentials)

Sets the value of TaskStateBaseOptions.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 TaskStateBaseOptions.Builder heartbeat(Duration heartbeat)

Deprecated.

use `heartbeatTimeout`

Sets the value of TaskStateBaseOptions.getHeartbeat()

Parameters:

heartbeat - Timeout for the heartbeat.

Returns:

this

heartbeatTimeout

@Stability(Stable)
public TaskStateBaseOptions.Builder heartbeatTimeout(Timeout heartbeatTimeout)

Sets the value of TaskStateBaseOptions.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 TaskStateBaseOptions.Builder integrationPattern(IntegrationPattern integrationPattern)

Sets the value of TaskStateBaseOptions.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

@Stability(Stable)
public TaskStateBaseOptions.Builder taskTimeout(Timeout taskTimeout)

Sets the value of TaskStateBaseOptions.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 TaskStateBaseOptions.Builder timeout(Duration timeout)

Deprecated.

use `taskTimeout`

Sets the value of TaskStateBaseOptions.getTimeout()

Parameters:

timeout - Timeout for the task.

Returns:

this

build

@Stability(Stable)
public TaskStateBaseOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<TaskStateBaseOptions>

Returns:

a new instance of TaskStateBaseOptions

Throws:

NullPointerException - if any required attribute was not provided