Deploy
apigateway.create_deployment
ActionAmazon Web Servicesconnection required
Calls the AWS apigateway API (SigV4).
Deploy a REST API to a stage.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Amazon API Gateway
- Secret shape
- {"access_key_id", "secret_access_key"}
- Config it needs
- region
- Resolved by
- config.connection_id, else node.connection_id
Configuration
4 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
region AWS region (overrides the connection). | string | No | — | — | — |
rest_api_id Id of the rest api to act on, from its API Gateway URL or console — not its name. | string | Yes | — | — | — |
stage_name Stage to deploy to. | string | Yes | — | — | — |
description Deployment description. | string | No | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
deployment_id | string | — |
created_date When the deployment was created, epoch seconds. | number | — |
stage_name | string | — |
{
"created_date": 0,
"deployment_id": "",
"stage_name": ""
}Related Amazon API Gateway nodes
See Deploy run in a workflow.
In a technical demo we add the Amazon API Gateway connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.