メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::ApiGateway::ClientCertificate

AWS::ApiGateway::ClientCertificate リソースは、Amazon API Gateway (API Gateway) がクライアント側 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

更新に伴う要件: 中断はありません。

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref により abc123 のようなクライアント証明書名が返されます。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

次の例では、API Gateway のデプロイメントとステージに使用できるクライアント証明書を作成します。

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"

このページの内容: