APIs.io Engineering Platform · Schema
CreateDeploymentRequest
Requests API Gateway to create a Deployment resource.
APIs.ioEngineeringPlatform
Properties
| Name | Type | Description |
|---|---|---|
| stageName | object | |
| stageDescription | object | |
| description | object | |
| cacheClusterEnabled | object | |
| cacheClusterSize | object | |
| variables | object | |
| canarySettings | object | |
| tracingEnabled | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/CreateDeploymentRequest",
"title": "CreateDeploymentRequest",
"type": "object",
"properties": {
"stageName": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The name of the Stage resource for the Deployment resource to create."
}
]
},
"stageDescription": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The description of the Stage resource for the Deployment resource to create."
}
]
},
"description": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The description for the Deployment resource to create."
}
]
},
"cacheClusterEnabled": {
"allOf": [
{
"$ref": "#/components/schemas/NullableBoolean"
},
{
"description": "Enables a cache cluster for the Stage resource specified in the input."
}
]
},
"cacheClusterSize": {
"allOf": [
{
"$ref": "#/components/schemas/CacheClusterSize"
},
{
"description": "The stage's cache capacity in GB. For more information about choosing a cache size, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html\">Enabling API caching to enhance responsiveness</a>."
}
]
},
"variables": {
"allOf": [
{
"$ref": "#/components/schemas/MapOfStringToString"
},
{
"description": "A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match <code>[A-Za-z0-9-._~:/?#&=,]+</code>."
}
]
},
"canarySettings": {
"allOf": [
{
"$ref": "#/components/schemas/DeploymentCanarySettings"
},
{
"description": "The input configuration for the canary deployment when the deployment is a canary release deployment. "
}
]
},
"tracingEnabled": {
"allOf": [
{
"$ref": "#/components/schemas/NullableBoolean"
},
{
"description": "Specifies whether active tracing with X-ray is enabled for the Stage."
}
]
}
},
"description": "Requests API Gateway to create a Deployment resource."
}