feat(stepfunctions): adding custom state name prop (#27306)

Closes #23532

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

Author: SankyRed

packages/aws-cdk-lib/aws-stepfunctions/README.md

@@ -124,6 +124,7 @@ becomes new the new Data object. This behavior can be modified by supplying valu
 
 These properties impact how each individual step interacts with the state machine data:
 
+* `stateName`: the name of the state in the state machine definition. If not supplied, defaults to the construct id.
 * `inputPath`: the part of the data object that gets passed to the step (`itemsPath` for `Map` states)
 * `resultSelector`: the part of the step result that should be added to the state machine data
 * `resultPath`: where in the state machine data the step result should be inserted
@@ -285,6 +286,7 @@ and also injects a field called `otherData`.
 
 ```ts
 const pass = new sfn.Pass(this, 'Filter input and inject data', {
+  stateName: 'my-pass-state', // the custom state name for the Pass state, defaults to 'Filter input and inject data' as the state name
   parameters: { // input to the pass state
     input: sfn.JsonPath.stringAt('$.input.greeting'),
     otherData: 'some-extra-stuff',

packages/aws-cdk-lib/aws-stepfunctions/lib/state-machine.ts

@@ -101,7 +101,7 @@ export interface StateMachineProps {
   readonly definitionBody?: DefinitionBody;
 
   /**
-   * substitutions for the definition body aas a key-value map
+   * substitutions for the definition body as a key-value map
    */
   readonly definitionSubstitutions?: { [key: string]: string };
 

packages/aws-cdk-lib/aws-stepfunctions/lib/states/choice.ts

@@ -9,6 +9,13 @@ import { IChainable, INextable } from '../types';
  * Properties for defining a Choice state
  */
 export interface ChoiceProps {
+  /**
+   * Optional name for this state
+   *
+   * @default - The construct ID will be used as state name
+   */
+  readonly stateName?: string;
+
   /**
    * An optional description for this state
    *

packages/aws-cdk-lib/aws-stepfunctions/lib/states/fail.ts

@@ -7,6 +7,13 @@ import { INextable } from '../types';
  * Properties for defining a Fail state
  */
 export interface FailProps {
+  /**
+   * Optional name for this state
+   *
+   * @default - The construct ID will be used as state name
+   */
+  readonly stateName?: string;
+
   /**
    * An optional description for this state
    *

packages/aws-cdk-lib/aws-stepfunctions/lib/states/map.ts

@@ -11,6 +11,13 @@ import { CatchProps, IChainable, INextable, RetryProps } from '../types';
  * Properties for defining a Map state
  */
 export interface MapProps {
+  /**
+   * Optional name for this state
+   *
+   * @default - The construct ID will be used as state name
+   */
+  readonly stateName?: string;
+
   /**
    * An optional description for this state
    *

packages/aws-cdk-lib/aws-stepfunctions/lib/states/parallel.ts

@@ -9,6 +9,13 @@ import { CatchProps, IChainable, INextable, RetryProps } from '../types';
  * Properties for defining a Parallel state
  */
 export interface ParallelProps {
+  /**
+   * Optional name for this state
+   *
+   * @default - The construct ID will be used as state name
+   */
+  readonly stateName?: string;
+
   /**
    * An optional description for this state
    *

packages/aws-cdk-lib/aws-stepfunctions/lib/states/pass.ts

@@ -56,6 +56,13 @@ export class Result {
  * Properties for defining a Pass state
  */
 export interface PassProps {
+  /**
+   * Optional name for this state
+   *
+   * @default - The construct ID will be used as state name
+   */
+  readonly stateName?: string;
+
   /**
    * An optional description for this state
    *

packages/aws-cdk-lib/aws-stepfunctions/lib/states/state.ts

@@ -9,6 +9,13 @@ import { CatchProps, Errors, IChainable, INextable, RetryProps } from '../types'
  * Properties shared by all states
  */
 export interface StateProps {
+  /**
+   * Optional name for this state
+   *
+   * @default - The construct ID will be used as state name
+   */
+  readonly stateName?: string;
+
   /**
    * A comment describing this state
    *
@@ -155,6 +162,7 @@ export abstract class State extends Construct implements IChainable {
   // features are shared by a couple of states, and it becomes cumbersome to
   // slice it out across all states. This is not great design, but it is
   // pragmatic!
+  protected readonly stateName?: string;
   protected readonly comment?: string;
   protected readonly inputPath?: string;
   protected readonly parameters?: object;
@@ -194,6 +202,7 @@ export abstract class State extends Construct implements IChainable {
 
     this.startState = this;
 
+    this.stateName = props.stateName;
     this.comment = props.comment;
     this.inputPath = props.inputPath;
     this.parameters = props.parameters;
@@ -219,7 +228,7 @@ export abstract class State extends Construct implements IChainable {
    * Tokenized string that evaluates to the state's ID
    */
   public get stateId(): string {
-    return this.prefixes.concat(this.id).join('');
+    return this.prefixes.concat(this.stateName? this.stateName: this.id).join('');
   }
 
   /**

packages/aws-cdk-lib/aws-stepfunctions/lib/states/succeed.ts

@@ -7,6 +7,13 @@ import { INextable } from '../types';
  * Properties for defining a Succeed state
  */
 export interface SucceedProps {
+  /**
+   * Optional name for this state
+   *
+   * @default - The construct ID will be used as state name
+   */
+  readonly stateName?: string;
+
   /**
    * An optional description for this state
    *

packages/aws-cdk-lib/aws-stepfunctions/lib/states/task-base.ts

@@ -13,6 +13,13 @@ import { CatchProps, IChainable, INextable, RetryProps } from '../types';
  * Props that are common to all tasks
  */
 export interface TaskStateBaseProps {
+  /**
+   * Optional name for this state
+   *
+   * @default - The construct ID will be used as state name
+   */
+  readonly stateName?: string;
+
   /**
    * An optional description for this state
    *