UpdateClusterRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/cloudera/main/json-schema/cloudera-update-cluster-request-schema.json",
  "title": "UpdateClusterRequest",
  "description": "Request object for the updateCluster method.",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cloudera-dw-api-openapi.yml#/components/schemas/UpdateClusterRequest",
  "type": "object",
  "required": [
    "clusterId"
  ],
  "properties": {
    "clusterId": {
      "type": "string",
      "description": "The ID of the cluster to update."
    },
    "description": {
      "type": "string",
      "description": "Cluster description."
    },
    "whitelistIpCIDRs": {
      "x-form-factors": "public,private",
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of IP address CIDRs to whitelist. NOTE: CDW is in process of rolling out a new feature to whitelist IP CIDR separately for Kubernetes Clusters and Loadbalancers on CDP Public Cloud. For an existing cluster, if different IP CIDR has been already applied to LoadBalancer and the Kubernetes cluster through the DWX UI, then updating the IP CIDR of such cluster is not supported from CLI. In the upcoming release, the CLI will support this feature. Please make use of UI for the same."
    },
    "whitelistK8sClusterAccessIpCIDRs": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of IP address CIDRs to whitelist for kubernetes cluster access."
    },
    "whitelistWorkloadAccessIpCIDRs": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of IP address CIDRs to whitelist for workload access."
    },
    "awsUpdate": {
      "type": "object",
      "description": "Additional properties for AWS clusters.",
      "properties": {
        "externalBuckets": {
          "type": "object",
          "description": "External bucket definition.",
          "additionalProperties": {
            "description": "External bucket access information.",
            "$ref": "#/$defs/UpdateClusterExternalBucketAccessInfo"
          }
        }
      }
    },
    "azureUpdate": {
      "type": "object",
      "description": "Additional properties for Azure clusters.",
      "properties": {
        "renewCertificate": {
          "type": "boolean",
          "default": false,
          "description": "Renew Azure cluster certificate."
        }
      }
    },
    "observabilityConfig": {
      "x-deprecated": true,
      "description": "DEPRECATED: This feature wil be removed in subsequent releases. Cluster observability configurations to update. You can forward logs from environments activated in Cloudera Data Warehouse (CDW) to observability and monitoring systems such as Datadog, New Relic, or Splunk. Please refer to the following Cloudera documentation for more info. https://docs.cloudera.com/data-warehouse/cloud/monitoring/topics/dw-observability-log-forwarding.html",
      "$ref": "#/$defs/UpdateClusterObservabilityConfig"
    }
  },
  "$defs": {
    "UpdateClusterExternalBucketAccessInfo": {
      "type": "object",
      "description": "Cluster external bucket definition to update.",
      "properties": {
        "accessMode": {
          "type": "string",
          "description": "Specifies whether the external bucket will be added in read-only or read-write mode.",
          "enum": [
            "READ",
            "READWRITE"
          ]
        },
        "kmsCmkArn": {
          "type": "string",
          "description": "Enable server side encryption with the specified KMS CMK ARN. If the value is empty or unspecified, default server side encryption will be used when the access mode is read-write. Otherwise this value is ignored."
        }
      }
    },
    "UpdateClusterObservabilityConfig": {
      "type": "object",
      "description": "Cluster observability settings to update.",
      "properties": {
        "logsForwardingConfig": {
          "type": "string",
          "description": "Create the log forwarding configuration in a valid fluentd format. Then that configuration is later inserted into a larger fluentd configuration."
        },
        "proxyCABundle": {
          "type": "string",
          "description": "Set the proxy CA certificates (PEM Bundle). If you use a TLS-terminating proxy server to inspect outbound internet traffic, you need to provide the proxy server's CA certificates bundle in PEM bundle format when you configure log forwarding."
        }
      }
    }
  }
}