Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Synopsis
- data CertificateAuthority = CertificateAuthority' {
- status :: Maybe CertificateAuthorityStatus
- failureReason :: Maybe FailureReason
- certificateAuthorityConfiguration :: Maybe CertificateAuthorityConfiguration
- arn :: Maybe Text
- createdAt :: Maybe POSIX
- serial :: Maybe Text
- keyStorageSecurityStandard :: Maybe KeyStorageSecurityStandard
- notBefore :: Maybe POSIX
- restorableUntil :: Maybe POSIX
- type' :: Maybe CertificateAuthorityType
- ownerAccount :: Maybe Text
- revocationConfiguration :: Maybe RevocationConfiguration
- lastStateChangeAt :: Maybe POSIX
- notAfter :: Maybe POSIX
- newCertificateAuthority :: CertificateAuthority
- certificateAuthority_status :: Lens' CertificateAuthority (Maybe CertificateAuthorityStatus)
- certificateAuthority_failureReason :: Lens' CertificateAuthority (Maybe FailureReason)
- certificateAuthority_certificateAuthorityConfiguration :: Lens' CertificateAuthority (Maybe CertificateAuthorityConfiguration)
- certificateAuthority_arn :: Lens' CertificateAuthority (Maybe Text)
- certificateAuthority_createdAt :: Lens' CertificateAuthority (Maybe UTCTime)
- certificateAuthority_serial :: Lens' CertificateAuthority (Maybe Text)
- certificateAuthority_keyStorageSecurityStandard :: Lens' CertificateAuthority (Maybe KeyStorageSecurityStandard)
- certificateAuthority_notBefore :: Lens' CertificateAuthority (Maybe UTCTime)
- certificateAuthority_restorableUntil :: Lens' CertificateAuthority (Maybe UTCTime)
- certificateAuthority_type :: Lens' CertificateAuthority (Maybe CertificateAuthorityType)
- certificateAuthority_ownerAccount :: Lens' CertificateAuthority (Maybe Text)
- certificateAuthority_revocationConfiguration :: Lens' CertificateAuthority (Maybe RevocationConfiguration)
- certificateAuthority_lastStateChangeAt :: Lens' CertificateAuthority (Maybe UTCTime)
- certificateAuthority_notAfter :: Lens' CertificateAuthority (Maybe UTCTime)
Documentation
data CertificateAuthority Source #
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).
See: newCertificateAuthority
smart constructor.
CertificateAuthority' | |
|
Instances
newCertificateAuthority :: CertificateAuthority Source #
Create a value of CertificateAuthority
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:CertificateAuthority'
, certificateAuthority_status
- Status of your private CA.
$sel:failureReason:CertificateAuthority'
, certificateAuthority_failureReason
- Reason the request to create your private CA failed.
$sel:certificateAuthorityConfiguration:CertificateAuthority'
, certificateAuthority_certificateAuthorityConfiguration
- Your private CA configuration.
$sel:arn:CertificateAuthority'
, certificateAuthority_arn
- Amazon Resource Name (ARN) for your private certificate authority (CA).
The format is 12345678-1234-1234-1234-123456789012
.
$sel:createdAt:CertificateAuthority'
, certificateAuthority_createdAt
- Date and time at which your private CA was created.
$sel:serial:CertificateAuthority'
, certificateAuthority_serial
- Serial number of your private CA.
$sel:keyStorageSecurityStandard:CertificateAuthority'
, certificateAuthority_keyStorageSecurityStandard
- 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."
$sel:notBefore:CertificateAuthority'
, certificateAuthority_notBefore
- Date and time before which your private CA certificate is not valid.
$sel:restorableUntil:CertificateAuthority'
, certificateAuthority_restorableUntil
- The period during which a deleted CA can be restored. For more
information, see the PermanentDeletionTimeInDays
parameter of the
DeleteCertificateAuthorityRequest
action.
$sel:type':CertificateAuthority'
, certificateAuthority_type
- Type of your private CA.
$sel:ownerAccount:CertificateAuthority'
, certificateAuthority_ownerAccount
- The AWS account ID that owns the certificate authority.
$sel:revocationConfiguration:CertificateAuthority'
, certificateAuthority_revocationConfiguration
- Information about the Online Certificate Status Protocol (OCSP)
configuration or certificate revocation list (CRL) created and
maintained by your private CA.
$sel:lastStateChangeAt:CertificateAuthority'
, certificateAuthority_lastStateChangeAt
- Date and time at which your private CA was last updated.
$sel:notAfter:CertificateAuthority'
, certificateAuthority_notAfter
- Date and time after which your private CA certificate is not valid.
certificateAuthority_status :: Lens' CertificateAuthority (Maybe CertificateAuthorityStatus) Source #
Status of your private CA.
certificateAuthority_failureReason :: Lens' CertificateAuthority (Maybe FailureReason) Source #
Reason the request to create your private CA failed.
certificateAuthority_certificateAuthorityConfiguration :: Lens' CertificateAuthority (Maybe CertificateAuthorityConfiguration) Source #
Your private CA configuration.
certificateAuthority_arn :: Lens' CertificateAuthority (Maybe Text) Source #
Amazon Resource Name (ARN) for your private certificate authority (CA).
The format is 12345678-1234-1234-1234-123456789012
.
certificateAuthority_createdAt :: Lens' CertificateAuthority (Maybe UTCTime) Source #
Date and time at which your private CA was created.
certificateAuthority_serial :: Lens' CertificateAuthority (Maybe Text) Source #
Serial number of your private CA.
certificateAuthority_keyStorageSecurityStandard :: Lens' CertificateAuthority (Maybe KeyStorageSecurityStandard) Source #
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."
certificateAuthority_notBefore :: Lens' CertificateAuthority (Maybe UTCTime) Source #
Date and time before which your private CA certificate is not valid.
certificateAuthority_restorableUntil :: Lens' CertificateAuthority (Maybe UTCTime) Source #
The period during which a deleted CA can be restored. For more
information, see the PermanentDeletionTimeInDays
parameter of the
DeleteCertificateAuthorityRequest
action.
certificateAuthority_type :: Lens' CertificateAuthority (Maybe CertificateAuthorityType) Source #
Type of your private CA.
certificateAuthority_ownerAccount :: Lens' CertificateAuthority (Maybe Text) Source #
The AWS account ID that owns the certificate authority.
certificateAuthority_revocationConfiguration :: Lens' CertificateAuthority (Maybe RevocationConfiguration) Source #
Information about the Online Certificate Status Protocol (OCSP) configuration or certificate revocation list (CRL) created and maintained by your private CA.
certificateAuthority_lastStateChangeAt :: Lens' CertificateAuthority (Maybe UTCTime) Source #
Date and time at which your private CA was last updated.
certificateAuthority_notAfter :: Lens' CertificateAuthority (Maybe UTCTime) Source #
Date and time after which your private CA certificate is not valid.