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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-keyspaces/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 in the Amazon Keyspaces Developer Guide.

Returns:



2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
 
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb', line 2300

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,
  :cdc_specification)
  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.

Returns:



2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
 
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb', line 2300

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,
  :cdc_specification)
  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.

Returns:



2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
 
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb', line 2300

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,
  :cdc_specification)
  SENSITIVE = []
  include Aws::Structure
end

#cdc_specification ⇒ Types::CdcSpecification

The CDC stream settings of the table.

Returns:



2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
 
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb', line 2300

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,
  :cdc_specification)
  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:



2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
 
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb', line 2300

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,
  :cdc_specification)
  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.

Returns:

  • (Integer) 


2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
 
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb', line 2300

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,
  :cdc_specification)
  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.

Returns:



2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
 
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb', line 2300

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,
  :cdc_specification)
  SENSITIVE = []
  include Aws::Structure
end

#keyspace_name ⇒ String

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

Returns:

  • (String) 


2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
 
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb', line 2300

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,
  :cdc_specification)
  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.

Returns:



2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
 
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb', line 2300

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,
  :cdc_specification)
  SENSITIVE = []
  include Aws::Structure
end

#replica_specifications ⇒ Array<Types::ReplicaSpecification>

The Region specific settings of a multi-Regional table.

Returns:



2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
 
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb', line 2300

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,
  :cdc_specification)
  SENSITIVE = []
  include Aws::Structure
end

#table_name ⇒ String

The name of the table.

Returns:

  • (String) 


2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
 
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb', line 2300

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,
  :cdc_specification)
  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.

Returns:



2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
 
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb', line 2300

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,
  :cdc_specification)
  SENSITIVE = []
  include Aws::Structure
end