Overview

Use the API Gateway component to represent RESTful, HTTP, and WebSocket APIs from your Amazon Web Services architecture.

Toolbar

Use the toolbar to configure and customize your component. The following options are available:

• 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 the 2D and 3D view, or different colors for each.
• Rotate item: Rotate the component and change its direction.
• API Type: Select the API type for the gateway.
• M req./month: Enter the number of requests sent per month, in the millions.
• M min./month: Enter the number of messages sent per minute, in the millions. Only available for APIs of type websocket.
• Cache Memory (GB). Select the amount of memory used for caching API responses, in gigabytes. Only available for APIs of type rest.

API

Use the Cloudcraft API to programmatically access and render your architecture diagrams as JSON objects.

Schema

The following is an example JSON object of an API Gateway:

{
  "type": "apigateway",
  "id": "5635395f-9441-494d-bcc7-5dd4f5c93ce1",
  "region": "us-east-1",
  "mapPos": [0,10],
  "direction": "down",
  "apiType": "rest",
  "apiCalls": "10",
  "connectionMinutes": 0,
  "cache": 1.6,
  "color": {
    "isometric": "#3c3c3c",
    "2d": "#693cc5"
  },
  "accentColor": {
    "isometric": "#f4b934",
    "2d": "#ffffff"
  },
  "link": "https://aws.amazon.com/api-gateway/",
  "locked": true
}

• type: apigateway: The type of component.
• id: string: A unique identifier for the component in the uuid format.
• region: string: The AWS region where the API Gateway is deployed in. All global regions are supported except for cn- regions.
• mapPos: [number, number]. The position of the component in the blueprint, expressed as an x- and y-coordinate pair.
• direction: string: The rotation or direction of the component. Accepted values are down or right. Defaults to down.
• apiType: string: The type of API used for the gateway. Accepted values are rest, http, and websocket.
• apiCalls: number: The number of API calls made per month, in the millions. Defaults to 5.
• connectionMinutes: number: The number of messages sent per minute, in the millions. Only applicable if apiType is set to websocket. Defaults to 0.
• cache: number: The amount of memory used for caching API responses, in gigabytes. Only applicable if apiType is set to rest. See Accepted values for cache for more information.
• color: object: The fill color for the component body.
  • isometric: string: The fill color for the component in the 3D view. Must be a hexadecimal color.
  • 2d: string: The fill color for the component in the 2D view. Must be a hexadecimal color.
• accentColor: object: The accent color used to display the component logo on the block.
  • isometric: string: The accent color for the component in the 3D view. Must be a hexadecimal color.
  • 2d: string: The accent color for the component in the 2D view. Must be a hexadecimal color.
• link: uri: Link the component to another diagram using the blueprint://ID format or to an external website using the https://LINK format.
• locked: boolean: If true, changes made to the component using the application are disabled until unlocked.

Accepted values for cache

The cache key defaults to 1.6 and accepts the following values:

0, 0.5, 1.6, 6.1, 13.5, 28.4, 58.2, 118.0, 237.0