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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

Overview

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

Client certificates are used authenticate an API by the back-end server. To authenticate an API client (or user), use a custom Authorizer.
[Use Client-Side Certificate][1]

Instance Attribute Summary collapse

Instance Attribute Details

#client_certificate_idString

The identifier of the client certificate.

Returns:

  • (String)


434
435
436
437
438
439
440
441
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 434

class ClientCertificate < Struct.new(
  :client_certificate_id,
  :description,
  :pem_encoded_certificate,
  :created_date,
  :expiration_date)
  include Aws::Structure
end

#created_dateTime

The timestamp when the client certificate was created.

Returns:

  • (Time)


434
435
436
437
438
439
440
441
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 434

class ClientCertificate < Struct.new(
  :client_certificate_id,
  :description,
  :pem_encoded_certificate,
  :created_date,
  :expiration_date)
  include Aws::Structure
end

#descriptionString

The description of the client certificate.

Returns:

  • (String)


434
435
436
437
438
439
440
441
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 434

class ClientCertificate < Struct.new(
  :client_certificate_id,
  :description,
  :pem_encoded_certificate,
  :created_date,
  :expiration_date)
  include Aws::Structure
end

#expiration_dateTime

The timestamp when the client certificate will expire.

Returns:

  • (Time)


434
435
436
437
438
439
440
441
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 434

class ClientCertificate < Struct.new(
  :client_certificate_id,
  :description,
  :pem_encoded_certificate,
  :created_date,
  :expiration_date)
  include Aws::Structure
end

#pem_encoded_certificateString

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

Returns:

  • (String)


434
435
436
437
438
439
440
441
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 434

class ClientCertificate < Struct.new(
  :client_certificate_id,
  :description,
  :pem_encoded_certificate,
  :created_date,
  :expiration_date)
  include Aws::Structure
end