ALIYUN::ApiGateway::Backend - Resource Orchestration Service

ALIYUN::ApiGateway::Backend is used to create a backend service.

Syntax

{
  "Type": "ALIYUN::ApiGateway::Backend",
  "Properties": {
    "BackendName": String,
    "BackendType": String,
    "Description": String,
    "Tags": List
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
BackendName	String	Yes	Yes	The name of the backend Service.	None.
BackendType	String	Yes	No	The type of the backend service.	Valid values: HTTP VPC FC_EVENT FC_EVENT_V3 FC_HTTP FC_HTTP_V3 OSS MOCK
Description	String	No	Yes	The description.	None.
Tags	List	No	Yes	The tags.	For more information, see Tags properties.

Tags syntax

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags properties

Property	Type	Required	Editable	Description	Constraint
Key	String	Yes	No	The key of the tag.	None.
Value	String	Yes	No	The value of the tag.	None.

Return values

Fn::GetAtt

BackendId: the ID of the backend service.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  BackendName:
    Type: String
    Description:
      en: The name of the backend service.
    Required: true
  BackendType:
    Type: String
    Description:
      en: 'The type the backend service. Allowed values: HTTP, VPC, FC_EVENT, FC_EVENT_V3, FC_HTTP, FC_HTTP_V3, OSS, MOCK'
    AllowedValues:
      - HTTP
      - VPC
      - FC_EVENT
      - FC_EVENT_V3
      - FC_HTTP
      - FC_HTTP_V3
      - OSS
      - MOCK
    Required: true
Resources:
  Backend:
    Type: ALIYUN::ApiGateway::Backend
    Properties:
      BackendName:
        Ref: BackendName
      BackendType:
        Ref: BackendType
Outputs:
  BackendId:
    Description: The ID of the backend service.
    Value:
      Fn::GetAtt:
        - Backend
        - BackendId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "BackendName": {
      "Type": "String",
      "Description": {
        "en": "The name of the backend service."
      },
      "Required": true
    },
    "BackendType": {
      "Type": "String",
      "Description": {
        "en": "The type the backend service. Allowed values: HTTP, VPC, FC_EVENT, FC_EVENT_V3, FC_HTTP, FC_HTTP_V3, OSS, MOCK"
      },
      "AllowedValues": [
        "HTTP",
        "VPC",
        "FC_EVENT",
        "FC_EVENT_V3",
        "FC_HTTP",
        "FC_HTTP_V3",
        "OSS",
        "MOCK"
      ],
      "Required": true
    }
  },
  "Resources": {
    "Backend": {
      "Type": "ALIYUN::ApiGateway::Backend",
      "Properties": {
        "BackendName": {
          "Ref": "BackendName"
        },
        "BackendType": {
          "Ref": "BackendType"
        }
      }
    }
  },
  "Outputs": {
    "BackendId": {
      "Description": "The ID of the backend service.",
      "Value": {
        "Fn::GetAtt": [
          "Backend",
          "BackendId"
        ]
      }
    }
  }
}