ALIYUN::ApiGateway::Deployment digunakan untuk menerbitkan API ke lingkungan runtime tertentu atau beralih ke versi tertentu dari API yang telah diterbitkan.
Sintaksis
{
"Type": "ALIYUN::ApiGateway::Deployment",
"Properties": {
"HistoryVersion": String ,
"ApiId": String ,
"Description": String ,
"StageName": String ,
"GroupId": String
}
}Properti
Properti | Tipe | Diperlukan | Dapat Diedit | Deskripsi | Kendala |
ApiId | String | Ya | Tidak | ID dari API. | Tidak ada. |
GroupId | String | Ya | Tidak | ID dari grup API. | Tidak ada. |
StageName | String | Ya | Ya | Nama dari lingkungan runtime. | Nilai yang valid:
Anda tidak dapat menentukan HistoryVersion dan StageName pada saat yang sama. |
Description | String | Tidak | Ya | Deskripsi dari penerbitan saat ini. | Tidak ada. |
HistoryVersion | String | Tidak | Ya | Versi historis dari API. Jika properti ini ditentukan, API yang diterbitkan akan beralih ke versi yang ditentukan. Jika properti ini tidak ditentukan, API akan diterbitkan. | Anda tidak dapat menentukan HistoryVersion dan StageName pada saat yang sama. |
Nilai kembali
Fn::GetAtt
Tidak ada.
Contoh
YAML format
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
GroupId:
Type: 'String '
Description: ID grup API
ApiId:
Type: 'String '
Description: ID API
Resources:
Deployment:
Type: ALIYUN::ApiGateway::Deployment
Properties:
GroupId:
Ref: GroupId
ApiId:
Ref: ApiId
StageName: PRE
Description: TEST_ONLY_CHANGE
JSON format
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"GroupId": {
"Type": "String ",
"Description": "ID grup API"
},
"ApiId": {
"Type": "String ",
"Description": "ID API"
}
},
"Resources": {
"Deployment": {
"Type": "ALIYUN::ApiGateway::Deployment",
"Properties": {
"GroupId": {
"Ref": "GroupId"
},
"ApiId": {
"Ref": "ApiId"
},
"StageName": "PRE",
"Description": "TEST_ONLY_CHANGE"
}
}
}
}