Skip to content

Commit

Permalink
chore: update cdk docs
Browse files Browse the repository at this point in the history
  • Loading branch information
OlafConijn committed Jan 28, 2024
1 parent bd27987 commit 145a572
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ All notable changes to aws organization formation will be documented in this fil
**BREAKING CHANGES**:
- v1.0.0: execution role under which org-formation is ran requires the ec2:describeRegions permission

**unreleased**
**version: 1.0.13**
- fix: cdk tasks use `--force` when deleting stacks
- chore: usage of AWS SDK v3 (upgrade from V2)
- fix: deleting stacks without explicit concurrency settings will default to settings passed to the CLI (instead of 1)
Expand Down
4 changes: 2 additions & 2 deletions docs/task-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -444,8 +444,8 @@ The `update-cdk` task will deploy the a CDK workload defined in the directory sp
| IgnoreFileChanges | string or list | Regex, Name or list of regex/names for files that if matched will be ignored when generating the MD5 hash to detect if update is actually necessary. |
| RunNpmInstall | boolean | When true, `npm ci` will be ran before CDK and removal |
| RunNpmBuild | boolean | When true, `npm run build` will be ran before CDK and removal |
| CustomDeployCommand | string | When specified will override the default command used when deploying a CDK workload. <br/><br/>default command is: `npm ci && npm run build && npx cdk deploy --all --require-approval ${CurrentTask.Parameters} --output cdk.out/${CurrentTask.AccountId} `. |
| CustomRemoveCommand | string | When specified will override the default command used when removing a CDK workload. <br/><br/>default command is: `npm ci && npm run build && npx cdk destroy --all --require-approval ${CurrentTask.Parameters} `. |
| CustomDeployCommand | string | When specified will override the default command used when deploying a CDK workload. <br/><br/>default command is: `npm ci && npm run build && npx cdk deploy --all --require-approval=never ${CurrentTask.Parameters} --output cdk.out/${CurrentTask.AccountId} `. |
| CustomRemoveCommand | string | When specified will override the default command used when removing a CDK workload. <br/><br/>default command is: `npm ci && npm run build && npx cdk destroy --all --force ${CurrentTask.Parameters} `. |
| DependsOn | Name of task or list of names | The tasks listed in this attribute will be executed before this task. |
| Skip | `true` or `false` | When `true` task (and dependent tasks) will not be executed. |
| TaskRoleName | string | Specifies the name of the IAM Role that must be used for cross account access. A role with this is expected to exist in the target account (and have the right AssumeRole permissions). |
Expand Down

0 comments on commit 145a572

Please sign in to comment.