ALIYUN::ApiGateway::CustomDomain - Resource Orchestration Service

ALIYUN::ApiGateway::CustomDomain digunakan untuk mengikat nama domain kustom dan mengunggah sertifikat Secure Sockets Layer (SSL) ke grup API tertentu.

Catatan

Sertifikat SSL harus sesuai dengan nama domain kustom.
Setelah sertifikat SSL diikat, layanan API berbasis HTTPS menjadi tersedia.

Sintaksis

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

Properti

Properti	Tipe	Diperlukan	Dapat Diedit	Deskripsi	Kendala
DomainName	String	Ya	Tidak	Nama domain kustom.	Jika pengikatan nama domain gagal, periksa penyebabnya dan ikat ulang nama domain tersebut. Untuk informasi lebih lanjut, lihat Mengikat nama domain kustom untuk memungkinkan panggilan API.
GroupId	String	Ya	Tidak	ID grup API.	Tidak ada.
CertificateBody	String	Tidak	Ya	Isi sertifikat.	Isi sertifikat ditulis dalam satu baris dan Anda dapat memecah baris menggunakan pemisah baris `\n`.
CertificateName	String	Tidak	Ya	Nama sertifikat SSL.	Tidak ada.
CertificatePrivateKey	String	Tidak	Ya	Kunci privat sertifikat SSL.	Tidak ada.

Nilai Pengembalian

Fn::GetAtt

CertificateId: ID sertifikat.

Contoh

Catatan

Ubah nilai parameter yang disembunyikan, seperti DomainName, sesuai dengan kebutuhan bisnis Anda.

`YAML` format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  GroupId:
    Type: String
    Description: ID grup API.
  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` format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GroupId": {
      "Type": "String",
      "Description": "ID grup API."
    },
    "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"
        }
      }
    }
  }
}