La ressource ALIYUN::ApiGateway::Deployment permet de publier une API dans un environnement d'exécution spécifique ou de basculer une API publiée vers une version donnée.
Syntaxe
{
"Type": "ALIYUN::ApiGateway::Deployment",
"Properties": {
"HistoryVersion": String ,
"ApiId": String ,
"Description": String ,
"StageName": String ,
"GroupId": String
}
}Propriétés
Propriété | Type | Obligatoire | Modifiable | Description | Contrainte |
ApiId | String | Oui | Non | Identifiant de l'API. | Aucune. |
GroupId | String | Oui | Non | Identifiant du groupe d'API. | Aucune. |
StageName | String | Oui | Oui | Nom de l'environnement d'exécution. | Valeurs valides :
Vous ne pouvez pas spécifier simultanément les propriétés HistoryVersion et StageName. |
Description | String | Non | Oui | Description du déploiement actuel. | Aucune. |
HistoryVersion | String | Non | Oui | Version historique de l'API. Si cette propriété est définie, l'API publiée bascule vers la version spécifiée. Sinon, l'API est publiée. | Vous ne pouvez pas spécifier simultanément les propriétés HistoryVersion et StageName. |
Valeurs de retour
Fn::GetAtt
Aucune.
Exemples
Format YAML
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
GroupId:
Type: 'String '
Description: API group ID
ApiId:
Type: 'String '
Description: API ID
Resources:
Deployment:
Type: ALIYUN::ApiGateway::Deployment
Properties:
GroupId:
Ref: GroupId
ApiId:
Ref: ApiId
StageName: PRE
Description: TEST_ONLY_CHANGE
Format JSON
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"GroupId": {
"Type": "String ",
"Description": "API group ID"
},
"ApiId": {
"Type": "String ",
"Description": "API ID"
}
},
"Resources": {
"Deployment": {
"Type": "ALIYUN::ApiGateway::Deployment",
"Properties": {
"GroupId": {
"Ref": "GroupId"
},
"ApiId": {
"Ref": "ApiId"
},
"StageName": "PRE",
"Description": "TEST_ONLY_CHANGE"
}
}
}
}