create-aws-cluster¶

Description¶

Creates an AWS workload cluster.

Synopsis¶

  create-aws-cluster
[--cluster-name <value>]
[--cluster-definition <value>]
[--environment <value>]
[--cluster-template <value>]
[--custom-configurations-name <value>]
[--instance-groups <value>]
[--subnet-id <value>]
[--image <value>]
[--tags <value>]
[--request-template <value>]
[--datahub-database <value>]
[--subnet-ids <value>]
[--multi-az | --no-multi-az]
[--cluster-extension <value>]
[--enable-load-balancer | --no-enable-load-balancer]
[--java-version <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cluster-name (string)

The name of the cluster. This name must be unique, must have between 5 and 40 characters, and must contain only lowercase letters, numbers and hyphens. Names are case-sensitive.

--cluster-definition (string)

The name or CRN of the cluster definition to use for cluster creation.

--environment (string)

Name or CRN of the environment to use when creating the cluster. The environment must be an AWS environment.

--cluster-template (string)

Name or CRN of the cluster template to use for cluster creation.

--custom-configurations-name (string)

The name of the custom configurations to use for cluster creation.

--instance-groups (array)

Instance group details.

Shorthand Syntax:

nodeCount=integer,instanceGroupName=string,instanceGroupType=string,instanceType=string,attachedVolumeConfiguration=[{volumeSize=integer,volumeCount=integer,volumeType=string},{volumeSize=integer,volumeCount=integer,volumeType=string}],rootVolumeSize=integer,recipeNames=string,string,recoveryMode=string,volumeEncryption={enableEncryption=boolean,encryptionKey=string},subnetIds=string,string ... (separate items with spaces)

JSON Syntax:

[
  {
    "nodeCount": integer,
    "instanceGroupName": "string",
    "instanceGroupType": "string",
    "instanceType": "string",
    "attachedVolumeConfiguration": [
      {
        "volumeSize": integer,
        "volumeCount": integer,
        "volumeType": "string"
      }
      ...
    ],
    "rootVolumeSize": integer,
    "recipeNames": ["string", ...],
    "recoveryMode": "string",
    "volumeEncryption": {
      "enableEncryption": true|false,
      "encryptionKey": "string"
    },
    "subnetIds": ["string", ...]
  }
  ...
]

--subnet-id (string)

The subnet ID.

--image (object)

The details of the image used for cluster instances.

id -> (string)

The ID of the image used for cluster instances. This is generated by the cloud provider to uniquely identify the image.

catalogName -> (string)

The image catalog name.

os -> (string)

The OS of the image used for cluster instances.

Shorthand Syntax:

id=string,catalogName=string,os=string

JSON Syntax:

{
  "id": "string",
  "catalogName": "string",
  "os": "string"
}

--tags (array)

Tags to be added to Datahub related resources.

Shorthand Syntax:

key=string,value=string ... (separate items with spaces)

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--request-template (string)

JSON template to use for cluster creation. This is different from cluster template and would be removed in the future.

--datahub-database (string)

Database type for datahub. Currently supported values: NONE, NON_HA, HA

Possible values:

• HA

• NON_HA

• NONE

--subnet-ids (array)

List of subnet IDs in case of multi availability zone setup.

Syntax:

"string" "string" ...

--multi-az | --no-multi-az (boolean)

Flag that toggles the multi availability zone for the given datahub cluster when you are not sure what subnet IDs can be used. This way the subnet IDs will be used what the environment suggests.

--cluster-extension (object)

Cluster extensions for Data Hub cluster.

customProperties -> (string)

The custom properties JSON, encoded in base64.

Shorthand Syntax:

customProperties=string

JSON Syntax:

{
  "customProperties": "string"
}

--enable-load-balancer | --no-enable-load-balancer (boolean)

Flag that decides whether to provision a load-balancer to front various service endpoints for the given datahub. This will typically be used for HA cluster shapes.

--java-version (integer)

Configure the major version of Java on the cluster.

--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¶

cluster -> (object)

Information about a cluster.

clusterName -> (string)

The name of the cluster.

crn -> (string)

The CRN of the cluster.

creationDate -> (datetime)

The date when the cluster was created.

status -> (string)

The status of the stack.

clusterStatus -> (string)

The status of the cluster.

nodeCount -> (integer)

The cluster node count.

instanceGroups -> (array)

The instance details.

item -> (object)

The type of the instance group which also contains the actual instance(s)

name -> (string)

The name of the instance group where the given instance is located.

instances -> (array)

List of instances in this instance group.

item -> (object)

Object which holds some details of an instance for the given cluster.

id -> (string)

The ID of the given instance.

state -> (string)

The health state of the instance. UNHEALTHY represents instances with unhealthy services, lost instances, or failed operations.

instanceType -> (string)

The type of the given instance (either GATEWAY, GATEWAY_PRIMARY, or CORE).

privateIp -> (string)

The private IP of the given instance.

publicIp -> (string)

The public IP of the given instance.

fqdn -> (string)

The FQDN of the instance.

status -> (string)

The status of the instance. This includes information like whether the instance is being provisioned, stopped, decommissioning failures etc.

statusReason -> (string)

The reason for the current status of this instance.

sshPort -> (integer)

The SSH port for the instance.

clouderaManagerServer -> (boolean)

Whether the instance has Cloudera Manager deployed or not.

instanceGroup -> (string)

The name of the instance group this instance belongs to.

attachedVolumes -> (array)

List of volumes attached to this instance.

( … recursive … )

availabilityZone -> (string)

The availability zone of the instance.

instanceVmType -> (string)

The VM type of the instance. Supported values depend on the cloud platform.

rackId -> (string)

The rack ID of the instance in Cloudera Manager.

subnetId -> (string)

The subnet ID of the instance.

subnetIds -> (array)

The list of subnet IDs in case of multi-availability zone setup

item -> (string)

availabilityZones -> (array)

List of availability zones that this instance group is associated with.

item -> (string)

recipes -> (array)

The recipe names for the Data Hub cluster.

item -> (string)

workloadType -> (string)

The workload type for the cluster.

cloudPlatform -> (string)

The cloud platform.

imageDetails -> (object)

The details of the image used for cluster instances.

name -> (string)

The name of the image used for cluster instances.

id -> (string)

The ID of the image used for cluster instances. This is internally generated by the cloud provider to uniquely identify the image.

os -> (string)

The OS of the image used for cluster instances.

catalogUrl -> (string)

The image catalog URL.

catalogName -> (string)

The image catalog name.

environmentCrn -> (string)

The CRN of the environment.

credentialCrn -> (string)

The CRN of the credential.

datalakeCrn -> (string)

The CRN of the attached datalake.

clusterTemplateCrn -> (string)

The CRN of the cluster template used for the cluster creation.

statusReason -> (string)

The status reason.

clouderaManager -> (object)

Cloudera Manager details.

version -> (string)

Cloudera Manager version.

platformVersion -> (string)

CDP Platform version.

endpoints -> (object)

Object which holds the exposed endpoints for the given cluster.

endpoints -> (array)

The endpoints.

item -> (object)

Object which holds the exposed endpoint.

serviceName -> (string)

The name of the exposed service

serviceUrl -> (string)

The server url for the given exposed service’s API.

displayName -> (string)

The more consumable name of the exposed service.

knoxService -> (string)

The related knox entry.

mode -> (string)

The SSO mode of the given service.

open -> (boolean)

The access status of the given endpoint. Whether its open or not.

multiAz -> (boolean)

Flag that toggles the multi availability zone for the given datahub cluster when you are not sure what subnet IDs can be used. This way the subnet IDs will be used what the environment suggests.

Form Factors¶

public