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 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][1]

Instance Attribute Summary collapse

Instance Attribute Details

#client_certificate_idString

The identifier of the client certificate.

Returns:

  • (String)


556
557
558
559
560
561
562
563
564
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 556

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

#created_dateTime

The timestamp when the client certificate was created.

Returns:

  • (Time)


556
557
558
559
560
561
562
563
564
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 556

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

#descriptionString

The description of the client certificate.

Returns:

  • (String)


556
557
558
559
560
561
562
563
564
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 556

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

#expiration_dateTime

The timestamp when the client certificate will expire.

Returns:

  • (Time)


556
557
558
559
560
561
562
563
564
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 556

class ClientCertificate < Struct.new(
  :client_certificate_id,
  :description,
  :pem_encoded_certificate,
  :created_date,
  :expiration_date,
  :tags)
  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)


556
557
558
559
560
561
562
563
564
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 556

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

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)


556
557
558
559
560
561
562
563
564
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 556

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