Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS::ApiGateway::ClientCertificate

The AWS::ApiGateway::ClientCertificate resource creates a client certificate that Amazon API Gateway (API Gateway) uses to configure client-side SSL authentication for sending requests to the integration endpoint.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

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

YAML

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

Properties

Description

A description of the client certificate.

Required: No

Type: String

Update requires: No interruption

Return Value

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the client certificate name, such as abc123.

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

Example

The following example creates a client certificate that you can use with an API Gateway deployment and stage.

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"