table_auto_scaling_settings
Creates, updates, deletes, gets or lists a table_auto_scaling_settings resource.
Overview
| Name | table_auto_scaling_settings |
| Type | Resource |
| Id | aws.keyspaces.table_auto_scaling_settings |
Fields
The following fields are returned by SELECT queries:
- get_table_auto_scaling_settings
| Name | Datatype | Description |
|---|---|---|
auto_scaling_specification | object | The auto scaling settings of the table. |
keyspace_name | string | The name of the keyspace. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9_]{0,47}</code>) |
replica_specifications | array | The Amazon Web Services Region specific settings of a multi-Region table. Returns the settings for all Regions the table is replicated in. |
resource_arn | string | The Amazon Resource Name (ARN) of the table. (pattern: <code>arn:(aws[a-zA-Z0-9-]):cassandra:.+.</code>) |
table_name | string | The name of the table. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9_]{0,47}</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_table_auto_scaling_settings | select | region | Returns auto scaling related settings of the specified table in JSON format. If the table is a multi-Region table, the Amazon Web Services Region specific auto scaling settings of the table are included. 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. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide. GetTableAutoScalingSettings can't be used as an action in an IAM policy. To define permissions for GetTableAutoScalingSettings, you must allow the following two actions in the IAM policy statement's Action element: application-autoscaling:DescribeScalableTargets application-autoscaling:DescribeScalingPolicies |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_table_auto_scaling_settings
Returns auto scaling related settings of the specified table in JSON format. If the table is a multi-Region table, the Amazon Web Services Region specific auto scaling settings of the table are included. 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. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide. GetTableAutoScalingSettings can't be used as an action in an IAM policy. To define permissions for GetTableAutoScalingSettings, you must allow the following two actions in the IAM policy statement's Action element: application-autoscaling:DescribeScalableTargets application-autoscaling:DescribeScalingPolicies
SELECT
auto_scaling_specification,
keyspace_name,
replica_specifications,
resource_arn,
table_name
FROM aws.keyspaces.table_auto_scaling_settings
WHERE region = '{{ region }}' -- required
;