AWS step-functions documentation change
Summary
Updated template selection instructions and restructured workflow creation steps. Clarified differences between 'Run a demo' (read-only with auto-deployed resources) and 'Build on it' (editable without auto-created resources). Streamlined execution steps and removed ASCII character warnings.
Security assessment
Changes focus on workflow clarity and template usage instructions. While the clarification about resources not being auto-created in 'Build on it' mode could prevent misconfigurations, there's no explicit mention of security vulnerabilities or security feature enhancements.
Diff
diff --git a/step-functions/latest/dg/sample-batch-fan-out.md b/step-functions/latest/dg/sample-batch-fan-out.md index d12defad2..9b18d84c8 100644 --- a/step-functions/latest/dg/sample-batch-fan-out.md +++ b/step-functions/latest/dg/sample-batch-fan-out.md @@ -5 +5 @@ -Step 1: Create the state machineStep 2: Run the state machine +Step 1: Create the state machineStep 2: Run the demo state machine @@ -17 +17 @@ In this project, Step Functions uses a state machine to invoke a Lambda function - 2. Find and choose the starter template you want to work with. Choose **Next** to continue. + 2. Choose **Create from template** and find the related starter template. Choose **Next** to continue. @@ -19,18 +19 @@ In this project, Step Functions uses a state machine to invoke a Lambda function - 3. Choose **Run a demo** to create a read-only and ready-to-deploy workflow, or choose **Build on it** to create an editable state machine definition that you can build on and later deploy. - - 4. Choose **Use template** to continue with your selection. - - - - -Next steps depend on your previous choice: - - 1. **Run a demo** – You can review the state machine before you create a **read-only** project with resources deployed by AWS CloudFormation to your AWS account. - -You can view the state machine definition, and when you are ready, choose **Deploy and run** to deploy the project and create the resources. - -Deploying can take up to 10 minutes to create resources and permissions. You can use the Stack ID link to monitor progress in AWS CloudFormation. - -After deploy completes, you should see your new state machine in the console. - - 2. **Build on it** – You can review and edit the workflow definition. You might need to set values for placeholders in the sample project before attemping to run your custom workflow. + 3. Choose how to use the template: @@ -37,0 +21 @@ After deploy completes, you should see your new state machine in the console. + 1. **Run a demo** – creates a read-only state machine. After review, you can create the workflow and all related resources. @@ -38,0 +23 @@ After deploy completes, you should see your new state machine in the console. + 2. **Build on it** – provides an editable workflow definition that you can review, customize, and deploy with your own resources. (Related resources, such as functions or queues, will **not** be created automatically.) @@ -39,0 +25 @@ After deploy completes, you should see your new state machine in the console. + 4. Choose **Use template** to continue with your selection. @@ -43,5 +29 @@ After deploy completes, you should see your new state machine in the console. - _Standard charges might apply for services deployed to your account._ - -## Step 2: Run the state machine - - 1. On the **State machines** page, choose your sample project. + _Standard charges apply for services deployed to your account._ @@ -49 +30,0 @@ After deploy completes, you should see your new state machine in the console. - 2. On the sample project page, choose **Start execution**. @@ -51 +31,0 @@ After deploy completes, you should see your new state machine in the console. - 3. In the **Start execution** dialog box, do the following: @@ -53 +32,0 @@ After deploy completes, you should see your new state machine in the console. - 1. (Optional) Enter a custom execution name to override the generated default. @@ -55 +34 @@ After deploy completes, you should see your new state machine in the console. -###### Non-ASCII names and logging +## Step 2: Run the demo state machine @@ -57 +36 @@ After deploy completes, you should see your new state machine in the console. -Step Functions accepts names for state machines, executions, activities, and labels that contain non-ASCII characters. Because such characters will not work with Amazon CloudWatch, we recommend using only ASCII characters so you can track metrics in CloudWatch. +If you chose the **Run a demo** option, all related resources will be deployed and ready to run. If you chose the **Build on it** option, you might need to set placeholder values and create additional resources before you can run your custom workflow. @@ -59 +38 @@ Step Functions accepts names for state machines, executions, activities, and lab - 2. (Optional) In the **Input** box, enter input values as JSON. You can skip this step if you are running a demo. + 1. Choose **Deploy and run**. @@ -61 +40 @@ Step Functions accepts names for state machines, executions, activities, and lab - 3. Choose **Start execution**. + 2. Wait for the AWS CloudFormation stack to deploy. This can take up to 10 minutes. @@ -63 +42 @@ Step Functions accepts names for state machines, executions, activities, and lab -The Step Functions console will direct you to an _Execution Details_ page where you can choose states in the **Graph view** to explore related information in the [Step details](./concepts-view-execution-details.html#exec-details-intf-step-details) pane. + 3. After the **Start execution** option appears, review the **Input** and choose **Start execution**. @@ -70 +49 @@ The Step Functions console will direct you to an _Execution Details_ page where -You should now have either a running demo or a state machine definition that you can customize. +You should now have a running demo of your state machine. You can choose states in the **Graph view** to review input, output, variables, definition, and events.