All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:: AthenaGetQueryExecutionJsonataProps, AthenaGetQueryExecutionJsonPathProps, AthenaGetQueryExecutionProps, AthenaGetQueryResultsJsonataProps, AthenaGetQueryResultsJsonPathProps, AthenaGetQueryResultsProps, AthenaStartQueryExecutionJsonataProps, AthenaStartQueryExecutionJsonPathProps, AthenaStartQueryExecutionProps, AthenaStopQueryExecutionJsonataProps, AthenaStopQueryExecutionJsonPathProps, AthenaStopQueryExecutionProps, BatchSubmitJobJsonataProps, BatchSubmitJobJsonPathProps, BatchSubmitJobProps, BedrockInvokeModelJsonataProps, BedrockInvokeModelJsonPathProps, BedrockInvokeModelProps, CallApiGatewayEndpointBaseProps, CallApiGatewayEndpointJsonataBaseProps, CallApiGatewayEndpointJsonPathBaseProps, CallApiGatewayHttpApiEndpointJsonataProps, CallApiGatewayHttpApiEndpointJsonPathProps, CallApiGatewayHttpApiEndpointProps, CallApiGatewayRestApiEndpointJsonataProps, CallApiGatewayRestApiEndpointJsonPathProps, CallApiGatewayRestApiEndpointProps, CallAwsServiceCrossRegionJsonataProps, CallAwsServiceCrossRegionJsonPathProps, CallAwsServiceCrossRegionProps, CallAwsServiceJsonataProps, CallAwsServiceJsonPathProps, CallAwsServiceProps, CodeBuildStartBuildBatchJsonataProps, CodeBuildStartBuildBatchJsonPathProps, CodeBuildStartBuildBatchProps, CodeBuildStartBuildJsonataProps, CodeBuildStartBuildJsonPathProps, CodeBuildStartBuildProps, DynamoDeleteItemJsonataProps, DynamoDeleteItemJsonPathProps, DynamoDeleteItemProps, DynamoGetItemJsonataProps, DynamoGetItemJsonPathProps, DynamoGetItemProps, DynamoPutItemJsonataProps, DynamoPutItemJsonPathProps, DynamoPutItemProps, DynamoUpdateItemJsonataProps, DynamoUpdateItemJsonPathProps, DynamoUpdateItemProps, EcsRunTaskJsonataProps, EcsRunTaskJsonPathProps, EcsRunTaskProps, EksCallJsonataProps, EksCallJsonPathProps, EksCallProps, EmrAddStepJsonataProps, EmrAddStepJsonPathProps, EmrAddStepProps, EmrCancelStepJsonataProps, EmrCancelStepJsonPathProps, EmrCancelStepProps, EmrContainersCreateVirtualClusterJsonataProps, EmrContainersCreateVirtualClusterJsonPathProps, EmrContainersCreateVirtualClusterProps, EmrContainersDeleteVirtualClusterJsonataProps, EmrContainersDeleteVirtualClusterJsonPathProps, EmrContainersDeleteVirtualClusterProps, EmrContainersStartJobRunJsonataProps, EmrContainersStartJobRunJsonPathProps, EmrContainersStartJobRunProps, EmrCreateClusterJsonataProps, EmrCreateClusterJsonPathProps, EmrCreateClusterProps, EmrModifyInstanceFleetByNameJsonataProps, EmrModifyInstanceFleetByNameJsonPathProps, EmrModifyInstanceFleetByNameProps, EmrModifyInstanceGroupByNameJsonataProps, EmrModifyInstanceGroupByNameJsonPathProps, EmrModifyInstanceGroupByNameProps, EmrSetClusterTerminationProtectionJsonataProps, EmrSetClusterTerminationProtectionJsonPathProps, EmrSetClusterTerminationProtectionProps, EmrTerminateClusterJsonataProps, EmrTerminateClusterJsonPathProps, EmrTerminateClusterProps, EvaluateExpressionProps, EventBridgePutEventsJsonataProps, EventBridgePutEventsJsonPathProps, EventBridgePutEventsProps, EventBridgeSchedulerCreateScheduleTaskJsonataProps, EventBridgeSchedulerCreateScheduleTaskJsonPathProps, EventBridgeSchedulerCreateScheduleTaskProps, GlueDataBrewStartJobRunJsonataProps, GlueDataBrewStartJobRunJsonPathProps, GlueDataBrewStartJobRunProps, GlueStartCrawlerRunJsonataProps, GlueStartCrawlerRunJsonPathProps, GlueStartCrawlerRunProps, GlueStartJobRunJsonataProps, GlueStartJobRunJsonPathProps, GlueStartJobRunProps, HttpInvokeJsonataProps, HttpInvokeJsonPathProps, HttpInvokeProps, LambdaInvokeJsonataProps, LambdaInvokeJsonPathProps, LambdaInvokeProps, MediaConvertCreateJobJsonataProps, MediaConvertCreateJobJsonPathProps, MediaConvertCreateJobProps, SageMakerCreateEndpointConfigJsonataProps, SageMakerCreateEndpointConfigJsonPathProps, SageMakerCreateEndpointConfigProps, SageMakerCreateEndpointJsonataProps, SageMakerCreateEndpointJsonPathProps, SageMakerCreateEndpointProps, SageMakerCreateModelJsonataProps, SageMakerCreateModelJsonPathProps, SageMakerCreateModelProps, SageMakerCreateTrainingJobJsonataProps, SageMakerCreateTrainingJobJsonPathProps, SageMakerCreateTrainingJobProps, SageMakerCreateTransformJobJsonataProps, SageMakerCreateTransformJobJsonPathProps, SageMakerCreateTransformJobProps, SageMakerUpdateEndpointJsonataProps, SageMakerUpdateEndpointJsonPathProps, SageMakerUpdateEndpointProps, SnsPublishJsonataProps, SnsPublishJsonPathProps, SnsPublishProps, SqsSendMessageJsonataProps, SqsSendMessageJsonPathProps, SqsSendMessageProps, StepFunctionsInvokeActivityJsonataProps, StepFunctionsInvokeActivityJsonPathProps, StepFunctionsInvokeActivityProps, StepFunctionsStartExecutionJsonataProps, StepFunctionsStartExecutionJsonPathProps, StepFunctionsStartExecutionProps, TaskStateBaseProps, TaskStateJsonataBaseProps, TaskStateJsonPathBaseProps

