ALIYUN::ApiGateway::CustomDomain -

ALIYUN::ApiGateway::CustomDomain類型用於給指定分組綁定自訂網域名和上傳SSL認證。

說明

SSL認證必須與自訂網域名匹配。
綁定SSL認證後，可提供基於HTTPS的API服務。

文法

{
  "Type": "ALIYUN::ApiGateway::CustomDomain",
  "Properties": {
    "CertificateBody": String,
    "CertificateName": String,
    "GroupId": String,
    "CertificatePrivateKey": String,
    "DomainName": String
  }
}

屬性

屬性名稱	類型	必須	允許更新	描述	約束
DomainName	String	是	否	自訂網域名	網域名稱綁定失敗時，請排查原因並重新綁定網域名稱。更多資訊，請參見分組的網域名稱綁定。
GroupId	String	是	否	API分組ID	無
CertificateBody	String	否	是	認證內容	認證內容需要寫到一行內，通過分行符號`\n`進行換行。
CertificateName	String	否	是	SSL認證名稱	無
CertificatePrivateKey	String	否	是	認證私密金鑰	無

傳回值

Fn::GetAtt

CertificateId：認證ID。

樣本

說明

請您根據實際情況更改脫敏的參數取值，例如DomainName。

`YAML`格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  GroupId:
    Type: String
    Description: 操作的分組
  CertificateBody:
    Type: String
  CertificatePrivateKey:
    Type: String
Resources:
  CustomDomain:
    Type: 'ALIYUN::ApiGateway::CustomDomain'
    Properties:
      GroupId:
        Ref: GroupId
      DomainName: ****.api.domain
      CertificateName: demo_cert
      CertificateBody:
        Ref: CertificateBody
      CertificatePrivateKey:
        Ref: CertificatePrivateKey

`JSON`格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GroupId": {
      "Type": "String",
      "Description": "操作的分組"
    },
    "CertificateBody": {
      "Type": "String"
    },
    "CertificatePrivateKey": {
      "Type": "String"
    }
  },
  "Resources": {
    "CustomDomain": {
      "Type": "ALIYUN::ApiGateway::CustomDomain",
      "Properties": {
        "GroupId": {
          "Ref": "GroupId"
        },
        "DomainName": "****.api.domain",
        "CertificateName": "demo_cert",
        "CertificateBody": {
          "Ref": "CertificateBody"
        },
        "CertificatePrivateKey": {
          "Ref": "CertificatePrivateKey"
        }
      }
    }
  }
}

文法

屬性

傳回值

樣本

YAML格式

JSON格式

`YAML`格式

`JSON`格式