S3 Component

Overview

Use the S3 component to represent S3 buckets from your Amazon Web Services architecture.

Screenshot of an isometric Cloudcraft diagram showing the 'S3' AWS component.

Toolbar

Use the toolbar to configure and customize the 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.
  • Volume type: The type of volume used for the S3 bucket.
  • Storage: The amount of storage used in the bucket in gigabytes.
  • PUT/COPY/POST: The number of monthly PUT, COPY, and POST requests to the S3 bucket, in the thousands.
  • GET and others: The number of monthly GET, SELECT, and other requests to the S3 bucket, in the thousands.
  • Lifecycle Transition: The number of monthly lifetime transition requests to the S3 bucket, in the thousands. Only available for S3 buckets with the Infrequent Access volume type.

API

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

Schema

The following is an example JSON of a S3 component:

{
  "type": "s3",
  "id": "e8622f0d-7fec-41e0-846d-fa14a6c3c9e7",
  "region": "us-east-1",
  "mapPos": [2.25,9.25],
  "volumeType": "Standard - Infrequent Access",
  "dataGb": "200",
  "putCopyPostRequests": "50",
  "getAndOtherRequests": "100",
  "lifecycleTransitions": "200",
  "color": {
    "isometric": "#4286c5",
    "2d": "#3f8624"
  },
  "accentColor": {
    "isometric": "#4286c5",
    "2d": "#ffffff"
  },
  "link": "blueprint://ae6349e1-fa15-41c8-8e89-d201f9fa3cc9",
  "locked": true
}
  • type: s3: The type of component.
  • id: string: A unique identifier for the component in the uuid format.
  • region: string: The AWS region the S3 bucket is deployed in. All global regions are supported except cn- regions..
  • mapPos: [number, number]: The position of the component in the blueprint, expressed as an x- and y-coordinate pair.
  • volumeType: string: The type of volume used by the S3 bucket. Accepted values are Standard, Standard - Infrequent Access, or One Zone - Infrequent Access.
  • dataGb: number: The amount of storage used in the bucket in gigabytes. Defaults to 10.
  • putCopyPostRequests: number: The number of monthly PUT, COPY, and POST requests in the thousands. Defaults to 0.
  • getAndOtherRequests: number: The number of monthly GET, SELECT, and other requests in the thousands. Defaults to 0.
  • lifecycleTransitions: number: The number of monthly lifetime transition requests in the thousands. Only applicable for Standard - Infrequent Access volume type .
  • 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.