Class: Aws::DynamoDB::Types::UpdateTableInput

Inherits:

Struct

Object
Struct
Aws::DynamoDB::Types::UpdateTableInput

show all

Includes:: Structure

Defined in:: 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.
#global_table_witness_updates ⇒ Array<Types::GlobalTableWitnessGroupUpdate>

A list of witness updates for a MRSC global 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.

Returns:

(Array<Types::AttributeDefinition>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 10925

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,
  :global_table_witness_updates,
  :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.

PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for most DynamoDB workloads. PAY_PER_REQUEST sets the billing mode to [On-demand capacity mode].
PROVISIONED - We recommend using PROVISIONED for steady workloads with predictable growth where capacity requirements can be reliably forecasted. PROVISIONED sets the billing mode to [Provisioned capacity mode].

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/on-demand-capacity-mode.html [2]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html

Returns:

(String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 10925

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,
  :global_table_witness_updates,
  :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.

Returns:

(Boolean)

# File 'lib/aws-sdk-dynamodb/types.rb', line 10925

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,
  :global_table_witness_updates,
  :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*.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.OnlineOps.html

Returns:

(Array<Types::GlobalSecondaryIndexUpdate>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 10925

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

#global_table_witness_updates ⇒ `Array<Types::GlobalTableWitnessGroupUpdate>`

A list of witness updates for a MRSC global table. A witness provides a cost-effective alternative to a full replica in a MRSC global table by maintaining replicated change data written to global table replicas. You cannot perform read or write operations on a witness. For each witness, you can request one action:

Create - add a new witness to the global table.
Delete - remove a witness from the global table.

You can create or delete only one witness per UpdateTable operation.

For more information, see [Multi-Region strong consistency (MRSC)] in the Amazon DynamoDB Developer Guide

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_HowItWorks.html#V2globaltables_HowItWorks.consistency-modes

Returns:

(Array<Types::GlobalTableWitnessGroupUpdate>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 10925

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,
  :global_table_witness_updates,
  :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 (MREC). This is the default consistency mode for global tables.
STRONG: Configures a new global table for multi-Region strong consistency (MRSC).

If you don’t specify this field, the global table consistency mode defaults to EVENTUAL. For more information about global tables consistency modes, see [ Consistency modes] in DynamoDB developer guide.

[1]: docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ReplicationGroupUpdate.html#DDB-Type-ReplicationGroupUpdate-Create [2]: docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTable.html#DDB-UpdateTable-request-ReplicaUpdates [3]: docs.aws.amazon.com/V2globaltables_HowItWorks.html#V2globaltables_HowItWorks.consistency-modes

Returns:

(String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 10925

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,
  :global_table_witness_updates,
  :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.

Returns:

(Types::OnDemandThroughput)

# File 'lib/aws-sdk-dynamodb/types.rb', line 10925

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,
  :global_table_witness_updates,
  :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.

Returns:

(Types::ProvisionedThroughput)

# File 'lib/aws-sdk-dynamodb/types.rb', line 10925

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,
  :global_table_witness_updates,
  :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.

Returns:

(Array<Types::ReplicationGroupUpdate>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 10925

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

#sse_specification ⇒ `Types::SSESpecification`

The new server-side encryption settings for the specified table.

Returns:

(Types::SSESpecification)

# File 'lib/aws-sdk-dynamodb/types.rb', line 10925

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

#stream_specification ⇒ `Types::StreamSpecification`

Represents the DynamoDB Streams configuration for the table.

<note markdown=“1”> You receive a 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.

</note>

Returns:

(Types::StreamSpecification)

# File 'lib/aws-sdk-dynamodb/types.rb', line 10925

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,
  :global_table_witness_updates,
  :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.

Returns:

(String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 10925

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,
  :global_table_witness_updates,
  :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.

Returns:

(String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 10925

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,
  :global_table_witness_updates,
  :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.

Returns:

(Types::WarmThroughput)

# File 'lib/aws-sdk-dynamodb/types.rb', line 10925

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

Class: Aws::DynamoDB::Types::UpdateTableInput

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_definitions ⇒ Array<Types::AttributeDefinition>

#billing_mode ⇒ String

#deletion_protection_enabled ⇒ Boolean

#global_secondary_index_updates ⇒ Array<Types::GlobalSecondaryIndexUpdate>

#global_table_witness_updates ⇒ Array<Types::GlobalTableWitnessGroupUpdate>

#multi_region_consistency ⇒ String

#on_demand_throughput ⇒ Types::OnDemandThroughput

#provisioned_throughput ⇒ Types::ProvisionedThroughput

#replica_updates ⇒ Array<Types::ReplicationGroupUpdate>

#sse_specification ⇒ Types::SSESpecification

#stream_specification ⇒ Types::StreamSpecification

#table_class ⇒ String

#table_name ⇒ String

#warm_throughput ⇒ Types::WarmThroughput

#attribute_definitions ⇒ `Array<Types::AttributeDefinition>`

#billing_mode ⇒ `String`

#deletion_protection_enabled ⇒ `Boolean`

#global_secondary_index_updates ⇒ `Array<Types::GlobalSecondaryIndexUpdate>`

#global_table_witness_updates ⇒ `Array<Types::GlobalTableWitnessGroupUpdate>`

#multi_region_consistency ⇒ `String`

#on_demand_throughput ⇒ `Types::OnDemandThroughput`

#provisioned_throughput ⇒ `Types::ProvisionedThroughput`

#replica_updates ⇒ `Array<Types::ReplicationGroupUpdate>`

#sse_specification ⇒ `Types::SSESpecification`

#stream_specification ⇒ `Types::StreamSpecification`

#table_class ⇒ `String`

#table_name ⇒ `String`

#warm_throughput ⇒ `Types::WarmThroughput`