All Known Implementing Classes:: AthenaGetQueryExecutionJsonataProps.Jsii$Proxy, AthenaGetQueryExecutionJsonPathProps.Jsii$Proxy, AthenaGetQueryExecutionProps.Jsii$Proxy, AthenaGetQueryResultsJsonataProps.Jsii$Proxy, AthenaGetQueryResultsJsonPathProps.Jsii$Proxy, AthenaGetQueryResultsProps.Jsii$Proxy, AthenaStartQueryExecutionJsonataProps.Jsii$Proxy, AthenaStartQueryExecutionJsonPathProps.Jsii$Proxy, AthenaStartQueryExecutionProps.Jsii$Proxy, AthenaStopQueryExecutionJsonataProps.Jsii$Proxy, AthenaStopQueryExecutionJsonPathProps.Jsii$Proxy, AthenaStopQueryExecutionProps.Jsii$Proxy, BatchSubmitJobJsonataProps.Jsii$Proxy, BatchSubmitJobJsonPathProps.Jsii$Proxy, BatchSubmitJobProps.Jsii$Proxy, BedrockInvokeModelJsonataProps.Jsii$Proxy, BedrockInvokeModelJsonPathProps.Jsii$Proxy, BedrockInvokeModelProps.Jsii$Proxy, CallApiGatewayEndpointBaseProps.Jsii$Proxy, CallApiGatewayEndpointJsonataBaseProps.Jsii$Proxy, CallApiGatewayEndpointJsonPathBaseProps.Jsii$Proxy, CallApiGatewayHttpApiEndpointJsonataProps.Jsii$Proxy, CallApiGatewayHttpApiEndpointJsonPathProps.Jsii$Proxy, CallApiGatewayHttpApiEndpointProps.Jsii$Proxy, CallApiGatewayRestApiEndpointJsonataProps.Jsii$Proxy, CallApiGatewayRestApiEndpointJsonPathProps.Jsii$Proxy, CallApiGatewayRestApiEndpointProps.Jsii$Proxy, CallAwsServiceCrossRegionJsonataProps.Jsii$Proxy, CallAwsServiceCrossRegionJsonPathProps.Jsii$Proxy, CallAwsServiceCrossRegionProps.Jsii$Proxy, CallAwsServiceJsonataProps.Jsii$Proxy, CallAwsServiceJsonPathProps.Jsii$Proxy, CallAwsServiceProps.Jsii$Proxy, CodeBuildStartBuildBatchJsonataProps.Jsii$Proxy, CodeBuildStartBuildBatchJsonPathProps.Jsii$Proxy, CodeBuildStartBuildBatchProps.Jsii$Proxy, CodeBuildStartBuildJsonataProps.Jsii$Proxy, CodeBuildStartBuildJsonPathProps.Jsii$Proxy, CodeBuildStartBuildProps.Jsii$Proxy, DynamoDeleteItemJsonataProps.Jsii$Proxy, DynamoDeleteItemJsonPathProps.Jsii$Proxy, DynamoDeleteItemProps.Jsii$Proxy, DynamoGetItemJsonataProps.Jsii$Proxy, DynamoGetItemJsonPathProps.Jsii$Proxy, DynamoGetItemProps.Jsii$Proxy, DynamoPutItemJsonataProps.Jsii$Proxy, DynamoPutItemJsonPathProps.Jsii$Proxy, DynamoPutItemProps.Jsii$Proxy, DynamoUpdateItemJsonataProps.Jsii$Proxy, DynamoUpdateItemJsonPathProps.Jsii$Proxy, DynamoUpdateItemProps.Jsii$Proxy, EcsRunTaskJsonataProps.Jsii$Proxy, EcsRunTaskJsonPathProps.Jsii$Proxy, EcsRunTaskProps.Jsii$Proxy, EksCallJsonataProps.Jsii$Proxy, EksCallJsonPathProps.Jsii$Proxy, EksCallProps.Jsii$Proxy, EmrAddStepJsonataProps.Jsii$Proxy, EmrAddStepJsonPathProps.Jsii$Proxy, EmrAddStepProps.Jsii$Proxy, EmrCancelStepJsonataProps.Jsii$Proxy, EmrCancelStepJsonPathProps.Jsii$Proxy, EmrCancelStepProps.Jsii$Proxy, EmrContainersCreateVirtualClusterJsonataProps.Jsii$Proxy, EmrContainersCreateVirtualClusterJsonPathProps.Jsii$Proxy, EmrContainersCreateVirtualClusterProps.Jsii$Proxy, EmrContainersDeleteVirtualClusterJsonataProps.Jsii$Proxy, EmrContainersDeleteVirtualClusterJsonPathProps.Jsii$Proxy, EmrContainersDeleteVirtualClusterProps.Jsii$Proxy, EmrContainersStartJobRunJsonataProps.Jsii$Proxy, EmrContainersStartJobRunJsonPathProps.Jsii$Proxy, EmrContainersStartJobRunProps.Jsii$Proxy, EmrCreateClusterJsonataProps.Jsii$Proxy, EmrCreateClusterJsonPathProps.Jsii$Proxy, EmrCreateClusterProps.Jsii$Proxy, EmrModifyInstanceFleetByNameJsonataProps.Jsii$Proxy, EmrModifyInstanceFleetByNameJsonPathProps.Jsii$Proxy, EmrModifyInstanceFleetByNameProps.Jsii$Proxy, EmrModifyInstanceGroupByNameJsonataProps.Jsii$Proxy, EmrModifyInstanceGroupByNameJsonPathProps.Jsii$Proxy, EmrModifyInstanceGroupByNameProps.Jsii$Proxy, EmrSetClusterTerminationProtectionJsonataProps.Jsii$Proxy, EmrSetClusterTerminationProtectionJsonPathProps.Jsii$Proxy, EmrSetClusterTerminationProtectionProps.Jsii$Proxy, EmrTerminateClusterJsonataProps.Jsii$Proxy, EmrTerminateClusterJsonPathProps.Jsii$Proxy, EmrTerminateClusterProps.Jsii$Proxy, EvaluateExpressionProps.Jsii$Proxy, EventBridgePutEventsJsonataProps.Jsii$Proxy, EventBridgePutEventsJsonPathProps.Jsii$Proxy, EventBridgePutEventsProps.Jsii$Proxy, EventBridgeSchedulerCreateScheduleTaskJsonataProps.Jsii$Proxy, EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Jsii$Proxy, EventBridgeSchedulerCreateScheduleTaskProps.Jsii$Proxy, GlueDataBrewStartJobRunJsonataProps.Jsii$Proxy, GlueDataBrewStartJobRunJsonPathProps.Jsii$Proxy, GlueDataBrewStartJobRunProps.Jsii$Proxy, GlueStartCrawlerRunJsonataProps.Jsii$Proxy, GlueStartCrawlerRunJsonPathProps.Jsii$Proxy, GlueStartCrawlerRunProps.Jsii$Proxy, GlueStartJobRunJsonataProps.Jsii$Proxy, GlueStartJobRunJsonPathProps.Jsii$Proxy, GlueStartJobRunProps.Jsii$Proxy, HttpInvokeJsonataProps.Jsii$Proxy, HttpInvokeJsonPathProps.Jsii$Proxy, HttpInvokeProps.Jsii$Proxy, LambdaInvokeJsonataProps.Jsii$Proxy, LambdaInvokeJsonPathProps.Jsii$Proxy, LambdaInvokeProps.Jsii$Proxy, MediaConvertCreateJobJsonataProps.Jsii$Proxy, MediaConvertCreateJobJsonPathProps.Jsii$Proxy, MediaConvertCreateJobProps.Jsii$Proxy, SageMakerCreateEndpointConfigJsonataProps.Jsii$Proxy, SageMakerCreateEndpointConfigJsonPathProps.Jsii$Proxy, SageMakerCreateEndpointConfigProps.Jsii$Proxy, SageMakerCreateEndpointJsonataProps.Jsii$Proxy, SageMakerCreateEndpointJsonPathProps.Jsii$Proxy, SageMakerCreateEndpointProps.Jsii$Proxy, SageMakerCreateModelJsonataProps.Jsii$Proxy, SageMakerCreateModelJsonPathProps.Jsii$Proxy, SageMakerCreateModelProps.Jsii$Proxy, SageMakerCreateTrainingJobJsonataProps.Jsii$Proxy, SageMakerCreateTrainingJobJsonPathProps.Jsii$Proxy, SageMakerCreateTrainingJobProps.Jsii$Proxy, SageMakerCreateTransformJobJsonataProps.Jsii$Proxy, SageMakerCreateTransformJobJsonPathProps.Jsii$Proxy, SageMakerCreateTransformJobProps.Jsii$Proxy, SageMakerUpdateEndpointJsonataProps.Jsii$Proxy, SageMakerUpdateEndpointJsonPathProps.Jsii$Proxy, SageMakerUpdateEndpointProps.Jsii$Proxy, SnsPublishJsonataProps.Jsii$Proxy, SnsPublishJsonPathProps.Jsii$Proxy, SnsPublishProps.Jsii$Proxy, SqsSendMessageJsonataProps.Jsii$Proxy, SqsSendMessageJsonPathProps.Jsii$Proxy, SqsSendMessageProps.Jsii$Proxy, StepFunctionsInvokeActivityJsonataProps.Jsii$Proxy, StepFunctionsInvokeActivityJsonPathProps.Jsii$Proxy, StepFunctionsInvokeActivityProps.Jsii$Proxy, StepFunctionsStartExecutionJsonataProps.Jsii$Proxy, StepFunctionsStartExecutionJsonPathProps.Jsii$Proxy, StepFunctionsStartExecutionProps.Jsii$Proxy, TaskStateBaseOptions.Jsii$Proxy, TaskStateBaseProps.Jsii$Proxy, TaskStateJsonataBaseProps.Jsii$Proxy, TaskStateJsonPathBaseProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)", date="2025-03-19T18:01:43.210Z") @Stability(Stable) public interface TaskStateBaseOptions extends software.amazon.jsii.JsiiSerializable

