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

Constant Summary collapse

SENSITIVE =
[]

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)


452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 452

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

#certificate_authority_configurationTypes::CertificateAuthorityConfiguration

Your private CA configuration.



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 452

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

#created_atTime

Date and time at which your private CA was created.

Returns:

  • (Time)


452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 452

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

#failure_reasonString

Reason the request to create your private CA failed.

Returns:

  • (String)


452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 452

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

#key_storage_security_standardString

Defines a cryptographic key management compliance standard used for handling CA keys.

Default: FIPS_140_2_LEVEL_3_OR_HIGHER

Note: AWS Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an InvalidArgsException with the message "A certificate authority cannot be created in this region with the specified security standard."

Returns:

  • (String)


452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 452

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

#last_state_change_atTime

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

Returns:

  • (Time)


452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 452

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

#not_afterTime

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

Returns:

  • (Time)


452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 452

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

#not_beforeTime

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

Returns:

  • (Time)


452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 452

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

#owner_accountString

The AWS account ID that owns the certificate authority.

Returns:

  • (String)


452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 452

class CertificateAuthority < Struct.new(
  :arn,
  :owner_account,
  :created_at,
  :last_state_change_at,
  :type,
  :serial,
  :status,
  :not_before,
  :not_after,
  :failure_reason,
  :certificate_authority_configuration,
  :revocation_configuration,
  :restorable_until,
  :key_storage_security_standard)
  SENSITIVE = []
  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)


452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 452

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

#revocation_configurationTypes::RevocationConfiguration

Information about the Online Certificate Status Protocol (OCSP) configuration or certificate revocation list (CRL) created and maintained by your private CA.



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 452

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

#serialString

Serial number of your private CA.

Returns:

  • (String)


452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 452

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

#statusString

Status of your private CA.

Returns:

  • (String)


452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 452

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

#typeString

Type of your private CA.

Returns:

  • (String)


452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 452

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