Skip to content

CertificateAuthority

Source code in docs_src/capo_acm_pca/types/certificate_authority.py
class CertificateAuthority(TypedDict, closed=True):
    arn: NotRequired["capo_acm_pca.types.arn.Arn"]
    """<p>Amazon Resource Name (ARN) for your private certificate authority (CA). The format is <code> <i>12345678-1234-1234-1234-123456789012</i> </code>.</p>"""
    owner_account: NotRequired["capo_acm_pca.types.account_id.AccountId"]
    """<p>The Amazon Web Services account ID that owns the certificate authority.</p>"""
    created_at: NotRequired["capo_acm_pca.types.t_stamp.TStamp"]
    """<p>Date and time at which your private CA was created.</p>"""
    last_state_change_at: NotRequired["capo_acm_pca.types.t_stamp.TStamp"]
    """<p>Date and time at which your private CA was last updated.</p>"""
    type: NotRequired[
        "capo_acm_pca.types.certificate_authority_type.CertificateAuthorityType"
    ]
    """<p>Type of your private CA.</p>"""
    serial: NotRequired["capo_acm_pca.types.string.String"]
    """<p>Serial number of your private CA.</p>"""
    status: NotRequired[
        "capo_acm_pca.types.certificate_authority_status.CertificateAuthorityStatus"
    ]
    """<p>Status of your private CA.</p>"""
    not_before: NotRequired["capo_acm_pca.types.t_stamp.TStamp"]
    """<p>Date and time before which your private CA certificate is not valid.</p>"""
    not_after: NotRequired["capo_acm_pca.types.t_stamp.TStamp"]
    """<p>Date and time after which your private CA certificate is not valid.</p>"""
    failure_reason: NotRequired["capo_acm_pca.types.failure_reason.FailureReason"]
    """<p>Reason the request to create your private CA failed.</p>"""
    certificate_authority_configuration: NotRequired[
        "capo_acm_pca.types.certificate_authority_configuration.CertificateAuthorityConfiguration"
    ]
    """<p>Your private CA configuration.</p>"""
    revocation_configuration: NotRequired[
        "capo_acm_pca.types.revocation_configuration.RevocationConfiguration"
    ]
    """<p>Information about the Online Certificate Status Protocol (OCSP) configuration or certificate revocation list (CRL) created and maintained by your private CA. </p>"""
    restorable_until: NotRequired["capo_acm_pca.types.t_stamp.TStamp"]
    """<p>The period during which a deleted CA can be restored. For more information, see the <code>PermanentDeletionTimeInDays</code> parameter of the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthorityRequest.html">DeleteCertificateAuthorityRequest</a> action. </p>"""
    key_storage_security_standard: NotRequired[
        "capo_acm_pca.types.key_storage_security_standard.KeyStorageSecurityStandard"
    ]
    """<p>Defines a cryptographic key management compliance standard for handling and protecting CA keys.</p> <p>Default: FIPS_140_2_LEVEL_3_OR_HIGHER</p> <note> <p>Starting January 26, 2023, Amazon Web Services Private CA protects all CA private keys in non-China regions using hardware security modules (HSMs) that comply with FIPS PUB 140-2 Level 3.</p> <p>For information about security standard support in different Amazon Web Services Regions, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/data-protection.html#private-keys">Storage and security compliance of Amazon Web Services Private CA private keys</a>.</p> </note>"""
    usage_mode: NotRequired[
        "capo_acm_pca.types.certificate_authority_usage_mode.CertificateAuthorityUsageMode"
    ]
    """<p>Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.</p> <p>The default value is GENERAL_PURPOSE.</p>"""

arn instance-attribute

arn: NotRequired[Arn]

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

certificate_authority_configuration instance-attribute

certificate_authority_configuration: NotRequired[CertificateAuthorityConfiguration]

Your private CA configuration.

created_at instance-attribute

created_at: NotRequired[TStamp]

Date and time at which your private CA was created.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

Reason the request to create your private CA failed.

key_storage_security_standard instance-attribute

key_storage_security_standard: NotRequired[KeyStorageSecurityStandard]

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

Default: FIPS_140_2_LEVEL_3_OR_HIGHER

Starting January 26, 2023, Amazon Web Services Private CA protects all CA private keys in non-China regions using hardware security modules (HSMs) that comply with FIPS PUB 140-2 Level 3.

For information about security standard support in different Amazon Web Services Regions, see Storage and security compliance of Amazon Web Services Private CA private keys.

last_state_change_at instance-attribute

last_state_change_at: NotRequired[TStamp]

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

not_after instance-attribute

not_after: NotRequired[TStamp]

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

not_before instance-attribute

not_before: NotRequired[TStamp]

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

owner_account instance-attribute

owner_account: NotRequired[AccountId]

The Amazon Web Services account ID that owns the certificate authority.

restorable_until instance-attribute

restorable_until: NotRequired[TStamp]

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

revocation_configuration instance-attribute

revocation_configuration: NotRequired[RevocationConfiguration]

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

serial instance-attribute

serial: NotRequired[String]

Serial number of your private CA.

status instance-attribute

status: NotRequired[CertificateAuthorityStatus]

Status of your private CA.

type instance-attribute

type: NotRequired[CertificateAuthorityType]

Type of your private CA.

usage_mode instance-attribute

usage_mode: NotRequired[CertificateAuthorityUsageMode]

Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.

The default value is GENERAL_PURPOSE.