create-aws-cluster¶

Description¶

Create an AWS cluster in the Cloudera Data Warehouse environment with the provided settings.

Synopsis¶

  create-aws-cluster
--environment-crn <value>
[--use-overlay-network | --no-use-overlay-network]
[--database-backup-retention-period <value>]
[--whitelist-k8s-cluster-access-ip-cidrs <value>]
[--whitelist-workload-access-ip-cidrs <value>]
[--use-private-load-balancer | --no-use-private-load-balancer]
[--use-public-worker-node | --no-use-public-worker-node]
[--enable-private-eks | --no-enable-private-eks]
[--reserved-compute-nodes <value>]
[--reserved-shared-services-nodes <value>]
[--custom-registry-options <value>]
[--custom-subdomain <value>]
[--worker-subnet-ids <value>]
[--lb-subnet-ids <value>]
[--custom-ami-id <value>]
[--node-role-cdw-managed-policy-arn <value>]
[--enable-spot-instances | --no-enable-spot-instances]
[--reduced-permission-mode | --no-reduced-permission-mode]
[--compute-instance-types <value>]
[--additional-instance-types <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--environment-crn (string)

The CRN of the environment for the cluster to create.

--use-overlay-network | --no-use-overlay-network (boolean)

Using an overlay network will save IP addresses in the VPC by using a private IP address range for Pods in the cluster.

--database-backup-retention-period (integer)

PostgreSQL server backup retention days.

--whitelist-k8s-cluster-access-ip-cidrs (array)

List of IP address CIDRs to whitelist for kubernetes cluster access.

Syntax:

"string" "string" ...

--whitelist-workload-access-ip-cidrs (array)

List of IP address CIDRs to whitelist for workload access.

Syntax:

"string" "string" ...

--use-private-load-balancer | --no-use-private-load-balancer (boolean)

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.

--use-public-worker-node | --no-use-public-worker-node (boolean)

Set up worker node with public IP address. In AWS it is created in public subnets.

--enable-private-eks | --no-enable-private-eks (boolean)

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.

--reserved-compute-nodes (integer)

Set additional number of nodes to reserve for executors and coordinators to use during autoscaling. Adding more reserved nodes increases your cloud costs.

--reserved-shared-services-nodes (integer)

Set additional number of nodes to reserve for other services in the cluster. Adding more reserved nodes increases your cloud costs.

--custom-registry-options (object)

Options for custom ACR, ECR, or Docker registry.

registryType -> (string)

Custom registry type.

repositoryUrl -> (string)

URL of the custom image repository.

userName -> (string)

Username for custom registry access (required only for Docker type).

password -> (string)

Password for custom registry access (required only for Docker type).

disableImageVerification -> (boolean)

Disable image verification.

Shorthand Syntax:

registryType=string,repositoryUrl=string,userName=string,password=string,disableImageVerification=boolean

JSON Syntax:

{
  "registryType": "ACR"|"ECR"|"Docker",
  "repositoryUrl": "string",
  "userName": "string",
  "password": "string",
  "disableImageVerification": true|false
}

--custom-subdomain (string)

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.

--worker-subnet-ids (array)

IDs of AWS subnets where the cluster worker nodes should be deployed.

Syntax:

"string" "string" ...

--lb-subnet-ids (array)

IDs of AWS subnets where the cluster load balancer should be deployed.

Syntax:

"string" "string" ...

--custom-ami-id (string)

Custom AMI ID.

--node-role-cdw-managed-policy-arn (string)

Managed Policy Arn to be attached to the Node Instance Role.

--enable-spot-instances | --no-enable-spot-instances (boolean)

Whether to enable Spot instances for Virtual warehouses. It cannot be updated later. Defaults to false.

--reduced-permission-mode | --no-reduced-permission-mode (boolean)

Use this option to activate the environment with fewer than half of the standard required IAM permissions on your AWS cross-account IAM role.

--compute-instance-types (array)

AWS compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values.

Syntax:

"string" "string" ...

--additional-instance-types (array)

Additional (fallback) instance types listed in their priority order. They will be used instead of the primary compute instance type in case it is unavailable. You cannot include any instance type that was already indicated in computeInstanceTypes. Use describe-allowed-instance-types to see currently supported values and also the default value when nothing is provided for the computeInstanceTypes.

Syntax:

"string" "string" ...

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

clusterId -> (string)

ID of new AWS cluster.

Form Factors¶

public, private