Component: Elasticsearch

Elasticsearch component

The Elasticsearch component is used to represent Elasticsearch clusters from your Amazon Web Services architecture with Cloudcraft.

Toolbar

The toolbar is displayed when selecting a component. It allows you to customize parts of your component and its visual to your liking.

  • Color. Select a predefined color or enter the hexadecimal value of the color for the component and its accent. The component can use the same color for both 2D and 3D view, or different colors for each.
  • Role. Select the role of the Elasticsearch instance.
  • Instance count. Enter a number of instances for the Elasticsearch cluster.
  • Instance type. Select the type of the instance. Changing the instance type changes the hardware details shown in the toolbar to reflect what is used by the hypervisor.
  • Size. Select the size of the instance. As with instance type, the hardware details shown in the toolbar change to reflect the size.
  • Billing option. The pricing model used for the instance.

API

AWS calls Elasticsearch instances "nodes," while Cloudcraft calls them "instances." The meaning is the same, but you should keep that in mind to avoid confusion.

In the Cloudcraft API, a Elasticsearch instance is represented in JSON.

{
  "type": "es",
  "id": "5f8df311-0641-410e-b427-89b7dc5e5b84",
  "region": "us-west-2",
  "mapPos": [0,10],
  "role": "data",
  "instanceCount": 2,
  "instanceType": "t3",
  "instanceSize": "medium",
  "billingOptions": {
    "type": "ri",
    "leaseContractLength": 36,
    "purchaseOption": "Partial Upfront"
  },
  "color": {
    "isometric": "#ececed",
    "2d": "#693cc5"
  },
  "accentColor": {
    "isometric": "#4286c5",
    "2d": "#ffffff"
  },
  "link": "https://aws.amazon.com/elasticsearch-service/",
  "locked": true
}
  • type: es. The type of component.
  • id: string. A unique identifier for the component in the uuid format.
  • region: string. The AWS region the Elasticsearch instance is deployed in. Except for cn- regions, all global regions are supported.
  • mapPos: [number, number]. The position of the component in the blueprint, expressed as a x,y coordinate pair.
  • role: string. The role used for the Elasticsearch instance. Accepted values are data and master.
  • instanceCount: number. The number of instances in the Elasticsearch cluster. Defaults to 1.
  • instanceType: string. The type of the instance. See below for more information.
  • instanceSize: string. The size of the instance. See below for more information.
  • billingOptions: object. The pricing model used for the instance. See below for more information.
  • color: object. The fill color for the component body.
    • isometric: string. Fill color for the component in 3D view. Must be a hexadecimal color.
    • 2d: string. Fill color for the component in 2D view. Must be a hexadecimal color.
  • accentColor: object. The accent color used to display the component logo on the block.
    • isometric: string. Accent color for the component in 3D view. Must be a hexadecimal color.
    • 2d: string. Accent color for the component in 2D view. Must be a hexadecimal color.
  • link: uri. Link component to another diagram in the blueprint://ID format or to external website in the https://LINK format.
  • locked: boolean. If true, changes to the component through the application are disabled until unlocked.

The Elasticsearch component can be added to VPCs, security groups, and subnets.

Accepted values for instanceType

The instanceType key accepts the following values:

c4, c5, i2, i3, m3, m4, m5, r3, r4, r5, t2, t3, ultrawarm1

Accepted values for instanceSize

The instanceSize key accepts the following values:

micro, small, medium, large, xlarge, 2xlarge, 4xlarge, 8xlarge, 9xlarge, 10xlarge, 12xlarge, 16xlarge, 18xlarge, 24xlarge, 32xlarge

Accepted values for billingOptions

The billingOptions key accepts all billing options currently accepted by the Cloudcraft web application:

  • On-demand
  • Reserved instance

Each option is represented differently inside the billingOptions object.

On-demand

{
  "billingOptions": {
    "type": "od",
    "utilization": 1
  }
}
  • type: od. The billing option value for on-demand is always od.
  • utilization: number. A floating number representing how much the instance will be used in a given month.

Reserved instance

{
  "billingOptions": {
    "type": "ri",
    "leaseContractLength": 36,
    "purchaseOption": "Partial Upfront"
  }
}
  • type: ri. The billing option value for a reserved instance is always ri.
  • leaseContractLength: number. The length of time the instance will be reserved. Accepted values are 12 or 36.
  • purchaseOption: string. The purchase option for the instance. Accepted values are No Upfront, Partial Upfront, and All Upfront.