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
-
The description of the client certificate.
Required: No
Type: String
Update requires: No interruption
-
The collection of tags. Each tag element is associated with a given resource.
Required: No
Type: Array 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
.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt
.
ClientCertificateId
-
The ID for the client certificate. For example:
abc123
.
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
-
clientcertificate:generate in the Amazon API Gateway REST API Reference