StateBaseProps Struct
Properties shared by all states.
| Source | aws-stepfunctions/lib/states/state.ts |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
const stateBaseProps: stepfunctions.StateBaseProps = {
comment: 'comment',
queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
stateName: 'stateName',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_stepfunctions as stepfunctions
state_base_props = stepfunctions.StateBaseProps(
comment="comment",
query_language=stepfunctions.QueryLanguage.JSON_PATH,
state_name="stateName"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.StepFunctions;
var stateBaseProps = new StateBaseProps {
Comment = "comment",
QueryLanguage = QueryLanguage.JSON_PATH,
StateName = "stateName"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
stateBaseProps := &StateBaseProps{
Comment: jsii.String("comment"),
QueryLanguage: awscdk.Aws_stepfunctions.QueryLanguage_JSON_PATH,
StateName: jsii.String("stateName"),
}
Properties
commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string #A comment describing this state.
Default: No comment
queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage = JSONPath #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.
stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string #Optional name for this state.
Default: The construct ID will be used as state name