CreateClusterRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/cloudera/main/json-schema/cloudera-create-cluster-request-schema.json",
  "title": "CreateClusterRequest",
  "description": "Request object for the createCluster 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/CreateClusterRequest",
  "type": "object",
  "required": [
    "environmentCrn"
  ],
  "properties": {
    "environmentCrn": {
      "type": "string",
      "description": "The CRN of the environment for the cluster to create."
    },
    "useOverlayNetwork": {
      "type": "boolean",
      "description": "Using an overlay network will save IP addresses in the VPC by using a private IP address range for Pods in the cluster."
    },
    "databaseBackupRetentionPeriod": {
      "type": "integer",
      "format": "int32",
      "default": 30,
      "description": "PostgreSQL server backup retention days."
    },
    "whitelistIpCIDRs": {
      "x-form-factors": "public,private",
      "type": "string",
      "description": "This field is still available for Private Cloud deployments, however it'll be removed for Public Cloud in the next DWX release. Please use the use 'whitelistK8sClusterAccessIpCIDRs' in combination of 'whitelistWorkloadAccessIpCIDRs' on Public Cloud. Comma separated list of IP address CIDRs to whitelist."
    },
    "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."
    },
    "usePrivateLoadBalancer": {
      "type": "boolean",
      "description": "Set up load balancer with private IP address. In AWS it is created in private subnets. In Azure an internal load balancer gets created. Make sure there is connectivity between your client network and the network (VPC/VNet) where CDW environment is deployed."
    },
    "usePublicWorkerNode": {
      "type": "boolean",
      "description": "Set up worker node with public IP address. In AWS it is created in public subnets."
    },
    "enableStorageRoles": {
      "type": "boolean",
      "description": "DEPRECATED - Enable Storage Roles",
      "default": false,
      "x-deprecated": true,
      "x-form-factors": "public",
      "x-entitlement": "CDW_STORAGE_ROLES"
    },
    "customRegistryOptions": {
      "description": "Options for custom ACR/ECR registries.",
      "$ref": "#/$defs/CustomRegistryOptions"
    },
    "awsOptions": {
      "description": "Options for activating an AWS environment.",
      "$ref": "#/$defs/AwsActivationOptions",
      "x-form-factors": "public"
    },
    "azureOptions": {
      "description": "Options for activating an Azure environment.",
      "$ref": "#/$defs/AzureActivationOptions",
      "x-form-factors": "public"
    },
    "privateCloudOptions": {
      "description": "Options for activating a Private Cloud environment.",
      "$ref": "#/$defs/PrivateCloudActivationOptions",
      "x-form-factors": "private"
    },
    "customSubdomain": {
      "type": "string",
      "description": "Custom environment subdomain. Overrides the environment subdomain using a customized domain either in the old subdomain format like ENV_ID.dw or the new format like dw-ENV_NAME."
    }
  },
  "$defs": {
    "AwsActivationOptions": {
      "type": "object",
      "description": "Options for activating an AWS environment.",
      "properties": {
        "enablePrivateEKS": {
          "type": "boolean",
          "description": "Use this option to set up AWS EKS cluster in private only mode with restricted access only from internal/peered networks. Ensure you have ccmv2 setup functional to achieve this integration.",
          "default": false
        },
        "workerSubnetIds": {
          "type": "array",
          "description": "IDs of AWS subnets where the cluster worker nodes should be deployed.",
          "items": {
            "type": "string"
          }
        },
        "lbSubnetIds": {
          "type": "array",
          "description": "IDs of AWS subnets where the cluster load balancer should be deployed.",
          "items": {
            "type": "string"
          }
        },
        "customAmiId": {
          "type": "string",
          "description": "Custom AMI ID."
        },
        "nodeRoleCDWManagedPolicyArn": {
          "type": "string",
          "description": "Managed Policy Arn to be attached to the Node Instance Role."
        },
        "enableSpotInstances": {
          "type": "boolean",
          "description": "Whether to enable Spot instances for Virtual warehouses. It cannot be updated later. If the aws-options is not provided it defaults to false.",
          "default": false
        },
        "reducedPermissionMode": {
          "type": "boolean",
          "description": "Use this option to activate the environment with fewer than half of the standard required IAM permissions on your AWS cross-account IAM role."
        },
        "nonTransparentProxy": {
          "description": "Non-transparent proxy settings. Read more: https://docs.cloudera.com/data-warehouse/cloud/aws-environments/topics/dw-aws-use-non-transparent-proxy.html",
          "$ref": "#/$defs/AwsActivationOptionsNonTransparentProxy"
        }
      }
    },
    "AwsActivationOptionsNonTransparentProxy": {
      "type": "object",
      "description": "Activation options for an AWS environment to enable non-transparent proxy. Read more: https://docs.cloudera.com/data-warehouse/cloud/aws-environments/topics/dw-aws-use-non-transparent-proxy.html",
      "properties": {
        "use": {
          "type": "boolean",
          "description": "Switch using the default non-transparent proxy on/off.",
          "x-omitempty": false
        },
        "bypassedDomains": {
          "type": "array",
          "x-omitempty": false,
          "description": "Domains where the proxy is getting by-passed.",
          "items": {
            "type": "string",
            "description": "Domain."
          }
        }
      }
    },
    "AzureActivationOptions": {
      "type": "object",
      "description": "Options for activating an Azure environment.",
      "properties": {
        "userAssignedManagedIdentity": {
          "type": "string",
          "description": "Resource ID of the managed identity used by AKS. It is a mandatory parameter for Azure cluster creation."
        },
        "subnetId": {
          "type": "string",
          "description": "ID of Azure subnet where the cluster should be deployed. It is a mandatory parameter for Azure cluster creation."
        },
        "enableAZ": {
          "type": "boolean",
          "description": "Enables Azure Availability Zones for the cluster deployment."
        },
        "enableSpotInstances": {
          "type": "boolean",
          "description": "Whether to enable spot instances for Virtual warehouses. It cannot be updated later. If the AzureActivationOptions is not provided it defaults to false.",
          "default": false
        },
        "logAnalyticsWorkspaceId": {
          "type": "string",
          "description": "Enable monitoring of Azure Kubernetes Service (AKS) cluster. Workspace ID for Azure log analytics."
        },
        "outboundType": {
          "type": "string",
          "description": "Network outbound type. This setting controls the egress traffic for cluster nodes in Azure Kubernetes Service. Please refer to the following AKS documentation on the Azure portal. https://learn.microsoft.com/en-us/azure/aks/egress-outboundtype, https://learn.microsoft.com/en-us/azure/aks/nat-gateway",
          "enum": [
            "LoadBalancer",
            "UserAssignedNATGateway",
            "UserDefinedRouting"
          ]
        },
        "aksPodCIDR": {
          "type": "string",
          "description": "Pod CIDR required for Azure CNI networking. Please refer to the following Azure documentation, https://docs.microsoft.com/en-us/azure/aks/azure-cni-overlay."
        },
        "enablePrivateSQL": {
          "type": "boolean",
          "description": "Enables private SQL for the cluster deployment.",
          "default": false
        },
        "privateSQLSubnetName": {
          "type": "string",
          "description": "Name of the delegated subnet where the private SQL should be deployed."
        },
        "privateDNSZoneSQL": {
          "type": "string",
          "description": "Private DNS zone ID for the PostgreSQL server."
        },
        "privateDNSZoneAKS": {
          "type": "string",
          "description": "Private DNS zone AKS resource ID."
        },
        "enablePrivateAks": {
          "type": "boolean",
          "description": "Enable Azure Private AKS mode.",
          "default": false
        }
      }
    },
    "CustomRegistryOptions": {
      "type": "object",
      "description": "Options for custom ACR, ECR registry.",
      "properties": {
        "registryType": {
          "enum": [
            "ACR",
            "ECR"
          ],
          "type": "string",
          "description": "Custom registry type."
        },
        "repositoryUrl": {
          "type": "string",
          "description": "URL of the custom image repository.",
          "x-no-paramfile": true
        }
      }
    },
    "KeyPairCredentials": {
      "x-form-factors": "private",
      "type": "object",
      "description": "Certificate and private key pair credentials, that could be used ie mutual TLS connections therefore these must belong together.",
      "required": [
        "certificate",
        "privateKey"
      ],
      "properties": {
        "certificate": {
          "type": "string",
          "description": "The content of certificate PEM file."
        },
        "privateKey": {
          "type": "string",
          "description": "The content of private key PEM file."
        }
      }
    },
    "PrivateCloudActivationOptions": {
      "type": "object",
      "description": "Options for activating a Private Cloud environment.",
      "x-form-factors": "private",
      "properties": {
        "storageClass": {
          "type": "string",
          "description": "The storage class for the Local Storage Operator."
        },
        "dedicatedExecutorNodes": {
          "x-deprecated": true,
          "type": "boolean",
          "description": "DEPRECATED: As of 1.5.5, this feature flag can be set as an advanced configuration. Enable to use dedicated nodes exclusively for executors and coordinators, and improve performance. You can enable this only if you reserved nodes while adding a CDP Private Cloud containerized ECS cluster. When disabled, non-compute pods such as MetaStore and Data Visualization can also use the reserved nodes.",
          "default": false
        },
        "dbClientCredentials": {
          "$ref": "#/$defs/KeyPairCredentials",
          "description": "A certificate and private key pair belonging together for mutual SSL handshake when Database Catalog (aka DBC) connects to the metastore database."
        },
        "customKerberosPrincipalHostname": {
          "type": "string",
          "description": "Optional hostname parameter. If not empty, this hostname will be used in the Kerberos service principal required by Cloudera Data Warehouse on Premises runtime components (Database Catalog, Virtual Warehouses)."
        }
      }
    }
  }
}