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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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.

<div class=“remarks”> 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. </div>

<div class=“seeAlso” markdown=“1”>

Use Client-Side Certificate][1

</div>

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_certificate_id ⇒ String

The identifier of the client certificate.

Returns:

  • (String) 


573
574
575
576
577
578
579
580
581
582
 
# File 'lib/aws-sdk-apigateway/types.rb', line 573

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

#created_date ⇒ Time

The timestamp when the client certificate was created.

Returns:

  • (Time) 


573
574
575
576
577
578
579
580
581
582
 
# File 'lib/aws-sdk-apigateway/types.rb', line 573

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

#description ⇒ String

The description of the client certificate.

Returns:

  • (String) 


573
574
575
576
577
578
579
580
581
582
 
# File 'lib/aws-sdk-apigateway/types.rb', line 573

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

#expiration_date ⇒ Time

The timestamp when the client certificate will expire.

Returns:

  • (Time) 


573
574
575
576
577
578
579
580
581
582
 
# File 'lib/aws-sdk-apigateway/types.rb', line 573

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

#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) 


573
574
575
576
577
578
579
580
581
582
 
# File 'lib/aws-sdk-apigateway/types.rb', line 573

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

#tags ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


573
574
575
576
577
578
579
580
581
582
 
# File 'lib/aws-sdk-apigateway/types.rb', line 573

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