Class: AWS.Keyspaces

var params = {
  keyspaceName: 'STRING_VALUE', /* required */
  schemaDefinition: { /* required */
    allColumns: [ /* required */
      {
        name: 'STRING_VALUE', /* required */
        type: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    partitionKeys: [ /* required */
      {
        name: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    clusteringKeys: [
      {
        name: 'STRING_VALUE', /* required */
        orderBy: ASC | DESC /* required */
      },
      /* more items */
    ],
    staticColumns: [
      {
        name: 'STRING_VALUE' /* required */
      },
      /* more items */
    ]
  },
  tableName: 'STRING_VALUE', /* required */
  autoScalingSpecification: {
    readCapacityAutoScaling: {
      autoScalingDisabled: true || false,
      maximumUnits: 'NUMBER_VALUE',
      minimumUnits: 'NUMBER_VALUE',
      scalingPolicy: {
        targetTrackingScalingPolicyConfiguration: {
          targetValue: 'NUMBER_VALUE', /* required */
          disableScaleIn: true || false,
          scaleInCooldown: 'NUMBER_VALUE',
          scaleOutCooldown: 'NUMBER_VALUE'
        }
      }
    },
    writeCapacityAutoScaling: {
      autoScalingDisabled: true || false,
      maximumUnits: 'NUMBER_VALUE',
      minimumUnits: 'NUMBER_VALUE',
      scalingPolicy: {
        targetTrackingScalingPolicyConfiguration: {
          targetValue: 'NUMBER_VALUE', /* required */
          disableScaleIn: true || false,
          scaleInCooldown: 'NUMBER_VALUE',
          scaleOutCooldown: 'NUMBER_VALUE'
        }
      }
    }
  },
  capacitySpecification: {
    throughputMode: PAY_PER_REQUEST | PROVISIONED, /* required */
    readCapacityUnits: 'NUMBER_VALUE',
    writeCapacityUnits: 'NUMBER_VALUE'
  },
  clientSideTimestamps: {
    status: ENABLED /* required */
  },
  comment: {
    message: 'STRING_VALUE' /* required */
  },
  defaultTimeToLive: 'NUMBER_VALUE',
  encryptionSpecification: {
    type: CUSTOMER_MANAGED_KMS_KEY | AWS_OWNED_KMS_KEY, /* required */
    kmsKeyIdentifier: 'STRING_VALUE'
  },
  pointInTimeRecovery: {
    status: ENABLED | DISABLED /* required */
  },
  replicaSpecifications: [
    {
      region: 'STRING_VALUE', /* required */
      readCapacityAutoScaling: {
        autoScalingDisabled: true || false,
        maximumUnits: 'NUMBER_VALUE',
        minimumUnits: 'NUMBER_VALUE',
        scalingPolicy: {
          targetTrackingScalingPolicyConfiguration: {
            targetValue: 'NUMBER_VALUE', /* required */
            disableScaleIn: true || false,
            scaleInCooldown: 'NUMBER_VALUE',
            scaleOutCooldown: 'NUMBER_VALUE'
          }
        }
      },
      readCapacityUnits: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  ttl: {
    status: ENABLED /* required */
  }
};
keyspaces.createTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • keyspaceName — (String)

    The name of the keyspace that the table is going to be created in.

  • tableName — (String)

    The name of the table.

  • schemaDefinition — (map)

    The schemaDefinition consists of the following parameters.

    For each column to be created:

    • name - The name of the column.

    • type - An Amazon Keyspaces data type. For more information, see Data types in the Amazon Keyspaces Developer Guide.

    The primary key of the table consists of the following columns:

    • partitionKeys - The partition key can be a single column, or it can be a compound value composed of two or more columns. The partition key portion of the primary key is required and determines how Amazon Keyspaces stores your data.

    • name - The name of each partition key column.

    • clusteringKeys - The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.

    • name - The name of the clustering column.

    • orderBy - Sets the ascendant (ASC) or descendant (DESC) order modifier.

      To define a column as static use staticColumns - Static columns store values that are shared by all rows in the same partition:

    • name - The name of the column.

    • type - An Amazon Keyspaces data type.

    • allColumns — required — (Array<map>)

      The regular columns of the table.

      • name — required — (String)

        The name of the column.

      • type — required — (String)

        The data type of the column. For a list of available data types, see Data types in the Amazon Keyspaces Developer Guide.

    • partitionKeys — required — (Array<map>)

      The columns that are part of the partition key of the table .

      • name — required — (String)

        The name(s) of the partition key column(s).

    • clusteringKeys — (Array<map>)

      The columns that are part of the clustering key of the table.

      • name — required — (String)

        The name(s) of the clustering column(s).

      • orderBy — required — (String)

        Sets the ascendant (ASC) or descendant (DESC) order modifier.

        Possible values include:
        • "ASC"
        • "DESC"
    • staticColumns — (Array<map>)

      The columns that have been defined as STATIC. Static columns store values that are shared by all rows in the same partition.

      • name — required — (String)

        The name of the static column.

  • comment — (map)

    This parameter allows to enter a description of the table.

    • message — required — (String)

      An optional description of the table.

  • capacitySpecification — (map)

    Specifies the read/write throughput capacity mode for the table. The options are:

    • throughputMode:PAY_PER_REQUEST and

    • throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.

    The default is throughput_mode:PAY_PER_REQUEST.

    For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.

    • throughputMode — required — (String)

      The read/write throughput capacity mode for a table. The options are:

      • throughputMode:PAY_PER_REQUEST and

      • throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.

      The default is throughput_mode:PAY_PER_REQUEST.

      For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.

      Possible values include:
      • "PAY_PER_REQUEST"
      • "PROVISIONED"
    • readCapacityUnits — (Integer)

      The throughput capacity specified for read operations defined in read capacity units (RCUs).

    • writeCapacityUnits — (Integer)

      The throughput capacity specified for write operations defined in write capacity units (WCUs).

  • encryptionSpecification — (map)

    Specifies how the encryption key for encryption at rest is managed for the table. You can choose one of the following KMS key (KMS key):

    • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

    • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

    The default is type:AWS_OWNED_KMS_KEY.

    For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.

    • type — required — (String)

      The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):

      • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

      • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

      The default is type:AWS_OWNED_KMS_KEY.

      For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.

      Possible values include:
      • "CUSTOMER_MANAGED_KMS_KEY"
      • "AWS_OWNED_KMS_KEY"
    • kmsKeyIdentifier — (String)

      The Amazon Resource Name (ARN) of the customer managed KMS key, for example kms_key_identifier:ARN.

  • pointInTimeRecovery — (map)

    Specifies if pointInTimeRecovery is enabled or disabled for the table. The options are:

    • status=ENABLED

    • status=DISABLED

    If it's not specified, the default is status=DISABLED.

    For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.

    • status — required — (String)

      The options are:

      • status=ENABLED

      • status=DISABLED

      Possible values include:
      • "ENABLED"
      • "DISABLED"
  • ttl — (map)

    Enables Time to Live custom settings for the table. The options are:

    • status:enabled

    • status:disabled

    The default is status:disabled. After ttl is enabled, you can't disable it for the table.

    For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer Guide.

    • status — required — (String)

      Shows how to enable custom Time to Live (TTL) settings for the specified table.

      Possible values include:
      • "ENABLED"
  • defaultTimeToLive — (Integer)

    The default Time to Live setting in seconds for the table.

    For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer Guide.

  • tags — (Array<map>)

    A list of key-value pair tags to be attached to the resource.

    For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.

    • key — required — (String)

      The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.

    • value — required — (String)

      The value of the tag. Tag values are case-sensitive and can be null.

  • clientSideTimestamps — (map)

    Enables client-side timestamps for the table. By default, the setting is disabled. You can enable client-side timestamps with the following option:

    • status: "enabled"

    Once client-side timestamps are enabled for a table, this setting cannot be disabled.

    • status — required — (String)

      Shows how to enable client-side timestamps settings for the specified table.

      Possible values include:
      • "ENABLED"
  • autoScalingSpecification — (map)

    The optional auto scaling settings for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity automatically on your behalf.

    Auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.

    By default, auto scaling is disabled for a table.

    • writeCapacityAutoScaling — (map)

      The auto scaling settings for the table's write capacity.

      • autoScalingDisabled — (Boolean)

        This optional parameter enables auto scaling for the table if set to false.

      • minimumUnits — (Integer)

        The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

      • maximumUnits — (Integer)

        Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

      • scalingPolicy — (map)

        Amazon Keyspaces supports the target tracking auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.

        • targetTrackingScalingPolicyConfiguration — (map)

          Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. A double between 20 and 90.

          • disableScaleIn — (Boolean)

            Specifies if scale-in is enabled.

            When auto scaling automatically decreases capacity for a table, the table scales in. When scaling policies are set, they can't scale in the table lower than its minimum capacity.

          • scaleInCooldown — (Integer)

            Specifies a scale-in cool down period.

            A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.

          • scaleOutCooldown — (Integer)

            Specifies a scale out cool down period.

            A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.

          • targetValue — required — (Float)

            Specifies the target value for the target tracking auto scaling policy.

            Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define targetValue as a percentage. A double between 20 and 90.

    • readCapacityAutoScaling — (map)

      The auto scaling settings for the table's read capacity.

      • autoScalingDisabled — (Boolean)

        This optional parameter enables auto scaling for the table if set to false.

      • minimumUnits — (Integer)

        The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

      • maximumUnits — (Integer)

        Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

      • scalingPolicy — (map)

        Amazon Keyspaces supports the target tracking auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.

        • targetTrackingScalingPolicyConfiguration — (map)

          Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. A double between 20 and 90.

          • disableScaleIn — (Boolean)

            Specifies if scale-in is enabled.

            When auto scaling automatically decreases capacity for a table, the table scales in. When scaling policies are set, they can't scale in the table lower than its minimum capacity.

          • scaleInCooldown — (Integer)

            Specifies a scale-in cool down period.

            A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.

          • scaleOutCooldown — (Integer)

            Specifies a scale out cool down period.

            A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.

          • targetValue — required — (Float)

            Specifies the target value for the target tracking auto scaling policy.

            Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define targetValue as a percentage. A double between 20 and 90.

  • replicaSpecifications — (Array<map>)

    The optional Amazon Web Services Region specific settings of a multi-Region table. These settings overwrite the general settings of the table for the specified Region.

    For a multi-Region table in provisioned capacity mode, you can configure the table's read capacity differently for each Region's replica. The write capacity, however, remains synchronized between all replicas to ensure that there's enough capacity to replicate writes across all Regions. To define the read capacity for a table replica in a specific Region, you can do so by configuring the following parameters.

    • region: The Region where these settings are applied. (Required)

    • readCapacityUnits: The provisioned read capacity units. (Optional)

    • readCapacityAutoScaling: The read capacity auto scaling settings for the table. (Optional)

    • region — required — (String)

      The Amazon Web Services Region.

    • readCapacityUnits — (Integer)

      The provisioned read capacity units for the multi-Region table in the specified Amazon Web Services Region.

    • readCapacityAutoScaling — (map)

      The read capacity auto scaling settings for the multi-Region table in the specified Amazon Web Services Region.

      • autoScalingDisabled — (Boolean)

        This optional parameter enables auto scaling for the table if set to false.

      • minimumUnits — (Integer)

        The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

      • maximumUnits — (Integer)

        Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

      • scalingPolicy — (map)

        Amazon Keyspaces supports the target tracking auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.

        • targetTrackingScalingPolicyConfiguration — (map)

          Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. A double between 20 and 90.

          • disableScaleIn — (Boolean)

            Specifies if scale-in is enabled.

            When auto scaling automatically decreases capacity for a table, the table scales in. When scaling policies are set, they can't scale in the table lower than its minimum capacity.

          • scaleInCooldown — (Integer)

            Specifies a scale-in cool down period.

            A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.

          • scaleOutCooldown — (Integer)

            Specifies a scale out cool down period.

            A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.

          • targetValue — required — (Float)

            Specifies the target value for the target tracking auto scaling policy.

            Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define targetValue as a percentage. A double between 20 and 90.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • resourceArn — (String)

      The unique identifier of the table in the format of an Amazon Resource Name (ARN).

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  keyspaceName: 'STRING_VALUE' /* required */
};
keyspaces.deleteKeyspace(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • keyspaceName — (String)

    The name of the keyspace to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  keyspaceName: 'STRING_VALUE', /* required */
  tableName: 'STRING_VALUE' /* required */
};
keyspaces.deleteTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • keyspaceName — (String)

    The name of the keyspace of the to be deleted table.

  • tableName — (String)

    The name of the table to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  keyspaceName: 'STRING_VALUE' /* required */
};
keyspaces.getKeyspace(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • keyspaceName — (String)

    The name of the keyspace.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • keyspaceName — (String)

      The name of the keyspace.

    • resourceArn — (String)

      Returns the ARN of the keyspace.

    • replicationStrategy — (String)

      Returns the replication strategy of the keyspace. The options are SINGLE_REGION or MULTI_REGION.

      Possible values include:
      • "SINGLE_REGION"
      • "MULTI_REGION"
    • replicationRegions — (Array<String>)

      If the replicationStrategy of the keyspace is MULTI_REGION, a list of replication Regions is returned.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.