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

Inherits:

Struct

• Object
• Struct
• Aws::Keyspaces::Types::UpdateTableRequest

Defined in:

gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #add_columns ⇒ Array<Types::ColumnDefinition>

  For each column to be added to the specified table:.

• #capacity_specification ⇒ Types::CapacitySpecification

  Modifies the read/write throughput capacity mode for the table.

• #client_side_timestamps ⇒ Types::ClientSideTimestamps

  Enables client-side timestamps for the table.

• #default_time_to_live ⇒ Integer

  The default Time to Live setting in seconds for the table.

• #encryption_specification ⇒ Types::EncryptionSpecification

  Modifies the encryption settings of the table.

• #keyspace_name ⇒ String

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

• #point_in_time_recovery ⇒ Types::PointInTimeRecovery

  Modifies the pointInTimeRecovery settings of the table.

• #table_name ⇒ String

  The name of the table.

• #ttl ⇒ Types::TimeToLive

  Modifies Time to Live custom settings for the table.

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:

• (Array<Types::ColumnDefinition>)

# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb', line 1369

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

• (Types::CapacitySpecification)

# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb', line 1369

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

• (Types::ClientSideTimestamps)

# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb', line 1369

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)
  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)

# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb', line 1369

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

• (Types::EncryptionSpecification)

# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb', line 1369

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

#keyspace_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb', line 1369

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

• (Types::PointInTimeRecovery)

# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb', line 1369

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

#table_name ⇒ String

The name of the table.

Returns:

• (String)

# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb', line 1369

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

• (Types::TimeToLive)

# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/types.rb', line 1369

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