Interface CertificateAuthority.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CertificateAuthority.Builder,CertificateAuthority>, SdkBuilder<CertificateAuthority.Builder,CertificateAuthority>, SdkPojo
Enclosing class:
CertificateAuthority
@Mutable @NotThreadSafe public static interface CertificateAuthority.Builder extends SdkPojo, CopyableBuilder<CertificateAuthority.Builder,CertificateAuthority>

  • Method Details

    • id

      CertificateAuthority.Builder id(String id)

      The unique identifier of the certificate authority.

      Parameters:
      id - The unique identifier of the certificate authority.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      CertificateAuthority.Builder createdAt(Instant createdAt)

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

      Parameters:
      createdAt - The Unix epoch timestamp in seconds for when the certificate authority was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdBy

      CertificateAuthority.Builder createdBy(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdBy

      CertificateAuthority.Builder createdBy(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • activatedAt

      CertificateAuthority.Builder activatedAt(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • activatedBy

      CertificateAuthority.Builder activatedBy(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • activatedBy

      CertificateAuthority.Builder activatedBy(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • signingStatus

      CertificateAuthority.Builder signingStatus(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • signingStatus

      CertificateAuthority.Builder signingStatus(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • distributionStatus

      CertificateAuthority.Builder distributionStatus(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • distributionStatus

      CertificateAuthority.Builder distributionStatus(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • validity

      CertificateAuthority.Builder validity(CertificateAuthorityValidity validity)

      The validity period of the certificate authority's certificate.

      Parameters:
      validity - The validity period of the certificate authority's certificate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • validity

      default CertificateAuthority.Builder validity(Consumer<CertificateAuthorityValidity.Builder> validity)

      The validity period of the certificate authority's certificate.

      This is a convenience method that creates an instance of the CertificateAuthorityValidity.Builder avoiding the need to create one manually via CertificateAuthorityValidity.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to validity(CertificateAuthorityValidity).

      Parameters:
      validity - a consumer that will call methods on CertificateAuthorityValidity.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scheduledEvents

      CertificateAuthority.Builder scheduledEvents(CertificateAuthorityScheduledEvents scheduledEvents)

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

      Parameters:
      scheduledEvents - The scheduled auto-activation events for the certificate authority, computed from its validity period.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduledEvents

      default CertificateAuthority.Builder scheduledEvents(Consumer<CertificateAuthorityScheduledEvents.Builder> scheduledEvents)

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

      This is a convenience method that creates an instance of the CertificateAuthorityScheduledEvents.Builder avoiding the need to create one manually via CertificateAuthorityScheduledEvents.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scheduledEvents(CertificateAuthorityScheduledEvents).

      Parameters:
      scheduledEvents - a consumer that will call methods on CertificateAuthorityScheduledEvents.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • rollbackAvailable

      CertificateAuthority.Builder rollbackAvailable(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • data

      CertificateAuthority.Builder data(String data)

      The Base64-encoded public certificate of the certificate authority.

      Parameters:
      data - The Base64-encoded public certificate of the certificate authority.
      Returns:
      Returns a reference to this object so that method calls can be chained together.