Class CertificateAuthority

java.lang.Object
software.amazon.awssdk.services.eks.model.CertificateAuthority
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CertificateAuthority.Builder,CertificateAuthority>
@Generated("software.amazon.awssdk:codegen") public final class CertificateAuthority extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CertificateAuthority.Builder,CertificateAuthority>

An object representing a certificate authority (CA) for an Amazon EKS cluster.

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier of the certificate authority.

      Returns:
      The unique identifier of the certificate authority.

    • createdAt

      public final Instant createdAt()

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

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

    • createdBy

      public final CertificateAuthorityCreatedBy createdBy()

      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.

      If the service returns an enum value that is not available in the current SDK version, createdBy will return CertificateAuthorityCreatedBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from createdByAsString().

      Returns:
      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.
      See Also:

    • createdByAsString

      public final String createdByAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, createdBy will return CertificateAuthorityCreatedBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from createdByAsString().

      Returns:
      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.
      See Also:

    • activatedAt

      public final Instant activatedAt()

      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.

      Returns:
      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.

    • activatedBy

      public final CertificateAuthorityActivatedBy activatedBy()

      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.

      If the service returns an enum value that is not available in the current SDK version, activatedBy will return CertificateAuthorityActivatedBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from activatedByAsString().

      Returns:
      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.
      See Also:

    • activatedByAsString

      public final String activatedByAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, activatedBy will return CertificateAuthorityActivatedBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from activatedByAsString().

      Returns:
      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.
      See Also:

    • signingStatus

      public final CertificateAuthoritySigningStatus signingStatus()

      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.

      If the service returns an enum value that is not available in the current SDK version, signingStatus will return CertificateAuthoritySigningStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from signingStatusAsString().

      Returns:
      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.
      See Also:

    • signingStatusAsString

      public final String signingStatusAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, signingStatus will return CertificateAuthoritySigningStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from signingStatusAsString().

      Returns:
      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.
      See Also:

    • distributionStatus

      public final CertificateAuthorityDistributionStatus distributionStatus()

      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.

      If the service returns an enum value that is not available in the current SDK version, distributionStatus will return CertificateAuthorityDistributionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from distributionStatusAsString().

      Returns:
      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.
      See Also:

    • distributionStatusAsString

      public final String distributionStatusAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, distributionStatus will return CertificateAuthorityDistributionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from distributionStatusAsString().

      Returns:
      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.
      See Also:

    • validity

      public final CertificateAuthorityValidity validity()

      The validity period of the certificate authority's certificate.

      Returns:
      The validity period of the certificate authority's certificate.

    • scheduledEvents

      public final CertificateAuthorityScheduledEvents scheduledEvents()

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

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

    • rollbackAvailable

      public final Boolean rollbackAvailable()

      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.

      Returns:
      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.

    • data

      public final String data()

      The Base64-encoded public certificate of the certificate authority.

      Returns:
      The Base64-encoded public certificate of the certificate authority.

    • toBuilder

      public CertificateAuthority.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CertificateAuthority.Builder,CertificateAuthority>
      Returns:
      a builder for type T

    • builder

      public static CertificateAuthority.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CertificateAuthority.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.