Skip to content

(stepfunctions): use Definition instead of DefinitionString #18880

@rittneje

Description

@rittneje

Description

When generating the CloudFormation template for an AWS::StepFunctions::StateMachine, use the Definition field not DefinitionString.

Use Case

When things change in the step function definition, using DefinitionString leads to a completely inscrutable CDK diff. For example, while switching from Task to LambdaInvoke, some fields in the JSON were reordered, and we got a cdk diff that we weren't expecting and was not at all human readable.

Proposed Solution

Never use DefinitionString. Always use Definition. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definition

Other information

No response

Acknowledge

  • I may be able to implement this feature request
  • This feature might incur a breaking change

Metadata

Metadata

Assignees

No one assigned

    Labels

    @aws-cdk/aws-stepfunctionsRelated to AWS StepFunctionseffort/smallSmall work item – less than a day of effortfeature-requestA feature should be added or improved.p2

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions