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

Class: Aws::ACMPCA::Types::CertificateAuthority

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

Overview

Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate Subject field owns or controls the public key contained in the Subject Public Key Info field. Call the CreateCertificateAuthority action to create your private CA. You must then call the GetCertificateAuthorityCertificate action to retrieve a private CA certificate signing request (CSR). Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA certificate. Call the ImportCertificateAuthorityCertificate action to import the signed certificate into AWS Certificate Manager (ACM).

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

Amazon Resource Name (ARN) for your private certificate authority (CA). The format is 12345678-1234-1234-1234-123456789012.

Returns:

  • (String)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 197

class CertificateAuthority < Struct.new(
  :arn,
  :created_at,
  :last_state_change_at,
  :type,
  :serial,
  :status,
  :not_before,
  :not_after,
  :failure_reason,
  :certificate_authority_configuration,
  :revocation_configuration,
  :restorable_until)
  include Aws::Structure
end

#certificate_authority_configurationTypes::CertificateAuthorityConfiguration

Your private CA configuration.



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 197

class CertificateAuthority < Struct.new(
  :arn,
  :created_at,
  :last_state_change_at,
  :type,
  :serial,
  :status,
  :not_before,
  :not_after,
  :failure_reason,
  :certificate_authority_configuration,
  :revocation_configuration,
  :restorable_until)
  include Aws::Structure
end

#created_atTime

Date and time at which your private CA was created.

Returns:

  • (Time)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 197

class CertificateAuthority < Struct.new(
  :arn,
  :created_at,
  :last_state_change_at,
  :type,
  :serial,
  :status,
  :not_before,
  :not_after,
  :failure_reason,
  :certificate_authority_configuration,
  :revocation_configuration,
  :restorable_until)
  include Aws::Structure
end

#failure_reasonString

Reason the request to create your private CA failed.

Returns:

  • (String)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 197

class CertificateAuthority < Struct.new(
  :arn,
  :created_at,
  :last_state_change_at,
  :type,
  :serial,
  :status,
  :not_before,
  :not_after,
  :failure_reason,
  :certificate_authority_configuration,
  :revocation_configuration,
  :restorable_until)
  include Aws::Structure
end

#last_state_change_atTime

Date and time at which your private CA was last updated.

Returns:

  • (Time)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 197

class CertificateAuthority < Struct.new(
  :arn,
  :created_at,
  :last_state_change_at,
  :type,
  :serial,
  :status,
  :not_before,
  :not_after,
  :failure_reason,
  :certificate_authority_configuration,
  :revocation_configuration,
  :restorable_until)
  include Aws::Structure
end

#not_afterTime

Date and time after which your private CA certificate is not valid.

Returns:

  • (Time)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 197

class CertificateAuthority < Struct.new(
  :arn,
  :created_at,
  :last_state_change_at,
  :type,
  :serial,
  :status,
  :not_before,
  :not_after,
  :failure_reason,
  :certificate_authority_configuration,
  :revocation_configuration,
  :restorable_until)
  include Aws::Structure
end

#not_beforeTime

Date and time before which your private CA certificate is not valid.

Returns:

  • (Time)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 197

class CertificateAuthority < Struct.new(
  :arn,
  :created_at,
  :last_state_change_at,
  :type,
  :serial,
  :status,
  :not_before,
  :not_after,
  :failure_reason,
  :certificate_authority_configuration,
  :revocation_configuration,
  :restorable_until)
  include Aws::Structure
end

#restorable_untilTime

The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.

Returns:

  • (Time)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 197

class CertificateAuthority < Struct.new(
  :arn,
  :created_at,
  :last_state_change_at,
  :type,
  :serial,
  :status,
  :not_before,
  :not_after,
  :failure_reason,
  :certificate_authority_configuration,
  :revocation_configuration,
  :restorable_until)
  include Aws::Structure
end

#revocation_configurationTypes::RevocationConfiguration

Information about the certificate revocation list (CRL) created and maintained by your private CA.



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 197

class CertificateAuthority < Struct.new(
  :arn,
  :created_at,
  :last_state_change_at,
  :type,
  :serial,
  :status,
  :not_before,
  :not_after,
  :failure_reason,
  :certificate_authority_configuration,
  :revocation_configuration,
  :restorable_until)
  include Aws::Structure
end

#serialString

Serial number of your private CA.

Returns:

  • (String)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 197

class CertificateAuthority < Struct.new(
  :arn,
  :created_at,
  :last_state_change_at,
  :type,
  :serial,
  :status,
  :not_before,
  :not_after,
  :failure_reason,
  :certificate_authority_configuration,
  :revocation_configuration,
  :restorable_until)
  include Aws::Structure
end

#statusString

Status of your private CA.

Returns:

  • (String)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 197

class CertificateAuthority < Struct.new(
  :arn,
  :created_at,
  :last_state_change_at,
  :type,
  :serial,
  :status,
  :not_before,
  :not_after,
  :failure_reason,
  :certificate_authority_configuration,
  :revocation_configuration,
  :restorable_until)
  include Aws::Structure
end

#typeString

Type of your private CA.

Returns:

  • (String)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 197

class CertificateAuthority < Struct.new(
  :arn,
  :created_at,
  :last_state_change_at,
  :type,
  :serial,
  :status,
  :not_before,
  :not_after,
  :failure_reason,
  :certificate_authority_configuration,
  :revocation_configuration,
  :restorable_until)
  include Aws::Structure
end