Amazon API Gateway Concepts: Difference between revisions
Jump to navigation
Jump to search
| Line 55: | Line 55: | ||
==<span id='Deployment'></span><span id='API_Deployment'></span>Deployment (API Deployment)== | ==<span id='Deployment'></span><span id='API_Deployment'></span>Deployment (API Deployment)== | ||
A Deployment resource represents a REST API deployment. The Deployment is like an executable of an API represented by a [[#RestApi|RestApi]] resource. | A Deployment resource represents a REST API deployment. The Deployment is like an executable of an API represented by a [[#RestApi|RestApi]] resource. Once an [[#RestAPI|API]] is created, it requires deployment and association with a [[#Stage|stage]] to make it callable by its users. To call a deployed URL, clients submit [[REST_and_Hypermedia#Request|requests]] against the API's URL. | ||
Once an [[#RestAPI|API]] is created, it requires deployment to make it callable by its users. To call a deployed URL, clients submit [[REST_and_Hypermedia#Request|requests]] against the API's URL. | |||
[[REST_and_Hypermedia#Resource|Resource]] updates require redeploying the API, whereas configuration updates to not. | [[REST_and_Hypermedia#Resource|Resource]] updates require redeploying the API, whereas configuration updates to not. | ||
Revision as of 22:47, 4 February 2019
Internal
REST and Hypermedia Concepts
Amazon Gateway URL
The URL is determined by a protocol (HTTP(S) or WSS), a hostname, a stage name and, for REST APIs, the resource path.
Amazon Gateway API Base URL
The hostname and the stage name determine the API's base URL.
Amazon Gateway Hostname
https://{restapi-id}.execute-api.{region}.amazonaws.com
Amazon API Gateway Resources that Require Redeployment
RestApi
Resource
Method
RequestValidator
MethodResponse
Integration
IntegrationResponse
GatewayResponse
DocumentationPart
DocumentationVersion
Model
ApiKey
Authorizer
VpcLink
Amazon API Gateway Resources that Require Configuration Changes without Redeployment
Account
Deployment (API Deployment)
A Deployment resource represents a REST API deployment. The Deployment is like an executable of an API represented by a RestApi resource. Once an API is created, it requires deployment and association with a stage to make it callable by its users. To call a deployed URL, clients submit requests against the API's URL.
Resource updates require redeploying the API, whereas configuration updates to not.
DomainName
BasePathMapping
Stage
An API stage is ...
Usage
UsagePlan
API Documentation
See DocumentationPart and DocumentationVersion above.