Component: Keyspaces

Component diagram

You can use the Keyspaces component to represent and visualize Apache Cassandra–compatible database services from your Amazon Web Services architecture with Cloudcraft.

Toolbar

To configure or customize how your repository looks in a diagram, you can use the toolbar that appears when selecting a component inside the application.

Options

Component toolbar in the Cloudcraft UI

For the Keyspaces component, the following options are available:

  • Color. Select a fill color for the body of the component and an accent color for its symbol. You can use the same colors on 2D and 3D views or different colors for each.
  • Capacity mode. Select the capacity mode of your Keyspaces database.
  • Writes (millions). Enter the total volume of writes to the database in the millions.
  • Reads (millions). Enter the total volume of reads to the database in the millions.
  • Quorum %. Enter the percentage of your reads that will use LOCAL_QUORUM consistency.
  • Dataset (GB). Enter the total volume of data in your database in gigabytes.
  • TTL Deletes (millions). Enter the total volume of DELETE operations triggered by the TTL process in the millions.
  • Point-in-time recovery. Whether or not to use point-in-time recovery for your database.

API

Suppose you need programmatic access and remote rendering of architecture diagrams. In that case, the Cloudcraft API provides an interface for you to interact with your AWS account within Cloudcraft by sending and receiving data as JSON objects.

Schema

 1{  2 "type": "keyspaces",  3 "id": "bd6da627-e07c-497e-bdbc-bec11655112a",  4 "region": "us-east-1",  5 "mapPos": [6,6],  6 "capacityMode": "on-demand",  7 "writeUnits": 5,  8 "readUnits": 5,  9 "quorumPercentage": 0, 10 "datasetGb": 10, 11 "ttlDeletes": 0, 12 "pointInTimeRecoveryEnabled": false, 13 "color": { 14 "isometric": "#ECECED", 15 "2d": "#3B48CC" 16 }, 17 "accentColor": { 18 "isometric": "#4286C5", 19 "2d": "#FFFFFF" 20 }, 21 "link": "https://aws.amazon.com/keyspaces/", 22 "locked": true 23}

The Keyspaces component schema representation follows the format above and defines all fields within a diagram for this component.

  • type: string. The type of component. Must be a string of value keyspaces for this component.
  • id: string, uuid. The unique identifier for the component. The API uses a UUID v4 internally but accepts any unique string.
  • arn: string. The globally unique identifier for the component within AWS, known as Amazon Resource Names.
  • region: string. The AWS region for the component. The API supports all global regions, except for AWS China.
  • mapPos: array. The position of the component in the blueprint. The API uses a unique X and Y coordinate pair to express positioning.
  • capacityMode: string. The capacity mode of the Keyspaces database. Accepts one of two values, on-demand or provisioned. Defaults to on-demand.
  • writeUnits: number. The total volume of writes to the database in the millions. Defaults to 5.
  • readUnits: number. The total volume of reads to the database in the millions. Defaults to 5.
  • quorumPercentage: number. The percentage of reads that will use LOCAL_QUORUM consistency. Defaults to 0.
  • datasetGb: number. The total volume of data in the database in gigabytes. Defaults to 10.
  • ttlDeletes: number. The total volume of DELETE operations triggered by the TTL process in the millions. Defaults to 0.
  • pointInTimeRecoveryEnabled: boolean. Whether or not to use point-in-time recovery for the database. Defaults to false.
  • color: object. The fill color for the component body.
    • isometric: string. A hexadecimal color for the component body in 3D view. Defaults to #ECECED.
    • 2d: string. A hexadecimal color for the component body in 2D view. Defaults to ##3B48CC.
  • accentColor: object. The accent color for the component logo.
    • isometric: string. A hexadecimal color for the component logo in 3D view. Defaults to #4286C5.
    • 2d: string. A hexadecimal color for the component logo in 2D view. Defaults to #FFFFFF.
  • link: string, uri. A URI that links the component to another diagram or an external website. Accepts one of two formats, blueprint:// or https://.
  • locked: boolean. Whether to allow changes to the position of the component through the web interface. Defaults to false.