{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/cloudera/main/json-schema/cloudera-describe-cluster-response-schema.json", "title": "DescribeClusterResponse", "description": "Describe cluster response.", "x-generated": "2026-10-04", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/cloudera-compute-api-openapi.yml#/components/schemas/DescribeClusterResponse", "type": "object", "properties": { "envName": { "type": "string", "description": "CDP environment name." }, "envCloudProvider": { "description": "CDP environment cloud provider.", "$ref": "#/$defs/EnvCloudProvider" }, "clusterName": { "type": "string", "description": "Compute cluster name." }, "clusterCrn": { "type": "string", "description": "Compute cluster CRN." }, "description": { "type": "string", "description": "Description about the cluster.", "x-form-factors": "private" }, "status": { "type": "string", "description": "Compute cluster status." }, "computePlatform": { "description": "Compute cluster platform provider.", "$ref": "#/$defs/ComputePlatform" }, "computePlatformVersion": { "type": "string", "description": "Compute cluster platform version.", "x-form-factors": "private" }, "kubernetesVersion": { "type": "string", "description": "Kubernetes version." }, "clusterSize": { "type": "integer", "format": "int32", "description": "Number of nodes in the cluster.", "x-form-factors": "private" }, "dashboardUrl": { "type": "string", "description": "Compute cluster platform dashboard url." }, "isClouderaManaged": { "type": "boolean", "description": "Is compute cluster cloudera managed or not.", "x-form-factors": "private" }, "clusterType": { "description": "Compute cluster type.", "$ref": "#/$defs/ComputeClusterType" }, "creationTime": { "type": "string", "description": "Compute cluster creation time in ISO format." }, "clusterId": { "type": "string", "description": "Compute cluster ID." }, "envCrn": { "type": "string", "description": "CDP environment CRN." }, "apiEndPoint": { "type": "string", "description": "API endpoint.", "x-form-factors": "public" }, "clusterStateVersion": { "type": "integer", "format": "int32", "description": "Cluster state version.", "x-form-factors": "public" }, "deletionTime": { "type": "string", "description": "Compute cluster deletion time in ISO format.", "x-form-factors": "public" }, "updateTime": { "type": "string", "description": "Compute cluster update time in ISO format.", "x-form-factors": "public" }, "workloads": { "type": "array", "items": { "type": "string" }, "description": "Workloads.", "x-form-factors": "public" }, "clusterOwner": { "description": "Cluster owner.", "$ref": "#/$defs/ComputeClusterOwner", "x-form-factors": "public" }, "region": { "type": "string", "description": "Region.", "x-form-factors": "public" }, "message": { "type": "string", "description": "Message with additional details about the cluster status.", "x-form-factors": "public" }, "account": { "type": "string", "description": "CDP account ID.", "x-form-factors": "public" }, "availableUpgrades": { "type": "array", "items": { "type": "string" }, "description": "List of available kubernetes upgrades.", "x-form-factors": "public" }, "imageCatalog": { "description": "The image catalog details.", "$ref": "#/$defs/CommonImageCatalogResp", "x-form-factors": "public" }, "storage": { "description": "The storage specifications.", "$ref": "#/$defs/CommonStorageSpecResp", "x-form-factors": "public" }, "labels": { "type": "object", "description": "Map of labels associated with this cluster.", "additionalProperties": { "type": "string" } }, "bootstrapScript": { "type": "string", "description": "Bootstrap script used to setup this cluster." }, "aks": { "description": "AKS state.", "$ref": "#/$defs/AksState", "x-form-factors": "public" }, "eks": { "description": "EKS state.", "$ref": "#/$defs/EksState", "x-form-factors": "public" }, "nodeImageUpgradeAvailable": { "type": "boolean", "description": "Is a node image upgrade available.", "x-form-factors": "public" }, "nodeImageUpgrades": { "type": "array", "items": { "$ref": "#/$defs/CommonNodeImageAvailableUpgrade" }, "description": "Lists the currently used images and the new upgrades available.", "x-form-factors": "public" }, "isDefault": { "type": "boolean", "description": "The cluster which is automatically created for every containerized environment.", "x-form-factors": "public" }, "clusterShape": { "type": "string", "description": "The clusterShape represents the shape of the cluster, which can be \"Embedded\" or \"Externalized\".", "x-form-factors": "public" } }, "$defs": { "AcceleratorConfigResp": { "type": "object", "description": "Accelerator Configurations structure", "properties": { "acceleratorManufacturers": { "type": "array", "items": { "type": "string" }, "description": "Accelerator Manufacturer type. For eg. amazon-web-service, AMD, nvidia." }, "acceleratorTypes": { "type": "array", "items": { "type": "string" }, "description": "Accelerator Types. For eg. gpu, inference." } }, "x-form-factors": "public" }, "AksInstanceGroup": { "type": "object", "description": "AKS instance group response structure.", "properties": { "instanceGroupName": { "type": "string", "description": "Instance group name." }, "instanceGroupId": { "type": "string", "description": "Instance group ID." }, "instanceType": { "type": "string", "description": "Instance type." }, "instanceTier": { "type": "string", "description": "Instance tier." }, "instanceStates": { "description": "Instance states", "$ref": "#/$defs/CommonInstanceStateCounts" }, "instanceCount": { "type": "integer", "format": "int64", "description": "Instance count." }, "nodeVolumeSize": { "type": "integer", "format": "int64", "description": "Node volume size." }, "enableAutoScaling": { "type": "boolean", "description": "Enable auto scaling." }, "minInstance": { "type": "integer", "format": "int64", "description": "Min instances." }, "maxInstance": { "type": "integer", "format": "int64", "description": "Max instances." }, "singleZone": { "type": "boolean", "description": "Single zone." }, "labels": { "type": "object", "description": "Labels.", "additionalProperties": { "type": "string" } }, "taints": { "type": "object", "description": "Taints.", "additionalProperties": { "type": "string" } }, "tags": { "type": "object", "description": "Tags.", "additionalProperties": { "type": "string" } }, "kubeReservedCpu": { "type": "integer", "format": "int64", "description": "Kube reserved CPU." }, "kubeReservedMemory": { "type": "integer", "format": "int64", "description": "Kube reserved memory." }, "kubeReservedStorage": { "type": "integer", "format": "int64", "description": "Kube reserved storage." }, "systemReservedCpu": { "type": "integer", "format": "int64", "description": "System reserved CPU." }, "systemReservedMemory": { "type": "integer", "format": "int64", "description": "System reserved memory." }, "systemReservedStorage": { "type": "integer", "format": "int64", "description": "System reserved storage." }, "availabilityZones": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Availability zones." }, "nodePool": { "description": "AKS node pool.", "$ref": "#/$defs/AksNodePool" }, "instances": { "type": "array", "items": { "$ref": "#/$defs/AksPoolInstance" }, "description": "AKS pool instance." }, "isSystem": { "type": "boolean", "description": "True for a system node." } }, "x-form-factors": "public" }, "AksNodePool": { "type": "object", "description": "AKS node pool response structure.", "properties": { "name": { "type": "string", "description": "Name." }, "type": { "type": "string", "description": "Type." }, "provisioningState": { "type": "string", "description": "Provisioning state." }, "instances": { "type": "array", "items": { "$ref": "#/$defs/AksPoolInstance" }, "description": "AKS pool instance." }, "availabilityZones": { "type": "array", "items": { "type": "string" }, "description": "Availability zones." } }, "x-form-factors": "public" }, "AksPoolInstance": { "type": "object", "description": "AKS pool instance response structure.", "properties": { "name": { "type": "string", "description": "Name." }, "instanceId": { "type": "string", "description": "Instance ID." }, "availabilityZone": { "type": "string", "description": "Availability zone." }, "subnetId": { "type": "string", "description": "Subnet ID." } }, "x-form-factors": "public" }, "AksState": { "type": "object", "description": "AKS state response structure.", "properties": { "provider": { "type": "string", "description": "Cloud provider." }, "clusterDisplayName": { "type": "string", "description": "Cluster display name." }, "clusterResourceGroup": { "type": "string", "description": "The Cluster ResourceGroup. Filled based on Parent ResourceGroup or ClusterDisplayName." }, "clusterResourceGroupCreated": { "type": "boolean", "description": "Specifies whether ClusterResourceGroup was created or not." }, "enableHttpApplicationRouting": { "type": "boolean", "description": "Specifies whether httpApplicationRouting addon is enabled or not." }, "enableMonitoring": { "type": "boolean", "description": "Specifies whether monitoring addon is enabled or not." }, "logAnalyticsWorkspaceResourceGroup": { "type": "string", "description": "The resource group for the Azure Log Analytics Workspace." }, "logAnalyticsWorkspace": { "type": "string", "description": "An existing Azure Log Analytics Workspace for monitoring addon." }, "virtualNetworkResourceGroup": { "type": "string", "description": "The resource group for the Azure Virtual Network. Composite of agent virtual network subnet ID." }, "virtualNetwork": { "type": "string", "description": "An existing Azure Virtual Network. Composite of agent virtual network subnet ID." }, "subnets": { "type": "array", "items": { "type": "string" }, "description": "An array specifying existing Azure Virtual Subnets. Composite of agent virtual network subnet IDs." }, "selectedSubnet": { "type": "string", "description": "Selected Subnet from the list that is provided" }, "parentResourceGroup": { "type": "string", "description": "The ResourceGroup which may be used for almost all the Azure resources created (with VirtualNetwork and Node ResourceGroup being exceptions)." }, "adminUsername": { "type": "string", "description": "The username to use for Linux VMs." }, "sshPublicKeyContents": { "type": "string", "description": "The content of the SSH configuration for Linux VMs, Opposite to sshPublicKey." }, "sshPublicKey": { "type": "string", "description": "The local path of the SSH configuration for Linux VMs, Opposite to sshPublicKeyContents." }, "dnsServiceIp": { "type": "string", "description": "An IP address assigned to the kubernetes DNS service, it must be within the kubernetes service address range specified in serviceCidr." }, "dockerBridgeCidr": { "type": "string", "description": "A CIDR notation IP range assigned to the Docker bridge network, it must not overlap with any Azure Subnet IP ranges or the kubernetes service address range." }, "networkPlugin": { "type": "string", "description": "The plugin used for kubernetes network." }, "networkPolicy": { "type": "string", "description": "The policy used for kubernetes network." }, "podCidr": { "type": "string", "description": "A CIDR notation IP range from which to assign pod IPs when networkPlugin is using kubenet." }, "serviceCidr": { "type": "string", "description": "A CIDR notation IP range from which to assign service cluster IPs, it must not overlap with any Azure Subnet IP ranges." }, "networkCidrs": { "type": "array", "items": { "type": "string" }, "description": "The actual CIDR ranges of the virtual network." }, "workerIngressRules": { "type": "array", "items": { "type": "string" }, "description": "Ingress rules for worker nodes." }, "workerEgressRules": { "type": "array", "items": { "type": "string" }, "description": "Egress rules for worker nodes." }, "masterDnsPrefix": { "type": "string", "description": "DNS prefix used for hostnames in the cluster." }, "tags": { "type": "object", "description": "Tags.", "additionalProperties": { "type": "string" } }, "instanceGroups": { "type": "object", "description": "Instance groups.", "additionalProperties": { "$ref": "#/$defs/AksInstanceGroup" } }, "deployments": { "description": "Deployments.", "$ref": "#/$defs/CommonDeploymentsResp" }, "userData": { "type": "string", "description": "User data." }, "security": { "description": "Security.", "$ref": "#/$defs/CommonSecurityResp" }, "egressType": { "type": "string", "description": "EgressType specifies the outbound type used by the cluster." }, "aksManagedIdentity": { "type": "string", "description": "AksManagedIdentity is the user-assigned managed identity to be used by the AKS control plane." }, "privateDnsZone": { "type": "string", "description": "PrivateDNSZone for the AKS cluster." }, "oidcIssuerURL": { "type": "string", "description": "URL of the OIDCIssuer attached to the cluster." } }, "x-form-factors": "public" }, "AzureSecretEncryptionResp": { "type": "object", "description": "Azure Secret Encryption response structure.", "properties": { "encryptionKeyUrl": { "type": "string", "description": "Encryption key URI." }, "userManagedIdentity": { "type": "string", "description": "Resource ID of the user managed identity." } }, "x-form-factors": "public" }, "AzureVolumeEncryptionResp": { "type": "object", "description": "Azure Volume Encryption response structure.", "properties": { "diskEncryptionSetId": { "type": "string", "description": "Disk encryption set ID." } }, "x-form-factors": "public" }, "CommonAlertmanagerResp": { "type": "object", "description": "Alertmanager response structure.", "properties": { "enabled": { "type": "boolean", "description": "Flag to indicate if Alertmanager is enabled." } }, "x-form-factors": "public" }, "CommonApiServerResp": { "type": "object", "description": "API server response structure.", "properties": { "authorizedIpRanges": { "type": "array", "items": { "type": "string" }, "description": "An array of IPv4 CIDR blocks." }, "enabled": { "type": "boolean", "description": "Flag to indicate if whitelist of IP Ranges (CIDR block) for public access to the kubernetes API server is enabled." } }, "x-form-factors": "public" }, "CommonAutoscalerResp": { "type": "object", "description": "Autoscaler response structure.", "properties": { "scaleDownDelayAfterAdd": { "type": "string", "description": "How long after scale up that scale down evaluation resumes. (Azure/AWS Support)." }, "scaleDownDelayAfterDelete": { "type": "string", "description": "How long after node deletion that scale down evaluation resumes, defaults to scanInterval. (Azure/AWS Support)." }, "scaleDownDelayAfterFailure": { "type": "string", "description": "How long after scale down failure that scale down evaluation resumes. (Azure/AWS Support)." }, "scaleDownEnabled": { "type": "boolean", "description": "Scale down flag. (AWS Support)." }, "scaleDownNonEmptyCandidatesCount": { "type": "integer", "format": "int32", "description": "Maximum number of non empty nodes considered in one iteration as candidates for scale down with drain. Lower value means better CA responsiveness but possible slower scale down latency. Higher value can affect CA performance with big clusters (100s of nodes). Set to non positive value to turn this heuristic off - CA will not limit the number of nodes it considers. (AWS Support)." }, "scaleDownUnneededTime": { "type": "string", "description": "How long a node should be unneeded before it is eligible for scale down. (Azure/AWS Support)." }, "scaleDownUtilizationThreshold": { "type": "number", "format": "double", "description": "Node utilization level, defined as the sum of requested resources divided by capacity,. below which a node can be considered for scale down. (Azure/AWS Support)." }, "scanInterval": { "type": "string", "description": "Scan interval. (Azure/AWS Support)." }, "skipNodesWithLocalStorage": { "type": "boolean", "description": "Skip nodes with local storage flag. (AWS Support)." }, "skipNodesWithSystemPods": { "type": "boolean", "description": "Skip nodes with system pods. (AWS Support)." }, "maxGracefulTerminationSec": { "type": "integer", "format": "int64", "description": "Maximum number of seconds CA waits for pod termination when trying to scale down a node. (Azure Support)." }, "scaleDownUnreadyTime": { "type": "string", "description": "How long an unready node should be unneeded before it is eligible for scale down. (Azure Support)." } }, "x-form-factors": "public" }, "CommonDeploymentProfileDetailsResp": { "type": "object", "description": "Deployment Profile details response structure.", "properties": { "enabled": { "type": "boolean", "description": "Deployment enable flag." }, "deploymentProfile": { "type": "string", "description": "Deployment profile used. Currently supported is common." } }, "x-form-factors": "public" }, "CommonDeploymentsResp": { "type": "object", "description": "Deployments response structure.", "properties": { "autoscaler": { "description": "Autoscaler specs.", "$ref": "#/$defs/CommonAutoscalerResp" }, "horizontalPodAutoscaler": { "description": "Horizontal pod autoscaler specs.", "$ref": "#/$defs/CommonHorizontalPodAutoScalerResp" }, "istio": { "description": "Istio specs.", "$ref": "#/$defs/CommonDeploymentProfileDetailsResp" }, "logging": { "description": "Logging specs.", "$ref": "#/$defs/CommonLoggingResp" }, "metering": { "description": "Metering specs.", "$ref": "#/$defs/CommonMeteringResp" }, "monitoring": { "description": "Monitoring specs.", "$ref": "#/$defs/CommonMonitoringResp" }, "nvidia": { "description": "Nvidia specs.", "$ref": "#/$defs/CommonNvidiaResp" }, "repository": { "type": "string", "description": "Repository for images." }, "yunikorn": { "description": "Yunikorn specs.", "$ref": "#/$defs/CommonYuniKornResp" }, "telemetryKmsKeyArn": { "type": "string", "description": "Telemetry KMS key ARN." }, "knox": { "description": "Knox specs.", "$ref": "#/$defs/CommonDeploymentProfileDetailsResp" } }, "x-form-factors": "public" }, "CommonEvent": { "type": "object", "description": "Event response structure.", "properties": { "details": { "type": "string", "description": "Details." }, "name": { "type": "string", "description": "Event name." }, "progress": { "type": "string", "description": "Progress." }, "resourceType": { "type": "string", "description": "Resource type." }, "status": { "type": "string", "description": "Status." }, "statusReason": { "type": "string", "description": "Status reason." }, "timestamp": { "type": "string", "description": "Timestamp." } }, "x-form-factors": "public" }, "CommonHorizontalPodAutoScalerResp": { "type": "object", "description": "Horizontal pod autoscaler response structure.", "properties": { "enabled": { "type": "boolean", "description": "Enable flag." } }, "x-form-factors": "public" }, "CommonImageCatalogResp": { "type": "object", "description": "Image catalog response structure.", "properties": { "crn": { "type": "string", "description": "The catalog CRN (either CRN or name is required)." }, "name": { "type": "string", "description": "The catalog name (either CRN or name is required)." } }, "x-form-factors": "public" }, "CommonInstanceRequirementsResp": { "type": "object", "description": "Instance requirements structure.", "properties": { "allowedInstanceTypes": { "type": "array", "items": { "type": "string" }, "description": "Instance types to include." }, "cpuTypes": { "type": "array", "items": { "type": "string" }, "description": "CPU types required. For eg. intel, amd, amazon-web-services etc." }, "excludedInstanceTypes": { "type": "array", "items": { "type": "string" }, "description": "Instance types to exclude, ignored if AllowedInstanceTypes is set." }, "maxCpu": { "type": "integer", "format": "int64", "description": "Maximum vCpu count." }, "minCpu": { "type": "integer", "format": "int64", "description": "Minimum vCpu count." }, "maxMemory": { "type": "integer", "format": "int64", "description": "Maximum memory requirement in MiB." }, "minMemory": { "type": "integer", "format": "int64", "description": "Minimum memory requirement in MiB." }, "acceleratorConfig": { "description": "Accelerator Config for AWS.", "$ref": "#/$defs/AcceleratorConfigResp" } }, "x-form-factors": "public" }, "CommonInstanceRequirementsWithMetadataResp": { "type": "object", "description": "Instance requirements with metadata response structure.", "properties": { "architectureTypes": { "type": "array", "items": { "type": "string" }, "description": "The architecture types. For eg, i386, x86_64, arm64, x86_64_mac, arm64_mac." }, "virtualizationTypes": { "type": "array", "items": { "type": "string" }, "description": "The virtualization types. For eg. hvm, paravirtual." }, "instanceRequirements": { "description": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.", "$ref": "#/$defs/CommonInstanceRequirementsResp" } }, "x-form-factors": "public" }, "CommonInstanceStateCounts": { "type": "object", "description": "Instance state counts response structure.", "properties": { "running": { "type": "integer", "format": "int64", "description": "Number of instances in running state." }, "creating": { "type": "integer", "format": "int64", "description": "Number of instances in creating state." }, "terminating": { "type": "integer", "format": "int64", "description": "Number of instances in terminating state." }, "total": { "type": "integer", "format": "int64", "description": "Total number of instances." } }, "x-form-factors": "public" }, "CommonLoggingResp": { "type": "object", "description": "Logging response structure.", "properties": { "enabled": { "type": "boolean", "description": "True to enable logging installation (default false)." } }, "x-form-factors": "public" }, "CommonMeteringResp": { "type": "object", "description": "Metering response structure.", "properties": { "enabled": { "type": "boolean", "description": "Flag to indicate if Monitoring is enabled." }, "services": { "type": "array", "items": { "$ref": "#/$defs/CommonMeteringServiceResp" }, "description": "Array of services." } }, "x-form-factors": "public" }, "CommonMeteringServiceResp": { "type": "object", "description": "Metering service response structure.", "properties": { "serviceType": { "type": "string", "description": "Service type." }, "serviceVersion": { "type": "string", "description": "Service version." }, "workloadCrn": { "type": "string", "description": "Workload CRN." }, "clusterCrn": { "type": "string", "description": "Cluster CRN." }, "serviceConfiguration": { "type": "string", "description": "Service configuration." } }, "x-form-factors": "public" }, "CommonMonitoringResp": { "type": "object", "description": "Monitoring response structure.", "properties": { "enabled": { "type": "boolean", "description": "Flag to indicate if Monitoring is enabled." }, "alertmanager": { "description": "Alertmanager.", "$ref": "#/$defs/CommonAlertmanagerResp" }, "serverResourceLimits": { "description": "Server resource limits.", "$ref": "#/$defs/CommonResourceLimitsResp" } }, "x-form-factors": "public" }, "CommonNodeImageAvailableUpgrade": { "type": "object", "description": "Structure to list the currently used images and the new upgrades available.", "properties": { "instanceGroup": { "type": "string", "description": "Instance group name." }, "current": { "type": "string", "description": "Currently used node image version." }, "upgrades": { "type": "array", "items": { "type": "string" }, "description": "Available node image upgrade versions." } }, "x-form-factors": "public" }, "CommonNvidiaResp": { "type": "object", "description": "Nvidia response structure.", "properties": { "gpuLabelKey": { "type": "string", "description": "GPU label key." }, "gpuLabelValue": { "type": "string", "description": "GPU label value." } }, "x-form-factors": "public" }, "CommonResourceLimitsResp": { "type": "object", "description": "Resource limits response structure.", "properties": { "cpu": { "type": "string", "description": "Prometheus server CPU limit (default 1000m)." }, "memory": { "type": "string", "description": "Prometheus server memory limit (default 2048M)." } }, "x-form-factors": "public" }, "CommonSecretEncryptionResp": { "type": "object", "description": "Secret Encryption response structure.", "properties": { "customerKmsKeyArn": { "type": "string", "description": "AWS KMS key ARN." }, "azure": { "description": "Azure secret encryption details.", "$ref": "#/$defs/AzureSecretEncryptionResp" } }, "x-form-factors": "public" }, "CommonSecurityResp": { "type": "object", "description": "Security response structure.", "properties": { "apiServer": { "description": "API server.", "$ref": "#/$defs/CommonApiServerResp" }, "secretEncryption": { "description": "Secret encryption.", "$ref": "#/$defs/CommonSecretEncryptionResp" }, "volumeEncryption": { "description": "Volume encryption.", "$ref": "#/$defs/CommonVolumeEncryptionResp" }, "private": { "type": "boolean", "description": "Flag to indicate if this is a private cluster with API Server having internal IP addressees." } }, "x-form-factors": "public" }, "CommonStorageSpecResp": { "type": "object", "description": "Storage spec response structure.", "properties": { "csiEnabled": { "type": "boolean", "description": "Flag to enable CSI (Container Storage Interface). It further sets specific inline cloud formation policies required for CSI." } }, "x-form-factors": "public" }, "CommonVolumeEncryptionResp": { "type": "object", "description": "Volume encryption response structure.", "properties": { "customerKmsKeyArn": { "type": "string", "description": "AWS KMS key ARN." }, "azure": { "description": "Azure volume encryption details.", "$ref": "#/$defs/AzureVolumeEncryptionResp" } }, "x-form-factors": "public" }, "CommonYuniKornResp": { "type": "object", "description": "YuniKorn response structure.", "properties": { "enabled": { "type": "boolean", "description": "Flag to indicate if yunikorn is enabled." }, "version": { "type": "string", "description": "Version. Deprecated.", "x-deprecated": true }, "appSortingPolicy": { "type": "string", "description": "The app sorting policy. Deprecated.", "x-deprecated": true }, "nodeSortingPolicy": { "type": "string", "description": "The node sorting policy. Deprecated.", "x-deprecated": true } }, "x-form-factors": "public" }, "ComputeClusterOwner": { "type": "object", "description": "Compute cluster owner structure.", "properties": { "email": { "type": "string", "description": "Owner's email." }, "firstName": { "type": "string", "description": "Owner's firstname." }, "lastName": { "type": "string", "description": "Owner's lastname." }, "userId": { "type": "string", "description": "Owner's user ID." }, "accountId": { "type": "string", "description": "Owner's account ID." }, "crn": { "type": "string", "description": "Owner's actor CRN." } }, "x-form-factors": "public" }, "ComputeClusterType": { "type": "string", "description": "Object representing compute cluster types.\n `Shared` - Value representing a shared compute cluster. `DedicatedExternal` - Value representing an external dedicated compute cluster. `Dedicated` - Value representing an embedded dedicated compute cluster.", "enum": [ "Shared", "DedicatedExternal", "Dedicated" ] }, "ComputePlatform": { "type": "string", "description": "Object representing Cloudera Compute Cluster Platform provider.\n `OPENSHIFT` - OpenShift Container Platform cluster as compute platform (Cloudera on-premises only). `EKS` - EKS cluster as compute platform `AKS` - AKS cluster as compute platform `RKE` - Rancher RKE as compute platform (Cloudera on-premises only). `GKE` - GKE cluster as compute platform `OCP` - OCP Container Platform cluster as compute platform (Cloudera on-premises only). `KCLOUD` - KCLOUD cluster as compute platform (Cloudera on-premises only). `STANDARD` - STANDARD cluster as compute platform (Cloudera on-premises only).", "enum": [ "OPENSHIFT", "EKS", "AKS", "RKE" ] }, "EksInstance": { "type": "object", "description": "EKS instance response structure.", "properties": { "instanceId": { "type": "string", "description": "Instance ID." }, "availabilityZone": { "type": "string", "description": "Availability zone." }, "subnetId": { "type": "string", "description": "Subnet ID." } }, "x-form-factors": "public" }, "EksInstanceGroup": { "type": "object", "description": "EKS instance group response structure.", "properties": { "ami": { "type": "string", "description": "AMI." }, "imageParam": { "type": "string", "description": "Image param." }, "instanceGroupName": { "type": "string", "description": "Instance group name." }, "instanceGroupId": { "type": "string", "description": "Instance group ID." }, "instanceTier": { "type": "string", "description": "Instance tier." }, "instanceTypes": { "type": "array", "items": { "type": "string" }, "description": "Instance types." }, "instanceCount": { "type": "integer", "format": "int64", "description": "Instance count." }, "instanceStates": { "description": "Instance states", "$ref": "#/$defs/CommonInstanceStateCounts" }, "singleZone": { "type": "boolean", "description": "Single zone." }, "minInstance": { "type": "integer", "format": "int64", "description": "Min instances." }, "maxInstance": { "type": "integer", "format": "int64", "description": "Max instances." }, "nodeInstanceRole": { "type": "string", "description": "Node instance role." }, "nodeVolumeSize": { "type": "integer", "format": "int64", "description": "Node volume size." }, "labels": { "type": "object", "description": "Labels.", "additionalProperties": { "type": "string" } }, "taints": { "type": "object", "description": "Taints.", "additionalProperties": { "type": "string" } }, "tags": { "type": "object", "description": "Tags.", "additionalProperties": { "type": "string" } }, "autoscalingEnabled": { "type": "boolean", "description": "Autoscaling enabled." }, "kubeReservedCpu": { "type": "integer", "format": "int64", "description": "Kube reserved CPU." }, "kubeReservedMemory": { "type": "integer", "format": "int64", "description": "Kube reserved memory." }, "kubeReservedStorage": { "type": "integer", "format": "int64", "description": "Kube reserved storage." }, "systemReservedCpu": { "type": "integer", "format": "int64", "description": "System reserved CPU." }, "systemReservedMemory": { "type": "integer", "format": "int64", "description": "System reserved memory." }, "systemReservedStorage": { "type": "integer", "format": "int64", "description": "System reserved storage." }, "enableCfsQuota": { "type": "boolean", "description": "Enable cfs quota." }, "instances": { "type": "array", "items": { "$ref": "#/$defs/EksInstance" }, "description": "EKS Instance." }, "events": { "type": "array", "items": { "$ref": "#/$defs/CommonEvent" }, "description": "Events." }, "instanceGroupStatus": { "type": "string", "description": "Instance group status." }, "lTNameSuffix": { "type": "string", "description": "Launch Template name suffix." }, "instanceRequirementswithMetadata": { "description": "Instance requirements.", "$ref": "#/$defs/CommonInstanceRequirementsWithMetadataResp" }, "instanceProfile": { "type": "string", "description": "Instance profile name." }, "imdsVersions": { "type": "array", "items": { "type": "string" }, "description": "IMDS versions." } }, "x-form-factors": "public" }, "EksState": { "type": "object", "description": "EKS state response structure.", "properties": { "provider": { "type": "string", "description": "Provider." }, "clusterDisplayName": { "type": "string", "description": "Cluster display name." }, "userData": { "type": "string", "description": "User data for this cluster." }, "virtualNetwork": { "type": "string", "description": "Virtual network details." }, "existingVirtualNetwork": { "type": "boolean", "description": "Existing virtual network if used." }, "subnets": { "type": "array", "items": { "type": "string" }, "description": "Subnets." }, "workerSubnets": { "type": "array", "items": { "type": "string" }, "description": "Worker subnets." }, "securityGroups": { "type": "array", "items": { "type": "string" }, "description": "Security groups." }, "serviceRole": { "type": "string", "description": "Service role." }, "workerInstanceProfile": { "type": "string", "description": "Worker instance profile." }, "associateWorkerNodePublicIp": { "type": "boolean", "description": "Associate worker node public IP." }, "vpcCidr": { "type": "string", "description": "VPC CIDR." }, "workerIngressRules": { "type": "array", "items": { "type": "string" }, "description": "Ingress rules for worker nodes." }, "workerEgressRules": { "type": "array", "items": { "type": "string" }, "description": "Egress rules for worker nodes." }, "workerSecurityGroup": { "type": "string", "description": "Worker security group." }, "telemetryEnabled": { "type": "boolean", "description": "Telemetry enabled." }, "telemetryLoggingEnabled": { "type": "boolean", "description": "Telemetry logging enabled." }, "telemetryLoggingStorageLocation": { "type": "string", "description": "Telemetry logging storage location." }, "telemetryLoggingBucket": { "type": "string", "description": "Telemetry logging bucket." }, "telemetryLoggingRootDir": { "type": "string", "description": "Telemetry logging root dir." }, "telemetryKmsKeyArn": { "type": "string", "description": "Telemetry logging root dir." }, "tags": { "type": "object", "description": "Tags.", "additionalProperties": { "type": "string" } }, "sshKeyPairName": { "type": "string", "description": "SSH key pair name." }, "kmsKeyArn": { "type": "string", "description": "KMS key ARN." }, "instanceGroups": { "type": "object", "description": "Instance groups.", "additionalProperties": { "$ref": "#/$defs/EksInstanceGroup" } }, "deployments": { "description": "Deployments.", "$ref": "#/$defs/CommonDeploymentsResp" }, "sshPublicKey": { "type": "string", "description": "SSH public key." }, "networkPlugin": { "type": "string", "description": "Network plugin." }, "serviceCidr": { "type": "string", "description": "Service CIDR." }, "inboundProxyCidrs": { "type": "array", "items": { "type": "string" }, "description": "Array of inbound proxy CIDRs." }, "security": { "description": "Security.", "$ref": "#/$defs/CommonSecurityResp" }, "suspendedProcesses": { "type": "array", "items": { "type": "string" }, "description": "Suspended processes." }, "csiEnabled": { "type": "boolean", "description": "Whether CSI is enabled." } }, "x-form-factors": "public" }, "EnvCloudProvider": { "type": "string", "description": "Object representing cloud provider type for Cloudera environment.\n `AWS` - Cloudera environment installed in AWS. `AZURE` - Cloudera environment installed in Azure. `OPENSHIFT` - Cloudera environment installed as on-premises installation using OpenShift in the base cluster. `GCP` - Cloudera environment installed in GCP. `REDHAT` - Cloudera environment installed as an on-premises deployment using Red Hat infrastructure. `KCLOUD` - Cloudera environment installed as an on-premises deployment using KCLOUD infrastructure. `STANDARD` - Cloudera environment installed as a generic on-premises deployment using CDP Data services.", "enum": [ "AWS", "AZURE", "OPENSHIFT" ] } } }