Class: Aws::EKS::Types::CertificateAuthority

Inherits:

Struct

• Object
• Struct
• Aws::EKS::Types::CertificateAuthority

Defined in:

gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #activated_at ⇒ Time

  The Unix epoch timestamp in seconds for when the certificate authority was last activated as the cluster's signer.

• #activated_by ⇒ String

  The entity that most recently activated the certificate authority.

• #created_at ⇒ Time

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

• #created_by ⇒ String

  The entity that created the certificate authority.

• #data ⇒ String

  The Base64-encoded public certificate of the certificate authority.

• #distribution_status ⇒ String

  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).

• #id ⇒ String

  The unique identifier of the certificate authority.

• #rollback_available ⇒ Boolean

  Indicates whether CA rollback is still available for this certificate authority.

• #scheduled_events ⇒ Types::CertificateAuthorityScheduledEvents

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

• #signing_status ⇒ String

  The signing status of the certificate authority.

• #validity ⇒ Types::CertificateAuthorityValidity

  The validity period of the certificate authority's certificate.

Instance Attribute Details

#activated_at ⇒ Time

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:

• (Time)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1448

class CertificateAuthority < Struct.new(
  :id,
  :created_at,
  :created_by,
  :activated_at,
  :activated_by,
  :signing_status,
  :distribution_status,
  :validity,
  :scheduled_events,
  :rollback_available,
  :data)
  SENSITIVE = []
  include Aws::Structure
end

#activated_by ⇒ String

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:

• (String)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1448

class CertificateAuthority < Struct.new(
  :id,
  :created_at,
  :created_by,
  :activated_at,
  :activated_by,
  :signing_status,
  :distribution_status,
  :validity,
  :scheduled_events,
  :rollback_available,
  :data)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1448

class CertificateAuthority < Struct.new(
  :id,
  :created_at,
  :created_by,
  :activated_at,
  :activated_by,
  :signing_status,
  :distribution_status,
  :validity,
  :scheduled_events,
  :rollback_available,
  :data)
  SENSITIVE = []
  include Aws::Structure
end

#created_by ⇒ String

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:

• (String)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1448

class CertificateAuthority < Struct.new(
  :id,
  :created_at,
  :created_by,
  :activated_at,
  :activated_by,
  :signing_status,
  :distribution_status,
  :validity,
  :scheduled_events,
  :rollback_available,
  :data)
  SENSITIVE = []
  include Aws::Structure
end

#data ⇒ String

The Base64-encoded public certificate of the certificate authority.

Returns:

• (String)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1448

class CertificateAuthority < Struct.new(
  :id,
  :created_at,
  :created_by,
  :activated_at,
  :activated_by,
  :signing_status,
  :distribution_status,
  :validity,
  :scheduled_events,
  :rollback_available,
  :data)
  SENSITIVE = []
  include Aws::Structure
end

#distribution_status ⇒ String

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:

• (String)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1448

class CertificateAuthority < Struct.new(
  :id,
  :created_at,
  :created_by,
  :activated_at,
  :activated_by,
  :signing_status,
  :distribution_status,
  :validity,
  :scheduled_events,
  :rollback_available,
  :data)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique identifier of the certificate authority.

Returns:

• (String)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1448

class CertificateAuthority < Struct.new(
  :id,
  :created_at,
  :created_by,
  :activated_at,
  :activated_by,
  :signing_status,
  :distribution_status,
  :validity,
  :scheduled_events,
  :rollback_available,
  :data)
  SENSITIVE = []
  include Aws::Structure
end

#rollback_available ⇒ Boolean

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:

• (Boolean)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1448

class CertificateAuthority < Struct.new(
  :id,
  :created_at,
  :created_by,
  :activated_at,
  :activated_by,
  :signing_status,
  :distribution_status,
  :validity,
  :scheduled_events,
  :rollback_available,
  :data)
  SENSITIVE = []
  include Aws::Structure
end

#scheduled_events ⇒ Types::CertificateAuthorityScheduledEvents

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

Returns:

• (Types::CertificateAuthorityScheduledEvents)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1448

class CertificateAuthority < Struct.new(
  :id,
  :created_at,
  :created_by,
  :activated_at,
  :activated_by,
  :signing_status,
  :distribution_status,
  :validity,
  :scheduled_events,
  :rollback_available,
  :data)
  SENSITIVE = []
  include Aws::Structure
end

#signing_status ⇒ String

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:

• (String)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1448

class CertificateAuthority < Struct.new(
  :id,
  :created_at,
  :created_by,
  :activated_at,
  :activated_by,
  :signing_status,
  :distribution_status,
  :validity,
  :scheduled_events,
  :rollback_available,
  :data)
  SENSITIVE = []
  include Aws::Structure
end

#validity ⇒ Types::CertificateAuthorityValidity

The validity period of the certificate authority's certificate.

Returns:

• (Types::CertificateAuthorityValidity)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1448

class CertificateAuthority < Struct.new(
  :id,
  :created_at,
  :created_by,
  :activated_at,
  :activated_by,
  :signing_status,
  :distribution_status,
  :validity,
  :scheduled_events,
  :rollback_available,
  :data)
  SENSITIVE = []
  include Aws::Structure
end