AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

AWS::ApiGateway::ClientCertificate

AWS::ApiGateway::ClientCertificate 资源创建客户端证书,Amazon API Gateway (API 网关) 使用该证书配置客户端 SSL 身份验证以发送请求到集成终端节点。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

Copy
{ "Type" : "AWS::ApiGateway::ClientCertificate", "Properties" : { "Description" : String } }

YAML

Copy
Type: "AWS::ApiGateway::ClientCertificate" Properties: Description: String

属性

Description

客户端证书的说明。

Required: No

Type: String

更新要求无需中断

返回值

Ref

当向 Ref 内部函数提供此资源的逻辑 ID 时,Ref 将返回客户端证书名称,如 abc123

有关使用 Ref 功能的更多信息,请参阅参考

示例

以下示例创建您可用于 API 网关 部署和阶段的客户端证书。

JSON

Copy
"TestClientCertificate": { "Type": "AWS::ApiGateway::ClientCertificate", "Properties": { "Description": "A test client certificate" } }

YAML

Copy
TestClientCertificate: Type: "AWS::ApiGateway::ClientCertificate" Properties: Description: "A test client certificate"

本页内容: