AWS CloudFormation
User Guide (Version )

AWS::ApiGateway::ClientCertificate

The AWS::ApiGateway::ClientCertificate resource creates a client certificate that 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

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

YAML

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

Properties

Description

A description of the client certificate.

Required: No

Type: String

Update requires: No interruption

Tags

An array of arbitrary tags (key-value pairs) to associate with the client certificate.

Required: No

Type: List of Tag

Update requires: No interruption

Return Values

Ref

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

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

Examples

Create client certificate

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

JSON

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

YAML

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

See Also