Skip to content

/AWS1/CL_KYS=>UPDATETABLE()

About UpdateTable

Adds new columns to the table or updates one of the table's settings, for example capacity mode, auto scaling, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation.

Method Signature

IMPORTING

Required arguments:

IV_KEYSPACENAME TYPE /AWS1/KYSKEYSPACENAME /AWS1/KYSKEYSPACENAME

The name of the keyspace the specified table is stored in.

IV_TABLENAME TYPE /AWS1/KYSTABLENAME /AWS1/KYSTABLENAME

The name of the table.

Optional arguments:

IT_ADDCOLUMNS TYPE /AWS1/CL_KYSCOLUMNDEFINITION=>TT_COLUMNDEFINITIONLIST TT_COLUMNDEFINITIONLIST

For each column to be added to the specified table:

  • name - The name of the column.

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

IO_CAPACITYSPECIFICATION TYPE REF TO /AWS1/CL_KYSCAPACITYSPEC /AWS1/CL_KYSCAPACITYSPEC

Modifies 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.

IO_ENCRYPTIONSPECIFICATION TYPE REF TO /AWS1/CL_KYSENCRYPTIONSPEC /AWS1/CL_KYSENCRYPTIONSPEC

Modifies the encryption settings of 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 AWS_OWNED_KMS_KEY.

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

IO_POINTINTIMERECOVERY TYPE REF TO /AWS1/CL_KYSPOINTINTIMEREC /AWS1/CL_KYSPOINTINTIMEREC

Modifies the pointInTimeRecovery settings of 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.

IO_TTL TYPE REF TO /AWS1/CL_KYSTIMETOLIVE /AWS1/CL_KYSTIMETOLIVE

Modifies 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.

IV_DEFAULTTIMETOLIVE TYPE /AWS1/KYSDEFAULTTIMETOLIVE /AWS1/KYSDEFAULTTIMETOLIVE

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.

IO_CLIENTSIDETIMESTAMPS TYPE REF TO /AWS1/CL_KYSCLIENTSIDETSMPS /AWS1/CL_KYSCLIENTSIDETSMPS

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.

IO_AUTOSCALINGSPECIFICATION TYPE REF TO /AWS1/CL_KYSAUTOSCALINGSPEC /AWS1/CL_KYSAUTOSCALINGSPEC

The optional auto scaling settings to update for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity of a provisioned table automatically on your behalf. Amazon Keyspaces 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.

If auto scaling is already enabled for the table, you can use UpdateTable to update the minimum and maximum values or the auto scaling policy settings independently.

For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.

IT_REPLICASPECIFICATIONS TYPE /AWS1/CL_KYSREPLICASPEC=>TT_REPLICASPECIFICATIONLIST TT_REPLICASPECIFICATIONLIST

The Region specific settings of a multi-Regional table.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_KYSUPDATETABLERSP /AWS1/CL_KYSUPDATETABLERSP