Class: Aws::DynamoDB::Types::UpdateTableInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::DynamoDB::Types::UpdateTableInput
- Defined in:
- gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb
Overview
Represents the input of an UpdateTable
operation.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#attribute_definitions ⇒ Array<Types::AttributeDefinition>
An array of attributes that describe the key schema for the table and indexes.
-
#billing_mode ⇒ String
Controls how you are charged for read and write throughput and how you manage capacity.
-
#deletion_protection_enabled ⇒ Boolean
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
-
#global_secondary_index_updates ⇒ Array<Types::GlobalSecondaryIndexUpdate>
An array of one or more global secondary indexes for the table.
-
#multi_region_consistency ⇒ String
Specifies the consistency mode for a new global table.
-
#on_demand_throughput ⇒ Types::OnDemandThroughput
Updates the maximum number of read and write units for the specified table in on-demand capacity mode.
-
#provisioned_throughput ⇒ Types::ProvisionedThroughput
The new provisioned throughput settings for the specified table or index.
-
#replica_updates ⇒ Array<Types::ReplicationGroupUpdate>
A list of replica update actions (create, delete, or update) for the table.
-
#sse_specification ⇒ Types::SSESpecification
The new server-side encryption settings for the specified table.
-
#stream_specification ⇒ Types::StreamSpecification
Represents the DynamoDB Streams configuration for the table.
-
#table_class ⇒ String
The table class of the table to be updated.
-
#table_name ⇒ String
The name of the table to be updated.
-
#warm_throughput ⇒ Types::WarmThroughput
Represents the warm throughput (in read units per second and write units per second) for updating a table.
Instance Attribute Details
#attribute_definitions ⇒ Array<Types::AttributeDefinition>
An array of attributes that describe the key schema for the table
and indexes. If you are adding a new global secondary index to the
table, AttributeDefinitions
must include the key element(s) of the
new index.
10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 10594 class UpdateTableInput < Struct.new( :attribute_definitions, :table_name, :billing_mode, :provisioned_throughput, :global_secondary_index_updates, :stream_specification, :sse_specification, :replica_updates, :table_class, :deletion_protection_enabled, :multi_region_consistency, :on_demand_throughput, :warm_throughput) SENSITIVE = [] include Aws::Structure end |
#billing_mode ⇒ String
Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned capacity mode.PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-demand capacity mode.
10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 10594 class UpdateTableInput < Struct.new( :attribute_definitions, :table_name, :billing_mode, :provisioned_throughput, :global_secondary_index_updates, :stream_specification, :sse_specification, :replica_updates, :table_class, :deletion_protection_enabled, :multi_region_consistency, :on_demand_throughput, :warm_throughput) SENSITIVE = [] include Aws::Structure end |
#deletion_protection_enabled ⇒ Boolean
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 10594 class UpdateTableInput < Struct.new( :attribute_definitions, :table_name, :billing_mode, :provisioned_throughput, :global_secondary_index_updates, :stream_specification, :sse_specification, :replica_updates, :table_class, :deletion_protection_enabled, :multi_region_consistency, :on_demand_throughput, :warm_throughput) SENSITIVE = [] include Aws::Structure end |
#global_secondary_index_updates ⇒ Array<Types::GlobalSecondaryIndexUpdate>
An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:
Create
- add a new global secondary index to the table.Update
- modify the provisioned throughput settings of an existing global secondary index.Delete
- remove a global secondary index from the table.
You can create or delete only one global secondary index per
UpdateTable
operation.
For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 10594 class UpdateTableInput < Struct.new( :attribute_definitions, :table_name, :billing_mode, :provisioned_throughput, :global_secondary_index_updates, :stream_specification, :sse_specification, :replica_updates, :table_class, :deletion_protection_enabled, :multi_region_consistency, :on_demand_throughput, :warm_throughput) SENSITIVE = [] include Aws::Structure end |
#multi_region_consistency ⇒ String
Specifies the consistency mode for a new global table. This parameter is only valid when you create a global table by specifying one or more Create actions in the ReplicaUpdates action list.
You can specify one of the following consistency modes:
EVENTUAL
: Configures a new global table for multi-Region eventual consistency. This is the default consistency mode for global tables.STRONG
: Configures a new global table for multi-Region strong consistency (preview).Multi-Region strong consistency (MRSC) is a new DynamoDB global tables capability currently available in preview mode. For more information, see Global tables multi-Region strong consistency.
If you don't specify this parameter, the global table consistency
mode defaults to EVENTUAL
.
10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 10594 class UpdateTableInput < Struct.new( :attribute_definitions, :table_name, :billing_mode, :provisioned_throughput, :global_secondary_index_updates, :stream_specification, :sse_specification, :replica_updates, :table_class, :deletion_protection_enabled, :multi_region_consistency, :on_demand_throughput, :warm_throughput) SENSITIVE = [] include Aws::Structure end |
#on_demand_throughput ⇒ Types::OnDemandThroughput
Updates the maximum number of read and write units for the specified
table in on-demand capacity mode. If you use this parameter, you
must specify MaxReadRequestUnits
, MaxWriteRequestUnits
, or both.
10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 10594 class UpdateTableInput < Struct.new( :attribute_definitions, :table_name, :billing_mode, :provisioned_throughput, :global_secondary_index_updates, :stream_specification, :sse_specification, :replica_updates, :table_class, :deletion_protection_enabled, :multi_region_consistency, :on_demand_throughput, :warm_throughput) SENSITIVE = [] include Aws::Structure end |
#provisioned_throughput ⇒ Types::ProvisionedThroughput
The new provisioned throughput settings for the specified table or index.
10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 10594 class UpdateTableInput < Struct.new( :attribute_definitions, :table_name, :billing_mode, :provisioned_throughput, :global_secondary_index_updates, :stream_specification, :sse_specification, :replica_updates, :table_class, :deletion_protection_enabled, :multi_region_consistency, :on_demand_throughput, :warm_throughput) SENSITIVE = [] include Aws::Structure end |
#replica_updates ⇒ Array<Types::ReplicationGroupUpdate>
A list of replica update actions (create, delete, or update) for the table.
10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 10594 class UpdateTableInput < Struct.new( :attribute_definitions, :table_name, :billing_mode, :provisioned_throughput, :global_secondary_index_updates, :stream_specification, :sse_specification, :replica_updates, :table_class, :deletion_protection_enabled, :multi_region_consistency, :on_demand_throughput, :warm_throughput) SENSITIVE = [] include Aws::Structure end |
#sse_specification ⇒ Types::SSESpecification
The new server-side encryption settings for the specified table.
10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 10594 class UpdateTableInput < Struct.new( :attribute_definitions, :table_name, :billing_mode, :provisioned_throughput, :global_secondary_index_updates, :stream_specification, :sse_specification, :replica_updates, :table_class, :deletion_protection_enabled, :multi_region_consistency, :on_demand_throughput, :warm_throughput) SENSITIVE = [] include Aws::Structure end |
#stream_specification ⇒ Types::StreamSpecification
Represents the DynamoDB Streams configuration for the table.
ValidationException
if you try to enable a stream on
a table that already has a stream, or if you try to disable a stream
on a table that doesn't have a stream.
10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 10594 class UpdateTableInput < Struct.new( :attribute_definitions, :table_name, :billing_mode, :provisioned_throughput, :global_secondary_index_updates, :stream_specification, :sse_specification, :replica_updates, :table_class, :deletion_protection_enabled, :multi_region_consistency, :on_demand_throughput, :warm_throughput) SENSITIVE = [] include Aws::Structure end |
#table_class ⇒ String
The table class of the table to be updated. Valid values are
STANDARD
and STANDARD_INFREQUENT_ACCESS
.
10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 10594 class UpdateTableInput < Struct.new( :attribute_definitions, :table_name, :billing_mode, :provisioned_throughput, :global_secondary_index_updates, :stream_specification, :sse_specification, :replica_updates, :table_class, :deletion_protection_enabled, :multi_region_consistency, :on_demand_throughput, :warm_throughput) SENSITIVE = [] include Aws::Structure end |
#table_name ⇒ String
The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 10594 class UpdateTableInput < Struct.new( :attribute_definitions, :table_name, :billing_mode, :provisioned_throughput, :global_secondary_index_updates, :stream_specification, :sse_specification, :replica_updates, :table_class, :deletion_protection_enabled, :multi_region_consistency, :on_demand_throughput, :warm_throughput) SENSITIVE = [] include Aws::Structure end |
#warm_throughput ⇒ Types::WarmThroughput
Represents the warm throughput (in read units per second and write units per second) for updating a table.
10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 10594 class UpdateTableInput < Struct.new( :attribute_definitions, :table_name, :billing_mode, :provisioned_throughput, :global_secondary_index_updates, :stream_specification, :sse_specification, :replica_updates, :table_class, :deletion_protection_enabled, :multi_region_consistency, :on_demand_throughput, :warm_throughput) SENSITIVE = [] include Aws::Structure end |