class Amazonite::DynamoDB::UpdateTableInput

Overview

Represents the input of an UpdateTable operation.

Included Modules

Defined in:

dynamodb/update_table_input.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(table_name : String, attribute_definitions : Array(AttributeDefinition) | Nil = nil, billing_mode : BillingMode | Nil = nil, provisioned_throughput : ProvisionedThroughput | Nil = nil, global_secondary_index_updates : Array(GlobalSecondaryIndexUpdate) | Nil = nil, stream_specification : StreamSpecification | Nil = nil, sse_specification : SSESpecification | Nil = nil, replica_updates : Array(ReplicationGroupUpdate) | Nil = nil, table_class : TableClass | Nil = nil, deletion_protection_enabled : Bool | Nil = nil, multi_region_consistency : MultiRegionConsistency | Nil = nil, global_table_witness_updates : Array(GlobalTableWitnessGroupUpdate) | Nil = nil, on_demand_throughput : OnDemandThroughput | Nil = nil, warm_throughput : WarmThroughput | Nil = nil, global_table_settings_replication_mode : GlobalTableSettingsReplicationMode | Nil = nil, vector_index_updates : Array(VectorIndexUpdate) | Nil = nil) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def attribute_definitions : Array(AttributeDefinition) | Nil #

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.


[View source]
def attribute_definitions=(attribute_definitions : Array(AttributeDefinition) | Nil) #

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.


[View source]
def billing_mode : BillingMode | Nil #

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.


[View source]
def billing_mode=(billing_mode : BillingMode | Nil) #

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.


[View source]
def deletion_protection_enabled : Bool | Nil #

Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.


[View source]
def deletion_protection_enabled=(deletion_protection_enabled : Bool | Nil) #

Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.


[View source]
def global_secondary_index_updates : Array(GlobalSecondaryIndexUpdate) | Nil #

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.


[View source]
def global_secondary_index_updates=(global_secondary_index_updates : Array(GlobalSecondaryIndexUpdate) | Nil) #

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.


[View source]
def global_table_settings_replication_mode : GlobalTableSettingsReplicationMode | Nil #

Controls the settings replication mode for a global table replica. This attribute can be defined using UpdateTable operation only on a regional table with values:

  • ENABLED: Defines settings replication on a regional table to be used as a source table for creating Multi-Account Global Table.

  • DISABLED: Remove settings replication on a regional table. Settings replication needs to be defined to ENABLED again in order to create a Multi-Account Global Table using this table.


[View source]
def global_table_settings_replication_mode=(global_table_settings_replication_mode : GlobalTableSettingsReplicationMode | Nil) #

Controls the settings replication mode for a global table replica. This attribute can be defined using UpdateTable operation only on a regional table with values:

  • ENABLED: Defines settings replication on a regional table to be used as a source table for creating Multi-Account Global Table.

  • DISABLED: Remove settings replication on a regional table. Settings replication needs to be defined to ENABLED again in order to create a Multi-Account Global Table using this table.


[View source]
def global_table_witness_updates : Array(GlobalTableWitnessGroupUpdate) | Nil #

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


[View source]
def global_table_witness_updates=(global_table_witness_updates : Array(GlobalTableWitnessGroupUpdate) | Nil) #

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


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def multi_region_consistency : MultiRegionConsistency | Nil #

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.


[View source]
def multi_region_consistency=(multi_region_consistency : MultiRegionConsistency | Nil) #

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.


[View source]
def on_demand_throughput : OnDemandThroughput | Nil #

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.


[View source]
def on_demand_throughput=(on_demand_throughput : OnDemandThroughput | Nil) #

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.


[View source]
def provisioned_throughput : ProvisionedThroughput | Nil #

The new provisioned throughput settings for the specified table or index.


[View source]
def provisioned_throughput=(provisioned_throughput : ProvisionedThroughput | Nil) #

The new provisioned throughput settings for the specified table or index.


[View source]
def replica_updates : Array(ReplicationGroupUpdate) | Nil #

A list of replica update actions (create, delete, or update) for the table.


[View source]
def replica_updates=(replica_updates : Array(ReplicationGroupUpdate) | Nil) #

A list of replica update actions (create, delete, or update) for the table.


[View source]
def sse_specification : SSESpecification | Nil #

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


[View source]
def sse_specification=(sse_specification : SSESpecification | Nil) #

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


[View source]
def stream_specification : StreamSpecification | Nil #

Represents the DynamoDB Streams configuration for the table.

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.


[View source]
def stream_specification=(stream_specification : StreamSpecification | Nil) #

Represents the DynamoDB Streams configuration for the table.

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.


[View source]
def table_class : TableClass | Nil #

The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.


[View source]
def table_class=(table_class : TableClass | Nil) #

The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.


[View source]
def 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.


[View source]
def table_name=(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.


[View source]
def validate! : Nil #

[View source]
def vector_index_updates : Array(VectorIndexUpdate) | Nil #

A list of vector indexes to be added to or removed from the table. You can add or remove one vector index for each UpdateTable operation.

To add a vector index, specify IndexName, VectorAttribute, Dimensions, DistanceFunction, and Projection. To remove a vector index, specify only the IndexName.


[View source]
def vector_index_updates=(vector_index_updates : Array(VectorIndexUpdate) | Nil) #

A list of vector indexes to be added to or removed from the table. You can add or remove one vector index for each UpdateTable operation.

To add a vector index, specify IndexName, VectorAttribute, Dimensions, DistanceFunction, and Projection. To remove a vector index, specify only the IndexName.


[View source]
def warm_throughput : WarmThroughput | Nil #

Represents the warm throughput (in read units per second and write units per second) for updating a table.


[View source]
def warm_throughput=(warm_throughput : WarmThroughput | Nil) #

Represents the warm throughput (in read units per second and write units per second) for updating a table.


[View source]