Base options for all task states.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.stepfunctions.*;
 TaskRole taskRole;
 Timeout timeout;
 TaskStateBaseOptions taskStateBaseOptions = TaskStateBaseOptions.builder()
         .credentials(Credentials.builder()
                 .role(taskRole)
                 .build())
         .heartbeat(Duration.minutes(30))
         .heartbeatTimeout(timeout)
         .integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
         .taskTimeout(timeout)
         .timeout(Duration.minutes(30))
         .build();

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

TaskStateBaseOptions.Builder

A builder for TaskStateBaseOptions

static final class

TaskStateBaseOptions.Jsii$Proxy

An implementation for TaskStateBaseOptions
Method Summary

Modifier and Type

Method

Description

static TaskStateBaseOptions.Builder

builder()

default Credentials

getCredentials()

Credentials for an IAM Role that the State Machine assumes for executing the task.

default Duration

getHeartbeat()

Deprecated.
use heartbeatTimeout

default Timeout

getHeartbeatTimeout()

Timeout for the heartbeat.

default IntegrationPattern

getIntegrationPattern()

AWS Step Functions integrates with services directly in the Amazon States Language.

default Timeout

getTaskTimeout()

Timeout for the task.

default Duration

getTimeout()

Deprecated.
use taskTimeout

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getCredentials
  
  @Stability(Stable) @Nullable default Credentials getCredentials()
  
  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)
  See Also:
  
  https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html
