Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(stepfunctions): replace definition with definitionBody in readm of aws-stepfunctions #27110

Merged
merged 2 commits into from
Sep 12, 2023
Merged

docs(stepfunctions): replace definition with definitionBody in readm of aws-stepfunctions #27110

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a9ee357
replace definition with definitionBody
Sep 12, 2023
0bec9c6
Merge branch 'main' into step-functions-readme
mergify[bot] Sep 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 16 additions & 12 deletions packages/aws-cdk-lib/aws-stepfunctions/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ const definition = submitJob
.otherwise(waitX));

new sfn.StateMachine(this, 'StateMachine', {
definition,
definitionBody: sfn.DefinitionBody.fromChainable(definition),
timeout: Duration.minutes(5),
comment: 'a super cool state machine',
});
Expand All @@ -76,7 +76,7 @@ all states reachable from the start state:
const startState = new sfn.Pass(this, 'StartState');

new sfn.StateMachine(this, 'StateMachine', {
definition: startState,
definitionBody: sfn.DefinitionBody.fromChainable(startState),
});
```

Expand Down Expand Up @@ -565,7 +565,7 @@ const chain = sfn.Chain.start(custom)
.next(finalStatus);

const sm = new sfn.StateMachine(this, 'StateMachine', {
definition: chain,
definitionBody: sfn.DefinitionBody.fromChainable(chain),
timeout: Duration.seconds(30),
comment: 'a super cool state machine',
});
Expand Down Expand Up @@ -610,7 +610,7 @@ const definition = step1
.next(finish);

new sfn.StateMachine(this, 'StateMachine', {
definition,
definitionBody: sfn.DefinitionBody.fromChainable(definition),
});
```

Expand Down Expand Up @@ -712,7 +712,7 @@ class MyStack extends Stack {
.branch(new MyJob(this, 'Slow', { jobFlavor: 'slow' }).prefixStates());

new sfn.StateMachine(this, 'MyStateMachine', {
definition: parallel,
definitionBody: sfn.DefinitionBody.fromChainable(parallel),
});
}
}
Expand Down Expand Up @@ -818,8 +818,10 @@ import * as logs from 'aws-cdk-lib/aws-logs';

const logGroup = new logs.LogGroup(this, 'MyLogGroup');

const definition = sfn.Chain.start(new sfn.Pass(this, 'Pass'));

new sfn.StateMachine(this, 'MyStateMachine', {
definition: sfn.Chain.start(new sfn.Pass(this, 'Pass')),
definitionBody: sfn.DefinitionBody.fromChainable(definition),
logs: {
destination: logGroup,
level: sfn.LogLevel.ALL,
Expand All @@ -832,8 +834,10 @@ new sfn.StateMachine(this, 'MyStateMachine', {
Enable X-Ray tracing for StateMachine:

```ts
const definition = sfn.Chain.start(new sfn.Pass(this, 'Pass'));

new sfn.StateMachine(this, 'MyStateMachine', {
definition: sfn.Chain.start(new sfn.Pass(this, 'Pass')),
definitionBody: sfn.DefinitionBody.fromChainable(definition),
tracingEnabled: true,
});
```
Expand Down Expand Up @@ -864,7 +868,7 @@ const role = new iam.Role(this, 'Role', {

declare const definition: sfn.IChainable;
const stateMachine = new sfn.StateMachine(this, 'StateMachine', {
definition,
definitionBody: sfn.DefinitionBody.fromChainable(definition),
});

// Give role permission to start execution of state machine
Expand All @@ -886,7 +890,7 @@ const role = new iam.Role(this, 'Role', {

declare const definition: sfn.IChainable;
const stateMachine = new sfn.StateMachine(this, 'StateMachine', {
definition,
definitionBody: sfn.DefinitionBody.fromChainable(definition),
});

// Give role read access to state machine
Expand Down Expand Up @@ -915,7 +919,7 @@ const role = new iam.Role(this, 'Role', {

declare const definition: sfn.IChainable;
const stateMachine = new sfn.StateMachine(this, 'StateMachine', {
definition,
definitionBody: sfn.DefinitionBody.fromChainable(definition),
});

// Give role task response permissions to the state machine
Expand All @@ -939,7 +943,7 @@ const role = new iam.Role(this, 'Role', {

declare const definition: sfn.IChainable;
const stateMachine = new sfn.StateMachine(this, 'StateMachine', {
definition,
definitionBody: sfn.DefinitionBody.fromChainable(definition),
});

// Give role permission to get execution history of ALL executions for the state machine
Expand All @@ -955,7 +959,7 @@ const user = new iam.User(this, 'MyUser');

declare const definition: sfn.IChainable;
const stateMachine = new sfn.StateMachine(this, 'StateMachine', {
definition,
definitionBody: sfn.DefinitionBody.fromChainable(definition),
});

//give user permission to send task success to the state machine
Expand Down