TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration
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.
Boolean autoScalingDisabled
This optional parameter enables auto scaling for the table if set to false.
Long minimumUnits
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).
Long maximumUnits
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).
AutoScalingPolicy scalingPolicy
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.
AutoScalingSettings writeCapacityAutoScaling
The auto scaling settings for the table's write capacity.
AutoScalingSettings readCapacityAutoScaling
The auto scaling settings for the table's read capacity.
String throughputMode
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.
Long readCapacityUnits
The throughput capacity specified for read operations defined in read capacity units
(RCUs).
Long writeCapacityUnits
The throughput capacity specified for write operations defined in write capacity units
(WCUs).
String throughputMode
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.
Long readCapacityUnits
The throughput capacity specified for read operations defined in read capacity units
(RCUs).
Long writeCapacityUnits
The throughput capacity specified for write operations defined in write capacity units
(WCUs).
Date lastUpdateToPayPerRequestTimestamp
The timestamp of the last operation that changed the provisioned throughput capacity of a table.
String status
Shows how to enable client-side timestamps settings for the specified table.
String name
The name of the column.
String type
The data type of the column. For a list of available data types, see Data types in the Amazon Keyspaces Developer Guide.
String message
An optional description of the table.
String keyspaceName
The name of the keyspace to be created.
List<E> tags
A list of key-value pair tags to be attached to the keyspace.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
ReplicationSpecification replicationSpecification
The replication specification of the keyspace includes:
replicationStrategy - the required value is SINGLE_REGION or MULTI_REGION.
regionList - if the replicationStrategy is MULTI_REGION, the
regionList requires the current Region and at least one additional Amazon Web Services Region where
the keyspace is going to be replicated in. The maximum number of supported replication Regions including the
current Region is six.
String resourceArn
The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).
String keyspaceName
The name of the keyspace that the table is going to be created in.
String tableName
The name of the table.
SchemaDefinition schemaDefinition
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.
Comment comment
This parameter allows to enter a description of the table.
CapacitySpecification capacitySpecification
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.
EncryptionSpecification encryptionSpecification
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.
PointInTimeRecovery pointInTimeRecovery
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.
TimeToLive ttl
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.
Integer defaultTimeToLive
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.
List<E> tags
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.
ClientSideTimestamps clientSideTimestamps
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.
AutoScalingSpecification autoScalingSpecification
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.
List<E> replicaSpecifications
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)
String resourceArn
The unique identifier of the table in the format of an Amazon Resource Name (ARN).
String keyspaceName
The name of the keyspace to be deleted.
String type
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.
String kmsKeyIdentifier
The Amazon Resource Name (ARN) of the customer managed KMS key, for example kms_key_identifier:ARN.
String keyspaceName
The name of the keyspace.
String keyspaceName
The name of the keyspace.
String resourceArn
Returns the ARN of the keyspace.
String replicationStrategy
Returns the replication strategy of the keyspace. The options are SINGLE_REGION or
MULTI_REGION.
List<E> replicationRegions
If the replicationStrategy of the keyspace is MULTI_REGION, a list of replication
Regions is returned.
String keyspaceName
The name of the keyspace.
String tableName
The name of the table.
String resourceArn
The Amazon Resource Name (ARN) of the table.
AutoScalingSpecification autoScalingSpecification
The auto scaling settings of the table.
List<E> replicaSpecifications
The Amazon Web Services Region specific settings of a multi-Region table. Returns the settings for all Regions the table is replicated in.
String keyspaceName
The name of the keyspace that the specified table is stored in.
String tableName
The name of the specified table.
String resourceArn
The Amazon Resource Name (ARN) of the specified table.
Date creationTimestamp
The creation timestamp of the specified table.
String status
The current status of the specified table.
SchemaDefinition schemaDefinition
The schema definition of the specified table.
CapacitySpecificationSummary capacitySpecification
The read/write throughput capacity mode for a table. The options are:
throughputMode:PAY_PER_REQUEST
throughputMode:PROVISIONED
EncryptionSpecification encryptionSpecification
The encryption settings of the specified table.
PointInTimeRecoverySummary pointInTimeRecovery
The point-in-time recovery status of the specified table.
TimeToLive ttl
The custom Time to Live settings of the specified table.
Integer defaultTimeToLive
The default Time to Live settings in seconds of the specified table.
Comment comment
The the description of the specified table.
ClientSideTimestamps clientSideTimestamps
The client-side timestamps setting of the table.
List<E> replicaSpecifications
Returns the Amazon Web Services Region specific settings of all Regions a multi-Region table is replicated in.
String keyspaceName
The name of the keyspace.
String resourceArn
The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).
String replicationStrategy
This property specifies if a keyspace is a single Region keyspace or a multi-Region keyspace. The available
values are SINGLE_REGION or MULTI_REGION.
List<E> replicationRegions
If the replicationStrategy of the keyspace is MULTI_REGION, a list of replication
Regions is returned.
String nextToken
The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent
API invocation.
Integer maxResults
The total number of keyspaces to return in the output. If the total number of keyspaces available is more than
the value specified, a NextToken is provided in the output. To resume pagination, provide the
NextToken value as an argument of a subsequent API invocation.
String nextToken
The pagination token. To resume pagination, provide the NextToken value as an argument of a
subsequent API invocation.
Integer maxResults
The total number of tables to return in the output. If the total number of tables available is more than the
value specified, a NextToken is provided in the output. To resume pagination, provide the
NextToken value as an argument of a subsequent API invocation.
String keyspaceName
The name of the keyspace.
String resourceArn
The Amazon Resource Name (ARN) of the Amazon Keyspaces resource.
String nextToken
The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent
API invocation.
Integer maxResults
The total number of tags to return in the output. If the total number of tags available is more than the value
specified, a NextToken is provided in the output. To resume pagination, provide the
NextToken value as an argument of a subsequent API invocation.
String name
The name(s) of the partition key column(s).
String status
The options are:
status=ENABLED
status=DISABLED
String region
The Amazon Web Services Region.
AutoScalingSpecification autoScalingSpecification
The auto scaling settings for a multi-Region table in the specified Amazon Web Services Region.
String region
The Amazon Web Services Region.
Long readCapacityUnits
The provisioned read capacity units for the multi-Region table in the specified Amazon Web Services Region.
AutoScalingSettings readCapacityAutoScaling
The read capacity auto scaling settings for the multi-Region table in the specified Amazon Web Services Region.
String region
The Amazon Web Services Region.
String status
The status of the multi-Region table in the specified Amazon Web Services Region.
CapacitySpecificationSummary capacitySpecification
String resourceArn
The unique identifier in the format of Amazon Resource Name (ARN), for the resource not found.
String sourceKeyspaceName
The keyspace name of the source table.
String sourceTableName
The name of the source table.
String targetKeyspaceName
The name of the target keyspace.
String targetTableName
The name of the target table.
Date restoreTimestamp
The restore timestamp in ISO 8601 format.
CapacitySpecification capacitySpecificationOverride
Specifies the read/write throughput capacity mode for the target table. The options are:
throughputMode:PAY_PER_REQUEST
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.
EncryptionSpecification encryptionSpecificationOverride
Specifies the encryption settings for the target 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.
PointInTimeRecovery pointInTimeRecoveryOverride
Specifies the pointInTimeRecovery settings for the target 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.
List<E> tagsOverride
A list of key-value pair tags to be attached to the restored table.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
AutoScalingSpecification autoScalingSpecification
The optional auto scaling settings for the restored 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.
For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.
List<E> replicaSpecifications
The optional Region specific settings of a multi-Regional table.
String restoredTableARN
The Amazon Resource Name (ARN) of the restored table.
List<E> allColumns
The regular columns of the table.
List<E> partitionKeys
The columns that are part of the partition key of the table .
List<E> clusteringKeys
The columns that are part of the clustering key of the table.
List<E> staticColumns
The columns that have been defined as STATIC. Static columns store values that are shared by all
rows in the same partition.
String name
The name of the static column.
String key
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.
String value
The value of the tag. Tag values are case-sensitive and can be null.
Boolean disableScaleIn
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.
Integer scaleInCooldown
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.
Integer scaleOutCooldown
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.
Double targetValue
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.
String status
Shows how to enable custom Time to Live (TTL) settings for the specified table.
String keyspaceName
The name of the keyspace the specified table is stored in.
String tableName
The name of the table.
List<E> addColumns
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.
CapacitySpecification capacitySpecification
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.
EncryptionSpecification encryptionSpecification
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.
PointInTimeRecovery pointInTimeRecovery
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.
TimeToLive ttl
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.
Integer defaultTimeToLive
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.
ClientSideTimestamps clientSideTimestamps
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.
AutoScalingSpecification autoScalingSpecification
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.
List<E> replicaSpecifications
The Region specific settings of a multi-Regional table.
String resourceArn
The Amazon Resource Name (ARN) of the modified table.
Copyright © 2024. All rights reserved.