API

API

  • Imply
  • Ingest
  • Query
  • Visualize
  • Administer
  • Deploy

›Object definitions

Cloud Manager API

  • Manager API overview
  • Manager API tutorial
  • Manager API reference
  • Available resources

    • Clusters API
    • ClustersHistorical API
    • ClustersServers API

    Object definitions

    • Cluster
    • ClusterSpec
    • ClusterStatus
    • CustomFile
    • DataConfiguration
    • DataTier
    • DeepStorage
    • Event
    • LoadBalancer
    • MasterConfiguration
    • MetadataStore
    • NameValue
    • ObjectMeta
    • PivotAccess
    • QueryConfiguration
    • Server
    • UpdateState

ClusterSpec

The ClusterSpec object defines metadata information of an Imply cluster.

Properties

version

String

The version of Imply the cluster will be running. Optional; defaults to the latest version of Imply.

desiredState

String

Possible values: STARTED, STOPPED

The desired state of the cluster. You cannot create a STOPPED cluster.

awsInstanceRole

String   required

The instance role to assign to the instances.

awsKeyPair

String

The AWS EC2 key pair that can be configured for customer SSH access. Optional; unset by default.

awsTags

array[NameValue]

Key/value pairs assigned to AWS resources created as a part of the cluster. Optional; unset by default. Requires that the AWS tags feature flag is enabled. Please contact support to enable this feature.

encryptVolumes

Boolean

Enables encryption on AWS EC2 volumes. Optional; defaults to true.

commonRuntimeProperties

array[NameValue]

Runtime values that apply to all Druid processes across all types and tiers.

master

MasterConfiguration   required

Configuration for the master nodes, including the Coordinator and Overlord processes.

query

QueryConfiguration   required

Configuration for the query nodes, including the Broker and Router processes.

data

DataConfiguration   required

Configuration for the data nodes, including the Historical and MiddleManager processes.

metadataStore

MetadataStore

Configuration for metadata store.

pivot

PivotAccess

Configuration for Pivot access.

deepStorage

DeepStorage

Configuration for deep storage.

druidExtensions

array[String]

List of Druid extensions to load. Array values should be named Druid extensions that are a part of the Imply package. Optional; unset by default.

featureFlags

array[String]

List of feature flags to enable. Optional; unset by default.

customFiles

array[CustomFile]

A list of additional files to load.

← ClusterClusterStatus →
  • Properties
    • version
    • desiredState
    • awsInstanceRole
    • awsKeyPair
    • awsTags
    • encryptVolumes
    • commonRuntimeProperties
    • master
    • query
    • data
    • metadataStore
    • pivot
    • deepStorage
    • druidExtensions
    • featureFlags
    • customFiles
API
Key links
Try ImplyApache Druid siteImply GitHub
Get help
Stack OverflowSupportContact us
Learn more
BlogApache Druid docs
Copyright © 2021 Imply Data, Inc