Package software.amazon.awscdk.services.stepfunctions

Interface StateBaseProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AthenaGetQueryExecutionJsonataProps, AthenaGetQueryExecutionJsonPathProps, AthenaGetQueryExecutionProps, AthenaGetQueryResultsJsonataProps, AthenaGetQueryResultsJsonPathProps, AthenaGetQueryResultsProps, AthenaStartQueryExecutionJsonataProps, AthenaStartQueryExecutionJsonPathProps, AthenaStartQueryExecutionProps, AthenaStopQueryExecutionJsonataProps, AthenaStopQueryExecutionJsonPathProps, AthenaStopQueryExecutionProps, BatchSubmitJobJsonataProps, BatchSubmitJobJsonPathProps, BatchSubmitJobProps, BedrockCreateModelCustomizationJobProps, BedrockInvokeModelJsonataProps, BedrockInvokeModelJsonPathProps, BedrockInvokeModelProps, CallApiGatewayEndpointBaseProps, CallApiGatewayEndpointJsonataBaseProps, CallApiGatewayEndpointJsonPathBaseProps, CallApiGatewayHttpApiEndpointJsonataProps, CallApiGatewayHttpApiEndpointJsonPathProps, CallApiGatewayHttpApiEndpointProps, CallApiGatewayRestApiEndpointJsonataProps, CallApiGatewayRestApiEndpointJsonPathProps, CallApiGatewayRestApiEndpointProps, CallAwsServiceCrossRegionJsonataProps, CallAwsServiceCrossRegionJsonPathProps, CallAwsServiceCrossRegionProps, CallAwsServiceJsonataProps, CallAwsServiceJsonPathProps, CallAwsServiceProps, ChoiceJsonataProps, ChoiceJsonPathProps, ChoiceProps, CodeBuildStartBuildBatchJsonataProps, CodeBuildStartBuildBatchJsonPathProps, CodeBuildStartBuildBatchProps, CodeBuildStartBuildJsonataProps, CodeBuildStartBuildJsonPathProps, CodeBuildStartBuildProps, DistributedMapJsonataProps, DistributedMapJsonPathProps, DistributedMapProps, 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, FailJsonataProps, FailJsonPathProps, FailProps, GlueDataBrewStartJobRunJsonataProps, GlueDataBrewStartJobRunJsonPathProps, GlueDataBrewStartJobRunProps, GlueStartCrawlerRunJsonataProps, GlueStartCrawlerRunJsonPathProps, GlueStartCrawlerRunProps, GlueStartJobRunJsonataProps, GlueStartJobRunJsonPathProps, GlueStartJobRunProps, HttpInvokeJsonataProps, HttpInvokeJsonPathProps, HttpInvokeProps, JsonataStateProps, JsonPathStateProps, LambdaInvokeJsonataProps, LambdaInvokeJsonPathProps, LambdaInvokeProps, MapBaseProps, MapJsonataProps, MapJsonPathProps, MapProps, MediaConvertCreateJobJsonataProps, MediaConvertCreateJobJsonPathProps, MediaConvertCreateJobProps, ParallelJsonataProps, ParallelJsonPathProps, ParallelProps, PassJsonataProps, PassJsonPathProps, PassProps, SageMakerCreateEndpointConfigJsonataProps, SageMakerCreateEndpointConfigJsonPathProps, SageMakerCreateEndpointConfigProps, SageMakerCreateEndpointJsonataProps, SageMakerCreateEndpointJsonPathProps, SageMakerCreateEndpointProps, SageMakerCreateModelJsonataProps, SageMakerCreateModelJsonPathProps, SageMakerCreateModelProps, SageMakerCreateTrainingJobJsonataProps, SageMakerCreateTrainingJobJsonPathProps, SageMakerCreateTrainingJobProps, SageMakerCreateTransformJobJsonataProps, SageMakerCreateTransformJobJsonPathProps, SageMakerCreateTransformJobProps, SageMakerUpdateEndpointJsonataProps, SageMakerUpdateEndpointJsonPathProps, SageMakerUpdateEndpointProps, SingleStateOptions, SnsPublishJsonataProps, SnsPublishJsonPathProps, SnsPublishProps, SqsSendMessageJsonataProps, SqsSendMessageJsonPathProps, SqsSendMessageProps, StateProps, StepFunctionsInvokeActivityJsonataProps, StepFunctionsInvokeActivityJsonPathProps, StepFunctionsInvokeActivityProps, StepFunctionsStartExecutionJsonataProps, StepFunctionsStartExecutionJsonPathProps, StepFunctionsStartExecutionProps, SucceedJsonataProps, SucceedJsonPathProps, SucceedProps, TaskStateBaseProps, TaskStateJsonataBaseProps, TaskStateJsonPathBaseProps, WaitJsonataProps, WaitJsonPathProps, WaitProps

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, BedrockCreateModelCustomizationJobProps.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, ChoiceJsonataProps.Jsii$Proxy, ChoiceJsonPathProps.Jsii$Proxy, ChoiceProps.Jsii$Proxy, CodeBuildStartBuildBatchJsonataProps.Jsii$Proxy, CodeBuildStartBuildBatchJsonPathProps.Jsii$Proxy, CodeBuildStartBuildBatchProps.Jsii$Proxy, CodeBuildStartBuildJsonataProps.Jsii$Proxy, CodeBuildStartBuildJsonPathProps.Jsii$Proxy, CodeBuildStartBuildProps.Jsii$Proxy, DistributedMapJsonataProps.Jsii$Proxy, DistributedMapJsonPathProps.Jsii$Proxy, DistributedMapProps.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, FailJsonataProps.Jsii$Proxy, FailJsonPathProps.Jsii$Proxy, FailProps.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, JsonataStateProps.Jsii$Proxy, JsonPathStateProps.Jsii$Proxy, LambdaInvokeJsonataProps.Jsii$Proxy, LambdaInvokeJsonPathProps.Jsii$Proxy, LambdaInvokeProps.Jsii$Proxy, MapBaseProps.Jsii$Proxy, MapJsonataProps.Jsii$Proxy, MapJsonPathProps.Jsii$Proxy, MapProps.Jsii$Proxy, MediaConvertCreateJobJsonataProps.Jsii$Proxy, MediaConvertCreateJobJsonPathProps.Jsii$Proxy, MediaConvertCreateJobProps.Jsii$Proxy, ParallelJsonataProps.Jsii$Proxy, ParallelJsonPathProps.Jsii$Proxy, ParallelProps.Jsii$Proxy, PassJsonataProps.Jsii$Proxy, PassJsonPathProps.Jsii$Proxy, PassProps.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, SingleStateOptions.Jsii$Proxy, SnsPublishJsonataProps.Jsii$Proxy, SnsPublishJsonPathProps.Jsii$Proxy, SnsPublishProps.Jsii$Proxy, SqsSendMessageJsonataProps.Jsii$Proxy, SqsSendMessageJsonPathProps.Jsii$Proxy, SqsSendMessageProps.Jsii$Proxy, StateBaseProps.Jsii$Proxy, StateProps.Jsii$Proxy, StepFunctionsInvokeActivityJsonataProps.Jsii$Proxy, StepFunctionsInvokeActivityJsonPathProps.Jsii$Proxy, StepFunctionsInvokeActivityProps.Jsii$Proxy, StepFunctionsStartExecutionJsonataProps.Jsii$Proxy, StepFunctionsStartExecutionJsonPathProps.Jsii$Proxy, StepFunctionsStartExecutionProps.Jsii$Proxy, SucceedJsonataProps.Jsii$Proxy, SucceedJsonPathProps.Jsii$Proxy, SucceedProps.Jsii$Proxy, TaskStateBaseProps.Jsii$Proxy, TaskStateJsonataBaseProps.Jsii$Proxy, TaskStateJsonPathBaseProps.Jsii$Proxy, WaitJsonataProps.Jsii$Proxy, WaitJsonPathProps.Jsii$Proxy, WaitProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:47.884Z")
@Stability(Stable)
public interface StateBaseProps
extends software.amazon.jsii.JsiiSerializable

Properties shared by all 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.services.stepfunctions.*;
 StateBaseProps stateBaseProps = StateBaseProps.builder()
         .comment("comment")
         .queryLanguage(QueryLanguage.JSON_PATH)
         .stateName("stateName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	StateBaseProps.Builder	A builder for StateBaseProps
static final class	StateBaseProps.Jsii$Proxy	An implementation for StateBaseProps

Method Summary

Modifier and Type	Method	Description
static StateBaseProps.Builder	builder()
default String	getComment()	A comment describing this state.
default QueryLanguage	getQueryLanguage()	The name of the query language used by the state.
default String	getStateName()	Optional name for this state.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComment

@Stability(Stable)
@Nullable
default String getComment()

A comment describing this state.

Default: No comment

getQueryLanguage

@Stability(Stable)
@Nullable
default QueryLanguage getQueryLanguage()

The name of the query language used by the state.

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

Default: - JSONPath

getStateName

@Stability(Stable)
@Nullable
default String getStateName()

Optional name for this state.

Default: - The construct ID will be used as state name

builder

@Stability(Stable)
static StateBaseProps.Builder builder()

Returns:

a StateBaseProps.Builder of StateBaseProps