- getHeartbeat
  
  @Stability(Deprecated) @Deprecated @Nullable default Duration getHeartbeat()
  
  Deprecated.
  use heartbeatTimeout
  
  (deprecated) Timeout for the heartbeat.
  Default: - None
- getHeartbeatTimeout
  
  @Stability(Stable) @Nullable default Timeout getHeartbeatTimeout()
  
  Timeout for the heartbeat.
  [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
  Default: - None
- getIntegrationPattern
  
  @Stability(Stable) @Nullable default IntegrationPattern getIntegrationPattern()
  
  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`.
  See Also:
  
  https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html
- getTaskTimeout
  
  @Stability(Stable) @Nullable default Timeout getTaskTimeout()
  
  Timeout for the task.
  [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
  Default: - None
- getTimeout
  
  @Stability(Deprecated) @Deprecated @Nullable default Duration getTimeout()
  
  Deprecated.
  use taskTimeout
  
  (deprecated) Timeout for the task.
  Default: - None
- builder
  
  @Stability(Stable) static TaskStateBaseOptions.Builder builder()
  
  Returns:
  
  a TaskStateBaseOptions.Builder of TaskStateBaseOptions

Interface TaskStateBaseOptions

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getCredentials

getHeartbeat

getHeartbeatTimeout

getIntegrationPattern

getTaskTimeout

getTimeout

builder