特定の実行時環境に API を公開するために ALIYUN::ApiGateway::Deployment を使用します。 - Resource Orchestration Service

ALIYUN::ApiGateway::Deployment は、特定の実行時環境に API を公開したり、公開済みの API を特定のバージョンに切り替えたりするために使用されます。

構文

{
  "Type": "ALIYUN::ApiGateway::Deployment",
  "Properties": {
    "HistoryVersion": String ,
    "ApiId": String ,
    "Description": String ,
    "StageName": String ,
    "GroupId": String 
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ApiId	String	はい	いいえ	API の ID。	なし。
GroupId	String	はい	いいえ	API グループの ID。	なし。
StageName	String	はい	はい	実行時環境の名前。	有効な値: TEST PRE RELEASE HistoryVersion と StageName を同時に指定することはできません。
Description	String	いいえ	はい	現在の公開の説明。	なし。
HistoryVersion	String	いいえ	はい	API の履歴バージョン。このプロパティが指定されている場合、公開されている API は指定されたバージョンに切り替えられます。このプロパティが指定されていない場合、API は公開されます。	HistoryVersion と StageName を同時に指定することはできません。

戻り値

Fn::GetAtt

なし。

例

`YAML` 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  GroupId:
    Type: 'String '
    Description: API group ID  # API グループ ID
  ApiId:
    Type: 'String '
    Description: API ID # API ID
Resources:
  Deployment:
    Type: ALIYUN::ApiGateway::Deployment
    Properties:
      GroupId:
        Ref: GroupId
      ApiId:
        Ref: ApiId
      StageName: PRE
      Description: TEST_ONLY_CHANGE

`JSON` 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GroupId": {
      "Type": "String ",
      "Description": "API group ID" // API グループ ID
    },
    "ApiId": {
      "Type": "String ",
      "Description": "API ID" // API ID
    }
  },
  "Resources": {
    "Deployment": {
      "Type": "ALIYUN::ApiGateway::Deployment",
      "Properties": {
        "GroupId": {
          "Ref": "GroupId"
        },
        "ApiId": {
          "Ref": "ApiId"
        },
        "StageName": "PRE",
        "Description": "TEST_ONLY_CHANGE"
      }
    }
  }
}

構文

プロパティ

戻り値

例

YAML 形式

JSON 形式

`YAML` 形式

`JSON` 形式