Class: Aws::Keyspaces::Types::UpdateTableRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-keyspaces/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#add_columns ⇒ Array<Types::ColumnDefinition>

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][1

    in the *Amazon Keyspaces Developer Guide*.

[1]: docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types

Returns:



1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 1874

class UpdateTableRequest < Struct.new(
  :keyspace_name,
  :table_name,
  :add_columns,
  :capacity_specification,
  :encryption_specification,
  :point_in_time_recovery,
  :ttl,
  :default_time_to_live,
  :client_side_timestamps,
  :auto_scaling_specification,
  :replica_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#auto_scaling_specification ⇒ Types::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*.

[1]: docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html

Returns:



1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 1874

class UpdateTableRequest < Struct.new(
  :keyspace_name,
  :table_name,
  :add_columns,
  :capacity_specification,
  :encryption_specification,
  :point_in_time_recovery,
  :ttl,
  :default_time_to_live,
  :client_side_timestamps,
  :auto_scaling_specification,
  :replica_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_specification ⇒ Types::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*.

[1]: docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html

Returns:



1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 1874

class UpdateTableRequest < Struct.new(
  :keyspace_name,
  :table_name,
  :add_columns,
  :capacity_specification,
  :encryption_specification,
  :point_in_time_recovery,
  :ttl,
  :default_time_to_live,
  :client_side_timestamps,
  :auto_scaling_specification,
  :replica_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#client_side_timestamps ⇒ Types::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.

Returns:



1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 1874

class UpdateTableRequest < Struct.new(
  :keyspace_name,
  :table_name,
  :add_columns,
  :capacity_specification,
  :encryption_specification,
  :point_in_time_recovery,
  :ttl,
  :default_time_to_live,
  :client_side_timestamps,
  :auto_scaling_specification,
  :replica_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#default_time_to_live ⇒ 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*.

[1]: docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl

Returns:

  • (Integer) 


1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 1874

class UpdateTableRequest < Struct.new(
  :keyspace_name,
  :table_name,
  :add_columns,
  :capacity_specification,
  :encryption_specification,
  :point_in_time_recovery,
  :ttl,
  :default_time_to_live,
  :client_side_timestamps,
  :auto_scaling_specification,
  :replica_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_specification ⇒ Types::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*.

[1]: docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html

Returns:



1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 1874

class UpdateTableRequest < Struct.new(
  :keyspace_name,
  :table_name,
  :add_columns,
  :capacity_specification,
  :encryption_specification,
  :point_in_time_recovery,
  :ttl,
  :default_time_to_live,
  :client_side_timestamps,
  :auto_scaling_specification,
  :replica_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#keyspace_name ⇒ String

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

Returns:

  • (String) 


1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 1874

class UpdateTableRequest < Struct.new(
  :keyspace_name,
  :table_name,
  :add_columns,
  :capacity_specification,
  :encryption_specification,
  :point_in_time_recovery,
  :ttl,
  :default_time_to_live,
  :client_side_timestamps,
  :auto_scaling_specification,
  :replica_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#point_in_time_recovery ⇒ Types::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*.

[1]: docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html

Returns:



1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 1874

class UpdateTableRequest < Struct.new(
  :keyspace_name,
  :table_name,
  :add_columns,
  :capacity_specification,
  :encryption_specification,
  :point_in_time_recovery,
  :ttl,
  :default_time_to_live,
  :client_side_timestamps,
  :auto_scaling_specification,
  :replica_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#replica_specifications ⇒ Array<Types::ReplicaSpecification>

The Region specific settings of a multi-Regional table.

Returns:



1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 1874

class UpdateTableRequest < Struct.new(
  :keyspace_name,
  :table_name,
  :add_columns,
  :capacity_specification,
  :encryption_specification,
  :point_in_time_recovery,
  :ttl,
  :default_time_to_live,
  :client_side_timestamps,
  :auto_scaling_specification,
  :replica_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#table_name ⇒ String

The name of the table.

Returns:

  • (String) 


1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 1874

class UpdateTableRequest < Struct.new(
  :keyspace_name,
  :table_name,
  :add_columns,
  :capacity_specification,
  :encryption_specification,
  :point_in_time_recovery,
  :ttl,
  :default_time_to_live,
  :client_side_timestamps,
  :auto_scaling_specification,
  :replica_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#ttl ⇒ Types::TimeToLive

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

[1]: docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html

Returns:



1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 1874

class UpdateTableRequest < Struct.new(
  :keyspace_name,
  :table_name,
  :add_columns,
  :capacity_specification,
  :encryption_specification,
  :point_in_time_recovery,
  :ttl,
  :default_time_to_live,
  :client_side_timestamps,
  :auto_scaling_specification,
  :replica_specifications)
  SENSITIVE = []
  include Aws::Structure
end