mirror of
https://gitea.com/mcereda/oam.git
synced 2026-02-09 05:44:23 +00:00
fix(kb/aws): warn about argument cases being inconsistent
This commit is contained in:
@@ -568,7 +568,7 @@ Refer [What is Step Functions?].
|
|||||||
|
|
||||||
Workflows (A.K.A. _state machines_) for building applications, automating processes, orchestrating microservices, and
|
Workflows (A.K.A. _state machines_) for building applications, automating processes, orchestrating microservices, and
|
||||||
creating pipelines.<br/>
|
creating pipelines.<br/>
|
||||||
Can also be long-running and require human interaction.
|
Can also be long-running, and require human interaction if correctly configured.
|
||||||
|
|
||||||
Step Functions call AWS services or external workers to perform tasks.<br/>
|
Step Functions call AWS services or external workers to perform tasks.<br/>
|
||||||
They can also call other Step Functions in various ways (wait for finish, just start, …). See
|
They can also call other Step Functions in various ways (wait for finish, just start, …). See
|
||||||
@@ -585,7 +585,7 @@ In the context of Step Functions:
|
|||||||
|
|
||||||
Workflows can be:
|
Workflows can be:
|
||||||
|
|
||||||
- _Standard_, if they run each step **exactly** once, for long time.<br/>
|
- _Standard_, if they run each step **exactly** once, eventually for long time.<br/>
|
||||||
They can run for up to 1y, are auditable, and show execution history and visual debugging.
|
They can run for up to 1y, are auditable, and show execution history and visual debugging.
|
||||||
|
|
||||||
Step Functions counts a _state transition_ each time a step in a standard workflow is executed.<br/>
|
Step Functions counts a _state transition_ each time a step in a standard workflow is executed.<br/>
|
||||||
@@ -662,6 +662,9 @@ If wanting to send logs to CloudWatch, the execution role must be able to access
|
|||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
The casing of arguments is inconsistent and might change from one called resource to another or even inside them.<br/>
|
||||||
|
E.g., `arn:aws:states:::aws-sdk:rds:restoreDBInstanceToPointInTime` uses both `SourceDBInstanceIdentifier` (focus on
|
||||||
|
`DB`, both letters being uppercase) and `DbInstanceClass` (focus on `Db`, only `D` being uppercase).<br/>
|
||||||
Unless one knows exactly what one is doing, prefer setting arguments from the service's Console to have _some_ level of
|
Unless one knows exactly what one is doing, prefer setting arguments from the service's Console to have _some_ level of
|
||||||
suggestions.
|
suggestions.
|
||||||
|
|
||||||
|
|||||||
@@ -29,6 +29,8 @@ type StateMachineBaseState = {
|
|||||||
/**
|
/**
|
||||||
* Choice state.\
|
* Choice state.\
|
||||||
* Enables conditional branching.
|
* Enables conditional branching.
|
||||||
|
*
|
||||||
|
* Refer <https://docs.aws.amazon.com/step-functions/latest/dg/state-choice.html>.
|
||||||
*/
|
*/
|
||||||
interface StateMachineChoiceState extends StateMachineBaseState {
|
interface StateMachineChoiceState extends StateMachineBaseState {
|
||||||
Type: "Choice";
|
Type: "Choice";
|
||||||
@@ -47,6 +49,8 @@ type StateMachineParallelBranch = {
|
|||||||
/**
|
/**
|
||||||
* Parallel state.\
|
* Parallel state.\
|
||||||
* Runs other step states in parallel.
|
* Runs other step states in parallel.
|
||||||
|
*
|
||||||
|
* Refer <https://docs.aws.amazon.com/step-functions/latest/dg/state-parallel.html>.
|
||||||
*/
|
*/
|
||||||
interface StateMachineParallelState extends StateMachineBaseState {
|
interface StateMachineParallelState extends StateMachineBaseState {
|
||||||
Type: "Parallel";
|
Type: "Parallel";
|
||||||
@@ -56,6 +60,8 @@ interface StateMachineParallelState extends StateMachineBaseState {
|
|||||||
/**
|
/**
|
||||||
* Task state.\
|
* Task state.\
|
||||||
* Runs a service integration or Lambda function.
|
* Runs a service integration or Lambda function.
|
||||||
|
*
|
||||||
|
* Refer <https://docs.aws.amazon.com/step-functions/latest/dg/state-task.html>.
|
||||||
*/
|
*/
|
||||||
interface StateMachineTaskState extends StateMachineBaseState {
|
interface StateMachineTaskState extends StateMachineBaseState {
|
||||||
Type: "Task";
|
Type: "Task";
|
||||||
@@ -67,6 +73,8 @@ interface StateMachineTaskState extends StateMachineBaseState {
|
|||||||
/**
|
/**
|
||||||
* Wait state.\
|
* Wait state.\
|
||||||
* Pauses execution for a fixed duration or until a specified time or date.
|
* Pauses execution for a fixed duration or until a specified time or date.
|
||||||
|
*
|
||||||
|
* Refer <https://docs.aws.amazon.com/step-functions/latest/dg/state-wait.html>.
|
||||||
*/
|
*/
|
||||||
interface StateMachineWaitState extends StateMachineBaseState {
|
interface StateMachineWaitState extends StateMachineBaseState {
|
||||||
Type: "Wait";
|
Type: "Wait";
|
||||||
@@ -110,7 +118,7 @@ const checkClonedDbInstanceIsAvailable: StateMachineChoiceState = {
|
|||||||
Type: "Choice",
|
Type: "Choice",
|
||||||
Choices: [
|
Choices: [
|
||||||
{
|
{
|
||||||
Condition: "{% $states.input.ClonedDBInstance.DBInstanceStatus in ['available'] %}",
|
Condition: "{% $states.input.ClonedDBInstance.DbInstanceStatus in ['available'] %}",
|
||||||
Next: "ChangeClonedDBInstancePassword",
|
Next: "ChangeClonedDBInstancePassword",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
|
|||||||
Reference in New Issue
Block a user