You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::APIGateway::Types::ClientCertificate

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.

Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool.
Use Client-Side Certificate

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#client_certificate_id ⇒ String

The identifier of the client certificate.

Returns:

  • (String) —

    The identifier of the client certificate.

#created_date ⇒ Time

The timestamp when the client certificate was created.

Returns:

  • (Time) —

    The timestamp when the client certificate was created.

#description ⇒ String

The description of the client certificate.

Returns:

  • (String) —

    The description of the client certificate.

#expiration_date ⇒ Time

The timestamp when the client certificate will expire.

Returns:

  • (Time) —

    The timestamp when the client certificate will expire.

#pem_encoded_certificate ⇒ String

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

Returns:

  • (String) —

    The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

#tags ⇒ Hash<String,String>

The collection of tags. Each tag element is associated with a given resource.

Returns:

  • (Hash<String,String>) —

    The collection of tags.