ALIYUN::ApiGateway::CustomDomain は、カスタムドメイン名をバインドし、Secure Sockets Layer（SSL）証明書を特定の API グループにアップロードするために使用されます。
説明
SSL 証明書は、カスタムドメイン名と一致する必要があります。
SSL 証明書がバインドされると、HTTPS ベースの API サービスが使用可能になります。
構文
{
"Type": "ALIYUN::ApiGateway::CustomDomain",
"Properties": {
"CertificateBody": String,
"CertificateName": String,
"GroupId": String,
"CertificatePrivateKey": String,
"DomainName": String
}
}プロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
DomainName | String | はい | いいえ | カスタムドメイン名。 | ドメイン名のバインドに失敗した場合は、原因を確認し、ドメイン名を再度バインドしてください。 詳細については、「Bind a custom domain name to allow API calls」をご参照ください。 |
GroupId | String | はい | いいえ | API グループの ID。 | なし。 |
CertificateBody | String | いいえ | はい | 証明書のコンテンツ。 | 証明書の内容は 1 行で記述され、 |
CertificateName | String | いいえ | はい | SSL 証明書の名前。 | なし。 |
CertificatePrivateKey | String | いいえ | はい | SSL 証明書の秘密鍵。 | なし。 |
戻り値
Fn::GetAtt
CertificateId：証明書 ID。
例
説明
DomainName などのマスクされたパラメーターの値は、ビジネス要件に基づいて変更してください。
YAML 形式
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
GroupId:
Type: String
Description: API グループの ID。 # translated comment
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": "API グループの ID。" // translated comment
},
"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"
}
}
}
}
}