AWS::ApiGateway::ClientCertificate - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::ApiGateway::ClientCertificate

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

语法

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

JSON

{ "Type" : "AWS::ApiGateway::ClientCertificate", "Properties" : { "Description" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::ApiGateway::ClientCertificate Properties: Description: String Tags: - Tag

属性

Description

客户端证书的说明。

必需:否

类型:字符串

Update requires: No interruption

Tags

与客户端证书关联的任意标签(键值对)的数组。

必需:否

类型Tag 的列表

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回 客户端证书名称,例如 abc123

For more information about using the Ref function, see Ref.

示例

创建客户端证书

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

JSON

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

YAML

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

另请参阅