[ aws . eks ]

delete-certificate-authority

Description

Deletes a certificate authority (CA) from your cluster.

Deleting a certificate authority removes its public certificate from the cluster’s trust bundle. You can’t delete the certificate authority that’s currently signing certificates for the cluster (its signingStatus is IN_USE ) — to remove the outgoing CA, first activate the successor CA with ` ActivateCertificateAuthority https://docs.aws.amazon.com/eks/latest/APIReference/API_ActivateCertificateAuthority.html`__ . Amazon EKS also protects a successor CA from deletion in certain cases to keep a valid rotation path — for example, a successor that Amazon EKS appended can’t be deleted while it’s the only successor on the cluster. This is an asynchronous operation that returns an update object.

See also: AWS API Documentation

Synopsis

  delete-certificate-authority
--cluster-name <value>
--certificate-authority-id <value>
[--client-request-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--cluster-name (string) [required]

The name of your cluster.

--certificate-authority-id (string) [required]

The ID of the certificate authority to delete. You can’t delete the certificate authority that’s currently signing certificates for the cluster.

--client-request-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

update -> (structure)

An object representing the asynchronous update that removes the certificate authority from the cluster’s trust bundle.

id -> (string)

A UUID that is used to track the update.

status -> (string)

The current status of the update.

Possible values:

  • InProgress
  • Failed
  • Cancelled
  • Successful

type -> (string)

The type of the update.

Possible values:

  • VersionUpdate
  • EndpointAccessUpdate
  • LoggingUpdate
  • ConfigUpdate
  • AssociateIdentityProviderConfig
  • DisassociateIdentityProviderConfig
  • AssociateEncryptionConfig
  • AddonUpdate
  • VpcConfigUpdate
  • AccessConfigUpdate
  • UpgradePolicyUpdate
  • ZonalShiftConfigUpdate
  • AutoModeUpdate
  • RemoteNetworkConfigUpdate
  • DeletionProtectionUpdate
  • CapabilityUpdate
  • ControlPlaneScalingConfigUpdate
  • VendedLogsUpdate
  • ControlPlaneEgressUpdate
  • VersionRollback
  • ControlPlaneComponentConfigUpdate
  • CertificateAuthorityUpdate

params -> (list)

A key-value map that contains the parameters associated with the update.

(structure)

An object representing the details of an update request.

type -> (string)

The keys associated with an update request.

Possible values:

  • Version
  • PlatformVersion
  • EndpointPrivateAccess
  • EndpointPublicAccess
  • ClusterLogging
  • DesiredSize
  • LabelsToAdd
  • LabelsToRemove
  • TaintsToAdd
  • TaintsToRemove
  • MaxSize
  • MinSize
  • ReleaseVersion
  • PublicAccessCidrs
  • LaunchTemplateName
  • LaunchTemplateVersion
  • IdentityProviderConfig
  • EncryptionConfig
  • AddonVersion
  • ServiceAccountRoleArn
  • ResolveConflicts
  • MaxUnavailable
  • MaxUnavailablePercentage
  • NodeRepairEnabled
  • UpdateStrategy
  • ConfigurationValues
  • SecurityGroups
  • Subnets
  • AuthenticationMode
  • PodIdentityAssociations
  • UpgradePolicy
  • ZonalShiftConfig
  • ComputeConfig
  • StorageConfig
  • KubernetesNetworkConfig
  • RemoteNetworkConfig
  • DeletionProtection
  • NodeRepairConfig
  • RoleArn
  • RoleMappingsToAddOrUpdate
  • RoleMappingsToRemove
  • NetworkAccess
  • VendedLogs
  • UpdatedTier
  • PreviousTier
  • WarmPoolEnabled
  • WarmPoolMaxGroupPreparedCapacity
  • WarmPoolMinSize
  • WarmPoolState
  • WarmPoolReuseOnScaleIn
  • ControlPlaneEgressMode
  • KubeApiServerConfig
  • KubeSchedulerConfig
  • KubeControllerManagerConfig
  • ActiveCertificateAuthority
  • TrustedCertificateAuthorities
  • CertificateAuthorityId
  • SigningStatus

value -> (string)

The value of the keys submitted as part of an update request.

createdAt -> (timestamp)

The Unix epoch timestamp at object creation.

errors -> (list)

Any errors associated with a Failed update.

(structure)

An object representing an error when an asynchronous operation fails.

errorCode -> (string)

A brief description of the error.

  • SubnetNotFound : We couldn’t find one of the subnets associated with the cluster.
  • SecurityGroupNotFound : We couldn’t find one of the security groups associated with the cluster.
  • EniLimitReached : You have reached the elastic network interface limit for your account.
  • IpNotAvailable : A subnet associated with the cluster doesn’t have any available IP addresses.
  • AccessDenied : You don’t have permissions to perform the specified operation.
  • OperationNotPermitted : The service role associated with the cluster doesn’t have the required access permissions for Amazon EKS.
  • VpcIdNotFound : We couldn’t find the VPC associated with the cluster.

Possible values:

  • SubnetNotFound
  • SecurityGroupNotFound
  • EniLimitReached
  • IpNotAvailable
  • AccessDenied
  • OperationNotPermitted
  • VpcIdNotFound
  • Unknown
  • NodeCreationFailure
  • PodEvictionFailure
  • InsufficientFreeAddresses
  • ClusterUnreachable
  • InsufficientNumberOfReplicas
  • ConfigurationConflict
  • AdmissionRequestDenied
  • UnsupportedAddonModification
  • K8sResourceNotFound

errorMessage -> (string)

A more complete description of the error.

resourceIds -> (list)

An optional field that contains the resource IDs associated with the error.

(string)

cancellation -> (structure)

The latest cancellation information for the update. This field is present only if any cancellation is attempted for the update.

status -> (string)

The current status of the cancellation. Valid values are InProgress , Failed , and Successful .

Possible values:

  • InProgress
  • Failed
  • Successful

reason -> (string)

A message providing additional details about the cancellation, such as the reason for the cancellation or failure details.

certificateAuthority -> (structure)

Summary information about the certificate authority that is being deleted.

id -> (string)

The unique identifier of the certificate authority.

createdAt -> (timestamp)

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

createdBy -> (string)

The entity that created the certificate authority, either CUSTOMER or EKS .

Possible values:

  • EKS
  • CUSTOMER

activatedAt -> (timestamp)

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

activatedBy -> (string)

The entity that most recently activated the certificate authority, either CUSTOMER or EKS .

Possible values:

  • EKS
  • CUSTOMER

signingStatus -> (string)

The signing status of the certificate authority: IN_USE , ACTIVATING , or NOT_USED .

Possible values:

  • NOT_USED
  • ACTIVATING
  • IN_USE

distributionStatus -> (string)

The distribution status of the certificate authority: IN_PROGRESS , COMPLETE , FAILED , or DELETING .

Possible values:

  • IN_PROGRESS
  • COMPLETE
  • FAILED
  • DELETING