Skip to content

CertificateAuthority

Source code in docs_src/capo_eks/types/certificate_authority.py
class CertificateAuthority(TypedDict, closed=True):
    id: NotRequired["capo_eks.types.string.String"]
    """<p>The unique identifier of the certificate authority.</p>"""
    created_at: NotRequired["capo_eks.types.timestamp.Timestamp"]
    """<p>The Unix epoch timestamp in seconds for when the certificate authority was created.</p>"""
    created_by: NotRequired[
        "capo_eks.types.certificate_authority_created_by.CertificateAuthorityCreatedBy"
    ]
    """<p>The entity that created the certificate authority. Certificate authorities that you create are <code>CUSTOMER</code>; those that Amazon EKS provisions on your behalf, such as a cluster's initial certificate authority, are <code>EKS</code>.</p>"""
    activated_at: NotRequired["capo_eks.types.timestamp.Timestamp"]
    """<p>The Unix epoch timestamp in seconds for when the certificate authority was last activated as the cluster's signer. This value is absent if the certificate authority has never been activated.</p>"""
    activated_by: NotRequired[
        "capo_eks.types.certificate_authority_activated_by.CertificateAuthorityActivatedBy"
    ]
    """<p>The entity that most recently activated the certificate authority. A value of <code>EKS</code> indicates that Amazon EKS activated it automatically; <code>CUSTOMER</code> indicates that you activated it.</p>"""
    signing_status: NotRequired[
        "capo_eks.types.certificate_authority_signing_status.CertificateAuthoritySigningStatus"
    ]
    """<p>The signing status of the certificate authority. <code>IN_USE</code> means the certificate authority is currently signing certificates for the cluster, <code>ACTIVATING</code> means it's being promoted to the signer, and <code>NOT_USED</code> means it's trusted by the cluster (for example, a successor CA during a rotation, or a retired outgoing CA) but isn't the signer.</p>"""
    distribution_status: NotRequired[
        "capo_eks.types.certificate_authority_distribution_status.CertificateAuthorityDistributionStatus"
    ]
    """<p>The distribution status of the certificate authority, which tracks whether Amazon EKS has distributed its trust to the Amazon Web Services managed components in your cluster (the control plane, Amazon EKS Auto Mode instances, and Amazon Web Services Fargate nodes). Valid values are <code>IN_PROGRESS</code>, <code>COMPLETE</code>, <code>FAILED</code>, and <code>DELETING</code>. A successor CA can only be activated after its distribution status is <code>COMPLETE</code>.</p>"""
    validity: NotRequired[
        "capo_eks.types.certificate_authority_validity.CertificateAuthorityValidity"
    ]
    """<p>The validity period of the certificate authority's certificate.</p>"""
    scheduled_events: NotRequired[
        "capo_eks.types.certificate_authority_scheduled_events.CertificateAuthorityScheduledEvents"
    ]
    """<p>The scheduled auto-activation events for the certificate authority, computed from its validity period.</p>"""
    rollback_available: NotRequired["capo_eks.types.boxed_boolean.BoxedBoolean"]
    """<p>Indicates whether CA rollback is still available for this certificate authority. After you activate a successor CA, rollback lets you revert to the outgoing CA for a limited period while you finish updating any worker nodes or clients that were missed.</p>"""
    data: NotRequired["capo_eks.types.string.String"]
    """<p>The Base64-encoded public certificate of the certificate authority.</p>"""

activated_at instance-attribute

activated_at: NotRequired[Timestamp]

The Unix epoch timestamp in seconds for when the certificate authority was last activated as the cluster's signer. This value is absent if the certificate authority has never been activated.

activated_by instance-attribute

activated_by: NotRequired[CertificateAuthorityActivatedBy]

The entity that most recently activated the certificate authority. A value of EKS indicates that Amazon EKS activated it automatically; CUSTOMER indicates that you activated it.

created_at instance-attribute

created_at: NotRequired[Timestamp]

The Unix epoch timestamp in seconds for when the certificate authority was created.

created_by instance-attribute

created_by: NotRequired[CertificateAuthorityCreatedBy]

The entity that created the certificate authority. Certificate authorities that you create are CUSTOMER; those that Amazon EKS provisions on your behalf, such as a cluster's initial certificate authority, are EKS.

data instance-attribute

data: NotRequired[String]

The Base64-encoded public certificate of the certificate authority.

distribution_status instance-attribute

distribution_status: NotRequired[CertificateAuthorityDistributionStatus]

The distribution status of the certificate authority, which tracks whether Amazon EKS has distributed its trust to the Amazon Web Services managed components in your cluster (the control plane, Amazon EKS Auto Mode instances, and Amazon Web Services Fargate nodes). Valid values are IN_PROGRESS, COMPLETE, FAILED, and DELETING. A successor CA can only be activated after its distribution status is COMPLETE.

id instance-attribute

id: NotRequired[String]

The unique identifier of the certificate authority.

rollback_available instance-attribute

rollback_available: NotRequired[BoxedBoolean]

Indicates whether CA rollback is still available for this certificate authority. After you activate a successor CA, rollback lets you revert to the outgoing CA for a limited period while you finish updating any worker nodes or clients that were missed.

scheduled_events instance-attribute

scheduled_events: NotRequired[CertificateAuthorityScheduledEvents]

The scheduled auto-activation events for the certificate authority, computed from its validity period.

signing_status instance-attribute

signing_status: NotRequired[CertificateAuthoritySigningStatus]

The signing status of the certificate authority. IN_USE means the certificate authority is currently signing certificates for the cluster, ACTIVATING means it's being promoted to the signer, and NOT_USED means it's trusted by the cluster (for example, a successor CA during a rotation, or a retired outgoing CA) but isn't the signer.

validity instance-attribute

validity: NotRequired[CertificateAuthorityValidity]

The validity period of the certificate authority's certificate.