CreateAwsClusterRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/cloudera/main/json-schema/cloudera-create-aws-cluster-request-schema.json",
  "title": "CreateAwsClusterRequest",
  "description": "Request object for the createAwsCluster 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/CreateAwsClusterRequest",
  "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."
    },
    "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."
    },
    "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
    },
    "customRegistryOptions": {
      "description": "Options for custom ACR/ECR registries.",
      "$ref": "#/$defs/CustomRegistryOptions"
    },
    "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."
    },
    "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. 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/CreateAwsClusterNonTransparentProxyRequest"
    }
  },
  "$defs": {
    "CreateAwsClusterNonTransparentProxyRequest": {
      "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",
          "description": "Domains where the proxy is getting by-passed.",
          "x-omitempty": false,
          "items": {
            "type": "string",
            "description": "Domain."
          }
        }
      }
    },
    "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
        }
      }
    }
  }
}