Class: Aws::Keyspaces::Types::CreateTableRequest

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

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

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

Returns:



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 628

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

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

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

Returns:



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 628

class CreateTableRequest < Struct.new(
  :keyspace_name,
  :table_name,
  :schema_definition,
  :comment,
  :capacity_specification,
  :encryption_specification,
  :point_in_time_recovery,
  :ttl,
  :default_time_to_live,
  :tags,
  :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:



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 628

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

#comment ⇒ Types::Comment

This parameter allows to enter a description of the table.

Returns:



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 628

class CreateTableRequest < Struct.new(
  :keyspace_name,
  :table_name,
  :schema_definition,
  :comment,
  :capacity_specification,
  :encryption_specification,
  :point_in_time_recovery,
  :ttl,
  :default_time_to_live,
  :tags,
  :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) 


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 628

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

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

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

Returns:



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 628

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

#keyspace_name ⇒ String

The name of the keyspace that the table is going to be created in.

Returns:

  • (String) 


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 628

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

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

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

Returns:



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 628

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

#replica_specifications ⇒ Array<Types::ReplicaSpecification>

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)

Returns:



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 628

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

#schema_definition ⇒ Types::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][1

    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.

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

Returns:



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 628

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

#table_name ⇒ String

The name of the table.

Returns:

  • (String) 


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 628

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

#tags ⇒ Array<Types::Tag>

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

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

Returns:



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 628

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

#ttl ⇒ Types::TimeToLive

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

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

Returns:



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/aws-sdk-keyspaces/types.rb', line 628

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