← AWS

DynamoDB - Create Table with AWS API

Pipedream makes it easy to connect APIs for AWS and 800+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
DynamoDB - Create Table with the AWS API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Create a workflow to DynamoDB - Create Table with the AWS API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the DynamoDB - Create Table action
    1. Connect your AWS account
    2. Select a AWS Region
    3. Configure Table Name
    4. Configure Key Hash Attribute Name
    5. Select a Key Hash Attribute Type
    6. Optional- Configure Key Range Attribute Name
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

DynamoDB - Create Table on AWS
Description:Creates a new table to your account. [See docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-dynamodb/classes/createtablecommand.html)
Version:0.2.0
Key:aws-dynamodb-create-table

Code

import common from "../../common/common-dynamodb.mjs";
import constants from "../../common/constants.mjs";
import { toSingleLineString } from "../../common/utils.mjs";

export default {
  ...common,
  key: "aws-dynamodb-create-table",
  name: "DynamoDB - Create Table",
  description: toSingleLineString(`
    Creates a new table to your account.
    [See docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-dynamodb/classes/createtablecommand.html)
  `),
  version: "0.2.0",
  type: "action",
  props: {
    aws: common.props.aws,
    region: common.props.region,
    tableName: {
      type: common.props.tableName.type,
      label: common.props.tableName.label,
      description: common.props.tableName.description,
    },
    keyPrimaryAttributeName: common.props.keyPrimaryAttributeName,
    keyPrimaryAttributeType: common.props.keyPrimaryAttributeType,
    // eslint-disable-next-line pipedream/props-label, pipedream/props-description
    keySecondaryAttributeName: {
      ...common.props.keySecondaryAttributeName,
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};

    if (this.keySecondaryAttributeName) {
      props.keySecondaryAttributeType = {
        type: "string",
        label: "Key Range Attribute Type",
        description: "The data type of the sort key",
        options: constants.dynamodb.keyAttributeTypes,
      };
    }

    // eslint-disable-next-line pipedream/props-label, pipedream/props-description
    props.billingMode = {
      ...common.props.billingMode,
      reloadProps: true,
    };

    if (this.billingMode === constants.dynamodb.billingModes.PROVISIONED) {
      props.readCapacityUnits = {
        type: "integer",
        label: "Read Capacity Units",
        description: "The maximum number of strongly consistent reads consumed per second before DynamoDB returns a `ThrottlingException`",
      };
      props.writeCapacityUnits = {
        type: "integer",
        label: "Write Capacity Units",
        description: "The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException`",
      };
    }

    // eslint-disable-next-line pipedream/props-label, pipedream/props-description
    props.streamSpecificationEnabled = {
      ...common.props.streamSpecificationEnabled,
      reloadProps: true,
    };

    if (this.streamSpecificationEnabled) {
      props.streamSpecificationViewType = {
        type: "string",
        label: "Stream Specification View Type",
        description: "When an item in the table is modified, StreamViewType determines what information is written to the table's stream. [See the docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-dynamodb/interfaces/createtablecommandinput.html#streamspecification)",
        options: constants.dynamodb.streamSpecificationViewTypes,
      };
    }

    return props;
  },
  async run({ $ }) {
    const params = {
      TableName: this.tableName,
      AttributeDefinitions: [
        {
          AttributeName: this.keyPrimaryAttributeName,
          AttributeType: this.keyPrimaryAttributeType,
        },
      ],
      KeySchema: [
        {
          AttributeName: this.keyPrimaryAttributeName,
          KeyType: constants.dynamodb.keyTypes.HASH,
        },
      ],
    };

    if (this.keySecondaryAttributeName && this.keySecondaryAttributeType) {
      params.AttributeDefinitions.push({
        AttributeName: this.keySecondaryAttributeName,
        AttributeType: this.keySecondaryAttributeType,
      });
      params.KeySchema.push({
        AttributeName: this.keySecondaryAttributeName,
        KeyType: constants.dynamodb.keyTypes.RANGE,
      });
    }

    if (this.billingMode) {
      params.BillingMode = this.billingMode;
      if (this.billingMode === constants.dynamodb.billingModes.PROVISIONED) {
        params.ProvisionedThroughput = {
          ReadCapacityUnits: this.readCapacityUnits,
          WriteCapacityUnits: this.writeCapacityUnits,
        };
      }
    }

    if (typeof (this.streamSpecificationEnabled) === "boolean") {
      params.StreamSpecification = {
        StreamEnabled: this.streamSpecificationEnabled,
      };
      if (this.streamSpecificationViewType) {
        params.StreamSpecification.StreamViewType = this.streamSpecificationViewType;
      }
    }

    const response = await this.createTable(params);
    $.export("$summary", `Created DynamoDB table ${this.tableName}`);
    return response;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
AWSawsappThis component uses the AWS app.
AWS RegionregionstringSelect a value from the drop down menu.
Table NametableNamestring

The name of the table

Key Hash Attribute NamekeyPrimaryAttributeNamestring

The name of the partition key

Key Hash Attribute TypekeyPrimaryAttributeTypestringSelect a value from the drop down menu:{ "label": "string", "value": "S" }{ "label": "number", "value": "N" }{ "label": "binary", "value": "B" }
Key Range Attribute NamekeySecondaryAttributeNamestring

The name of the sort key

Authentication

AWS uses API keys for authentication. When you connect your AWS account, Pipedream securely stores the keys so you can easily authenticate to AWS APIs in both code and no-code steps.

Follow the AWS Instructions for creating an IAM user with an associated access and secret key.

As a best practice, attach the minimum set of IAM permissions necessary to perform the specific task in Pipedream. If your workflow only needs to perform a single API call, you should create a user and associate an IAM group / policy with permission to do only that task. You can create as many linked AWS accounts in Pipedream as you'd like.

Enter your access and secret key below.

About AWS

On-demand cloud computing platforms and APIs

More Ways to Use AWS

Triggers

Actions