Skip to content

Commit 99293a6

Browse files
author
Bob Strahan
committed
Update IDP CLI documentation with template URL parameter and deployment examples
1 parent 8717f73 commit 99293a6

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

docs/idp-cli.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,14 +113,16 @@ idp-cli deploy [OPTIONS]
113113

114114
**Required for New Stacks:**
115115
- `--stack-name`: CloudFormation stack name
116-
- `--pattern`: IDP pattern (`pattern-1`, `pattern-2`, or `pattern-3`)
116+
- `--pattern`: IDP pattern architecture to deploy (`pattern-1`, `pattern-2`, or `pattern-3`)
117117
- `--admin-email`: Admin user email
118118

119119
**Optional Parameters:**
120+
- `--template-url`: URL to CloudFormation template in S3 (optional, auto-selected based on region)
120121
- `--custom-config`: Path to local config file or S3 URI
121122
- `--max-concurrent`: Maximum concurrent workflows (default: 100)
122-
- `--log-level`: Logging level (`DEBUG`, `INFO`, `WARN`, `ERROR`)
123+
- `--log-level`: Logging level (`DEBUG`, `INFO`, `WARN`, `ERROR`) (default: INFO)
123124
- `--enable-hitl`: Enable Human-in-the-Loop (`true` or `false`)
125+
- `--pattern-config`: Pattern-specific configuration preset (optional, distinct from --pattern)
124126
- `--parameters`: Additional parameters as `key=value,key2=value2`
125127
- `--wait`: Wait for stack operation to complete
126128
- `--region`: AWS region (optional, auto-detected)
@@ -147,6 +149,15 @@ idp-cli deploy \
147149
--max-concurrent 200 \
148150
--log-level DEBUG \
149151
--wait
152+
153+
# Deploy with custom template URL (for regions not auto-supported)
154+
idp-cli deploy \
155+
--stack-name my-idp \
156+
--pattern pattern-2 \
157+
--admin-email user@example.com \
158+
--template-url https://s3.eu-west-1.amazonaws.com/my-bucket/idp-main.yaml \
159+
--region eu-west-1 \
160+
--wait
150161
```
151162

152163
---

0 commit comments

Comments
 (0)