fix(eks): fail to update cluster by disabling logging props

[pahud]

When updating the EKS cluster by turning off LogType from clusterLogging, the custom resource of cluster resource handler fails because it does not add LogType with enabled: false in the LogSetup. For example, if we disable the logging like this:

const cluster = new eks.Cluster(this, 'Cluster', {
        vpc,
        version: eks.KubernetesVersion.V1_24,
        kubectlLayer: new KubectlLayer(this, 'KubectlLayer'),
        // clusterLogging: [
        //   eks.ClusterLoggingTypes.AUDIT,
        // ],
      })

The logging of oldProps would be

{logging: { clusterLogging: [  { types: ['audit'] , enabled: 'true' }] }

and the newProps would be

{logging: { }

while the expected argument for the updateClusterConfig should be

{logging: { clusterLogging: [  { types: ['audit'] , enabled: 'false' }] }

Similarly, if we update the clusterLogging from

  clusterLogging: [
     eks.ClusterLoggingTypes.AUDIT,
     eks.ClusterLoggingTypes.API,
   ],

to

  clusterLogging: [
     eks.ClusterLoggingTypes.API,
   ],

The argument should be:

{logging: { clusterLogging: [   { types: ['api'] , enabled: 'true' }, { types: ['audit'] , enabled: 'false' }, ] }

instead of

{logging: { clusterLogging: [   { types: ['api'] , enabled: 'true' } ] }

This PR adds a new compareLoggingProps() function that compares the logging configuration between oldProps and newProps and return an result object that contains LogSetup with enabled: false if any and this fixes the bug that fails to update the cluster with modified cluster logging.

While this PR includes unit tests, I have successfully tested the following use cases manually as well:

• from no clusterLogging to clusterLogging with API and AUDIT
• from clusterLogging with API and AUDIT to no clusterLogging
• from clusterLogging with API and AUDIT to API only
• from clusterLogging with API and AUDIT to AUTHENTICATE only
• from clusterLogging with API and AUDIT to AUTHENTICATE and API only

This PR will not have integ tests update as it only happens when we update the stack with clusterLogging changes.

Closes #20779

---

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

[aws-cdk-automation]

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

[pahud]

Exemption Request

✅ Updated pull request passes all PRLinter validations. Dissmissing previous PRLinter review.

[MrArnoldPalmer]

LGTM, thank you @pahud !

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: 90cfba0
• Result: SUCCEEDED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository